diff --git a/doc/source/contact_support.rst b/doc/source/contact_support.rst new file mode 100644 index 0000000..d1f652d --- /dev/null +++ b/doc/source/contact_support.rst @@ -0,0 +1,9 @@ +.. raw:: pdf + + PageBreak + +Contact Support +=============== + +| For reporting a problem, suggesting an enhancements or new features please contact + Pure Storage support for help (support@purestorage.com). diff --git a/doc/source/index.rst b/doc/source/index.rst index c83eaad..e43745f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,5 +12,9 @@ Contents: .. toctree:: :maxdepth: 2 + overview installation + user_guide + contact_support + known_issues appendix diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 93f71c8..06d43d5 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -1,4 +1,6 @@ -.. _installation: +.. raw:: pdf + + PageBreak Installation Guide ================== @@ -11,23 +13,21 @@ Pure Storage Cinder Plugin installation 2. Copy the plugin to an already installed Fuel Master node. If you do not have the Fuel Master node yet, please follow `the instructions `_: -..code-block:: ini - # scp fuel-plugin-purestorage-cinder-3.0-3.0.0-1.noarch.rpm root@::/tmp`` 3. Log into the Fuel Master node. 4. Install the plugin - ``# cd /tmp - # fuel plugins --install fuel-plugin-purestorage-cinder-3.0-3.0.0-1.noarch.rpm`` + # cd /tmp + # fuel plugins --install fuel-plugin-purestorage-cinder-3.0-3.0.0-1.noarch.rpm 5. Check if the plugin was installed successfully - ``# fuel plugins - id | name | version | package_version - ---|--------------------------------|---------|---------------- - 1 | fuel-plugin-purestorage-cinder | 3.0.0 | 4.0.0`` + # fuel plugins + # id | name | version | package_version + # ---|--------------------------------|---------|---------------- + # 1 | fuel-plugin-purestorage-cinder | 3.0.0 | 4.0.0 6. After the plugin is installed, `create a new OpenStack environment `_ using the Fuel UI Wizard. @@ -53,7 +53,7 @@ Pure Storage Cinder Plugin installation or use the following Purity CLI command to obtain the API token: - ``# pureadmin list --api-token --expose `` + # pureadmin list --api-token --expose * Obtain the Pure Storage VIP from the Pure Storage GUI @@ -64,7 +64,7 @@ or use the following Purity CLI command to obtain the API token: or use the following Purity CLI command to obtain the VIP address: - ``# purenetwork list vir0`` + # purenetwork list vir0 10. Select the defaults for all other Pure Storage options. Each selectable option has a description in the Fuel GUI. diff --git a/doc/source/known_issues.rst b/doc/source/known_issues.rst new file mode 100644 index 0000000..813a5f4 --- /dev/null +++ b/doc/source/known_issues.rst @@ -0,0 +1,12 @@ +.. raw:: pdf + + PageBreak + +Known issues +============ + +#. Ensure your controller nodes have access to the public internet to allow for correct Python module installation required by the Fuel plugin + +#. If you environment is deployed with multiple controllers for HA, you cannot run all the Cinder Volume services at the same time in Active-Active mode + +#. There are specific changes that need to be made to the local deb packages. More details can be found in the Pure Storage/Mirantis Reference Architecture diff --git a/doc/source/overview.rst b/doc/source/overview.rst new file mode 100644 index 0000000..8841232 --- /dev/null +++ b/doc/source/overview.rst @@ -0,0 +1,28 @@ +.. raw:: pdf + + PageBreak + +Pure Storage Cinder plugin +========================== + +| The Pure Storage Cinder Fuel plugin provides an automated method +to insert the necessary lines into the ``cinder.conf`` file. The plugin +extends the Fuel Web UI to provide the necessary entry locations for the +information for the configuration file. Thus, the plugin incorporates +`OpenStack Cinder Driver for Pure Storage Flash Array `_. +| Thus, the plugin provides the ability to +create a configuration file stanza so that when multi-backend support is selected, the stanza is correct. + +Requirements +------------ + ++-----------------------------------+-----------------+ +| Requirement | Version/Comment | ++===================================+=================+ +| Mirantis OpenStack compatibility | 9.0 | ++-----------------------------------+-----------------+ + +Limitations +----------- + +| No limitations are present. diff --git a/doc/source/user_guide.rst b/doc/source/user_guide.rst new file mode 100644 index 0000000..71b7ad6 --- /dev/null +++ b/doc/source/user_guide.rst @@ -0,0 +1,18 @@ +.. raw:: pdf + + PageBreak + +User Guide +========== + +| Once the OpenStack instance is deployed by Fuel the Pure Storage plugin provides no + user configurable or maintainable options. + +| Validation of the plugins correct operation can be performed by comparing the parameters selected in the Fuel GUI to those added into the + ``/etc/cinder/cinder.conf`` and ``/etc/nova/nova.conf`` files on the Controller and Compute nodes respectively. + +| As part of this installation a new multipath.conf file is provided to all nodes. Ensure that other device entries required for your + local environment are added to these files and multipath is restarted to accept any changes. + +| The Pure Storage driver (Once configured by Fuel) will output all logs into the + cinder-volume process log file with the 'Pure Storage' title.