Merge branch 'main' into issue_5401

jillian-maroket · web-flow · commit 1064d93ce726 · 2025-10-14T10:36:53.000+08:00
diff --git a/docs/advanced/addons/nvidiadrivertoolkit.md b/docs/advanced/addons/nvidiadrivertoolkit.md
@@ -30,6 +30,20 @@ To enable the addon, users need to perform the following:
 
 Once the addon is enabled, a nvidia-driver-toolkit daemonset is deployed to the cluster.
 
-On pod startup, the entrypoint script will download the nvidia driver from the speificied `Driver Location`, install the driver and load the kernel drivers.
+On pod startup, the ENTRYPOINT script will download the NVIDIA driver from the specified `Driver Location`. Install the driver and load the kernel drivers.
 
-The `PCIDevices` addon can now leverage this addon to manage the lifecycle of the vGPU devices on nodes containing supported GPU [devices](../vgpusupport.md).
+The `PCIDevices` addon can now leverage this addon to manage the lifecycle of the vGPU devices on nodes containing supported GPU [devices](../vgpusupport.md).
+
+## Install Different NVIDIA Driver Versions
+
+_Available as of v1.7.0_
+
+NVIDIA driver versions can vary across cluster nodes. If you want to install a specific driver version on a node, you must annotate the node before starting the nvidia-driver-toolkit add-on.
+
+```
+kubectl annotate nodes {node name} sriovgpu.harvesterhci.io/custom-driver=https://[driver location]
+```
+
+The nvidia-driver-toolkit installs the specified driver version upon starting.
+
+If an NVIDIA driver was previously installed, you must restart the pod to trigger the installation process again.
diff --git a/docs/install/external-disk-support.md b/docs/install/external-disk-support.md
@@ -75,8 +75,16 @@ os:
   externalStorageConfig:
     enabled: true
     multiPathConfig:
-    - vendor: "IET"
-      product: "MediaFiles"
+      blacklist:
+      - vendor: "!QEMU"
+        product: "!QEMU HARDDISK"
+      blacklistWwids:
+      - ".*"
+      blacklistExceptions:
+      - vendor: "DELL"
+        product: "POWERVAULT"
+      blacklistExceptionWwids:
+      - "^0QEMU_QEMU_HARDDISK_disk[0-9]+"
   additionalKernelArguments: "rd.iscsi.firmware vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none"
 ``` 
 
diff --git a/docs/install/harvester-configuration.md b/docs/install/harvester-configuration.md
@@ -54,6 +54,20 @@ os:
     topology.kubernetes.io/zone: zone1
     foo: bar
     mylabel: myvalue
+  externalStorageConfig:
+    enabled: true
+    multiPathConfig:
+      blacklist:
+      - vendor: "!QEMU"
+        product: "!QEMU HARDDISK"
+      blacklistWwids:
+      - ".*"
+      blacklistExceptions:
+      - vendor: "DELL"
+        product: "POWERVAULT"
+      blacklistExceptionWwids:
+      - "^0QEMU_QEMU_HARDDISK_disk[0-9]+"
+  additionalKernelArguments: "multipath=on"
 install:
   mode: create
   management_interface:
@@ -427,6 +441,66 @@ os:
     mylabel: myvalue
 ```
 
+### `os.externalStorageConfig`
+
+#### Definition
+
+Setting that enables support for external storage devices (for example, storage area network (SAN) devices) that use multipath I/O (MPIO). In the multipath configuration (`multiPathConfig`), you can add devices to the blacklist and whitelist based on specific criteria: vendor, product names, or World Wide Identifiers (WWIDs).
+
+When the setting is enabled, Harvester generates the `/etc/multipath.conf` file with the specified configuration, which the multipath daemon uses to manage storage devices.
+
+#### Example
+
+```yaml
+os:
+  externalStorageConfig:
+    enabled: true
+    multiPathConfig:
+      blacklist:
+      - vendor: "!QEMU"
+        product: "!QEMU HARDDISK"
+      blacklistWwids:
+      - ".*"
+      blacklistExceptions:
+      - vendor: "DELL"
+        product: "POWERVAULT"
+      blacklistExceptionWwids:
+      - "^0QEMU_QEMU_HARDDISK_disk[0-9]+"
+```
+
+This configuration generates the following `/etc/multipath.conf` file:
+
+```conf
+blacklist {
+    device {
+        vendor "!QEMU"
+        product "!QEMU HARDDISK"
+    }
+    wwid ".*"
+}
+
+blacklist_exceptions {
+    device {
+        vendor "DELL"
+        product "POWERVAULT"
+    }
+    wwid "^0QEMU_QEMU_HARDDISK_disk[0-9]+"
+}
+```
+
+### `os.additionalKernelArguments`
+
+#### Definition
+
+Additional kernel parameters to be passed to the Linux kernel at boot time. These arguments are appended to the default kernel command line and can be used to enable specific kernel features, configure hardware settings, or modify kernel behavior. Common use cases include enabling multipath support, configuring hardware-specific settings, or debugging options.
+
+#### Example
+
+```yaml
+os: 
+  additionalKernelArguments: "multipath=on"
+```
+
 ### `os.sshd.sftp`
 
 #### Definition
