Skip to content

Commit

Permalink
doc(v1.7.0): update "Important Notes"
Browse files Browse the repository at this point in the history
Longhorn 8813

Signed-off-by: Derek Su <derek.su@suse.com>
  • Loading branch information
derekbit committed Jul 26, 2024
1 parent fa3271c commit 82f8130
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
5 changes: 5 additions & 0 deletions content/docs/1.7.0/deploy/important-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current
- [High Availability of Backing Images](#high-availability-of-backing-images)
- [V2 Data Engine](#v2-data-engine)
- [Longhorn System Upgrade](#longhorn-system-upgrade)
- [Using `vfio_pci` as the Default Userspace I/O Driver for Bare-Metal and Virtualized Environments](#using-vfio_pci-as-the-default-userspace-io-driver-for-bare-metal-and-virtualized-environments)
- [Introduction of Online Replica Rebuilding](#introduction-of-online-replica-rebuilding)
- [Block-type Disk Supports SPDK AIO, NVMe and VirtIO Bdev Drivers](#block-type-disk-supports-spdk-aio-nvme-and-virtio-bdev-drivers)
- [Introduction of Filesystem Trim](#introduction-of-filesystem-trim)
Expand Down Expand Up @@ -174,6 +175,10 @@ To address the single point of failure (SPOF) issue with backing images, high av
Longhorn currently does not support live upgrading of V2 volumes. Ensure that all V2 volumes are detached before initiating the upgrade process.
### Using `vfio_pci` as the Default Userspace I/O Driver for Bare-Metal and Virtualized Environments

For improved compatibility with both bare-metal and virtualized environments, it is recommended to use `vfio_pci` as the default Userspace I/O Driver. For more information, see this [link](https://github.com/longhorn/longhorn/issues/8813).

### Introduction of Online Replica Rebuilding

Online replica rebuilding was introduced in Longhorn 1.7.0, so offline replica rebuilding has been removed.
Expand Down
3 changes: 1 addition & 2 deletions content/docs/1.7.0/v2-data-engine/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ Longhorn nodes must meet the following requirements:
> Memory corruption may occur on hosts using versions of the Linux kernel earlier than 6.7, as highlighted by this SPDK upstream issue: https://github.com/spdk/spdk/issues/3116#issuecomment-1890984674. In Longhorn environment the kernel panic can be caused by prevalent IO timeouts in communications between the nvme-tcp driver and SPDK. Update the Linux kernel on Longhorn nodes to version 6.7 or later to prevent the issue from occurring.
- Linux kernel modules
- uio
- uio_pci_generic
- `vfio_pci`
- nvme-tcp

- Huge page support
Expand Down
5 changes: 2 additions & 3 deletions content/docs/1.7.0/v2-data-engine/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ SPDK environment is configured successfully
Or, you can install them manually by following these steps.
- Load the kernel modules on the each Longhorn node
```
modprobe uio
modprobe uio_pci_generic
modprobe vfio_pci
```

- Configure huge pages
Expand Down Expand Up @@ -93,7 +92,7 @@ Or, you can manually load `nvme-tcp` kernel module on the each Longhorn node

### Load Kernel Modules Automatically on Boot

Rather than manually loading kernel modules `uio`, `uio_pci_generic` and `nvme-tcp` each time after reboot, you can streamline the process by configuring automatic module loading during the boot sequence. For detailed instructions, please consult the manual provided by your operating system.
Rather than manually loading kernel modules `vfio_pci` and `nvme-tcp` each time after reboot, you can streamline the process by configuring automatic module loading during the boot sequence. For detailed instructions, please consult the manual provided by your operating system.

Reference:
- [SUSE/OpenSUSE: Loading kernel modules automatically on boot](https://documentation.suse.com/sles/15-SP4/html/SLES-all/cha-mod.html#sec-mod-modprobe-d)
Expand Down

0 comments on commit 82f8130

Please sign in to comment.