When oceanctl is used to create a storage backend, the entered account and key information is stored in the Secret object. It is recommended that the customer container platform encrypt the Secret object based on the suggestions of the supplier or K8s community. For details about how to encrypt the Secret object in the K8s community, see Encrypting Confidential Data at Rest .
When a backend is created using a .json file, the backend name of an earlier version may contain uppercase letters or underscores (_). In this case, the old name is remapped to a new name. The mapping process automatically occurs and does not affect the original functions. For example, ABC_123 is mapped to abc-123-fd68e. The mapping rules are as follows:
Uppercase letters are converted to lowercase letters.
An underscore (_) is converted to a hyphen (-).
A 5-digit hash code is added to the end.
If a storage backend is connected to a vStore, the vStore name cannot be changed after the storage backend is created.

1 - Flash Storage (OceanStor Dorado/OceanStor V5/OceanStor V6 and Later)

1.1 - File System

1.1.1 - NFS

This section describes how to create a storage backend of the NFS protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
vstoreName	vStore name on the storage side. This parameter needs to be specified when the connected backend is OceanStor V5 and resources need to be provisioned under a specified vStore.	No	-	This parameter needs to be specified only when the backend is OceanStor V5 and vStores need to be supported.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If resources need to be provisioned to a specified vStore, set this parameter to the logical management port URL of the specified vStore. If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If a vStore is used to connect to a backend, portals must be set to the logical port information of the vStore. You can enter a domain name address. IPv6 is supported. Only one port can be configured.
metrovStorePairID	HyperMetro vStore pair ID. This parameter is mandatory when a PV to be created on the storage side needs to support the NAS HyperMetro feature. In this case, you need to enter the ID of the HyperMetro vStore pair to which the PV to be created belongs.	No	-	You can query the HyperMetro vStore pair ID on DeviceManager.
metroBackend	Backend name of the HyperMetro peer. The value is a character string. This parameter is mandatory when a PV to be created on the storage side needs to support the NAS HyperMetro feature. In this case, you need to enter the name of the other backend to form a HyperMetro pair with the current backend.	No	-	The names of the two backends in the pair must be entered. After the two backends form a HyperMetro relationship, they cannot form a HyperMetro relationship with other backends.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	When Huawei enterprise storage is OceanStor V5, the ID of the LDAP domain authentication server must be 0.

Creating Storage Backends of the Local Type

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "nfs"
  portals:
    - "10.10.30.20"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

Creating Storage Backends of the HyperMetro Type

Before configuring NAS HyperMetro, you need to configure the HyperMetro relationship between two storage devices, including the remote device and HyperMetro domain. The HyperMetro domain of the file system can only work in HyperMetro active-active (AA) mode. For details about the configuration operation, see the product documentation of the corresponding storage model.
The accounts for connecting to NAS HyperMetro backends must be the administrator accounts of the storage vStores.
Except NAS HyperMetro backends, the management URLs of other backends cannot be the URL of a logical management port of a vStore that has established the HyperMetro relationship.
When a HyperMetro storage backend is used, do not provision common file systems. Otherwise, services may be interrupted in logical port failover scenarios.

Prepare a storage backend configuration file, for example, backend.yaml.

storage: "oceanstor-nas"
name: "backend-active"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.155:8088"
pools:
  - "StoragePool001"
metrovStorePairID: "2100xxxxxxxxxx0000000000600000000"
metroBackend: "backend-standby"
parameters:
  protocol: "nfs"
  portals:
    - "192.168.129.156"
maxClientThreads: "30"
---
storage: "oceanstor-nas"
name: "backend-standby"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
metrovStorePairID: "2100xxxxxxxxxx0000000000600000000"
metroBackend: "backend-active"
parameters:
  protocol: "nfs"
  portals:
    - "192.168.129.158"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME              STORAGE              URLS                
1       false         backend-active    oceanstor-nas        https://192.168.129.155:8088 
2       false         backend-standby   oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: user1
Please enter this backend password:

Backend backend-standby is configured
NUMBER  CONFIGURED    NAME              STORAGE              URLS               
1       true          backend-active    oceanstor-nas        https://192.168.129.155:8088 
2       true          backend-standby   oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME              PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-active    nfs         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.155:8088   
huawei-csi    backend-standby   nfs         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

