Skip to content

Commit

Permalink
docs: update the rwx volume document
Browse files Browse the repository at this point in the history
Signed-off-by: Vicente Cheng <[email protected]>
Co-authored-by: Jillian <[email protected]>
  • Loading branch information
Vicente-Cheng and jillian-maroket committed Jan 9, 2025
1 parent 1a4478c commit e326f32
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/rancher/csi-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Expand All @@ -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 <storage network nic> up
$ ip a add <reserved IP> dev <storage network nic>
```

:::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.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions versioned_docs/version-v1.4/rancher/csi-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Expand All @@ -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 <storage network nic> up
$ ip a add <reserved IP> dev <storage network nic>
```

:::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.
Expand Down

0 comments on commit e326f32

Please sign in to comment.