Skip to content

Commit

Permalink
doc(talos): support for v2 data engine
Browse files Browse the repository at this point in the history
longhorn/longhorn-7791

Signed-off-by: Chin-Ya Huang <[email protected]>
  • Loading branch information
c3y1huang committed Sep 3, 2024
1 parent 4ca2728 commit 6a4f7f3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,22 @@ machine:

For detailed instructions, see the Talos documentation on [Editing Machine Configuration](https://www.talos.dev/v1.6/talos-guides/configuration/editing-machine-configuration/).

## Limitations
## v2 Data Engine

- Exclusive to v1 data volume: currently, within a Talos Linux cluster, Longhorn only supports v1 data volume. The v2 data volume isn't currently supported in this environment.
To use the v2 data engine volumes, ensure your nodes fulfill the v2 data engine [prerequisites](../../../v2-data-engine/prerequisites#prerequisites).

```yaml
machine:
sysctls:
vm.nr_hugepages: "1024"
kernel:
modules:
- name: nvme_tcp
- name: vfio_pci
# - name: uio_pci_generio
```

**Note:** Talos Linux version prior to 1.7.0 do not include the `uio_pci_generio` kernel module. If your system device supports `vfio_pci`, it's the preferred method and you won't need to install and enable the `uio_pci_generio` kernel driver, for more details, see [SPDK: System Configuration User Guide](https://spdk.io/doc/system_configuration.html). If `vfio_pci` is incompatible with your system or specific hardware, you will need to use `uio_pci_generio`. Furture version of Talos Linux are expected to include native support for `uio_pci_generio`, see GitHub issue - [uio_pci_generic can be required for DPDK or SPDK](https://github.com/siderolabs/talos/issues/9236).

Check failure on line 74 in content/docs/1.8.0/advanced-resources/os-distro-specific/talos-linux-support.md

View workflow job for this annotation

GitHub Actions / codespell

Furture ==> Future

## Talos Linux Upgrades

Expand Down
8 changes: 8 additions & 0 deletions content/docs/1.8.0/important-notes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current
- [Auto-Balance Pressured Disks](#auto-balance-pressured-disks)
- [Networking](#networking)
- [Storage Network Support for Read-Write-Many (RWX) Volumes](#storage-network-support-for-read-write-many-rwx-volumes)
- [OS Distro Specific](#os-distro-specific)
- [V2 Data Engine Support for Talos Linux](#talos-linux)
- [V2 Data Engine](#v2-data-engine)
- [Longhorn System Upgrade](#longhorn-system-upgrade)
- [Enable Both `vfio_pci` and `uio_pci_generic` Kernel Modules](#enable-both-vfio_pci-and-uio_pci_generic-kernel-modules)
Expand Down Expand Up @@ -193,6 +195,12 @@ To apply the storage network to existing RWX volumes, you must detach the volume

For more information, see [Issue #8184](https://github.com/longhorn/longhorn/issues/8184).

## OS Distro Specific

### Talos Linux

The v2 volumes are supported from Longhorn v1.8.0. To use the v2 data engine, setup your Talos Linux cluster to mee the v2 data engine prerequisites. For more information, see [Talos Linux Support: v2 data engine](../advanced-resources/os-distro-specific/talos-linux-support#v2-data-engine).

## V2 Data Engine

### Longhorn System Upgrade
Expand Down

0 comments on commit 6a4f7f3

Please sign in to comment.