Skip to content

Commit e3baa99

Browse files
Vicente-Chengjillian-maroket
authored andcommitted
docs: update the rwx volume document
Signed-off-by: Vicente Cheng <[email protected]> Co-authored-by: Jillian <[email protected]>
1 parent 28a4845 commit e3baa99

File tree

5 files changed

+78
-0
lines changed

5 files changed

+78
-0
lines changed

docs/rancher/csi-driver.md

+39
Original file line numberDiff line numberDiff line change
@@ -294,10 +294,28 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber
294294

295295
## RWX Volumes Support
296296

297+
:::caution
298+
299+
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.
300+
301+
:::
302+
297303
### Prerequisites
298304

299305
- Harvester v1.4 or later is installed on the host cluster.
300306

307+
- A [storage network](../advanced/storagenetwork.md) is configured on the Harvester cluster.
308+
309+
Use **exclude** to reserve a range of IP addresses for the guest cluster virtual machines.
310+
311+
![](/img/v1.5/rancher/configure-storage-network-01.png)
312+
313+
- The **Storage Network for RWX Volume** setting on the embedded Longhorn UI is enabled.
314+
315+
Go to **General**, and then select **Storage Network for RWX Volume Enabled**.
316+
317+
![](/img/v1.5/rancher/enable-rwx-storage-network-01.png)
318+
301319
- You have created an RWX StorageClass on the host Harvester cluster.
302320

303321
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
377395
harvester-networkfs-manager-xvkgp 1/1 Running 4 (37m ago) 3h41m
378396
```
379397

398+
- The VM must have two interfaces. The first one is the default network interface for cluster/external networking. The second one must be in a network which can connect to the storage network.
399+
400+
The NAD **default/vlan101** is used for the storage network.
401+
402+
![](/img/v1.5/rancher/create-guest-cluster-with-two-nics.png)
403+
380404
- The Harvester CSI driver version is v0.1.20 or later.
381405

382406
![](/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
391415

392416
- SUSE and OpenSUSE: `zypper install -y nfs-client`
393417

418+
- An IP is manually assigned to the storage network interface.
419+
420+
You can assign any of the reserved IPs using the following commands:
421+
422+
```
423+
$ ip link set <storage network nic> up
424+
$ ip a add <reserved IP> dev <storage network nic>
425+
```
426+
427+
:::info important
428+
429+
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.
430+
431+
:::
432+
394433
### Usage
395434

396435
1. Create a new StorageClass on the guest cluster.
Loading
Loading
Loading

versioned_docs/version-v1.4/rancher/csi-driver.md

+39
Original file line numberDiff line numberDiff line change
@@ -294,10 +294,28 @@ Now you can create a new StorageClass that you intend to use in your guest Kuber
294294

295295
## RWX Volumes Support
296296

297+
:::caution
298+
299+
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.
300+
301+
:::
302+
297303
### Prerequisites
298304

299305
- Harvester v1.4 or later is installed on the host cluster.
300306

307+
- A [storage network](../advanced/storagenetwork.md) is configured on the Harvester cluster.
308+
309+
Use **exclude** to reserve a range of IP addresses for the guest cluster virtual machines.
310+
311+
![](/img/v1.5/rancher/configure-storage-network-01.png)
312+
313+
- The **Storage Network for RWX Volume** setting on the embedded Longhorn UI is enabled.
314+
315+
Go to **General**, and then select **Storage Network for RWX Volume Enabled**.
316+
317+
![](/img/v1.5/rancher/enable-rwx-storage-network-01.png)
318+
301319
- You have created an RWX StorageClass on the host Harvester cluster.
302320

303321
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
377395
harvester-networkfs-manager-xvkgp 1/1 Running 4 (37m ago) 3h41m
378396
```
379397

398+
- The VM must have two interfaces. The first one is the default network interface for cluster/external networking. The second one must be in a network which can connect to the storage network.
399+
400+
The NAD **default/vlan101** is used for the storage network.
401+
402+
![](/img/v1.5/rancher/create-guest-cluster-with-two-nics.png)
403+
380404
- The Harvester CSI driver version is v0.1.20 or later.
381405

382406
![](/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
391415

392416
- SUSE and OpenSUSE: `zypper install -y nfs-client`
393417

418+
- An IP is manually assigned to the storage network interface.
419+
420+
You can assign any of the reserved IPs using the following commands:
421+
422+
```
423+
$ ip link set <storage network nic> up
424+
$ ip a add <reserved IP> dev <storage network nic>
425+
```
426+
427+
:::info important
428+
429+
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.
430+
431+
:::
432+
394433
### Usage
395434

396435
1. Create a new StorageClass on the guest cluster.

0 commit comments

Comments
 (0)