1.1.2 - NFS+

This section describes how to create a storage backend of the NFS+ protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If resources need to be provisioned to a specified vStore, set this parameter to the logical management port URL of the specified vStore. If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS+ client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If a vStore is used to connect to a backend, portals must be set to the logical port information of the vStore. You can enter a domain name address. IPv6 is supported. Multiple ports can be configured.
metrovStorePairID	HyperMetro vStore pair ID. This parameter is mandatory when a PV to be created on the storage side needs to support the NAS HyperMetro feature. In this case, you need to enter the ID of the HyperMetro vStore pair to which the PV to be created belongs.	No	-	You can query the HyperMetro vStore pair ID on DeviceManager.
metroBackend	Backend name of the HyperMetro peer. The value is a character string. This parameter is mandatory when a PV to be created on the storage side needs to support the NAS HyperMetro feature. In this case, you need to enter the name of the other backend to form a HyperMetro pair with the current backend.	No	-	The names of the two backends in the pair must be entered. After the two backends form a HyperMetro relationship, they cannot form a HyperMetro relationship with other backends.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	-

Creating Storage Backends of the Local Type

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "nfs+"
  portals:
    - "10.10.30.20"
    - "10.10.30.30"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL     STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs+         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

Creating Storage Backends of the HyperMetro Type

Before configuring NAS HyperMetro, you need to configure the HyperMetro relationship between two storage devices, including the remote device and HyperMetro domain. The HyperMetro domain of the file system can only work in HyperMetro active-active (AA) mode. For details about the configuration operation, see the product documentation of the corresponding storage model.
The accounts for connecting to NAS HyperMetro backends must be the administrator accounts of the storage vStores.
Except NAS HyperMetro backends, the management URLs of other backends cannot be the URL of a logical management port of a vStore that has established the HyperMetro relationship.
When a HyperMetro storage backend is used, do not provision common file systems. Otherwise, services may be interrupted in logical port failover scenarios.

Procedure

Prepare a storage backend configuration file, for example, backend.yaml.

storage: "oceanstor-nas"
name: "backend-active"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.155:8088"
pools:
  - "StoragePool001"
metrovStorePairID: "2100xxxxxxxxxx0000000000600000000"
metroBackend: "backend-standby"
parameters:
  protocol: "nfs+"
  portals:
    - "192.168.129.156"
    - "192.168.129.157"
maxClientThreads: "30"
---
storage: "oceanstor-nas"
name: "backend-standby"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.158:8088"
pools:
  - "StoragePool001"
metrovStorePairID: "2100xxxxxxxxxx0000000000600000000"
metroBackend: "backend-active"
parameters:
  protocol: "nfs+"
  portals:
    - "192.168.129.159"
    - "192.168.129.160"   
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME              STORAGE              URLS                
1       false         backend-active    oceanstor-nas        https://192.168.129.155:8088 
2       false         backend-standby   oceanstor-nas        https://192.168.129.158:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: user1
Please enter this backend password:

Backend backend-standby is configured
NUMBER  CONFIGURED    NAME              STORAGE              URLS               
1       true          backend-active    oceanstor-nas        https://192.168.129.155:8088 
2       true          backend-standby   oceanstor-nas        https://192.168.129.158:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME              PROTOCOL     STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-active    nfs+         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.155:8088   
huawei-csi    backend-standby   nfs+         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.158:8088

1.2 - Dtree

1.2.1 - NFS

This section describes how to create a storage backend of the NFS protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-dtree.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If resources need to be provisioned to a specified vStore, set this parameter to the logical management port URL of the specified vStore. If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If a vStore is used to connect to a backend, portals must be set to the logical port information of the vStore. You can enter a domain name address. IPv6 is supported. Only one port can be configured.
parameters.parentname	Name of a file system on the current storage device. A dtree is created in the file system.	No	-	Query the name on the File Systems page of DeviceManager. You can configure the parameter in StorageClass.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	-

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-dtree"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
parameters:
  protocol: "nfs"
  parentname: "parent-filesystem"
  portals:
    - "10.10.30.20"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-dtree      https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-dtree      https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs         oceanstor-dtree  xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

1.2.2 - NFS+

