CSTACKEX-201: Documentation for netapp ontap plugin

source/adminguide/storage.rst

@@ -105,6 +105,7 @@ Storage media \\ hypervisor                    VMware vSphere   Citrix XenServer
 **SMB/CIFS**                                   No               No                   No                          Yes
 **Ceph/RBD**                                   No               No                   Yes                         No
 **PowerFlex/ScaleIO**                          No               No                   Yes                         No
+**NetApp ONTAP**                               No               No                   Yes                         No
 ============================================== ================ ==================== =========================== ============================
 
 XenServer uses a clustered LVM system to store Instance images on iSCSI and

source/conceptsandterminology/concepts.rst

@@ -442,6 +442,10 @@ as Zone-wide Primary Storage.
 PowerFlex/ScaleIO (v3.5) is only supported by the KVM hypervisor. It can be used
 as Cluster-wide or Zone-wide Primary Storage.
 
+NetApp ONTAP is only supported by the KVM hypervisor. It can be used as
+Cluster-wide or Zone-wide Primary Storage. It supports both NFS 3.0 and iSCSI
+protocols.
+
 CloudStack is designed to work with all standards-compliant iSCSI and
 NFS servers that are supported by the underlying hypervisor, including,
 for example:
@@ -460,6 +464,8 @@ for example:
 
 -  Pure FlashArray for FiberChannel
 
+-  NetApp ONTAP for NFS 3.0 and iSCSI
+
 If you intend to use only local disk for your installation, you can skip
 adding separate primary storage.
 

source/installguide/configuration.rst

@@ -1594,6 +1594,67 @@ When a volume is created by the plugin, it will create bi-directional mappings i
 -  Each volume's description field in the Pure Flasharray storage system will have a formatted key/value pair with metadata mappings for the Cloudstack volume definition (user volume name, volume uuid, account/project information)
 -  Each virtual volume's WWID will be stored in the volume's path field in Cloudstack
 
+NetApp ONTAP Plug-in
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This plugin enables NetApp Unified ONTAP storage systems as a managed primary
+storage in CloudStack for KVM hypervisors. It supports both NFS 3.0 and iSCSI
+protocols, integrating with the traditional ONTAP unified storage architecture.
+
+This documentation assumes you have the following configured in your
+environment before adding a storage pool in CloudStack:
+
+-  NetApp Unified ONTAP 9.15.1 or higher.
+-  A Storage Virtual Machine (SVM) in ONTAP storage with NFS 3.0 or iSCSI protocol enabled.
+-  ONTAP Management LIF accessible from the CloudStack management server on port 443
+   (HTTPS).
+-  A Data LIF of IPv4 type on the SVM, reachable from all KVM hypervisor hosts.
+-  Aggregates assigned to the SVM with sufficient capacity.
+-  For iSCSI: iSCSI protocol enabled on the SVM and adapter configured.
+-  For NFS 3.0: NFS protocol enabled on the SVM and NFS client installed on
+   each KVM host.
+
+When this storage pool is used with Compute or Disk Offerings, an administrator
+is able to build an environment in which a root or data disk that a user creates
+leads to the dynamic creation of a LUN or file on the ONTAP storage system. Such a
+LUN or file is associated with one (and only ever one) CloudStack volume, so
+performance of the CloudStack volume does not vary depending on how heavily other
+tenants are using the system.
+
+.. note::
+   ONTAP requires a minimum volume size of 1.56 GB (1,677,721,600 bytes). The
+   plugin will automatically adjust any requested size below this threshold.
+
+The ``createStoragePool`` API can be used to configure an ONTAP primary storage
+pool with the following parameters:
+
+-  command=createStoragePool
+-  scope=[zone | cluster]
+-  zoneid=[your zone id]
+-  podid=[your pod id, for cluster-wide primary storage]
+-  clusterid=[your cluster id, for cluster-wide primary storage]
+-  name=[name for primary storage]
+-  hypervisor=KVM
+-  provider=ONTAP
+-  managed=true
+-  capacitybytes=[capacity in bytes; minimum 1,677,721,600]
+
+The ``details`` parameter contains the ONTAP storage pool connection details,
+specified as key=value pairs in the following format::
+
+   details[0].key=username,details[0].value=<USERNAME>
+   details[1].key=password,details[1].value=<PASSWORD>
+   details[2].key=svmName,details[2].value=<SVM_NAME>
+   details[3].key=protocol,details[3].value=<NFS3|ISCSI>
+   details[4].key=storageIP,details[4].value=<MGMT_LIF_IP>
+
+-  USERNAME: ONTAP cluster admin username
+-  PASSWORD: ONTAP cluster admin password
+-  SVM_NAME: name of the Storage Virtual Machine (SVM) on ONTAP
+-  PROTOCOL: storage protocol. Must be one of ``NFS3`` or ``ISCSI``
+-  MGMT_LIF_IP: IPv4 address of the ONTAP management LIF (port 443, HTTPS)
+
+
 .. _add-secondary-storage:
 
 Add Secondary Storage