Skip to content

Commit 99036c5

Browse files
committed
update docs
1 parent 8ac1ead commit 99036c5

File tree

115 files changed

+172
-172
lines changed

Some content is hidden

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

115 files changed

+172
-172
lines changed

content/en/docs/about-this-document/_index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,28 +24,28 @@ The symbols that may be found in this document are defined as follows.
2424
</th>
2525
</tr>
2626
</thead>
27-
<tbody><tr id="en-us_topic_0140239342_row199251834104413"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p10925173420449"><a name="en-us_topic_0140239342_p10925173420449"></a><a name="en-us_topic_0140239342_p10925173420449"></a><a name="en-us_topic_0140239342_image19925163414449"></a><a name="en-us_topic_0140239342_image19925163414449"></a><span><img class="" id="en-us_topic_0140239342_image19925163414449" height="25.199377000000002" width="106.7325" src="/figures/en-us_image_0000001192017206.png"></span></p>
27+
<tbody><tr id="en-us_topic_0140239342_row199251834104413"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p10925173420449"><a name="en-us_topic_0140239342_p10925173420449"></a><a name="en-us_topic_0140239342_p10925173420449"></a><a name="en-us_topic_0140239342_image19925163414449"></a><a name="en-us_topic_0140239342_image19925163414449"></a><span><img class="" id="en-us_topic_0140239342_image19925163414449" height="25.199377000000002" width="106.7325" src="/css-docs/figures/en-us_image_0000001192017206.png"></span></p>
2828
</td>
2929
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0140239342_p1992520345443"><a name="en-us_topic_0140239342_p1992520345443"></a><a name="en-us_topic_0140239342_p1992520345443"></a>Indicates a hazard with a high level of risk which, if not avoided, will result in death or serious injury.</p>
3030
</td>
3131
</tr>
32-
<tr id="en-us_topic_0140239342_row1892553411445"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p10925173434418"><a name="en-us_topic_0140239342_p10925173434418"></a><a name="en-us_topic_0140239342_p10925173434418"></a><a name="en-us_topic_0140239342_image10925183419447"></a><a name="en-us_topic_0140239342_image10925183419447"></a><span><img class="" id="en-us_topic_0140239342_image10925183419447" height="25.199377000000002" width="106.7325" src="/figures/en-us_image_0000001237377101.png"></span></p>
32+
<tr id="en-us_topic_0140239342_row1892553411445"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p10925173434418"><a name="en-us_topic_0140239342_p10925173434418"></a><a name="en-us_topic_0140239342_p10925173434418"></a><a name="en-us_topic_0140239342_image10925183419447"></a><a name="en-us_topic_0140239342_image10925183419447"></a><span><img class="" id="en-us_topic_0140239342_image10925183419447" height="25.199377000000002" width="106.7325" src="/css-docs/figures/en-us_image_0000001237377101.png"></span></p>
3333
</td>
3434
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0140239342_p09254345448"><a name="en-us_topic_0140239342_p09254345448"></a><a name="en-us_topic_0140239342_p09254345448"></a>Indicates a hazard with a medium level of risk which, if not avoided, could result in death or serious injury.</p>
3535
</td>
3636
</tr>
37-
<tr id="en-us_topic_0140239342_row17925134134420"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p209256341443"><a name="en-us_topic_0140239342_p209256341443"></a><a name="en-us_topic_0140239342_p209256341443"></a><a name="en-us_topic_0140239342_image3925834204416"></a><a name="en-us_topic_0140239342_image3925834204416"></a><span><img class="" id="en-us_topic_0140239342_image3925834204416" height="25.199377000000002" width="106.7325" src="/figures/en-us_image_0000001236977133.png"></span></p>
37+
<tr id="en-us_topic_0140239342_row17925134134420"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p209256341443"><a name="en-us_topic_0140239342_p209256341443"></a><a name="en-us_topic_0140239342_p209256341443"></a><a name="en-us_topic_0140239342_image3925834204416"></a><a name="en-us_topic_0140239342_image3925834204416"></a><span><img class="" id="en-us_topic_0140239342_image3925834204416" height="25.199377000000002" width="106.7325" src="/css-docs/figures/en-us_image_0000001236977133.png"></span></p>
3838
</td>
3939
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0140239342_p39258341443"><a name="en-us_topic_0140239342_p39258341443"></a><a name="en-us_topic_0140239342_p39258341443"></a>Indicates a hazard with a low level of risk which, if not avoided, could result in minor or moderate injury.</p>
4040
</td>
4141
</tr>
42-
<tr id="en-us_topic_0140239342_row592583414414"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p1292583414446"><a name="en-us_topic_0140239342_p1292583414446"></a><a name="en-us_topic_0140239342_p1292583414446"></a><a name="en-us_topic_0140239342_image392511343441"></a><a name="en-us_topic_0140239342_image392511343441"></a><span><img class="" id="en-us_topic_0140239342_image392511343441" height="25.199377000000002" width="104.73750000000001" src="/figures/en-us_image_0000001192177174.png"></span></p>
42+
<tr id="en-us_topic_0140239342_row592583414414"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p1292583414446"><a name="en-us_topic_0140239342_p1292583414446"></a><a name="en-us_topic_0140239342_p1292583414446"></a><a name="en-us_topic_0140239342_image392511343441"></a><a name="en-us_topic_0140239342_image392511343441"></a><span><img class="" id="en-us_topic_0140239342_image392511343441" height="25.199377000000002" width="104.73750000000001" src="/css-docs/figures/en-us_image_0000001192177174.png"></span></p>
4343
</td>
4444
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0140239342_p169258345447"><a name="en-us_topic_0140239342_p169258345447"></a><a name="en-us_topic_0140239342_p169258345447"></a>Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results.</p>
4545
<p id="en-us_topic_0140239342_p9925193454410"><a name="en-us_topic_0140239342_p9925193454410"></a><a name="en-us_topic_0140239342_p9925193454410"></a>NOTICE is used to address practices not related to personal injury.</p>
4646
</td>
4747
</tr>
48-
<tr id="en-us_topic_0140239342_row169251342440"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p1192514346447"><a name="en-us_topic_0140239342_p1192514346447"></a><a name="en-us_topic_0140239342_p1192514346447"></a><a name="en-us_topic_0140239342_image18925234194414"></a><a name="en-us_topic_0140239342_image18925234194414"></a><span><img class="" id="en-us_topic_0140239342_image18925234194414" height="25.199377000000002" width="75.81" src="/figures/en-us_image_0000001192337154.png"></span></p>
48+
<tr id="en-us_topic_0140239342_row169251342440"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0140239342_p1192514346447"><a name="en-us_topic_0140239342_p1192514346447"></a><a name="en-us_topic_0140239342_p1192514346447"></a><a name="en-us_topic_0140239342_image18925234194414"></a><a name="en-us_topic_0140239342_image18925234194414"></a><span><img class="" id="en-us_topic_0140239342_image18925234194414" height="25.199377000000002" width="75.81" src="/css-docs/figures/en-us_image_0000001192337154.png"></span></p>
4949
</td>
5050
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0140239342_p1992511341444"><a name="en-us_topic_0140239342_p1992511341444"></a><a name="en-us_topic_0140239342_p1992511341444"></a>Supplements the important information in the main text.</p>
5151
<p id="en-us_topic_0140239342_p9925434124419"><a name="en-us_topic_0140239342_p9925434124419"></a><a name="en-us_topic_0140239342_p9925434124419"></a>NOTE is used to address information not related to personal injury, equipment damage, and environment deterioration.</p>

