Update Documentation and convert to FPB v4.0

Add new images to show FPB 4.0 GUI layout.
Upgrade config files to FPB v4.0
Update documentation with more FC information and v4.0 layout images

Change-Id: Iaa5096075a3431fed0014833d7ec659eed54d656
This commit is contained in:
Simon Dodsley 2016-02-29 11:31:10 -05:00
parent b30de2e8a0
commit 3622db6bce
9 changed files with 25 additions and 17 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 111 KiB

BIN
docs/figures/fc-options.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

View File

@ -55,11 +55,11 @@ Pure Storage Cinder Plugin installation
1. Download the plugin from the `Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
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 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/quickstart-guide.html#quickstart-guide>`_:
have the Fuel Master node yet, please follow `the instructions <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html#quickstart-guide>`_:
::
scp fuel-plugin-purestorage-cinder-2.0-2.0.0.noarch.rpm root@:<the_Fuel_Master_node_IP>:/tmp
scp fuel-plugin-purestorage-cinder-2.0-2.0.0-1.noarch.rpm root@:<the_Fuel_Master_node_IP>:/tmp
3. Log into the Fuel Master node.
@ -68,7 +68,7 @@ Pure Storage Cinder Plugin installation
::
cd /tmp
fuel plugins --install fuel-plugin-purestorage-cinder-2.0-2.0.0.noarch.rpm
fuel plugins --install fuel-plugin-purestorage-cinder-2.0-2.0.0-1.noarch.rpm
5. Check if the plugin was installed successfully
@ -77,19 +77,21 @@ Pure Storage Cinder Plugin installation
# fuel plugins
id | name | version | package_version
---|--------------------------------|---------|----------------
1 | fuel-plugin-purestorage-cinder | 2.0.0 | 2.0.0
1 | fuel-plugin-purestorage-cinder | 2.0.0 | 4.0.0
6. After the plugin is installed, `create a new OpenStack environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_ using the Fuel UI Wizard.
6. After the plugin is installed, `create a new OpenStack environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#create-a-new-openstack-environment>`_ using the Fuel UI Wizard.
7. `Configure your environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#configure-your-environment>`_.
7. `Configure your environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#configure-your-environment>`_.
8. Open the Settings tab of the Fuel Web UI and scroll down the page. Select the Fuel plugin to enable Pure Storage driver in Cinder plugin checkbox.
8. Open the Settings tab of the Fuel Web UI and scroll down the page. Select the Storage section to enable Pure Storage driver in Cinder plugin checkbox.
.. image:: figures/fuel-settings-page.png
.. image:: figures/cinder-purestorage-liberty-plugin-1.png
:width: 100%
.. image:: figures/cinder-purestorage-liberty-plugin-2.png
:width: 100%
9. Enter the Purity API Token and the IP address of the management VIP of the Pure Storage FlashArray.
* Obtain the Purity API token from the Pure Storage GUI
::
@ -122,12 +124,17 @@ or use the following Purity CLI command to obtain the VIP address:
10. Select the defaults for all other Pure Storage options. More details on these options can be found in the `Pure Storage Fuel Plugin documentation <https://xxx.purestorage.com>`_.
11. If using Fibre Channel as the storage protocol you need to select the zoning method to be used in your deployment. If you are configuring your own zones then select 'Manual' but you can select 'Automatic' if you wish to use the Openstack Fibre Channel Zone Manager. If 'Automatic' is selected you will need to provide the necessary information for the Zone Manager to communicate and configure your fibre channel switches.
.. image:: figures/fc-options.png
:width: 100%
User Guide
==========
Once the OpenStack instance is deployed by Fuel the Pure Storage plugin provides no
user configurable or maintainable options. As part of this installation a new multipath.conf
file is provided to all nodes. Ensure that other device entries required for your
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

View File

@ -1,4 +1,6 @@
attributes:
metadata:
group: 'storage'
multibackend:
value: true
label: 'Multi-backend enabled'
@ -41,11 +43,11 @@ attributes:
values:
- data: "true"
label: "True"
description: "Enables multipathing for Nova compute servers"
description: "Enables multipathing for Nova compute servers - applies to both iSCSI and FC"
- data: "false"
label: "False"
description: "Disables multipathing for Nova compute servers"
label: "Multipathing for Nova Compute servers (iscsi_use_multipath)"
description: "Disables multipathing for Nova compute servers - applies to both iSCSI and FC"
label: "Multipathing for iSCSI and FC in Nova Compute servers (iscsi_use_multipath)"
description: 'Enable/Disable multipathing for Nova compute servers.'
weight: 26
type: "radio"

View File

@ -7,6 +7,7 @@ licenses: ['Apache License Version 2.0']
authors: ['Simon Dodsley <simon@purestorage.com>']
homepage: 'https://github.com/openstack/fuel-plugin-purestorage-cinder'
groups: ['storage::cinder']
is_hotpluggable: false
releases:
- os: ubuntu
@ -21,4 +22,4 @@ releases:
repository_path: repositories/ubuntu
# Version of plugin package
package_version: '3.0.0'
package_version: '4.0.0'

View File

@ -68,8 +68,6 @@ Other deployer impact
The deployer should configure the IP addresses on the Pure Storage array before
they deploy the Fuel Plugin to the controllers.
The fibre channel Zone Manager must be configured should FC be the chosen block
storage protocol.
Developer impact
----------------
@ -92,7 +90,7 @@ Plugin has three tasks. Each task per role. They are run in the following order:
Cinder-volume service is installed on all Controller nodes and is managed by
Pacemaker. It runs in active/passive mode where only one instance is active.
All instances of cinder-volume have the same “host” parameter in cinder.conf
All instances of cinder-volume have the same “backend-host” parameter in cinder.conf
file. This is required to achieve ability to manage all volumes in the
environment by any cinder-volume instance.