This section describes how to create a storage backend of the NFS+ protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-dtree.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If resources need to be provisioned to a specified vStore, set this parameter to the logical management port URL of the specified vStore. If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS+ client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If a vStore is used to connect to a backend, portals must be set to the logical port information of the vStore. You can enter a domain name address. IPv6 is supported. Multiple ports can be configured.
parameters.parentname	Name of a file system on the current storage device. A dtree is created in the file system.	No	-	Query the name on the File Systems page of DeviceManager. You can configure the parameter in StorageClass.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	-

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-dtree"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
parameters:
  protocol: "nfs+"
  parentname: "parent-filesystem"
  portals:
    - "10.10.30.20"
    - "10.10.30.30"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-dtree      https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-dtree      https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL     STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs+         oceanstor-dtree  xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

1.3 - Block Service

1.3.1 - iSCSI

This section describes how to create a storage backend of the iSCSI protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to iscsi. Ensure that an iSCSI client has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	IPv6 is supported. Multiple ports can be configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	When Huawei enterprise storage is OceanStor V5, the ID of the LDAP domain authentication server must be 0.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "iscsi"
  portals:
    - "10.10.30.20"
    - "10.10.30.21"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    iscsi       oceanstor-san    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

1.3.2 - FC

This section describes how to create a storage backend of the FC protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to fc.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	When Huawei enterprise storage is OceanStor V5, the ID of the LDAP domain authentication server must be 0.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "fc"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    fc          oceanstor-san    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

1.3.3 - NVMe over RoCE

This section describes how to create a storage backend of the NVMe over RoCE protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to roce. Ensure that the nvme-cli tool has been installed on the compute node to be connected. The supported nvme-cli tool version is 1.9 and later.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	IPv6 is supported. Multiple ports can be configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	When Huawei enterprise storage is OceanStor V5, the ID of the LDAP domain authentication server must be 0.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "roce"
  portals:
    - "10.10.30.20"
    - "10.10.30.21"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    roce        oceanstor-san    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

1.3.4 - FC-NVMe

This section describes how to create a storage backend of the FC-NVMe protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If the management URL is of the IPv6 type, the URL format is https://[IPv6 address]:Port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to fc-nvme. Ensure that the nvme-cli tool has been installed on the compute node to be connected. The supported nvme-cli tool version is 1.9 and later.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	When Huawei enterprise storage is OceanStor V5, the ID of the LDAP domain authentication server must be 0.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "fc-nvme"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    fc-nvme     oceanstor-san    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

2 - Flash Storage (OceanStor A600/A800)

2.1 - Local File System

2.1.1 - NFS

This section describes how to create a storage backend of the NFS protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-a-series-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	Only one port can be configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	-

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-a-series-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "nfs"
  portals:
    - "10.10.30.20"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE                   URLS                
1       false         backend-demo   oceanstor-a-series-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE                   URLS               
1       true          backend-demo    oceanstor-a-series-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE             SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs         oceanstor-a-series-nas  xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

2.1.2 - DataTurbo

This section describes how to create a storage backend of the DataTurbo protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-a-series-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to dtfs. Ensure that a DataTurbo client has been installed on the connected compute node and the connectivity of the storage logical port has been configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.
authenticationMode	Authentication mode for logging in to a storage backend. The following modes are supported: local: local authentication ldap: LDAP authentication	No	local	-

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-a-series-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "dtfs"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-a-series-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-a-series-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL   STORAGETYPE             SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    dtfs       oceanstor-a-series-nas  xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

3 - Mass Storage (OceanStor Pacific Series)

3.1 - Namespace

3.1.1 - NFS

This section describes how to create a storage backend of the NFS protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to fusionstorage-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
accountName	Account name on the storage side.	No	-	This parameter is mandatory when NAS resources need to be provisioned under a specified account.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If an account is used to connect to a backend, portals must be set to the logical port information of the account. You can enter a domain name address.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "fusionstorage-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "nfs"
  portals:
    - "10.10.30.20"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   fusionstorage-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    fusionstorage-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE        SN             STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs         fusionstorage-nas                 Bound   true    https://192.168.129.157:8088

3.1.2 - DPC

