Skip to content

Commit 0137fe2

Browse files
committed
update v4.6.0 docs
1 parent 10f643d commit 0137fe2

File tree

521 files changed

+23641
-883
lines changed

Some content is hidden

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

521 files changed

+23641
-883
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/v4.5/docs/eSDK%20Huawei%20Storage%20Kubernetes%20CSI%20Plugins%20V4.5.0%20User%20Guide%2002.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%2001.pdf">
1111
PDF Download <i class="fa-solid fa-file-pdf"></i>
1212
</a>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "About This Document"
33
linkTitle: "About This Document"
4-
description:
4+
description:
55
weight: 1
66
---
77

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

Lines changed: 1 addition & 1 deletion
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-
>![](/css-docs/public_sys-resources/en/icon-note.gif)
12+
>![](/css-docs/public_sys-resources/en-us/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

Lines changed: 2 additions & 2 deletions
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-
>![](/css-docs/public_sys-resources/en/icon-note.gif)
12+
>![](/css-docs/public_sys-resources/en-us/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-
>![](/css-docs/public_sys-resources/en/icon-note.gif)
105+
>![](/css-docs/public_sys-resources/en-us/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

Lines changed: 1 addition & 1 deletion
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-
>![](/css-docs/public_sys-resources/en/icon-note.gif)
66+
>![](/css-docs/public_sys-resources/en-us/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/configuring-storage-topology-awareness/configuring-storage-topology-awareness-using-helm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ weight: 1
1515
cp backend.yaml backend.yaml.bak
1616
```
1717
18-
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.
18+
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.
1919
2020
```yaml
2121
storage: "oceanstor-san"
@@ -130,7 +130,7 @@ weight: 1
130130
</td>
131131
</tr>
132132
<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>
133-
<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>
133+
<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>
134134
<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>
135135
</td>
136136
</tr>

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

Lines changed: 1 addition & 1 deletion
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-
>![](/css-docs/public_sys-resources/en/icon-note.gif)
44+
>![](/css-docs/public_sys-resources/en-us/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

Lines changed: 1 addition & 1 deletion
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-
>![](/css-docs/public_sys-resources/en/icon-note.gif)
10+
>![](/css-docs/public_sys-resources/en-us/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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ The sample template of the PVC change file is **/examples/volumemodifyclaim.yam
5555
<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>
5656
</td>
5757
<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>
58+
<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>
5859
</td>
5960
</tr>
6061
<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>
@@ -108,7 +109,7 @@ The sample template of the PVC change file is **/examples/volumemodifyclaim.yam
108109
</tbody>
109110
</table>
110111

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
weight: 3
66
---
77

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

0 commit comments

Comments
 (0)