Skip to content

Commit 1e515f3

Browse files
QiuzhuoYangcabbetlong
authored andcommitted
update v4.11.0 docs
1 parent 77ce7fb commit 1e515f3

File tree

762 files changed

+46175
-990
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

762 files changed

+46175
-990
lines changed

content/en/docs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ weight: 20
77

88
You can get the PDF version of the user guide from the following link:
99

10-
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/Huawei/eSDK_K8S_Plugin/blob/master/docs/eSDK%20Huawei%20Storage%20Kubernetes%20CSI%20Plugins%20V4.10.0%20User%20Guide%2001.pdf">
10+
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/Huawei/eSDK_K8S_Plugin/blob/master/docs/eSDK%20Huawei%20Storage%20Kubernetes%20CSI%20Plugins%20V4.6.0%20User%20Guide%2002.pdf">
1111
PDF Download <i class="fa-solid fa-file-pdf"></i>
1212
</a>

content/en/docs/advanced-services/snapshot-management/configuring-a-volume-snapshot.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ driver: csi.huawei.com
2222
deletionPolicy: Delete
2323
```
2424
25-
You can modify the parameters according to [Table 1](#en-us_topic_0254162578_table189495491346). Currently, Huawei CSI does not support user-defined parameters \(**parameters**\) in a VolumeSnapshotClass. Therefore, you are advised to create a VolumeSnapshotClass for all snapshots.
25+
You can modify the parameters according to [Table 1](#en-us_topic_0254162578_table189495491346).
2626
2727
**Table 1** VolumeSnapshotClass parameters
2828
@@ -57,6 +57,15 @@ You can modify the parameters according to [Table 1](#en-us_topic_0254162578_ta
5757
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.2.4.1.3 "><a name="ul925601066"></a><a name="ul925601066"></a><ul id="ul925601066"><li>If the deletion policy is <strong id="b1091982014164"><a name="b1091982014164"></a><a name="b1091982014164"></a>Delete</strong>, the snapshot on the storage device will be deleted together with the VolumeSnapshotContent object.</li><li>If the deletion policy is <strong id="b1013813510484"><a name="b1013813510484"></a><a name="b1013813510484"></a>Retain</strong>, the snapshot and VolumeSnapshotContent object on the storage device will be retained.</li></ul>
5858
</td>
5959
</tr>
60+
<tr id="row123551713017"><td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.2.4.1.1 "><p id="p586014583516"><a name="p586014583516"></a><a name="p586014583516"></a>parameters.enableHyperMetroSnap</p>
61+
</td>
62+
<td class="cellrowborder" valign="top" width="26.99%" headers="mcps1.2.4.1.2 "><p id="p158602581659"><a name="p158602581659"></a><a name="p158602581659"></a>Whether to create SAN HyperMetro snapshots on both ends.</p>
63+
<a name="ul1952015398716"></a><a name="ul1952015398716"></a><ul id="ul1952015398716"><li><strong id="b13651495568"><a name="b13651495568"></a><a name="b13651495568"></a>"true"</strong>: Create snapshots on the two storage systems that form the HyperMetro pair.</li><li><strong id="b191151317195619"><a name="b191151317195619"></a><a name="b191151317195619"></a>"false"</strong>: Create a snapshot on the storage system associated with the current storage class.</li></ul>
64+
</td>
65+
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.2.4.1.3 "><p id="p486075816514"><a name="p486075816514"></a><a name="p486075816514"></a>The default value is <strong id="b137398514423"><a name="b137398514423"></a><a name="b137398514423"></a>"false"</strong>.</p>
66+
<p id="p1586018581150"><a name="p1586018581150"></a><a name="p1586018581150"></a>When the backend type is oceanstor-san and the storage version is V700R001C10 or later, this parameter can be set to <strong id="b1236892018435"><a name="b1236892018435"></a><a name="b1236892018435"></a>"true"</strong>.</p>
67+
</td>
68+
</tr>
6069
</tbody>
6170
</table>
6271

content/en/docs/appendix/configuring-custom-permissions.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,24 @@ For different storage resources, refer to the following configurations:
323323
<td class="cellrowborder" valign="top" width="30.836916308369155%" headers="mcps1.2.5.1.4 "><p id="p12576164017592"><a name="p12576164017592"></a><a name="p12576164017592"></a>Queries vStore information.</p>
324324
</td>
325325
</tr>
326+
<tr id="row149271424132312"><td class="cellrowborder" valign="top" width="21.897810218978098%" headers="mcps1.2.5.1.1 "><p id="p3806112312320"><a name="p3806112312320"></a><a name="p3806112312320"></a>hyper_metro_pair</p>
327+
</td>
328+
<td class="cellrowborder" valign="top" width="28.95710428957104%" headers="mcps1.2.5.1.2 "><p id="p208062231232"><a name="p208062231232"></a><a name="p208062231232"></a>hyper_metro</p>
329+
</td>
330+
<td class="cellrowborder" valign="top" width="18.30816918308169%" headers="mcps1.2.5.1.3 "><p id="p14806182313234"><a name="p14806182313234"></a><a name="p14806182313234"></a>Read and write</p>
331+
</td>
332+
<td class="cellrowborder" valign="top" width="30.836916308369155%" headers="mcps1.2.5.1.4 "><p id="p20806112319238"><a name="p20806112319238"></a><a name="p20806112319238"></a>Creates a block HyperMetro pair.</p>
333+
</td>
334+
</tr>
335+
<tr id="row9927182442316"><td class="cellrowborder" valign="top" width="21.897810218978098%" headers="mcps1.2.5.1.1 "><p id="p580692332316"><a name="p580692332316"></a><a name="p580692332316"></a>hyper_metro_domain</p>
336+
</td>
337+
<td class="cellrowborder" valign="top" width="28.95710428957104%" headers="mcps1.2.5.1.2 "><p id="p13806102311239"><a name="p13806102311239"></a><a name="p13806102311239"></a>hyper_metro</p>
338+
</td>
339+
<td class="cellrowborder" valign="top" width="18.30816918308169%" headers="mcps1.2.5.1.3 "><p id="p1680632316231"><a name="p1680632316231"></a><a name="p1680632316231"></a>Read-only</p>
340+
</td>
341+
<td class="cellrowborder" valign="top" width="30.836916308369155%" headers="mcps1.2.5.1.4 "><p id="p480612352313"><a name="p480612352313"></a><a name="p480612352313"></a>Queries block HyperMetro domain information.</p>
342+
</td>
343+
</tr>
326344
</tbody>
327345
</table>
328346

content/en/docs/basic-services/persistent-volume-management/configuring-pvs/configuring-a-static-pv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ A storage resource, such as a LUN or file system, required by the PV to be creat
149149
</td>
150150
<td class="cellrowborder" valign="top" width="33.20699708454811%" headers="mcps1.2.6.1.5 "><p id="en-us_topic_0000001255922865_p105611631131211"><a name="en-us_topic_0000001255922865_p105611631131211"></a><a name="en-us_topic_0000001255922865_p105611631131211"></a>The value of this parameter consists of the following parts:</p>
151151
<a name="en-us_topic_0000001255922865_ul317520442816"></a><a name="en-us_topic_0000001255922865_ul317520442816"></a><ul id="en-us_topic_0000001255922865_ul317520442816"><li><em id="i11303163992212"><a name="i11303163992212"></a><a name="i11303163992212"></a>&lt;backendName&gt;</em>: indicates the name of the backend where the volume resides. You can run the following command to obtain the configured backend information.<p id="p101424597119"><a name="p101424597119"></a><a name="p101424597119"></a><strong id="b1736283518212"><a name="b1736283518212"></a><a name="b1736283518212"></a>oceanctl get backend</strong></p>
152-
</li><li><em id="i12322151610233"><a name="i12322151610233"></a><a name="i12322151610233"></a>&lt;volume-name&gt;</em>: indicates the name of a resource (LUN/file system) on the storage. You can obtain the value from DeviceManager.</li></ul>
152+
</li><li><em id="i61551151132013"><a name="i61551151132013"></a><a name="i61551151132013"></a>&lt;volume-name&gt;</em>: indicates the name of a resource (LUN/file system/dtree) on the storage. You can obtain the value from DeviceManager.</li></ul>
153153
</td>
154154
</tr>
155155
<tr id="en-us_topic_0000001255922865_row197581481108"><td class="cellrowborder" valign="top" width="17.687074829931973%" headers="mcps1.2.6.1.1 "><p id="en-us_topic_0000001255922865_p110831210"><a name="en-us_topic_0000001255922865_p110831210"></a><a name="en-us_topic_0000001255922865_p110831210"></a>spec.csi.fsType</p>
@@ -322,7 +322,7 @@ After a PV is created in static volume provisioning mode, you can create a PVC b
322322
<tr id="row10874152212484"><td class="cellrowborder" valign="top" width="13.47865213478652%" headers="mcps1.2.6.1.1 "><p id="p0833642172413"><a name="p0833642172413"></a><a name="p0833642172413"></a>spec.accessModes</p>
323323
</td>
324324
<td class="cellrowborder" valign="top" width="30.12698730126987%" headers="mcps1.2.6.1.2 "><p id="p2083384212416"><a name="p2083384212416"></a><a name="p2083384212416"></a>Access mode of the volume.</p>
325-
<a name="ul18620120655"></a><a name="ul18620120655"></a><ul id="ul18620120655"><li><strong id="b1920971745"><a name="b1920971745"></a><a name="b1920971745"></a>RWO</strong> (ReadWriteOnce): A volume can be mounted to a node in read/write mode. This mode also allows multiple Pods running on the same node to access the volume.</li><li><strong id="b1245755049"><a name="b1245755049"></a><a name="b1245755049"></a>ROX</strong> (ReadOnlyMany): A volume can be mounted to multiple nodes in read-only mode.</li><li><strong id="b890416672"><a name="b890416672"></a><a name="b890416672"></a>RWX</strong> (ReadWriteMany): A volume can be mounted to multiple nodes in read/write mode.</li><li><strong id="b1190976238"><a name="b1190976238"></a><a name="b1190976238"></a>RWOP</strong> (ReadWriteOncePod): A volume can only be mounted to a single Pod in read/write mode. Kubernetes 1.22 and later versions support this feature.</li></ul>
325+
<a name="ul18620120655"></a><a name="ul18620120655"></a><ul id="ul18620120655"><li><strong id="b617788276"><a name="b617788276"></a><a name="b617788276"></a>RWO</strong> (ReadWriteOnce): A volume can be mounted to a node in read/write mode. This mode also allows multiple Pods running on the same node to access the volume.</li><li><strong id="b1021183257"><a name="b1021183257"></a><a name="b1021183257"></a>ROX</strong> (ReadOnlyMany): A volume can be mounted to multiple nodes in read-only mode.</li><li><strong id="b1821823460"><a name="b1821823460"></a><a name="b1821823460"></a>RWX</strong> (ReadWriteMany): A volume can be mounted to multiple nodes in read/write mode.</li><li><strong id="b1178306101"><a name="b1178306101"></a><a name="b1178306101"></a>RWOP</strong> (ReadWriteOncePod): A volume can only be mounted to a single Pod in read/write mode. Kubernetes 1.22 and later versions support this feature.</li></ul>
326326
</td>
327327
<td class="cellrowborder" valign="top" width="5.899410058994099%" headers="mcps1.2.6.1.3 "><p id="p1823972854011"><a name="p1823972854011"></a><a name="p1823972854011"></a>Yes</p>
328328
</td>

content/en/docs/basic-services/persistent-volume-management/configuring-pvs/configuring-dynamic-pvs.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,19 @@ Before configuring dynamic PVs, configure StorageClass by referring to [Configu
2323

2424
1. Prepare the PVC configuration file **mypvc.yaml**. The following is an example. For details about other parameters, see [Table 1](#en-us_topic_0150885187_table195731435604).
2525

26-
```
27-
kind: PersistentVolumeClaimapiVersion: v1metadata: name: mypvcspec: accessModes: - ReadWriteOnce volumeMode: Filesystem storageClassName: mysc resources: requests: storage: 100Gi
26+
```yaml
27+
kind: PersistentVolumeClaim
28+
apiVersion: v1
29+
metadata:
30+
name: mypvc
31+
spec:
32+
accessModes:
33+
- ReadWriteOnce
34+
volumeMode: Filesystem
35+
storageClassName: mysc
36+
resources:
37+
requests:
38+
storage: 100Gi
2839
```
2940
3041
2. Run the following command to create a PVC using the configuration file.
@@ -42,7 +53,8 @@ Before configuring dynamic PVs, configure StorageClass by referring to [Configu
4253
The following is an example of the command output. If the PVC status is **Bound**, the PVC has been created and can be used by a Pod.
4354

4455
```
45-
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGEmypvc Bound pvc-840054d3-1d5b-4153-b73f-826f980abf9e 100Gi RWO mysc 12s
56+
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
57+
mypvc Bound pvc-840054d3-1d5b-4153-b73f-826f980abf9e 100Gi RWO mysc 12s
4658
```
4759

4860
>![](/css-docs/public_sys-resources/en-us/icon-notice.gif)
@@ -217,8 +229,32 @@ Before configuring dynamic PVs, configure StorageClass by referring to [Configu
217229

218230
After a PVC is created, you can use the PVC to create a Pod. The following is a simple example of using a PVC. In this example, the created Pod uses the newly created _mypvc_.
219231

220-
```
221-
apiVersion: apps/v1kind: Deploymentmetadata: name: nginx-deploymentspec: selector: matchLabels: app: nginx replicas: 2 template: metadata: labels: app: nginx spec: containers: - image: nginx:alpine name: container-0 volumeMounts: - mountPath: /tmp name: pvc-mypvc restartPolicy: Always volumes: - name: pvc-mypvc persistentVolumeClaim: claimName: mypvc # name of PVC
232+
```yaml
233+
apiVersion: apps/v1
234+
kind: Deployment
235+
metadata:
236+
name: nginx-deployment
237+
spec:
238+
selector:
239+
matchLabels:
240+
app: nginx
241+
replicas: 2
242+
template:
243+
metadata:
244+
labels:
245+
app: nginx
246+
spec:
247+
containers:
248+
- image: nginx:alpine
249+
name: container-0
250+
volumeMounts:
251+
- mountPath: /tmp
252+
name: pvc-mypvc
253+
restartPolicy: Always
254+
volumes:
255+
- name: pvc-mypvc
256+
persistentVolumeClaim:
257+
claimName: mypvc # name of PVC
222258
```
223259

224260
>![](/css-docs/public_sys-resources/en-us/icon-note.gif)

content/en/docs/basic-services/persistent-volume-management/configuring-pvs/managing-pvs.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ Manage Volume Provisioning allows administrators to use resources created on sto
1212
- Storage data is migrated in disaster recovery \(DR\) scenarios.
1313

1414
>![](/css-docs/public_sys-resources/en-us/icon-note.gif)
15-
>Manage Volume Provisioning allows existing storage resources to be managed by Kubernetes. You are not allowed to manage a storage resource for multiple times and concurrently delete or create a storage resource.
16-
>When a storage resource is managed by multiple clusters, operations on the managed volume in a single cluster take effect only in the cluster and will not be synchronized to other clusters. Instead, you need to perform these operations on the managed volume in other clusters.
17-
>For example, when you expand the capacity of a PVC in a cluster, the capacity of the corresponding PVC in other clusters will not be automatically expanded. In this case, you need to manually expand the capacity in other clusters by running the expansion commands in [Expanding the Capacity of a PV](/docs/basic-services/persistent-volume-management/managing-pvs-87/expanding-the-capacity-of-a-pv).
15+
>- Manage Volume Provisioning allows existing storage resources to be managed by Kubernetes. You are not allowed to manage a storage resource for multiple times and concurrently delete or create a storage resource.
16+
> When a storage resource is managed by multiple clusters, operations on the managed volume in a single cluster take effect only in the cluster and will not be synchronized to other clusters. Instead, you need to perform these operations on the managed volume in other clusters.
17+
> For example, when you expand the capacity of a PVC in a cluster, the capacity of the corresponding PVC in other clusters will not be automatically expanded. In this case, you need to manually expand the capacity in other clusters by running the expansion commands in [Expanding the Capacity of a PV](/docs/basic-services/persistent-volume-management/managing-pvs-91/expanding-the-capacity-of-a-pv).
18+
>- When managing PVs, ensure that the PVs comply with the storage class declaration. Otherwise, Huawei CSI may fail to manage the PVs. For example, when you manage a common PV, the storage backend of the HyperMetro type is referenced in the storage class, and the HyperMetro parameter is enabled. After the PV is managed, if you clone the PV or create a PV based on a snapshot, Huawei CSI will fail to execute the operation.
1819
1920
## Configuration Description{#section121779524353}
2021

@@ -159,6 +160,8 @@ Perform the following steps to manage and use PVs:
159160
<tr id="en-us_topic_0150885187_row1157316351102"><td class="cellrowborder" valign="top" width="13.47134713471347%" headers="mcps1.2.6.1.1 "><p id="en-us_topic_0150885187_p9573035309"><a name="en-us_topic_0150885187_p9573035309"></a><a name="en-us_topic_0150885187_p9573035309"></a>spec.resources.requests.storage</p>
160161
</td>
161162
<td class="cellrowborder" valign="top" width="26.852685268526855%" headers="mcps1.2.6.1.2 "><p id="en-us_topic_0150885187_p1573183510015"><a name="en-us_topic_0150885187_p1573183510015"></a><a name="en-us_topic_0150885187_p1573183510015"></a>Size of the volume to be created. The format is ***Gi and the unit is GiB.</p>
163+
<div class="note" id="note25632263375"><a name="note25632263375"></a><a name="note25632263375"></a><span class="notetitle"> NOTE: </span><div class="notebody"><p id="p15563526103719"><a name="p15563526103719"></a><a name="p15563526103719"></a>For OceanStor Dorado/OceanStor Pacific series, in the dtree management scenario, the capacity corresponds to the hard quota of the dtree on the storage system.</p>
164+
</div></div>
162165
</td>
163166
<td class="cellrowborder" valign="top" width="5.15051505150515%" headers="mcps1.2.6.1.3 "><p id="p1436044990"><a name="p1436044990"></a><a name="p1436044990"></a>Yes</p>
164167
</td>

content/en/docs/basic-services/persistent-volume-management/managing-pvs-87/_index.md renamed to content/en/docs/basic-services/persistent-volume-management/managing-pvs-91/_index.md

File renamed without changes.

content/en/docs/basic-services/persistent-volume-management/managing-pvs-87/changing-a-pv/_index.md renamed to content/en/docs/basic-services/persistent-volume-management/managing-pvs-91/changing-a-pv/_index.md

File renamed without changes.

content/en/docs/basic-services/persistent-volume-management/managing-pvs-87/changing-a-pv/configuring-pvc-changes/_index.md renamed to content/en/docs/basic-services/persistent-volume-management/managing-pvs-91/changing-a-pv/configuring-pvc-changes/_index.md

File renamed without changes.

0 commit comments

Comments
 (0)