Skip to content

Commit 982b8c6

Browse files
futureteaLucasSaintarbor
authored andcommitted
Update multi CSI driver related docs
Signed-off-by: futuretea <Hang.Yu@suse.com> Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
1 parent 9e1c726 commit 982b8c6

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

docs/advanced/settings.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ If you set a username and password for a private registry, the system will autom
135135

136136
_Available as of v1.2.0_
137137

138-
This setting allows you to install a Container Storage Interface (CSI) in your Harvester cluster to support and use external storage as the VM's non-system data partition and leverage different drivers.
138+
If you install third-party CSI drivers in the Harvester cluster, you must configure some necessary information through this setting before using **Backup/Snapshot** related features.
139139

140140
Default:
141141
```
@@ -151,8 +151,6 @@ Default:
151151
1. Configure **Volume Snapshot Class Name**, which refers to the name of the `VolumeSnapshotClass` used to create volume snapshots or VM snapshots.
152152
1. Configure **Backup Volume Snapshot Class Name**, which refers to the name of the `VolumeSnapshotClass` used to create VM backups.
153153

154-
Select the desired StorageClass when creating an empty volume or adding a new empty volume to a virtual machine.
155-
156154
## `default-vm-termination-grace-period-seconds`
157155

158156
_Available as of v1.2.0_

docs/advanced/storageclass.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93,25 +93,21 @@ The `volumeBindingMode` field controls when volume binding and dynamic provision
9393

9494
## Multi Container Storage Interface support
9595

96-
Harvester now supports installing a Container Storage Interface (CSI) in your Harvester cluster to support and use external storage as the VM's non-system data partition. For example, choose an existing storage provider (e.g., Dell PowerFlex) to create a data volume in Harvester. Leverage different drivers for specific purposes, such as performance optimization or integration with existing internal storage providers.
96+
Harvester now supports installing a Container Storage Interface (CSI) in your Harvester cluster to support and use external storage as the VM's non-system data disks. Leverage different drivers for specific purposes, such as performance optimization or integration with existing in-house storage providers.
9797

9898
:::note
9999

100-
The system partition of the VM can still use Longhorn. Before v1.2.0, Harvester only supports the use of Longhorn to store virtual machine data, and does not support the use of external storage to store VM data.
100+
The provisioner of the VM image still uses Longhorn. Before v1.2.0, Harvester only supports using Longhorn to store virtual machine data and does not support using external storage to store VM data.
101101

102102
:::
103103

104-
You must first manually install your CSI driver. Then create a new StorageClass and edit the `csi-driver-config` setting.
104+
Administrators can enable this feature through the following steps:
105+
1. Set the [`os.persistent_state_paths`](../install/harvester-configuration.md#ospersistent_state_paths) and [`os.after_install_chroot_commands`](../install/harvester-configuration.md#osafter_install_chroot_commands) settings before creating the Harvester cluster for the specific CSI driver needs.
106+
2. Install the CSI driver to the Harvester cluster manually after creating the Harvester cluster.
107+
3. Edit the [`csi-driver-config`](../advanced/settings.md#csi-driver-config) setting.
108+
4. Create a new StorageClass that uses the CSI driver.
105109

106-
### Header Section
107-
108-
- **Name**: Name of the StorageClass
109-
- **Description** (optional): Description of the StorageClass.
110-
- **Provisioner**: Select a provisioner.
111-
112-
### Parameters
113-
114-
Edit the [`csi-driver-config`](../advanced/settings.md#csi-driver-config) setting to add the provisioner for the newly added CSI driver.
110+
After performing these steps, you must select the desired StorageClass when creating an empty volume or adding a new empty volume to a virtual machine.
115111

116112
## Appendix - Use Case
117113

0 commit comments

Comments
 (0)