Adds Plugin Guide for 7.0-compatible plugin

Change-Id: I63d70e14e0efae469f02903800a0d4fd05da1239
This commit is contained in:
Irina Povolotskaya 2015-09-23 14:42:35 +03:00 committed by Andrey Volochay
parent d12e7c202b
commit d5aa1b7ed1
15 changed files with 206 additions and 0 deletions

9
doc/content/appendix.rst Normal file
View File

@ -0,0 +1,9 @@
Appendix
========
#. `ONTAP documentation <http://mysupport.netapp.com/documentation/productlibrary/index.html?productID=30092>`_
#. `E-Series documentation <https://mysupport.netapp.com/info/web/ECMP1658252.html>`_

View File

@ -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 <http://mysupport.netapp.com/documentation/productlibrary/index.html?productID=30092>`_.
* 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 <https://mysupport.netapp.com/info/web/ECMP1658252.html>`_.

107
doc/content/guide.rst Normal file
View File

@ -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 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
#. 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 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#add-nodes-to-the-environment>`_.
Please, note that all controller nodes should be configured with Cinder role.
#. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_
once you are done with environment configuration.

View File

@ -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 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/quickstart-guide.html#installing-mirantis-openstack-manually>`_)::
[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 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-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/

7
doc/content/licenses.rst Normal file
View File

@ -0,0 +1,7 @@
Licenses
========
The plugin does not include any third-party
components and is published under Apache 2.0 license.

BIN
doc/images/7mode_iscsi.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

BIN
doc/images/7mode_nfs.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

BIN
doc/images/cmode_iscsi.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

BIN
doc/images/cmode_nfs.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
doc/images/create_env.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

BIN
doc/images/eseries.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

BIN
doc/images/multibackend.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

12
doc/user-guide.rst Normal file
View File

@ -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