Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update the rwx volume document #699

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update the rwx volume document #699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/rancher/csi-driver.md
View file
Open in desktop
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 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.
- The virtual machine must have two network interfaces: 1) the default network interface for intra-cluster communications and allowing access from the infrastructure network (external to the Harvester cluster); and 2) a network that can connect to the storage network.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cluster/external networking was a bit vague. Is this what you mean?


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>
Vicente-Cheng marked this conversation as resolved.
Show resolved Hide resolved
```

:::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
Binary file added static/img/v1.5/rancher/configure-storage-network-01.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.5/rancher/create-guest-cluster-with-two-nics.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.5/rancher/enable-rwx-storage-network-01.png
View file
Open in desktop
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
View file
Open in desktop
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 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.

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:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a side topic. Don't we have any IPAM in this case? @starbops


```
$ 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