This section describes how to create a storage backend of the DPC protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to fusionstorage-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
accountName	Account name on the storage side.	No	-	This parameter is mandatory when NAS resources need to be provisioned under a specified account.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to dpc. Ensure that DPC has been installed on the connected compute node and the node has been added as a DPC compute node on the storage device to be connected.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "fusionstorage-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "dpc"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   fusionstorage-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    fusionstorage-nas    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE        SN               STATUS  ONLINE  URL                 
huawei-csi    backend-demo    dpc         fusionstorage-nas                   Bound   true    https://192.168.129.157:8088

3.2 - Dtree

3.2.1 - NFS

This section describes how to create a storage backend of the NFS protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to fusionstorage-dtree.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
accountName	Account name on the storage side.	No	-	This parameter is mandatory when NAS resources need to be provisioned under a specified account.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If an account is used to connect to a backend, portals must be set to the logical port information of the account. You can enter a domain name address.
parameters.parentname	Name of a file system on the current storage device. A dtree is created in the file system.	No	-	Query the name on the File Systems page of DeviceManager. You can configure the parameter in StorageClass.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "fusionstorage-dtree"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
parameters:
  protocol: "nfs"
  parentname: "parent-filesystem"
  portals:
    - "10.10.30.20"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   fusionstorage-dtree  https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    fusionstorage-dtree  https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE           SN            STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs         fusionstorage-dtree                 Bound   true    https://192.168.129.157:8088

3.2.2 - DPC

This section describes how to create a storage backend of the DPC protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to fusionstorage-dtree.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
accountName	Account name on the storage side.	No	-	This parameter is mandatory when NAS resources need to be provisioned under a specified account.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
parameters.protocol	Storage protocol. The value is a character string. dpc	Yes	-	The value is fixed to dpc. Ensure that DPC has been installed on the connected compute node and the node has been added as a DPC compute node on the storage device to be connected.
parameters.parentname	Name of a file system on the current storage device. A dtree is created in the file system.	No	-	Query the name on the File Systems page of DeviceManager. You can configure the parameter in StorageClass.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "fusionstorage-dtree"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
parameters:
  protocol: "dpc"
  parentname: "parent-filesystem"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE                URLS                
1       false         backend-demo   fusionstorage-dtree    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE                URLS               
1       true          backend-demo    fusionstorage-dtree    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE          SN          STATUS  ONLINE  URL                 
huawei-csi    backend-demo    dpc         fusionstorage-dtree              Bound   true    https://192.168.129.157:8088

3.3 - Block Service

3.3.1 - iSCSI

This section describes how to create a storage backend of the iSCSI protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to fusionstorage-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to iscsi. Ensure that an iSCSI client has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Conditionally mandatory	-	Multiple ports can be configured. Either iscsiLinks or portals must be set.
parameters.iscsiLinks	Number of dynamic access links. This parameter is supported only in OceanStor Pacific 8.1.5 and later versions.	Conditionally mandatory		Either iscsiLinks or portals must be set. NOTE: The iscsiLinks parameter takes effect only when the portals parameter is left empty. The number of valid links is the maximum value among the following three values: Value of iscsiLinks Minimum number of links dynamically allocated by the storage Number of established links on the host
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "fusionstorage-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "iscsi"
  portals:
    - "10.10.30.20"
    - "10.10.30.21"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   fusionstorage-san    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    fusionstorage-san    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE        SN       STATUS  ONLINE  URL                 
huawei-csi    backend-demo    iscsi       fusionstorage-san           Bound   true    https://192.168.129.157:8088

3.3.2 - SCSI

This section describes how to create a storage backend of the SCSI protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to fusionstorage-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to scsi. Ensure that a distributed storage VBS client has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If the protocol is scsi, the port is in dictionary format where the key indicates the name of the host where the VBS client is deployed and the value indicates the IP address of the host where the VBS client is deployed.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "fusionstorage-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "scsi"
  portals:
    - {"hostname01": "192.168.125.21","hostname02": "192.168.125.22"}
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   fusionstorage-san    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    fusionstorage-san    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE        SN      STATUS  ONLINE  URL                 
huawei-csi    backend-demo    scsi        fusionstorage-san          Bound   true    https://192.168.129.157:8088

4 - Mass Storage (OceanDisk Series)

4.1 - File System

4.1.1 - NFS