content/en/docs/advanced-features/configuring-alua/configuring-alua-using-helm/configuring-alua-parameters-for-a-distributed-storage-backend.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For details about how to configure ALUA for Huawei distributed storage, see the
99

1010
The ALUA configuration may vary according to the OS. Visit [Huawei Technical Support](https://support.huawei.com/enterprise/en/index.html), enter **Host Connectivity Guide** in the search box, and click the search button. In the search result, select the host connectivity guide for the desired OS. Configure ALUA according to the actual situation and the description in the guide. Huawei CSI will apply the configuration items you set to the initiator of the host on Huawei storage.
1111

12-
>![](/public_sys-resources/en/icon-note.gif)
12+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
1313
>A node with a Pod provisioned does not proactively change ALUA information. The host ALUA configuration changes only after a Pod is provisioned again to the node.
1414
>In non-HyperMetro scenarios of distributed storage, you are advised to set the switchover mode to "disable ALUA" \(default value\). This is because the storage system is in active/active mode and "enables ALUA" is meaningless. Therefore, you are advised not to configure ALUA parameters for distributed storage.
1515

content/en/docs/advanced-features/configuring-alua/configuring-alua-using-helm/configuring-alua-parameters-for-a-huawei-enterprise-storage-backend.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For details about how to configure ALUA for Huawei enterprise storage, see the h
99

1010
The ALUA configuration may vary according to the OS. Visit [Huawei Technical Support](https://support.huawei.com/enterprise/en/index.html), enter **Host Connectivity Guide** in the search box, and click the search button. In the search result, select the host connectivity guide for the desired OS. Configure ALUA according to the actual situation and the description in the guide. Huawei CSI will apply the configuration items you set to the initiator of the host on Huawei storage.
1111

12-
>![](/public_sys-resources/en/icon-note.gif)
12+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
1313
>A node with a Pod provisioned does not proactively change ALUA information. The host ALUA configuration changes only after a Pod is provisioned again to the node.
1414
1515
## ALUA Parameters for OceanStor V5 and OceanStor Dorado V3 Series{#section16218353201717}
@@ -102,7 +102,7 @@ parameters:
102102
103103
[Table 2](#en-us_topic_0000001352783505_en-us_topic_0000001198982584_table7143850202411) lists the ALUA parameters supported by Huawei CSI for OceanStor and OceanStor Dorado series.
104104
105-
>![](/public_sys-resources/en/icon-note.gif)
105+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
106106
>By default, the initiator host access mode of OceanStor and OceanStor Dorado series storage is "balanced mode". Therefore, you are advised not to configure ALUA parameters for OceanStor and OceanStor Dorado series storage.
107107
108108
**Table 2** ALUA parameters for OceanStor and OceanStor Dorado series

content/en/docs/advanced-features/configuring-storage-topology-awareness/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ You need to configure topology labels on worker nodes in the cluster. The method
6363
</tbody>
6464
</table>
6565
66-
>![](/public_sys-resources/en/icon-note.gif)
66+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
6767
>- A topology label must start with **topology.kubernetes.io**. Topology label examples:
6868
> - Example 1: **topology.kubernetes.io/region=China-west**
6969
> - Example 2: **topology.kubernetes.io/zone=ChengDu**

content/en/docs/advanced-features/pvc-change/configuring-pvc-changes/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The PVC change feature is implemented using CRD. Related resources are described
4141
</tbody>
4242
</table>
4343

44-
>![](/public_sys-resources/en/icon-note.gif)
44+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
4545
>- VolumeModifyClaim resources can be created, deleted, and queried, but cannot be updated.
4646
>- VolumeModifyContent resources can only be queried and are used to display the change details of a single PVC. Do not manually create, delete, or modify the resources.
4747
>- VolumeModifyContent resources are managed by VolumeModifyClaim. Do not manually manage VolumeModifyContent resources.

content/en/docs/advanced-features/pvc-change/configuring-pvc-changes/creating-a-pvc-change/creating-a-pvc-change-resource.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 2
77

88
This section describes how to create a PVC change resource based on a configured PVC change file.
99

10-
>![](/public_sys-resources/en/icon-note.gif)
10+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
1111
>- Only the HyperMetro active-active \(AA\) mode is supported.
1212
>- When a common volume is changed to a HyperMetro volume, only the storage volume at the primary site can be changed.
1313
>- Do not use Huawei CSI to manage a PVC during PVC change resource creation.

content/en/docs/advanced-features/pvc-change/configuring-pvc-changes/creating-a-pvc-change/preparing-a-pvc-change-file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The sample template of the PVC change file is **/examples/volumemodifyclaim.yam
108108
</tbody>
109109
</table>
110110

111-
>![](/public_sys-resources/en/icon-note.gif)
111+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
112112
>- The **spec.source.kind** and **spec.source.name** parameters are used to specify the volume change scope. For example, if they are set to a StorageClass and the corresponding name respectively, all PVCs in the **Bound** state provisioned using the target StorageClass will be changed.
113113
>- After all associated PVCs are changed, Huawei CSI will replace the original StorageClass and add the **spec.parameters** parameter of the VolumeModifyClaim so that the PVCs meet the StorageClass definition.
114114

content/en/docs/advanced-features/pvc-change/configuring-pvc-changes/deleting-a-pvc-change.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
weight: 3
66
---
77

8-
>![](/public_sys-resources/en/icon-notice.gif)
8+
>![](/css-docs/public_sys-resources/en/icon-notice.gif)
99
>- If **STATUS** of a VolumeModifyClaim is **Creating**, deleting the VolumeModifyClaim resource will delete the created resource on the storage side and then remove the cluster resource. After the deletion, if you continue to use the original StorageClass for PVC management, you need to restore the associated storage backend to a non-HyperMetro storage backend.
1010
>- If **STATUS** of a VolumeModifyClaim is **Pending** or **Completed**, deleting the VolumeModifyClaim resource will only remove the cluster resource and will not delete the created resource on the storage side \(that is, there is not interaction with the storage side\).
1111
>- VolumeModifyContent resources are managed by VolumeModifyClaim. Do not manually manage VolumeModifyContent resources.

content/en/docs/advanced-features/pvc-change/configuring-pvc-changes/querying-a-pvc-change.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ To query a VolumeModifyClaim using kubectl, perform the following steps.
7878
</tbody>
7979
</table>
8080
81-
>![](/public_sys-resources/en/icon-note.gif)
81+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
8282
>You can use kubectl to view the **Events** information of a VolumeModifyClaim. If a VolumeModifyClaim cannot meet the creation requirements or an error occurs during the creation, the server will record the **Events** information. The following command is used as an example:
8383
>```
8484
>kubectl describe volumemodifyclaims local-to-hypermetro
@@ -150,7 +150,7 @@ A VolumeModifyContent is created using a VolumeModifyClaim and records the chang
150150
</tbody>
151151
</table>
152152
153-
>![](/public_sys-resources/en/icon-note.gif)
153+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
154154
>You can use kubectl to view the **Events** information of a VolumeModifyContent. If a VolumeModifyContent cannot meet the creation requirements or an error occurs during the PVC change, the server will record the **Events** information. The following command is used as an example:
155155
>```
156156
>kubectl describe volumemodifycontents myvmc-uid

content/en/docs/advanced-features/pvc-change/enabling-the-pvc-change-feature/enabling-the-pvc-change-feature-using-helm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ weight: 1
3939
customresourcedefinition.apiextensions.k8s.io/volumemodifycontents.xuanwu.huawei.io configured
4040
```
4141
42-
>![](/public_sys-resources/en/icon-note.gif)
42+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
4343
>If the command output contains **Warning: resource customresourcedefinitions/volumemodifycontents.xuanwu.huawei.io is missing the kubectl.kubernetes.io/last-applied-configuration...**, you can ignore it. This message is displayed because the **kubectl create** command instead of the **kubectl apply** command is used for installation by Helm.
4444
4545
4. <a name="li1230915254221"></a>Run the following command to obtain the original service configuration file.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For different storage resources, refer to the following configurations:
1212
- For NAS resources, configure the minimum permissions by referring to [Table 1](#table66121923174916).
1313
- For SAN resources, configure the minimum permissions by referring to [Table 2](#table51362243359).
1414

15-
>![](/public_sys-resources/en/icon-note.gif)
15+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
1616
>For details about how to configure permissions for user-defined roles, see [OceanStor Dorado 6000, Dorado 18000 Series Product Documentation](https://support.huawei.com/hedex/hdx.do?docid=EDOC1100214756&id=EN-US_TOPIC_0000001640708705&lang=en).
1717
1818
**Table 1** Minimum permissions for NAS resources

content/en/docs/appendix/huawei-csi-resource-management.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ If you need to modify the resource requests and limits of a container, perform t
184184
- If the Pod name is **huawei-csi-controller**, modify the **huawei-csi-controller.yaml** file.
185185
- If the Pod name is **huawei-csi-node**, modify the **huawei-csi-node.yaml** file.
186186

187-
>![](/public_sys-resources/en/icon-note.gif)
187+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
188188
>For details about Pod names, see [Table 1](#table4106151116363).
189189
190190
For example, to modify the resource request of the **huawei-csi-driver** container in the Pod named **huawei-csi-node**, run the following command to edit the configuration file and find the container whose **spec.template.spec.containes.name** is **huawei-csi-driver**. Modify resource requests and limits as required.

content/en/docs/common-operations/enabling-the-readwriteoncepod-feature-gate.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The ReadWriteOnce access mode is the fourth access mode introduced by Kubernetes
99

1010
The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.24. Therefore, you need to enable the ReadWriteOncePod feature in **feature-gates** of kube-apiserver, kube-scheduler, and kubelet before using the access mode.
1111

12-
>![](/public_sys-resources/en/icon-note.gif)
12+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
1313
>Currently, the CCE or CCE Agile platform does not support the ReadWriteOncePod feature gate.
1414
1515
## Procedure{#en-us_topic_0000001259843616_section137882216292}
@@ -28,7 +28,7 @@ The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.
2828
...
2929
```
3030
31-
>![](/public_sys-resources/en/icon-note.gif)
31+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
3232
>After the editing is complete, Kubernetes will automatically apply the updates.
3333
3434
2. Enable the ReadWriteOncePod feature gate for kube-scheduler.
@@ -45,12 +45,12 @@ The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.
4545
...
4646
```
4747
48-
>![](/public_sys-resources/en/icon-note.gif)
48+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
4949
>After the editing is complete, Kubernetes will automatically apply the updates.
5050
5151
3. Enable the ReadWriteOncePod feature gate for kubelet.
5252
53-
>![](/public_sys-resources/en/icon-notice.gif)
53+
>![](/css-docs/public_sys-resources/en/icon-notice.gif)
5454
>The dynamic Kubelet configuration function is not used since v1.22 and deleted in v1.24. Therefore, you need to perform the following operations on kubelet on each worker node in the cluster.
5555
5656
1. Use a remote access tool, such as PuTTY, to log in to any worker node in the Kubernetes cluster through the management IP address.
@@ -63,7 +63,7 @@ The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.
6363
...
6464
```
6565
66-
>![](/public_sys-resources/en/icon-note.gif)
66+
>![](/css-docs/public_sys-resources/en/icon-note.gif)
6767
>The default path of the kubelet configuration file is **/var/lib/kubelet/config.yaml**. Enter the path based on site requirements.
6868
6969
3. After the configuration is complete, run the **systemctl restart kubelet** command to restart kubelet.

0 commit comments

Comments
 (0)