Skip to content

Commit

Permalink
update v4.6.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cabbetlong committed Dec 30, 2024
1 parent 10f643d commit 0137fe2
Show file tree
Hide file tree
Showing 521 changed files with 23,641 additions and 883 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ weight: 20

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

<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/Huawei/eSDK_K8S_Plugin/blob/v4.5/docs/eSDK%20Huawei%20Storage%20Kubernetes%20CSI%20Plugins%20V4.5.0%20User%20Guide%2002.pdf">
<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%2001.pdf">
PDF Download <i class="fa-solid fa-file-pdf"></i>
</a>
2 changes: 1 addition & 1 deletion content/en/docs/about-this-document/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "About This Document"
linkTitle: "About This Document"
description:
description:
weight: 1
---

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.

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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.

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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.
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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>
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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 @@ -15,7 +15,7 @@ weight: 1
cp backend.yaml backend.yaml.bak
```
4. Run the **vi **_backend.yaml_ command to open the file and configure topology awareness as required. The following is an example. After the modification is complete, press **Esc** and enter **:wq!** to save the modification.
4. Run the **vi backend.yaml** command to open the file and configure topology awareness as required. The following is an example. After the modification is complete, press **Esc** and enter **:wq!** to save the modification.
```yaml
storage: "oceanstor-san"
Expand Down Expand Up @@ -130,7 +130,7 @@ weight: 1
</td>
</tr>
<tr id="en-us_topic_0000001352573769_row85481628121017"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="en-us_topic_0000001352573769_p1209324123216"><a name="en-us_topic_0000001352573769_p1209324123216"></a><a name="en-us_topic_0000001352573769_p1209324123216"></a><span class="parmname" id="en-us_topic_0000001352573769_parmname1166435611312"><a name="en-us_topic_0000001352573769_parmname1166435611312"></a><a name="en-us_topic_0000001352573769_parmname1166435611312"></a><b>value</b></span>:</p>
<p id="en-us_topic_0000001352573769_p1024122115329"><a name="en-us_topic_0000001352573769_p1024122115329"></a><a name="en-us_topic_0000001352573769_p1024122115329"></a>If <span class="parmname" id="parmname6687855171313"><a name="parmname6687855171313"></a><a name="parmname6687855171313"></a><b>key</b></span> is <span class="parmvalue" id="parmvalue4687135517137"><a name="parmvalue4687135517137"></a><a name="parmvalue4687135517137"></a><b>topology.kubernetes.io/zone</b></span> or <span class="parmvalue" id="parmvalue19687165512136"><a name="parmvalue19687165512136"></a><a name="parmvalue19687165512136"></a><b>topology.kubernetes.io/region</b></span>, <span class="parmname" id="parmname1168755519130"><a name="parmname1168755519130"></a><a name="parmname1168755519130"></a><b>value</b></span> must be the same as the <a href="configuring-storage-topology-awareness.md#en-us_topic_0000001200451233_section12171124814413">topology label set in the prerequisites</a>.</p>
<p id="en-us_topic_0000001352573769_p1024122115329"><a name="en-us_topic_0000001352573769_p1024122115329"></a><a name="en-us_topic_0000001352573769_p1024122115329"></a>If <span class="parmname" id="parmname6687855171313"><a name="parmname6687855171313"></a><a name="parmname6687855171313"></a><b>key</b></span> is <span class="parmvalue" id="parmvalue4687135517137"><a name="parmvalue4687135517137"></a><a name="parmvalue4687135517137"></a><b>topology.kubernetes.io/zone</b></span> or <span class="parmvalue" id="parmvalue19687165512136"><a name="parmvalue19687165512136"></a><a name="parmvalue19687165512136"></a><b>topology.kubernetes.io/region</b></span>, <span class="parmname" id="parmname1168755519130"><a name="parmname1168755519130"></a><a name="parmname1168755519130"></a><b>value</b></span> must be the same as the <a href="/css-docs/docs/advanced-features/configuring-storage-topology-awareness#en-us_topic_0000001200451233_section12171124814413">topology label set in the prerequisites</a>.</p>
<p id="en-us_topic_0000001352573769_p195481328151018"><a name="en-us_topic_0000001352573769_p195481328151018"></a><a name="en-us_topic_0000001352573769_p195481328151018"></a>If <span class="parmname" id="en-us_topic_0000001352573769_parmname13144742173219"><a name="en-us_topic_0000001352573769_parmname13144742173219"></a><a name="en-us_topic_0000001352573769_parmname13144742173219"></a><b>key</b></span> is <strong id="en-us_topic_0000001352573769_b1914414427326"><a name="en-us_topic_0000001352573769_b1914414427326"></a><a name="en-us_topic_0000001352573769_b1914414427326"></a>topology.kubernetes.io/protocol.</strong><em id="en-us_topic_0000001352573769_i14145194283217"><a name="en-us_topic_0000001352573769_i14145194283217"></a><a name="en-us_topic_0000001352573769_i14145194283217"></a>&lt;protocol&gt;</em>, <span class="parmname" id="en-us_topic_0000001352573769_parmname1114654215323"><a name="en-us_topic_0000001352573769_parmname1114654215323"></a><a name="en-us_topic_0000001352573769_parmname1114654215323"></a><b>value</b></span> is fixed at <span class="parmvalue" id="en-us_topic_0000001352573769_parmvalue9146174218322"><a name="en-us_topic_0000001352573769_parmvalue9146174218322"></a><a name="en-us_topic_0000001352573769_parmvalue9146174218322"></a><b>csi.huawei.com</b></span>.</p>
</td>
</tr>
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>

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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.

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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 @@ -55,6 +55,7 @@ The sample template of the PVC change file is **/examples/volumemodifyclaim.yam
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.2.6.1.4 "><p id="p1782413895514"><a name="p1782413895514"></a><a name="p1782413895514"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.2.6.1.5 "><p id="p1482417805520"><a name="p1482417805520"></a><a name="p1482417805520"></a>The name must comply with the naming rules of a <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names" target="_blank" rel="noopener noreferrer">DNS subdomain name</a>. The value can contain a maximum of 63 characters, including digits, lowercase letters, hyphens (-), and periods (.). It must start and end with a lowercase letter or digit.</p>
<p id="p1890916560354"><a name="p1890916560354"></a><a name="p1890916560354"></a>Note: During a PVC change, the original StorageClass is backed up. The name of the backup StorageClass is <em id="i1932131117367"><a name="i1932131117367"></a><a name="i1932131117367"></a>&lt;Original StorageClass name&gt;&lt;VolumeModifyClaim name&gt;</em>, and must comply with the StorageClass naming rules.</p>
</td>
</tr>
<tr id="row1482498135514"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.2.6.1.1 "><p id="p18241589552"><a name="p18241589552"></a><a name="p18241589552"></a>spec.source.kind</p>
Expand Down Expand Up @@ -108,7 +109,7 @@ The sample template of the PVC change file is **/examples/volumemodifyclaim.yam
</tbody>
</table>

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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
---