diff --git a/versioned_docs/version-v1.4/install/external-disk-support.md b/versioned_docs/version-v1.4/install/external-disk-support.md
@@ -80,6 +80,12 @@ os:
   additionalKernelArguments: "rd.iscsi.firmware vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none"
 ``` 
 
+:::info important
+
+The multiPathConfig structure changed starting in v1.7.0. While this change does not affect upgrades, you must review the [`os.externalStorageConfig`](/v1.7/install/harvester-configuration#osexternalstorageconfig) documentation before performing a fresh installation of v1.7.0 or later versions.
+
+:::
+
 The test setup uses multiple tagged VLANs, such as VLAN 2017 (used for connecting with the iSCSI volume) and VLAN 2011 (used for the Harvester management interface).
 
 The kernel argument `vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none` is necessary only if the iSCSI volume is accessible via an interface on a tagged VLAN. The arguments ensure that an additional tagged interface is created during boot and that a static address is allocated to the interface. See [dracut.cmdline](https://manpages.opensuse.org/Tumbleweed/dracut/dracut.cmdline.7.en.html) for more information about configuring the kernel arguments to match your use case.
diff --git a/versioned_docs/version-v1.5/install/external-disk-support.md b/versioned_docs/version-v1.5/install/external-disk-support.md
@@ -80,6 +80,12 @@ os:
   additionalKernelArguments: "rd.iscsi.firmware vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none"
 ``` 
 
+:::warning
+
+The `multiPathConfig` structure has changed since v1.7.0. Check the [latest configuration](/v1.7/install/harvester-configuration#osexternalstorageconfig) to set up your multipath configuration for fresh installations. This change will not impact upgrades.
+
+:::
+
 The test setup uses multiple tagged VLANs, such as VLAN 2017 (used for connecting with the iSCSI volume) and VLAN 2011 (used for the Harvester management interface).
 
 The kernel argument `vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none` is necessary only if the iSCSI volume is accessible via an interface on a tagged VLAN. The arguments ensure that an additional tagged interface is created during boot and that a static address is allocated to the interface. See [dracut.cmdline](https://manpages.opensuse.org/Tumbleweed/dracut/dracut.cmdline.7.en.html) for more information about configuring the kernel arguments to match your use case.
diff --git a/versioned_docs/version-v1.6/install/external-disk-support.md b/versioned_docs/version-v1.6/install/external-disk-support.md
@@ -80,6 +80,12 @@ os:
   additionalKernelArguments: "rd.iscsi.firmware vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none"
 ``` 
 
+:::warning
+
+The `multiPathConfig` structure has changed since v1.7.0. Check the [latest configuration](/v1.7/install/harvester-configuration#osexternalstorageconfig) to set up your multipath configuration for fresh installations. This change will not impact upgrades.
+
+:::
+
 The test setup uses multiple tagged VLANs, such as VLAN 2017 (used for connecting with the iSCSI volume) and VLAN 2011 (used for the Harvester management interface).
 
 The kernel argument `vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none` is necessary only if the iSCSI volume is accessible via an interface on a tagged VLAN. The arguments ensure that an additional tagged interface is created during boot and that a static address is allocated to the interface. See [dracut.cmdline](https://manpages.opensuse.org/Tumbleweed/dracut/dracut.cmdline.7.en.html) for more information about configuring the kernel arguments to match your use case.
