Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cabbetlong committed Oct 9, 2024
1 parent 8ac1ead commit 99036c5
Show file tree
Hide file tree
Showing 115 changed files with 172 additions and 172 deletions.
10 changes: 5 additions & 5 deletions content/en/docs/about-this-document/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,28 @@ The symbols that may be found in this document are defined as follows.
</th>
</tr>
</thead>
<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>
<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>
</td>
<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>
</td>
</tr>
<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>
<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>
</td>
<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>
</td>
</tr>
<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>
<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>
</td>
<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>
</td>
</tr>
<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>
<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>
</td>
<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>
<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>
</td>
</tr>
<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>
<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>
</td>
<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>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For details about how to configure ALUA for Huawei distributed storage, see the

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.

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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.
>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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For details about how to configure ALUA for Huawei enterprise storage, see the h

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.

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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.
## ALUA Parameters for OceanStor V5 and OceanStor Dorado V3 Series{#section16218353201717}
Expand Down Expand Up @@ -102,7 +102,7 @@ parameters:
[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.
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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.
**Table 2** ALUA parameters for OceanStor and OceanStor Dorado series
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ You need to configure topology labels on worker nodes in the cluster. The method
</tbody>
</table>
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>- A topology label must start with **topology.kubernetes.io**. Topology label examples:
> - Example 1: **topology.kubernetes.io/region=China-west**
> - Example 2: **topology.kubernetes.io/zone=ChengDu**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The PVC change feature is implemented using CRD. Related resources are described
</tbody>
</table>

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>- VolumeModifyClaim resources can be created, deleted, and queried, but cannot be updated.
>- 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.
>- VolumeModifyContent resources are managed by VolumeModifyClaim. Do not manually manage VolumeModifyContent resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 2

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

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>- Only the HyperMetro active-active \(AA\) mode is supported.
>- When a common volume is changed to a HyperMetro volume, only the storage volume at the primary site can be changed.
>- Do not use Huawei CSI to manage a PVC during PVC change resource creation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The sample template of the PVC change file is **/examples/volumemodifyclaim.yam
</tbody>
</table>

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>- 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.
>- 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description:
weight: 3
---

>![](/public_sys-resources/en/icon-notice.gif)
>![](/css-docs/public_sys-resources/en/icon-notice.gif)
>- 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.
>- 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\).
>- VolumeModifyContent resources are managed by VolumeModifyClaim. Do not manually manage VolumeModifyContent resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ To query a VolumeModifyClaim using kubectl, perform the following steps.
</tbody>
</table>
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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:
>```
>kubectl describe volumemodifyclaims local-to-hypermetro
Expand Down Expand Up @@ -150,7 +150,7 @@ A VolumeModifyContent is created using a VolumeModifyClaim and records the chang
</tbody>
</table>
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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:
>```
>kubectl describe volumemodifycontents myvmc-uid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ weight: 1
customresourcedefinition.apiextensions.k8s.io/volumemodifycontents.xuanwu.huawei.io configured
```
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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.
4. <a name="li1230915254221"></a>Run the following command to obtain the original service configuration file.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/appendix/configuring-custom-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For different storage resources, refer to the following configurations:
- For NAS resources, configure the minimum permissions by referring to [Table 1](#table66121923174916).
- For SAN resources, configure the minimum permissions by referring to [Table 2](#table51362243359).

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>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).
**Table 1** Minimum permissions for NAS resources
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/appendix/huawei-csi-resource-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ If you need to modify the resource requests and limits of a container, perform t
- If the Pod name is **huawei-csi-controller**, modify the **huawei-csi-controller.yaml** file.
- If the Pod name is **huawei-csi-node**, modify the **huawei-csi-node.yaml** file.

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>For details about Pod names, see [Table 1](#table4106151116363).
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The ReadWriteOnce access mode is the fourth access mode introduced by Kubernetes

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.

>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>Currently, the CCE or CCE Agile platform does not support the ReadWriteOncePod feature gate.
## Procedure{#en-us_topic_0000001259843616_section137882216292}
Expand All @@ -28,7 +28,7 @@ The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.
...
```
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>After the editing is complete, Kubernetes will automatically apply the updates.
2. Enable the ReadWriteOncePod feature gate for kube-scheduler.
Expand All @@ -45,12 +45,12 @@ The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.
...
```
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>After the editing is complete, Kubernetes will automatically apply the updates.
3. Enable the ReadWriteOncePod feature gate for kubelet.
>![](/public_sys-resources/en/icon-notice.gif)
>![](/css-docs/public_sys-resources/en/icon-notice.gif)
>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.
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.
Expand All @@ -63,7 +63,7 @@ The ReadWriteOncePod access mode is an alpha feature in Kubernetes v1.22/1.23/1.
...
```
>![](/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>The default path of the kubelet configuration file is **/var/lib/kubelet/config.yaml**. Enter the path based on site requirements.
3. After the configuration is complete, run the **systemctl restart kubelet** command to restart kubelet.
Expand Down
Loading

0 comments on commit 99036c5

Please sign in to comment.