diff --git a/docs/rancher/csi-driver.md b/docs/rancher/csi-driver.md index 5c12a485d8..956280f585 100644 --- a/docs/rancher/csi-driver.md +++ b/docs/rancher/csi-driver.md @@ -294,10 +294,28 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber ## RWX Volumes Support +:::caution + +RWX volumes currently only work with a dedicated storage network. [GitHub issue #7218](https://github.com/harvester/harvester/issues/7218) tracks the enhancement that will allow RWX volumes to use various VLANs on guest clusters. + +::: + ### Prerequisites - Harvester v1.4 or later is installed on the host cluster. +- A [storage network](../advanced/storagenetwork.md) is configured on the Harvester cluster. + + Use **exclude** to reserve a range of IP addresses for the guest cluster virtual machines. + + ![](/img/v1.5/rancher/configure-storage-network-01.png) + +- The **Storage Network for RWX Volume** setting on the embedded Longhorn UI is enabled. + + Go to **General**, and then select **Storage Network for RWX Volume Enabled**. + + ![](/img/v1.5/rancher/enable-rwx-storage-network-01.png) + - You have created an RWX StorageClass on the host Harvester cluster. On the **Storage Class: Create** screen, click **Edit as YAML** and specify the following: @@ -377,6 +395,12 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber harvester-networkfs-manager-xvkgp 1/1 Running 4 (37m ago) 3h41m ``` +- The guest cluster has two network interfaces (`mgmt` and the storage network). + + The NAD **default/vlan101** is used for the storage network. + + ![](/img/v1.5/rancher/create-guest-cluster-with-two-nics.png) + - The Harvester CSI driver version is v0.1.20 or later. ![](/img/v1.4/rancher/harvester-csi-driver-version.png) @@ -391,6 +415,21 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber - SUSE and OpenSUSE: `zypper install -y nfs-client` +- An IP is manually assigned to the storage network interface. + + You can assign any of the reserved IPs using the following commands: + + ``` + $ ip link set up + $ ip a add dev + ``` + + :::info important + + An IP that is assigned using the given commands does not persist after a reboot. To make the IP persistent, you must add it to the network configuration file of your guest operating system. + + ::: + ### Usage 1. Create a new StorageClass on the guest cluster. diff --git a/static/img/v1.5/rancher/configure-storage-network-01.png b/static/img/v1.5/rancher/configure-storage-network-01.png new file mode 100644 index 0000000000..0f6b51c2a7 Binary files /dev/null and b/static/img/v1.5/rancher/configure-storage-network-01.png differ diff --git a/static/img/v1.5/rancher/create-guest-cluster-with-two-nics.png b/static/img/v1.5/rancher/create-guest-cluster-with-two-nics.png new file mode 100644 index 0000000000..ca7358e466 Binary files /dev/null and b/static/img/v1.5/rancher/create-guest-cluster-with-two-nics.png differ diff --git a/static/img/v1.5/rancher/enable-rwx-storage-network-01.png b/static/img/v1.5/rancher/enable-rwx-storage-network-01.png new file mode 100644 index 0000000000..ae80e6bf6d Binary files /dev/null and b/static/img/v1.5/rancher/enable-rwx-storage-network-01.png differ diff --git a/versioned_docs/version-v1.4/rancher/csi-driver.md b/versioned_docs/version-v1.4/rancher/csi-driver.md index 5c12a485d8..956280f585 100644 --- a/versioned_docs/version-v1.4/rancher/csi-driver.md +++ b/versioned_docs/version-v1.4/rancher/csi-driver.md @@ -294,10 +294,28 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber ## RWX Volumes Support +:::caution + +RWX volumes currently only work with a dedicated storage network. [GitHub issue #7218](https://github.com/harvester/harvester/issues/7218) tracks the enhancement that will allow RWX volumes to use various VLANs on guest clusters. + +::: + ### Prerequisites - Harvester v1.4 or later is installed on the host cluster. +- A [storage network](../advanced/storagenetwork.md) is configured on the Harvester cluster. + + Use **exclude** to reserve a range of IP addresses for the guest cluster virtual machines. + + ![](/img/v1.5/rancher/configure-storage-network-01.png) + +- The **Storage Network for RWX Volume** setting on the embedded Longhorn UI is enabled. + + Go to **General**, and then select **Storage Network for RWX Volume Enabled**. + + ![](/img/v1.5/rancher/enable-rwx-storage-network-01.png) + - You have created an RWX StorageClass on the host Harvester cluster. On the **Storage Class: Create** screen, click **Edit as YAML** and specify the following: @@ -377,6 +395,12 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber harvester-networkfs-manager-xvkgp 1/1 Running 4 (37m ago) 3h41m ``` +- The guest cluster has two network interfaces (`mgmt` and the storage network). + + The NAD **default/vlan101** is used for the storage network. + + ![](/img/v1.5/rancher/create-guest-cluster-with-two-nics.png) + - The Harvester CSI driver version is v0.1.20 or later. ![](/img/v1.4/rancher/harvester-csi-driver-version.png) @@ -391,6 +415,21 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber - SUSE and OpenSUSE: `zypper install -y nfs-client` +- An IP is manually assigned to the storage network interface. + + You can assign any of the reserved IPs using the following commands: + + ``` + $ ip link set up + $ ip a add dev + ``` + + :::info important + + An IP that is assigned using the given commands does not persist after a reboot. To make the IP persistent, you must add it to the network configuration file of your guest operating system. + + ::: + ### Usage 1. Create a new StorageClass on the guest cluster.