Skip to content

Commit

Permalink
doc(1.6.0): Talos Linux support
Browse files Browse the repository at this point in the history
longhorn-3161

Signed-off-by: Chin-Ya Huang <chin-ya.huang@suse.com>
  • Loading branch information
c3y1huang committed Dec 29, 2023
1 parent a20125c commit f92fe86
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Talos Linux Support
weight: 5
---

Before Longhorn installation on a Talos Linux cluster, specific configurations are required.

- [Installation Of System Extensions](#installation-of-system-extensions)
- [Data Path Mounts](#data-path-mounts)
- [References](#references)

## Installation Of System Extensions

Longhorn depends on `siderolabs/iscsi-tools` and `siderolabs/util-linux-tools` system extensions, which need to be installed before installing Longhorn.

The most straightforward way is patching these system extensions into existing Talos Linux nodes.

```yaml
customization:
systemExtensions:
officialExtensions:
- siderolabs/iscsi-tools
- siderolabs/util-linux-tools
```
For detailed instructions, see Talos' documentation on [System Extensions](https://www.talos.dev/v1.6/talos-guides/configuration/system-extensions/) and [Boot Assets](https://www.talos.dev/v1.6/talos-guides/install/boot-assets/).
## Data Path Mounts
Longhorn requires to mount the datapath to the kubelete container.
```yaml
machine:
kubelet:
extraMounts:
- destination: /var/lib/longhorn
type: bind
source: /var/lib/longhorn
options:
- bind
- rshared
- rw
```
For detailed instructions, see Talos' documentation on [Editing Machine Configuration](https://www.talos.dev/v1.6/talos-guides/configuration/editing-machine-configuration/).
## References
- [[FEATURE] Talos support](https://github.com/longhorn/longhorn/issues/3161)
1 change: 1 addition & 0 deletions content/docs/1.6.0/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ The following Linux OS distributions and versions have been verified during the
| 4. | RHEL | 9.1
| 5. | Oracle Linux | 9.1
| 6. | Rocky Linux | 9.2
| 7. | Talos Linux | 1.6.0

Note: It's recommended to guarantee that the kernel version is at least 5.8 as there is filesystem optimization/improvement since this version. See [this issue](https://github.com/longhorn/longhorn/issues/2507#issuecomment-857195496) for details.

Expand Down
5 changes: 5 additions & 0 deletions content/docs/1.6.0/deploy/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ For the minimum recommended hardware, refer to the [best practices guide.](../..
- **K3s clusters** require some extra setup. Refer to [this section](../../advanced-resources/os-distro-specific/csi-on-k3s)
- **RKE clusters with CoreOS** need [this configuration.](../../advanced-resources/os-distro-specific/csi-on-rke-and-coreos)
- **OCP/OKD clusters** require some extra setup. Refer to [this section](../../advanced-resources/os-distro-specific/okd-support)
- **Talos Linux** require some extra setup. Refer to [this section](../../advanced-resources/os-distro-specific/talos-linux-support)

### Using the Environment Check Script

Expand Down Expand Up @@ -156,6 +157,8 @@ You may need to edit the cluster security group to allow SSH access.
systemctl start iscsid
```

- For Talos Linux, refer to [this section](../../advanced-resources/os-distro-specific/talos-linux-support.md).

Please ensure iscsi_tcp module has been loaded before iscsid service starts. Generally, it should be automatically loaded along with the package installation.

```
Expand Down Expand Up @@ -223,6 +226,8 @@ The command used to install a NFSv4 client differs depending on the Linux distri
zypper install nfs-client
```

- For Talos Linux, [The NFS client is part of the `kubelet` image maintained by the Talos team](https://www.talos.dev/v1.6/kubernetes-guides/configuration/storage/#nfs).

We also provide an `nfs` installer to make it easier for users to install `nfs-client` automatically:
```
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{{< current-version >}}/deploy/prerequisite/longhorn-nfs-installation.yaml
Expand Down

0 comments on commit f92fe86

Please sign in to comment.