Skip to content

Commit 73c2738

Browse files
cabbetlongcabbetlong
committed
update v4.8.0 docs
1 parent d2b9c4c commit 73c2738

File tree

366 files changed

+24939
-593
lines changed

Some content is hidden

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

366 files changed

+24939
-593
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.7.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.8.0%20User%20Guide%2001.pdf">
1111
PDF Download <i class="fa-solid fa-file-pdf"></i>
1212
</a>

‎content/en/docs/advanced-features/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ weight: 8
88

99

1010

11+

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ The ALUA configuration may vary according to the OS. Visit [Huawei Technical Su
1212
>![](/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
15-
## ALUA Parameters for OceanStor V5 and OceanStor Dorado V3 Series{#section16218353201717}
15+
## ALUA Parameters for OceanStor V5 Series{#section16218353201717}
1616

17-
[Table 1](#en-us_topic_0000001299863718_en-us_topic_0000001199142540_table106361351202112) lists the ALUA parameters supported by Huawei CSI for OceanStor V5 and OceanStor Dorado V3 series.
17+
[Table 1](#en-us_topic_0000001299863718_en-us_topic_0000001199142540_table106361351202112) lists the ALUA parameters supported by Huawei CSI for OceanStor V5 series.
1818

19-
**Table 1** ALUA parameters supported by Huawei CSI for OceanStor V5 and OceanStor Dorado V3 series
19+
**Table 1** ALUA parameters supported by Huawei CSI for OceanStor V5 series
2020

2121
<a name="en-us_topic_0000001299863718_en-us_topic_0000001199142540_table106361351202112"></a>
2222
<table><thead align="left"><tr id="en-us_topic_0000001299863718_en-us_topic_0000001199142540_row12636135142110"><th class="cellrowborder" valign="top" width="20.77%" id="mcps1.2.4.1.1"><p id="en-us_topic_0000001299863718_en-us_topic_0000001199142540_p7636151112111"><a name="en-us_topic_0000001299863718_en-us_topic_0000001199142540_p7636151112111"></a><a name="en-us_topic_0000001299863718_en-us_topic_0000001199142540_p7636151112111"></a>Parameter</p>

‎content/en/docs/advanced-features/configuring-ipv6/_index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Configuring IPv6"
3+
linkTitle: "Configuring IPv6"
4+
description:
5+
weight: 4
6+
---
7+
8+
This section describes how to use Huawei CSI to configure IPv6.
9+
10+
11+

‎content/en/docs/advanced-features/configuring-ipv6/configuring-ipv6-during-the-initial-installation-of-huawei-csi.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "Configuring IPv6 During the Initial Installation of Huawei CSI"
3+
linkTitle: "Configuring IPv6 During the Initial Installation of Huawei CSI"
4+
description:
5+
weight: 1
6+
---
7+
8+
This section describes how to specify IPv6 during the initial installation of Huawei CSI.
9+
10+
## Prerequisites{#section11013445374}
11+
12+
- IPv6 can be configured only when the storage backend type is **oceanstor-nas**, **oceanstor-san**, or **oceanstor-dtree**.
13+
- The host environment and Kubernetes cluster environment support IPv6. For details, see [IPv4/IPv6 dual-stack of Kubernetes](https://kubernetes.io/docs/concepts/services-networking/dual-stack/).
14+
15+
## Procedure{#section147071119142913}
16+
17+
1. Install the CSI-dependent components by following the instructions in [1](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/installing-huawei-csi-on-kubernetes-openshift-and-tanzu#en-us_topic_0000001324610777_li9582123242310) to [7](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/installing-huawei-csi-on-kubernetes-openshift-and-tanzu#li1759104413237) in [Installation Procedure](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/installing-huawei-csi-on-kubernetes-openshift-and-tanzu#section9426125115349).
18+
2. Run the **vi values.yaml** command to open the configuration file and modify the **service.ipFamilyPolicy** and **service.ipFamilies** configuration items. For details about the parameters, see [Table 5](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/parameters-in-the-values-yaml-file-of-helm#table258712427285).
19+
20+
The following is an example:
21+
22+
```yaml
23+
service:
24+
ipFamilyPolicy: SingleStack
25+
ipFamilies:
26+
- IPv6
27+
```
28+
29+
3. Install and deploy Huawei CSI by following the instructions in [8](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/installing-huawei-csi-on-kubernetes-openshift-and-tanzu#en-us_topic_0000001324610777_li888917271326) to [9](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/installing-huawei-csi-on-kubernetes-openshift-and-tanzu#en-us_topic_0000001324610777_li108160349154) in [Installation Procedure](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/installing-huawei-csi-on-kubernetes-openshift-and-tanzu#section9426125115349).
30+
4. Run the following command to check the status of the service in the **huawei-csi** namespace.
31+
32+
```
33+
kubectl get service -n huawei-csi
34+
```
35+
36+
The following is an example of the command output.
37+
38+
```
39+
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
40+
huawei-csi-controller ClusterIP fd00:10:96::8136 <none> 4433/TCP 19m
41+
```
42+
43+
5. Run the following command to check the value of **ipFamilies** for the huawei-csi-controller service.
44+
45+
```
46+
kubectl get svc -n huawei-csi huawei-csi-controller -o=jsonpath='{.spec.ipFamilies}'
47+
```
48+
49+
The following is an example of the command output.
50+
51+
```
52+
["IPv6"]
53+
```
54+
55+
6. Run the following command to check the value of **ipFamilyPolicy** for the huawei-csi-controller service.
56+
57+
```
58+
kubectl get svc -n huawei-csi huawei-csi-controller -o=jsonpath='{.spec.ipFamilyPolicy}'
59+
```
60+
61+
The following is an example of the command output.
62+
63+
```
64+
SingleStack
65+
```
66+

‎content/en/docs/advanced-features/configuring-ipv6/switching-from-ipv4-to-ipv6-for-huawei-csi.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Switching from IPv4 to IPv6 for Huawei CSI"
3+
linkTitle: "Switching from IPv4 to IPv6 for Huawei CSI"
4+
description:
5+
weight: 2
6+
---
7+
8+
This section describes how to switch from IPv4 to IPv6 when updating Huawei CSI.
9+
10+
## Prerequisites{#section11013445374}
11+
12+
- The host environment and Kubernetes cluster environment support IPv6. For details, see [IPv4/IPv6 dual-stack of Kubernetes](https://kubernetes.io/docs/concepts/services-networking/dual-stack/).
13+
- Huawei CSI has been installed and services are running properly.
14+
15+
## Procedure{#section826141105010}
16+
17+
1. <a name="li19355236151916"></a>Run the following command to obtain the original service configuration file. **helm-huawei-csi** indicates the Helm chart name specified during the installation of the earlier version, and **huawei-csi** indicates the Helm chart namespace specified during the installation of the earlier version.
18+
19+
```
20+
helm get values helm-huawei-csi -n huawei-csi -a > ./update-values.yaml
21+
```
22+
23+
2. Run the **vi update-values.yaml** command to open the file obtained in [1](#li19355236151916) and modify the **service.ipFamilyPolicy** and **service.ipFamilies** configuration items. For details about the parameters, see [Table 5](/docs/installation-and-deployment/installing-huawei-csi/installing-huawei-csi-using-helm/parameters-in-the-values-yaml-file-of-helm#table258712427285).
24+
25+
The following is an example:
26+
27+
```yaml
28+
service:
29+
ipFamilyPolicy: SingleStack
30+
ipFamilies:
31+
- IPv6
32+
```
33+
34+
3. Before switching to IPv6, run the following command to delete the service in the **huawei-csi** namespace.
35+
36+
```
37+
kubectl delete service -n huawei-csi --all
38+
```
39+
40+
4. Run the following command to upgrade Huawei CSI. In the following command, **helm-huawei-csi** indicates the specified Helm chart name, **huawei-csi** indicates the specified Helm chart namespace, and **update-values.yaml** indicates the file obtained in [1](#li19355236151916).
41+
42+
```
43+
helm upgrade helm-huawei-csi ./ -n huawei-csi -f ./values.yaml -f ./update-values.yaml
44+
```
45+
46+
5. Run the following command to query the **ipFamilies** parameter of the huawei-csi-controller service after the update.
47+
48+
```
49+
kubectl get svc -n huawei-csi huawei-csi-controller -o=jsonpath='{.spec.ipFamilies}'
50+
```
51+
52+
The expected output is as follows:
53+
54+
```
55+
["IPv6"]
56+
```
57+

‎content/en/docs/appendix/example-alua-configuration-policy-of-oceanstor-v5-series.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: "Example ALUA Configuration Policy of OceanStor V5 Series"
3+
linkTitle: "Example ALUA Configuration Policy of OceanStor V5 Series"
4+
description:
5+
weight: 1
6+
---
7+
8+
**Example 1:** The configuration file content is as follows:
9+
10+
```yaml
11+
parameters:
12+
ALUA:
13+
"*":
14+
MULTIPATHTYPE: 1
15+
FAILOVERMODE: 3
16+
SPECIALMODETYPE: 0
17+
PATHTYPE: 0
18+
node1:
19+
MULTIPATHTYPE: 1
20+
FAILOVERMODE: 3
21+
SPECIALMODETYPE: 0
22+
PATHTYPE: 1
23+
```
24+
25+
If the host name is **node1**, both of the preceding ALUA configuration sections can be used to configure initiators. According to the configuration policy rules in [Configuring ALUA Parameters for a Huawei Enterprise Storage Backend](/docs/advanced-features/configuring-alua/configuring-alua-using-helm/configuring-alua-parameters-for-a-huawei-enterprise-storage-backend), the priority of the second configuration section \(where **HostName** is **node1**\) is higher than that of the first configuration section \(where **HostName** is **\***\).
26+
27+
**Example 2:** The configuration file content is as follows:
28+
29+
```yaml
30+
parameters:
31+
ALUA:
32+
node[0-9]:
33+
MULTIPATHTYPE: 1
34+
FAILOVERMODE: 3
35+
SPECIALMODETYPE: 0
36+
PATHTYPE: 0
37+
node[5-7]:
38+
MULTIPATHTYPE: 1
39+
FAILOVERMODE: 3
40+
SPECIALMODETYPE: 0
41+
PATHTYPE: 1
42+
```
43+
44+
If the host name is **node6**, both of the preceding ALUA configuration sections can be used to configure initiators. According to the configuration policy rules in [Configuring ALUA Parameters for a Huawei Enterprise Storage Backend](/docs/advanced-features/configuring-alua/configuring-alua-using-helm/configuring-alua-parameters-for-a-huawei-enterprise-storage-backend), select the first ALUA configuration section to configure initiators.
45+
46+
**Example 3:** The configuration file content is as follows:
47+
48+
```yaml
49+
parameters:
50+
ALUA:
51+
node$:
52+
MULTIPATHTYPE: 1
53+
FAILOVERMODE: 3
54+
SPECIALMODETYPE: 0
55+
PATHTYPE: 0
56+
node10$:
57+
MULTIPATHTYPE: 1
58+
FAILOVERMODE: 3
59+
SPECIALMODETYPE: 0
60+
PATHTYPE: 1
61+
```
62+
63+
According to the configuration policy rules in [Configuring ALUA Parameters for a Huawei Enterprise Storage Backend](/docs/advanced-features/configuring-alua/configuring-alua-using-helm/configuring-alua-parameters-for-a-huawei-enterprise-storage-backend): For host **node1**, select the first ALUA configuration section to configure initiators. For host **node10**, select the second ALUA configuration section to configure initiators. **^** matches the beginning of a character string, and **$** matches the end of a character string.
64+

‎content/en/docs/common-operations/collecting-information/collecting-logs.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 3
88
## Performing Check Before Collection{#section298992810393}
99

1010
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.
11-
2. Run the following command. The displayed version is **v4.7.0**.
11+
2. Run the following command. The displayed version is **v4.8.0**.
1212

1313
```
1414
oceanctl version
@@ -17,7 +17,7 @@ weight: 3
1717
The following is an example of the command output.
1818
1919
```yaml
20-
Oceanctl Version: v4.7.0
20+
Oceanctl Version: v4.8.0
2121
```
2222
2323
3. Run the **oceanctl collect logs --help** command. The following information is displayed.

‎content/en/docs/common-operations/collecting-information/obtaining-the-csi-version.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ This section describes how to view the CSI version.
3434
The version information is displayed as follows:
3535
3636
```
37-
4.7.0
37+
4.8.0
3838
```
3939

‎content/en/docs/compatibility-and-features/compatibility-with-huawei-distributed-storage.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Huawei CSI plug-in supports the following features for Huawei distributed storag
6060
<td class="cellrowborder" rowspan="3" valign="top" width="27%" headers="mcps1.2.5.1.3 "><p id="p1550235510250"><a name="p1550235510250"></a><a name="p1550235510250"></a>SAN: iSCSI/SCSI</p>
6161
<p id="p1155184451813"><a name="p1155184451813"></a><a name="p1155184451813"></a>NAS: DPC<sup id="sup03431118543"><a name="sup03431118543"></a><a name="sup03431118543"></a>2</sup>/NFS 3/4.1<sup id="sup592411910418"><a name="sup592411910418"></a><a name="sup592411910418"></a>3</sup></p>
6262
</td>
63-
<td class="cellrowborder" rowspan="3" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1899101904919"><a name="p1899101904919"></a><a name="p1899101904919"></a>SAN: FC/iSCSI/NVMe over RoCE<sup id="sup4943164011220"><a name="sup4943164011220"></a><a name="sup4943164011220"></a>5</sup></p>
63+
<td class="cellrowborder" rowspan="3" valign="top" width="25%" headers="mcps1.2.5.1.4 "><p id="p1899101904919"><a name="p1899101904919"></a><a name="p1899101904919"></a>SAN<sup id="sup9603152783919"><a name="sup9603152783919"></a><a name="sup9603152783919"></a>4</sup>: FC/iSCSI/NVMe over RoCE<sup id="sup4943164011220"><a name="sup4943164011220"></a><a name="sup4943164011220"></a>6</sup></p>
6464
</td>
6565
</tr>
6666
<tr id="row16502165517252"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="p145026553256"><a name="p145026553256"></a><a name="p145026553256"></a>Dynamic Provisioning</p>
@@ -69,7 +69,7 @@ Huawei CSI plug-in supports the following features for Huawei distributed storag
6969
<tr id="row247620119518"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="p447601759"><a name="p447601759"></a><a name="p447601759"></a>Manage Provisioning<sup id="sup25964561381"><a name="sup25964561381"></a><a name="sup25964561381"></a>1</sup></p>
7070
</td>
7171
</tr>
72-
<tr id="row1050205518258"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="p1650211552251"><a name="p1650211552251"></a><a name="p1650211552251"></a>Expand Persistent Volume<sup id="sup99731871303"><a name="sup99731871303"></a><a name="sup99731871303"></a>4</sup></p>
72+
<tr id="row1050205518258"><td class="cellrowborder" valign="top" headers="mcps1.2.5.1.1 "><p id="p1650211552251"><a name="p1650211552251"></a><a name="p1650211552251"></a>Expand Persistent Volume<sup id="sup99731871303"><a name="sup99731871303"></a><a name="sup99731871303"></a>5</sup></p>
7373
</td>
7474
<td class="cellrowborder" colspan="3" valign="top" headers="mcps1.2.5.1.2 mcps1.2.5.1.3 mcps1.2.5.1.4 "><p id="p3160102971819"><a name="p3160102971819"></a><a name="p3160102971819"></a>Volumes created in Dynamic Provisioning or Manage Provisioning mode are supported.</p>
7575
</td>
@@ -172,8 +172,9 @@ Huawei CSI plug-in supports the following features for Huawei distributed storag
172172
- Note 1: Manage Provisioning is a volume management feature customized by Huawei CSI. This feature 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.
173173
- Note 2: Only OceanStor Pacific series 8.1.2 and later versions support DPC. When DPC is used, the OS must meet the requirements for the [OSs supported by Huawei CSI](/docs/compatibility-and-features/kubernetes-and-os-compatibility#table133422378818) and the DPC basic connectivity requirements of OceanStor Pacific series.
174174
- Note 3: Only OceanStor Pacific series 8.1.2 and later versions support NFS 4.1. OceanStor Pacific series 8.2.0 and later versions support NFS over RDMA. When NFS over RDMA is used, only NFS 3 is supported.
175-
- Note 4: The provisioned PVC whose **volumeType** is **lun** and **accessModes** is **ReadOnlyMany** does not support capacity expansion.
176-
- Note 5: If NVMe over RoCE is used, the version of the nvme-cli tool on worker nodes ranges from 1.9 to 1.16. To query the version, run the **nvme version** command.
175+
- Note 4 If a container platform is deployed on a virtualization platform, you are advised to use the iSCSI protocol when connecting to SAN storage. If the customer requires the FC, NVMe over FC, or NVMe over RoCE protocol, the virtualization platform needs to be configured. In this case, the customer's virtualization team needs to provide technical support.
176+
- Note 5: The provisioned PVC whose **volumeType** is **lun** and **accessModes** is **ReadOnlyMany** does not support capacity expansion.
177+
- Note 6: If NVMe over RoCE is used, the version of the nvme-cli tool on worker nodes ranges from 1.9 to 1.16. To query the version, run the **nvme version** command.
177178

178179
Huawei CSI plug-in supports the following features for Huawei distributed storage dtrees.
179180

0 commit comments

Comments
 (0)