>![](/css-docs/public_sys-resources/en/icon-notice.gif)
>![](/css-docs/public_sys-resources/en-us/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>
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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>
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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 @@ -8,7 +8,7 @@ weight: 1
## Prerequisites{#section10631153612202}

- You have installed Huawei CSI using Helm.
- Huawei CSI v4.5.0 or later is used.
- Huawei CSI v4.6.0 or later is used.

## Procedure{#section1361061612118}

Expand Down Expand Up @@ -39,7 +39,7 @@ weight: 1
customresourcedefinition.apiextensions.k8s.io/volumemodifycontents.xuanwu.huawei.io configured
```
>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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
6 changes: 4 additions & 2 deletions content/en/docs/appendix/communication-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,10 @@ weight: 4
</th>
<td class="cellrowborder" valign="top" width="16.98830116988301%" headers="mcps1.1.6.14.1 "><p id="p834114216248"><a name="p834114216248"></a><a name="p834114216248"></a>Enable some source ports.</p>
</td>
<td class="cellrowborder" valign="top" width="21.657834216578344%" headers="mcps1.1.6.14.1 ">&nbsp;&nbsp;</td>
<td class="cellrowborder" valign="top" width="21.01789821017898%" headers="mcps1.1.6.14.1 ">&nbsp;&nbsp;</td>
<td class="cellrowborder" valign="top" width="21.657834216578344%" headers="mcps1.1.6.14.1 "><p id="p73411227241"><a name="p73411227241"></a><a name="p73411227241"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="21.01789821017898%" headers="mcps1.1.6.14.1 "><p id="p1834172102410"><a name="p1834172102410"></a><a name="p1834172102410"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="20.377962203779624%" headers="mcps1.1.6.14.1 "><p id="p183414219248"><a name="p183414219248"></a><a name="p183414219248"></a>For details about how to change the webhook port, see the CSI user guide.</p>
</td>
</tr>
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).

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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.

>![](/css-docs/public_sys-resources/en/icon-note.gif)
>![](/css-docs/public_sys-resources/en-us/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 @@ -8,7 +8,7 @@ weight: 3
## Performing Check Before Collection{#section298992810393}

1. Use a remote access tool, such as PuTTY, to log in to the node where the oceanctl tool is installed in the Kubernetes cluster through the management IP address.
2. Run the following command. The displayed version is **v4.5.0**.
2. Run the following command. The displayed version is **v4.6.0**.

```
oceanctl version
Expand All @@ -17,7 +17,7 @@ weight: 3
The following is an example of the command output.
```yaml
Oceanctl Version: v4.5.0
Oceanctl Version: v4.6.0
```
3. Run the **oceanctl collect logs --help** command. The following information is displayed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ This section describes how to view the CSI version.
The version information is displayed as follows:
```
4.5.0
4.6.0
```
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ weight: 2
6. Run the following command to view the standard output logs of the container.
```
vi huawei-csi-controller-<name>_huawei-csi_huawei-csi-driver-<contrainer-id>.log
vi huawei-csi-controller-<name>_huawei-csi_huawei-csi-driver-<container-id>.log
```
## Viewing Logs of the huawei-csi-node Service{#en-us_topic_0000001191906803_section66851055357}
Expand Down Expand Up @@ -82,6 +82,6 @@ weight: 2
6. Run the following command to view the standard output logs of the container.
```
vi huawei-csi-node-<name>_huawei-csi_huawei-csi-driver-<contrainer-id>.log
vi huawei-csi-node-<name>_huawei-csi_huawei-csi-driver-<container-id>.log
```
Loading

0 comments on commit 0137fe2

Please sign in to comment.