Merge "Add new features description in Huawei doc"

doc/source/devref/huawei_nas_driver.rst

@@ -39,11 +39,18 @@ The following operations is supported on V3 storage:
 - Create CIFS/NFS Share
 - Delete CIFS/NFS Share
 - Allow CIFS/NFS Share access
-  * Only IP access type is supported for NFS.
-  * Only USER access type is supported for CIFS.
+
+  * Only IP access type is supported for NFS(ro/rw).
+  * Only USER access type is supported for CIFS(ro/rw).
 - Deny CIFS/NFS Share access
 - Create snapshot
 - Delete snapshot
+- Manage CIFS/NFS share
+- Support pools in one backend
+- Extend share
+- Shrink share
+- Support multi RestURLs(<RestURL>)
+
 
 Pre-Configurations on Huawei
 ----------------------------
@@ -63,7 +70,8 @@ storage systems, the driver configuration file is as follows:
         <Storage>
             <Product>V3</Product>
             <LogicalPortIP>x.x.x.x</LogicalPortIP>
-            <RestURL>https://x.x.x.x:8088/deviceManager/rest/</RestURL>
+            <RestURL>https://x.x.x.x:8088/deviceManager/rest/;
+            https://x.x.x.x:8088/deviceManager/rest/</RestURL>
             <UserName>xxxxxxxxx</UserName>
             <UserPassword>xxxxxxxxx</UserPassword>
         </Storage>
@@ -76,8 +84,10 @@ storage systems, the driver configuration file is as follows:
     </Config>
 
 - `Product` is a type of a storage product. Set it to `V3`.
-- `LogicalPortIP` is a IP address of the logical port.
-- `RestURL` is a access address of the REST interface.
+- `LogicalPortIP` is an IP address of the logical port.
+- `RestURL` is an access address of the REST interface. Multi RestURLs
+  can be configured in <RestURL>(separated by ";"). When one of the RestURL
+  failed to connect, driver will retry another automatically.
 - `UserName` is a user name of an administrator.
 - `UserPassword` is a password of an administrator.
 - `AllocType` is a type of file system space allocation. Valid values are
@@ -90,7 +100,7 @@ storage systems, the driver configuration file is as follows:
 Backend Configuration
 ---------------------
 
-1. Modify the `manila.conf` Manila configuration file and add share_driver and
+Modify the `manila.conf` Manila configuration file and add share_driver and
 manila_huawei_conf_file items.
 Example for configuring a storage system:
 
@@ -108,6 +118,79 @@ Example for configuring a storage system:
 Restart of manila-share service is needed for the configuration changes to take
 effect.
 
+Share Types
+-----------
+
+When creating a share, a share type can be specified to determine where and
+how the share will be created. If a share type is not specified, the
+`default_share_type` set in the Manila configuration file is used.
+
+Manila requires that the share type includes the `driver_handles_share_servers`
+extra-spec. This ensures that the share will be created on a backend that
+supports the requested driver_handles_share_servers (share networks) capability.
+For the Huawei driver, this must be set to False.
+
+Another common Manila extra-spec used to determine where a share is created
+is `share_backend_name`. When this extra-spec is defined in the share type,
+the share will be created on a backend with a matching share_backend_name.
+
+Manila "share types" may contain qualified extra-specs, -extra-specs that
+have significance for the backend driver and the CapabilityFilter. This
+commit makes the Huawei driver report the following boolean capabilities:
+
+- capabilities:dedupe
+- capabilities:compression
+- capabilities:thin_provisioning
+- capabilities:huawei_smartcache
+
+  * huawei_smartcache:cachename
+
+- capabilities:huawei_smartpartition
+
+  * huawei_smartpartition:partitionname
+
+The scheduler will choose a host that supports the needed
+capability when the CapabilityFilter is used and a share
+type uses one or more of the following extra-specs:
+
+- capabilities:dedupe='<is> True' or '<is> False'
+- capabilities:compression='<is> True' or '<is> False'
+- capabilities:thin_provisioning='<is> True' or '<is> False'
+- capabilities:huawei_smartcache='<is> True' or '<is> False'
+
+  * huawei_smartcache:cachename=test_cache_name
+
+- capabilities:huawei_smartpartition='<is> True' or '<is> False'
+
+  * huawei_smartpartition:partitionname=test_partition_name
+
+`thin_provisioning` will be reported as True for backends that use thin
+provisioned pool. Backends that use thin provisioning also support Manila's
+over-subscription feature. 'thin_provisioning' will be reported as False for
+backends that use thick provisioned pool.
+
+`dedupe` will be reported as True for backends that use deduplication
+technology.
+
+`compression` will be reported as True for backends that use compression
+technology.
+
+`huawei_smartcache` will be reported as True for backends that use smartcache
+technology. Adds SSDs into a high-speed cache pool and divides the pool into
+multiple cache partitions to cache hotspot data in random and small read I/Os.
+
+`huawei_smartpartition` will be reported as True for backends that use
+smartpartition technology. Add share to the smartpartition named
+'test_partition_name'. Allocates cache resources based on service characteristics,
+ensuring the quality of critical services.
+
+.. note::
+    `snapshot_support` will be reported as True for backends that support all
+    snapshot functionalities, including create_snapshot, delete_snapshot, and
+    create_share_from_snapshot. Huawei Driver does not support
+    create_share_from_snapshot API now, so make sure that used `share type` has
+    extra spec `snapshot_support` set to `False`.
+
 Restrictions
 ------------
 
@@ -117,4 +200,11 @@ The Huawei driver has the following restrictions:
 
 - Only USER access type is supported for CIFS.
 
-- Only one StoragePool can be configured in the configuration file.
+The :mod:`manila.share.drivers.huawei.huawei_nas` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: manila.share.drivers.huawei.huawei_nas
+    :noindex:
+    :members:
+    :undoc-members:
+    :show-inheritance: