[Infortrend] Add Infortrend Manila Doc

This patch updates the Manila administrator reference adding
documentation to the recently introduced Infortrend driver.

Closes-Bug: #1839486

Change-Id: I3332f90bc84fbc8918277d23ab7c51ede16376f2

doc/source/admin/index.rst

@@ -87,5 +87,6 @@ each back end.
    hdfs_native_driver
    hitachi_hnas_driver
    hpe_3par_driver
+   infortrend_driver
    tegile_driver
    ../configuration/shared-file-systems/drivers/windows-smb-driver

doc/source/admin/infortrend_driver.rst

@@ -0,0 +1,94 @@
+..
+      Copyright (c) 2019 Infortrend Technologies Co., Ltd.
+      All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+Infortrend Driver for OpenStack Manila
+======================================
+
+The `Infortrend <http://www.infortrend.com/global>`__ Manila driver
+provides NFS and CIFS shared file systems to Openstack.
+
+Requirements
+------------
+
+- The EonStor GS/GSe series Fireware version 139A23
+
+Supported shared filesystems and operations
+-------------------------------------------
+
+This driver supports NFS and CIFS shares.
+
+The following operations are supported:
+
+- Create CIFS/NFS Share
+- Delete CIFS/NFS Share
+- Allow CIFS/NFS Share access
+
+  * 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
+- Manage a share.
+- Unmanage a share.
+- Extend a share.
+- Shrink a share.
+
+Backend Configuration
+---------------------
+
+The following parameters need to be configured in the manila configuration
+file for the Infortrend driver:
+
+- `share_backend_name` = <backend name to enable>
+- `share_driver` = manila.share.drivers.infortrend.driver.InfortrendNASDriver
+- `driver_handles_share_servers` = False
+- `infortrend_nas_ip` = <IP address for SSH access to the SAN controller>
+- `infortrend_nas_user` = <username with the 'edit' role>
+- `infortrend_nas_password` = <password for the user specified in infortrend_nas_user>
+- `infortrend_share_pools` = <Poolname of the SAN controller>
+- `infortrend_share_channels` = <Data channel for file service in SAN controller>
+
+
+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 Infortrend driver, this must be set to False.
+
+
+Back-end configuration example
+------------------------------
+
+.. code-block:: ini
+
+   [DEFAULT]
+   enabled_share_backends = ift-manila
+   enabled_share_protocols = NFS, CIFS
+
+   [ift-manila]
+   share_backend_name = ift-manila
+   share_driver = manila.share.drivers.infortrend.driver.InfortrendNASDriver
+   driver_handles_share_servers = False
+   infortrend_nas_ip = FAKE_IP
+   infortrend_nas_user = FAKE_USER
+   infortrend_nas_password = FAKE_PASS
+   infortrend_share_pools = pool-1, pool-2
+   infortrend_share_channels = 0, 1

doc/source/configuration/shared-file-systems/drivers.rst

@@ -26,6 +26,7 @@ Share drivers
    drivers/huawei-nas-driver.rst
    drivers/ibm-spectrumscale-driver.rst
    drivers/infinidat-share-driver.rst
+   drivers/infortrend-nas-driver.rst
    drivers/maprfs-native-driver.rst
    drivers/netapp-cluster-mode-driver.rst
    drivers/quobyte-driver.rst

doc/source/configuration/shared-file-systems/drivers/infortrend-nas-driver.rst

@@ -0,0 +1,85 @@
+========================
+Infortrend Manila driver
+========================
+
+The `Infortrend <http://www.infortrend.com/global>`__ Manila driver
+provides NFS and CIFS shared file systems to OpenStack.
+
+Requirements
+~~~~~~~~~~~~
+
+To use the Infortrend Manila driver, the following items are required:
+
+- GS/GSe Family firmware version v73.1.0-4 and later.
+
+- Configure at least one channel for shared file systems.
+
+Supported shared filesystems and operations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This driver supports NFS and CIFS shares.
+
+The following operations are supported:
+
+- Create a share.
+
+- Delete a share.
+
+- Allow share access.
+
+  Note the following limitations:
+
+  - Only IP access type is supported for NFS.
+
+  - Only user access type is supported for CIFS.
+
+- Deny share access.
+
+- Manage a share.
+
+- Unmanage a share.
+
+- Extend a share.
+
+- Shrink a share.
+
+Restrictions
+~~~~~~~~~~~~
+
+The Infortrend manila driver has the following restrictions:
+
+-  Only IP access type is supported for NFS.
+
+-  Only user access type is supported for CIFS.
+
+-  Only file-level data service channel can offer the NAS service.
+
+Driver configuration
+~~~~~~~~~~~~~~~~~~~~
+
+On ``manila-share`` nodes, set the following in your
+``/etc/manila/manila.conf``, and use the following options to configure it:
+
+Driver options
+--------------
+
+.. include:: ../../tables/manila-infortrend.inc
+
+Back-end configuration example
+------------------------------
+
+.. code-block:: ini
+
+   [DEFAULT]
+   enabled_share_backends = ift-manila
+   enabled_share_protocols = NFS, CIFS
+
+   [ift-manila]
+   share_backend_name = ift-manila
+   share_driver = manila.share.drivers.infortrend.driver.InfortrendNASDriver
+   driver_handles_share_servers = False
+   infortrend_nas_ip = FAKE_IP
+   infortrend_nas_user = FAKE_USER
+   infortrend_nas_password = FAKE_PASS
+   infortrend_share_pools = pool-1, pool-2
+   infortrend_share_channels = 0, 1

doc/source/configuration/tables/manila-infortrend.inc

@@ -0,0 +1,34 @@
+..
+    Warning: Do not edit this file. It is automatically generated from the
+    software project's code and your changes will be overwritten.
+
+    The tool to generate this file lives in openstack-doc-tools repository.
+
+    Please make any changes needed in the code, then run the
+    autogenerate-config-doc tool from the openstack-doc-tools repository, or
+    ask for help on the documentation mailing list, IRC channel or meeting.
+
+.. _manila-infortrend:
+
+.. list-table:: Description of Infortrend Manila driver configuration options
+   :header-rows: 1
+   :class: config-ref-table
+
+   * - Configuration option = Default value
+     - Description
+   * - **[DEFAULT]**
+     -
+   * - ``infortrend_nas_ip`` = ``None``
+     - (String) Infortrend NAS ip. It is the ip for management.
+   * - ``infortrend_nas_user`` = ``manila``
+     - (String) Infortrend NAS username.
+   * - ``infortrend_nas_password`` = ``None``
+     - (String) Password for the Infortrend NAS server. This is not necessary if infortrend_nas_ssh_key is set.
+   * - ``infortrend_nas_ssh_key`` = ``None``
+     - (String) SSH key for the Infortrend NAS server. This is not necessary if infortrend_nas_password is set.
+   * - ``infortrend_share_pools`` = ``None``
+     - (String) Infortrend nas pool name list. It is separated with comma.
+   * - ``infortrend_share_channels`` = ``None``
+     - (String) Infortrend channels for file service. It is separated with comma.
+   * - ``infortrend_cli_timeout`` = ``30``
+     - (Integer) CLI timeout in seconds.