This section describes how to create a storage backend of the NFS protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceanstor-nas.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list. The value can be a domain name or an IP address + port number.	Yes	-	If resources need to be provisioned to a specified vStore, set this parameter to the logical management port URL of the specified vStore.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to nfs. Ensure that an NFS client tool has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	If a vStore is used to connect to a backend, portals must be set to the logical port information of the vStore. You can enter a domain name address. Only one port can be configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating Storage Backends of the Local Type

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceanstor-nas"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "nfs"
  portals:
    - "10.10.30.20"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceanstor-nas        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE      SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    nfs         oceanstor-nas    xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

4.2 - Block Service

4.2.1 - iSCSI

This section describes how to create a storage backend of the iSCSI protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceandisk-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to iscsi. Ensure that an iSCSI client has been installed on the connected compute node.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	Multiple ports can be configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceandisk-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "iscsi"
  portals:
    - "10.10.30.20"
    - "10.10.30.21"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE          URLS                
1       false         backend-demo   oceandisk-san    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE          URLS               
1       true          backend-demo    oceandisk-san    https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE     SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    iscsi       oceandisk-san   xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

4.2.2 - FC

This section describes how to create a storage backend of the FC protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceandisk-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to fc.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceandisk-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "fc"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceandisk-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceandisk-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE        SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    fc          oceandisk-san      xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088

4.2.3 - NVMe over RoCE

This section describes how to create a storage backend of the NVMe over RoCE protocol type.

Configuration Item Description

Table 1 backend parameters

Parameter	Description	Mandatory	Default Value	Remarks
storage	Storage service type.	Yes	-	The value is fixed to oceandisk-san.
name	Storage backend name. The value can contain a maximum of 63 characters, including lowercase letters, digits, and hyphens (-). It must start with a letter or digit.	Yes	-	Ensure that the storage backend name is unique.
namespace	Namespace.	No	huawei-csi	The storage backend must be in the same namespace as Huawei CSI.
urls	Management URLs of storage device. The value format is a list.	Yes	-	The value can be a domain name or an IP address + port number.
pools	Storage pools of storage devices. The value format is a list.	Yes	-	Enter the storage pool names.
parameters.protocol	Storage protocol. The value is a character string.	Yes	-	The value is fixed to roce. Ensure that the nvme-cli tool has been installed on the compute node to be connected. The supported nvme-cli tool version is 1.9 and later.
parameters.portals	Service access port. Nodes will use this port to read and write storage resources. The value format is a list.	Yes	-	Multiple ports can be configured.
supportedTopologies	Storage topology awareness configuration. The parameter format is JSON of the list type.	No	-	This parameter is mandatory if storage topology awareness is enabled. For details, see Configuring Storage Topology Awareness.
maxClientThreads	Maximum number of concurrent connections to a storage backend.	No	30	The value ranges from 1 to 30. If this parameter is not set or the value is not in the specified range, the default value 30 is used.

Creating a Storage Backend

Prepare a backend configuration file, for example, backend.yaml.

storage: "oceandisk-san"
name: "backend-demo"
namespace: "huawei-csi"
urls:
  - "https://192.168.129.157:8088"
pools:
  - "StoragePool001"
parameters:
  protocol: "roce"
  portals:
    - "10.10.30.20"
    - "10.10.30.21"
maxClientThreads: "30"

Run the following command to create a storage backend.

oceanctl create backend -f /path/to/backend.yaml -i yaml

The following is an example of the command output.

NUMBER  CONFIGURED    NAME           STORAGE              URLS                
1       false         backend-demo   oceandisk-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Enter the serial number of the backend to be created and enter the account and password.

Please enter the backend number to configure (Enter 'exit' to exit):1
Please enter this backend user name: admin
Please enter this backend password:

Backend backend-demo is configured
NUMBER  CONFIGURED    NAME            STORAGE              URLS               
1       true          backend-demo    oceandisk-san        https://192.168.129.157:8088 
Please enter the backend number to configure (Enter 'exit' to exit):

Check the storage backend creation result.

oceanctl get backend

The following is an example of the command output. If the backend status is Bound, the creation is successful.

NAMESPACE     NAME            PROTOCOL    STORAGETYPE        SN                    STATUS  ONLINE  URL                 
huawei-csi    backend-demo    roce        oceandisk-san      xxxxxxxxxxxxxxxxxxxx  Bound   true    https://192.168.129.157:8088