diff --git a/doc/content/appendix.rst b/doc/content/appendix.rst new file mode 100644 index 0000000..04e4cf8 --- /dev/null +++ b/doc/content/appendix.rst @@ -0,0 +1,9 @@ +Appendix +======== + +#. `ONTAP documentation `_ + +#. `E-Series documentation `_ + + + diff --git a/doc/content/description.rst b/doc/content/description.rst new file mode 100644 index 0000000..93a7ae5 --- /dev/null +++ b/doc/content/description.rst @@ -0,0 +1,42 @@ +NetApp plugin +============= + +NetApp plugin provides support of ONTAP and E-series storage clusters to Cinder. +NetApp plugin uses NetApp unified driver; the latter is a +block storage driver that supports multiple storage families and protocols. +A storage family corresponds to storage systems built on different NetApp technologies +such as clustered Data ONTAP, Data ONTAP operating in 7-Mode, +and E-Series. +The storage protocol refers to the protocol used to initiate data +storage and access operations on those storage systems like iSCSI and NFS. +The NetApp unified driver can be configured to provision and manage OpenStack volumes +on the given storage family using the specified storage protocol. +The OpenStack volumes can then be used for accessing and storing data with +the storage protocol on the storage family system. +The NetApp unified driver is an extensible interface that can support new +storage families and protocols. + + +Requirements +------------ + +======================= ================================= +Requirement Version/Comment +======================= ================================= +Fuel 7.0 +ONTAP or E-Series All storage family is supported. +======================= ================================= + + + +Prerequisites +------------- + +* If you plan to use the plugin with **ONTAP**, please make sure that it + is configured, up and running. For instructions, see `the official + NetApp ONTAP documentation `_. + + +* If you plan to use the plugin with **E-Series**, please make sure that it + is configured, up and running. For instructions, see `the official + NetApp E-Series documentation `_. diff --git a/doc/content/guide.rst b/doc/content/guide.rst new file mode 100644 index 0000000..aae6c17 --- /dev/null +++ b/doc/content/guide.rst @@ -0,0 +1,107 @@ + +Once the Fuel Cinder NetApp plugin has been installed, you can +create OpenStack environments that use NetApp storage as a Cinder backend. + + +Configuring NetApp plugin +------------------------- + +#. Create an OpenStack environment using the Fuel UI wizard: + + .. image:: images/create_env.png + :width: 90% + +#. Finish environment creation following + `the instructions `_. + +#. Once the environment is created, open the **Settings** tab of the Fuel Web UI + and scroll down the page. Select the **Cinder and NetApp integration** + checkbox: + + .. image:: images/select-checkbox.png + :width: 40% + +#. Configure the plugin.Select **Multibackend enabled** checkbox + if you would like NetApp driver to be used as the Cinder Multibackend feature: + + .. image:: images/multibackend.png + :width: 50% + +#. Choose storage family and storage protocol. Several options are available. + + - If you plan to use ONTAP cluster mode through NFS, click **Ontap Cluster** + radiobutton and select *nfs* option in **Netapp storage protocol**. + You should also choose NetApp transport type (http or https). + Specify the following parameters in the text fields: + + - Netapp username + - Netapp password + - Netapp server hostname + - NFS server + - NFS share(s) + - Netapp Vserver + + .. image:: images/cmode_nfs.png + :width: 100% + + - If you plan to use ONTAP cluster mode through iSCSI, click **Ontap Cluster** + radiobutton and select *iscsi* option in **Netapp storage protocol**. + You should also choose NetApp transport type (http or https). + Specify the following parameters in the text fields: + + - Netapp username + - Netapp password + - Netapp server hostname + - Netapp Vserver + + .. image:: images/cmode_iscsi.png + :width: 100% + + - If you plan to use ONTAP 7 mode through NFS, click **Ontap 7mode** + radiobutton and select *nfs* option in **Netapp storage protocol**. + You should also choose NetApp transport type (http or https). + Specify the following parameters in the text fields: + + - Netapp username + - Netapp password + - Netapp server hostname + - NFS server + - NFS share(s) + + .. image:: images/7mode_nfs.png + :width: 100% + + - If you plan to use ONTAP 7 mode through iSCSI, click **Ontap 7mode** + radiobutton and select *iscsi* option in **Netapp storage protocol**. + You should also choose NetApp transport type (http or https). + Specify the following parameters in the text fields: + + - Netapp username + - Netapp password + - Netapp server hostname + + .. image:: images/7mode_iscsi.png + :width: 100% + + - If you plan to use E-series, click **E-Series** + radiobutton and select the only available *iscsi* option in **Netapp storage protocol**. + You should also choose NetApp transport type (http or https). + Specify the following parameters in the text fields: please specify the following parameters: + + - Netapp username + - Netapp password + - Netapp server hostname + - Netapp controller IPs + - Netapp SA password + - Storage pools + + .. image:: images/eseries.png + :width: 100% + +#. Using *Nodes* tab, + `add nodes and assign roles to them `_. + Please, note that all controller nodes should be configured with Cinder role. + +#. Press `Deploy button `_ + once you are done with environment configuration. + diff --git a/doc/content/installation.rst b/doc/content/installation.rst new file mode 100644 index 0000000..1b92b84 --- /dev/null +++ b/doc/content/installation.rst @@ -0,0 +1,29 @@ + +Installing NetApp plugin +======================== + +To install the Cinder Netapp plugin, follow these steps: + +#. Download it from the `Fuel Plugins Catalog`_. + +#. Copy the plugin's RPM to the Fuel Master node (if you don't + have the Fuel Master node, please see `the official + Mirantis OpenStack documentation `_):: + + [root@home ~]# scp cinder_netapp-3.2-3.2.0-1.noarch.rpm root@fuel-master:/tmp + +#. Log into Fuel Master node and install the plugin using the + `Fuel CLI `_:: + + [root@fuel-master ~]# fuel plugins --install cinder_netapp-3.2-3.2.0-1.noarch.rpm + +#. Verify that the plugin is installed correctly:: + + + [root@fuel-master ~]# fuel plugins + id | name | version | package_version + ---|---------------|---------|---------------- + 1 | cinder_netapp | 3.2.0 | 3.0.0 + + +.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/ diff --git a/doc/content/licenses.rst b/doc/content/licenses.rst new file mode 100644 index 0000000..f4762a9 --- /dev/null +++ b/doc/content/licenses.rst @@ -0,0 +1,7 @@ +Licenses +======== + +The plugin does not include any third-party +components and is published under Apache 2.0 license. + + diff --git a/doc/images/7mode_iscsi.png b/doc/images/7mode_iscsi.png new file mode 100644 index 0000000..c6918aa Binary files /dev/null and b/doc/images/7mode_iscsi.png differ diff --git a/doc/images/7mode_nfs.png b/doc/images/7mode_nfs.png new file mode 100644 index 0000000..c171b4a Binary files /dev/null and b/doc/images/7mode_nfs.png differ diff --git a/doc/images/cmode_iscsi.png b/doc/images/cmode_iscsi.png new file mode 100644 index 0000000..7f1259b Binary files /dev/null and b/doc/images/cmode_iscsi.png differ diff --git a/doc/images/cmode_nfs.png b/doc/images/cmode_nfs.png new file mode 100644 index 0000000..db18e0b Binary files /dev/null and b/doc/images/cmode_nfs.png differ diff --git a/doc/images/config_plugin.png b/doc/images/config_plugin.png new file mode 100644 index 0000000..f2e3355 Binary files /dev/null and b/doc/images/config_plugin.png differ diff --git a/doc/images/create_env.png b/doc/images/create_env.png new file mode 100644 index 0000000..727ddf3 Binary files /dev/null and b/doc/images/create_env.png differ diff --git a/doc/images/eseries.png b/doc/images/eseries.png new file mode 100644 index 0000000..d1fa0b5 Binary files /dev/null and b/doc/images/eseries.png differ diff --git a/doc/images/multibackend.png b/doc/images/multibackend.png new file mode 100644 index 0000000..66dc70c Binary files /dev/null and b/doc/images/multibackend.png differ diff --git a/doc/images/select-checkbox.png b/doc/images/select-checkbox.png new file mode 100644 index 0000000..4cc6b4b Binary files /dev/null and b/doc/images/select-checkbox.png differ diff --git a/doc/user-guide.rst b/doc/user-guide.rst new file mode 100644 index 0000000..9dc8ba5 --- /dev/null +++ b/doc/user-guide.rst @@ -0,0 +1,12 @@ +============================================ +Guide to the Cinder NetApp plugin ver. 3.2.0 +============================================ + +This document will guide you through the steps to install, +configure and use Cinder NetApp plugin for Fuel. + +.. include:: content/description.rst +.. include:: content/installation.rst +.. include:: content/guide.rst +.. include:: content/licenses.rst +.. include:: content/appendix.rst