fix format

Change-Id: Idbd4cee88ff2e487c43cf34a2e40de252df055cc
This commit is contained in:
msalem2 2015-10-27 14:32:13 +09:00
parent 1ffd80812d
commit 5a8c0713e1
3 changed files with 90 additions and 69 deletions

View File

@ -1,86 +1,105 @@
===========================================================
===========================================================
ScaleIO Cinder plugin installation
===========================================================
===========================================================
The first step is to install the ScaleIO Cinder plugin in the Fuel Master:
1. Download the plugin from the https://github.com/openstack/fuel-plugin-scaleio-cinder/releases "Releases Page" or from the https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/ "Fuel Plugins Catalog".
2. Copy the plugin to an already installed Fuel Master node. If you do not have the Fuel Master node yet, follow the instructions from the official Mirantis OpenStack documentation:
1. Download the plugin from the
https://github.com/openstack/fuel-plugin-scaleio-cinder/releases
"Releases Page" or from the
https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/
"Fuel Plugins Catalog".
`scp fuel-plugin-scaleio-cinder-1.0.noarch.rpm root@:<the_Fuel_Master_node_IP>:/tmp`
2. Copy the plugin to an already installed Fuel Master node. If you do
not have the Fuel Master node yet, follow the instructions from the
official Mirantis OpenStack documentation:
3. Log into the Fuel Master node and install the plugin, if downloaded in the `/tmp` directory:
``scp fuel-plugin-scaleio-cinder-1.0.noarch.rpm root@:<the_Fuel_Master_node_IP>:/tmp``
`cd /tmp`
`fuel plugins --install /tmp/fuel-plugin-scaleio-cinder-1.0.noarch.rpm`
3. Log into the Fuel Master node and install the plugin, if downloaded
in the ``/tmp`` directory:
4. Verify that the plugin has been installed successfully:
``cd /tmp``
``fuel plugins --install /tmp/fuel-plugin-scaleio-cinder-1.0.noarch.rpm``
..image::https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-1.png
4. Verify that the plugin has been installed successfully:
.. image:: https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-1.png
===========================================================
ScaleIO Cinder plugin configuration
===========================================================
Once the plugin has been installed in the Master, we configure the nodes and set the parameters for the plugin:
=========================================================== ScaleIO
Cinder plugin configuration
=========================================================== Once the
plugin has been installed in the Master, we configure the nodes and set
the parameters for the plugin:
1. Start by creating a new OpenStack environment following the
https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#create-a-new-openstack-environment
"Creating a new OpenStack environment")
1. Start by creating a new OpenStack environment following the https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#create-a-new-openstack-environment "Creating a new OpenStack environment")
2. Configure your environment following the
https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#configure-your-environment
2. Configure your environment following the https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#configure-your-environment
.. image:: https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-2.png
..image::https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-2.png
3. Open the **Settings tab** of the Fuel web UI and scroll down the
page. Select the Fuel plugin check-box to enable ScaleIO Cinder
plugin for Fuel:
3. Open the **Settings tab** of the Fuel web UI and scroll down the page. Select the Fuel plugin check-box to enable ScaleIO Cinder plugin for Fuel:
.. image:: https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-4.PNG
..image::https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-4.PNG
**Plugin's parameters explanation:**
+-------------------------+---------------------------------------------------------+
|Parameter Name |Parameter Description |
+=========================+=========================================================+
|userName |The ScaleIO User Name |
+-------------------------+---------------------------------------------------------+
|Password |The SclaeIO password for the selected user name |
+-------------------------+---------------------------------------------------------+
|ScaleIO GW IP |The IP address of the the ScaleIO Gateway service |
+-------------------------+---------------------------------------------------------+
|ScaleIO Primary IP |The ScaleIO cluster's primary IP address |
+-------------------------+---------------------------------------------------------+
|ScaleIO Secondary IP |The ScaleIO cluster's secondary IP address |
+-------------------------+---------------------------------------------------------+
|ScaleIO protection domain|Name of the ScaleIO's protection domain |
+-------------------------+---------------------------------------------------------+
|ScaleIO storage pool 1 |Name of the first storage pool |
+-------------------------+---------------------------------------------------------+
**Note:** Please refer to the ScaleIO documentation for more information on these parameters
**Plugin's parameters explanation:**
+-------------------------+---------------------------------------------------------+
\|Parameter Name \|Parameter Description \|
+=========================+=========================================================+
\|userName \|The ScaleIO User Name \|
+-------------------------+---------------------------------------------------------+
\|Password \|The SclaeIO password for the selected user name \|
+-------------------------+---------------------------------------------------------+
\|ScaleIO GW IP \|The IP address of the the ScaleIO Gateway service
\|
+-------------------------+---------------------------------------------------------+
\|ScaleIO Primary IP \|The ScaleIO cluster's primary IP address \|
+-------------------------+---------------------------------------------------------+
\|ScaleIO Secondary IP \|The ScaleIO cluster's secondary IP address
\|
+-------------------------+---------------------------------------------------------+
\|ScaleIO protection domain\|Name of the ScaleIO's protection domain
\|
+-------------------------+---------------------------------------------------------+
\|ScaleIO storage pool 1 \|Name of the first storage pool \|
+-------------------------+---------------------------------------------------------+
**Note:** Please refer to the ScaleIO documentation for more
information on these parameters
This is an example of the ScaleIO configuration paremets populated:
This is an example of the ScaleIO configuration paremets populated:
..image::https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-5.PNG
.. image:: https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-5.PNG
4. | After the configuration is done, you can Add the nodes to the
Openstack Deployment. There is a minimum of two nodes for this
configuration:
+-------------------------+----------------------------------------------------------------------------------------------+
\|Service/Role Name \| Description \|
+=========================+==============================================================================================+
\|Controller Node \|A node that runs network, volume, API,
scheduler, and image services. Each service may be \| \|+ Cinder
Host \|broken out into separate nodes for scalability or
availability. \| \| \|In addition this node is a Cinder Host, that
contains the Cinder Volume Manager \|
+-------------------------+----------------------------------------------------------------------------------------------+
| \|Compute Node \|A node that runs the nova-compute daemon that
manages Virtual Machines (VMs) instances that \| \| \|provide a
wide range of services, such as web applications and analytics. \|
+-------------------------+----------------------------------------------------------------------------------------------+
| .. image:: https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-3.PNG
4. After the configuration is done, you can Add the nodes to the Openstack Deployment. There is a minimum of two nodes for this configuration:
+-------------------------+----------------------------------------------------------------------------------------------+
|Service/Role Name | Description |
+=========================+==============================================================================================+
|Controller Node |A node that runs network, volume, API, scheduler, and image services. Each service may be |
|+ Cinder Host |broken out into separate nodes for scalability or availability. |
| |In addition this node is a Cinder Host, that contains the Cinder Volume Manager |
+-------------------------+----------------------------------------------------------------------------------------------+
|Compute Node |A node that runs the nova-compute daemon that manages Virtual Machines (VMs) instances that |
| |provide a wide range of services, such as web applications and analytics. |
+-------------------------+----------------------------------------------------------------------------------------------+
..image::https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-3.PNG
**Note:** you can run the
.. image:: https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#verify-networks
check and
https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#deploy-changes.
**Note:** you can run the
..image::https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#verify-networks
check and https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#deploy-changes.
After this is complete you should see a success message:
After this is complete you should see a success message:
..image::https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-complete.jpg
**Note:** It make take an hour or more for the OpenStack deployment to complete, depending on your hardware configuration.
.. image:: https://github.com/openstack/fuel-plugin-scaleio-cinder/blob/master/doc/images/scaleio-cinder-install-complete.jpg
**Note:** It make take an hour or more for the OpenStack deployment
to complete, depending on your hardware configuration.

View File

@ -1,6 +1,7 @@
=========================================================== Introduction
=========================================================== Fuel plugin
for ScaleIO for enabling OpenStack to work with an **External** ScaleIO
===========================================================
Introduction
===========================================================
Fuel plugin for ScaleIO for enabling OpenStack to work with an **External** ScaleIO
deployment. This ScaleIO plugin for Fuel extends Mirantis OpenStack
functionality by adding support for ScaleIO block storage.

View File

@ -1,6 +1,7 @@
=========================================================== User Guide
=========================================================== 1. Upload
scaleio-cinder plugin code to the master node |user guide1| |user
===========================================================
User Guide
===========================================================
1. Upload scaleio-cinder plugin code to the master node |user guide1| |user
guide2| Build the code using fpb build command |user guide3|
2. Install scaleio-cinder plugin using fuel plugins install command