fixing the documentation

Change-Id: I291d375639932ab87249337cb40e7bfe7998e9f2
2015-11-12 15:04:15 -05:00 · 2015-11-12 15:04:15 -05:00 · b73f0083f3
parent 8e52bedbb8
commit b73f0083f3
8 changed files with 3229 additions and 42 deletions
--- a/doc/content/guide.pdf
+++ b/doc/content/guide.pdf
--- a/doc/content/images/installation/image008-o.png
+++ b/doc/content/images/installation/image008-o.png
--- a/doc/content/images/installation/image008.png
+++ b/doc/content/images/installation/image008.png
--- a/doc/content/images/scaleio-cinder-install-6.PNG
+++ b/doc/content/images/scaleio-cinder-install-6.PNG
--- a/doc/content/installation.rst
+++ b/doc/content/installation.rst
@ -21,8 +21,8 @@ To install the ScaleIO-Cinder Fuel plugin:
   ::

     [root@fuel-master ~]# fuel plugins
-     id | name    | version | package_version
-     ---|---------|---------|----------------
+     id | name          | version | package_version
+     ---|---------------|---------|----------------
     1  | scaleio-cinder| 1.0.0   | 1.0.0


@ -41,12 +41,14 @@ Fuel Master node, you can configure the nodes and set the parameters for the plu
 #. `Configure your environment <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#configure-your-environment>`_.

 	.. image:: images/scaleio-cinder-install-2.png
-
+	   :width: 50%
+	   	   
 #. Open the **Settings tab** of the Fuel web UI and scroll down the page.
   Select the Fuel plugin checkbox to enable ScaleIO Cinder plugin for Fuel:

-	 .. image:: images/scaleio-cinder-install-4.PNG
-
+	.. image:: images/scaleio-cinder-install-4.PNG
+	   :width: 50%
+	   
   +----------------------------+----------------------------------------------------+
   |   Parameter name           |         Parameter description                      |
   |                            |                                                    |
@ -70,19 +72,22 @@ Fuel Master node, you can configure the nodes and set the parameters for the plu

    This is an example of the ScaleIO configuration parameters populated: 

-	  .. image:: images/scaleio-cinder-install-5.PNG
-
+	.. image:: images/scaleio-cinder-install-5.PNG
+	   :width: 50%
+	   
 #. After the configuration is done, you can add the nodes to the Openstack Deployment.

-	  .. image:: images/scaleio-cinder-install-3.png
-
+	.. image:: images/scaleio-cinder-install-3.png
+	   :width: 50%
+	   
 #. You can run the network verification check and
   `deploy changes <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#deploy-changes>`_ then.

 #. After deployment is completed, you should see a success message:

-	 .. image:: images/scaleio-cinder-install-complete.jpg
-
+	.. image:: images/scaleio-cinder-install-complete.jpg
+	   :width: 50%
+	   
 .. note:: It may take an hour or more for the OpenStack deployment
          to complete, depending on your hardware configuration. 

--- a/doc/content/user-guide.rst
+++ b/doc/content/user-guide.rst
@ -16,21 +16,23 @@ User Guide
    role:

    .. image:: images/installation/image006.png
-
+       :width: 50%
 #.  Picture of the External ScaleIO Cluster Running:

    .. image:: images/installation/image007.png
-
+       :width: 50%
 #.  Retrive the external ScaleIO Cluster information. For
    our example these are the configuration settings:

-    .. image:: images/installation/image008.png
-
+    .. image:: images/installation/image007.png
+       :width: 50%   
+   
 #.  Use the ScaleIO Cluster information to update the ScaleIO Plugin
    information:

    .. image:: images/installation/image009.png
-
+       :width: 50%
+	   
 #.  Apply network settings

 #.  Use the networking settings that are appropriate for your
@ -38,24 +40,29 @@ User Guide
    by Fuel:

    .. image:: images/installation/image010.png
-
+       :width: 50%
+	   
 #.  Run network verification check:

    .. image:: images/installation/image011.png
-
+       :width: 50%
+	   
 #.  Deploy the cluster:

    .. image:: images/installation/image012.png
-
+       :width: 50%
+	   
 #.  Once the deployment finished successfully, open OpenStack Dashboard (Horizon):

    .. image:: images/installation/image013.png
-
+       :width: 50%
+	   
 #. Check Storage tab under system information and make sure ScaleIO
    service is up and running:

-   .. image:: images/installation/image014.png
-
+    .. image:: images/installation/image014.png
+       :width: 50%
+	   
 ScaleIO Cinder plugin OpenStack operations
 ==========================================

@ -64,43 +71,51 @@ is an example in how to attach a Volume to a running VM:

 #. Login into the OpenStack Cluster:

-   .. image:: images/scaleio-cinder-install-6.PNG
-      :alt: OpenStack Login
-
+    .. image:: images/scaleio-cinder-install-6.PNG
+       :alt: OpenStack Login
+       :width: 50%
+	   
 #. Review the Block storage services by navigating: Admin -> System ->
   System Information secction. You should see the ScaleIO Cinder
   Volume.

-   .. image:: images/scaleio-cinder-install-7.PNG
-      :alt: Block Storage Services Verification
-
+    .. image:: images/scaleio-cinder-install-7.PNG
+       :alt: Block Storage Services Verification
+       :width: 50%
+	   
 #. Review the System Volumes by navigating to: Admin -> System ->
   Volumes. You should see the ScaleIO Volume Type:

-   .. image:: images/scaleio-cinder-install-8.PNG
-      :alt: Volume Type Verification
-
+    .. image:: images/scaleio-cinder-install-8.PNG
+       :alt: Volume Type Verification
+       :width: 50%
+	   
 #. Create a new OpenStack Volume:

-   .. image:: images/scaleio-cinder-install-9.PNG
-      :alt: Volume Creation
-
+    .. image:: images/scaleio-cinder-install-9.PNG
+       :alt: Volume Creation
+       :width: 50%
+	   
 #. View the newly created Volume:

-   .. image:: images/scaleio-cinder-install-10.PNG
-      :alt: Volume Listing
-
+    .. image:: images/scaleio-cinder-install-10.PNG
+       :alt: Volume Listing
+       :width: 50%
+	   
 #. In the ScaleIO Control Panel, you will see that no Volumes have been
   mapped yet:

-   .. image:: images/scaleio-cinder-install-11.PNG
-      :alt: ScaleIO UI No mapped Volumes
+    .. image:: images/scaleio-cinder-install-11.PNG
+       :alt: ScaleIO UI No mapped Volumes
+       :width: 50%

+	  
 #. Once the Volume is attached to a VM, the ScaleIO UI will reflect the
   mapping:

-   .. image:: images/scaleio-cinder-install-12.png
-      :alt: ScaleIO UI Mapped Volume
-
+    .. image:: images/scaleio-cinder-install-12.png
+       :alt: ScaleIO UI Mapped Volume
+       :width: 50%
+	   


--- a/spec/fuel-plugin-scaleio-cinder-1-0-0-spec.rst
+++ b/spec/fuel-plugin-scaleio-cinder-1-0-0-spec.rst
@ -0,0 +1,120 @@
+===========================================================
+Fuel plugin for ScaleIO-Cinder clusters as a Cinder backend
+===========================================================
+
+ScaleIO-Cinder plugin for Fuel extends Mirantis OpenStack functionality by adding
+support for ScaleIO clusters for Cinder backend.
+
+Problem description
+===================
+
+Currently, Fuel has no support for ScaleIO clusters as block storage for
+OpenStack environments. ScaleIO-Cinder plugin aims to provide support for it.
+This plugin will configure OpenStack environments with an existing ScaleIO cluster
+
+Proposed change
+===============
+
+Implement a Fuel plugin that will configure the ScaleIO-Cinder driver for
+Cinder on all Controller nodes and Compute nodes. All Cinder services run
+on controllers no additional Cinder node is required in environment.
+
+Alternatives
+------------
+None
+
+Data model impact
+-----------------
+
+None
+
+REST API impact
+---------------
+
+None
+
+Upgrade impact
+--------------
+
+None
+
+Security impact
+---------------
+
+None
+
+Notifications impact
+--------------------
+
+None
+
+Other end user impact
+---------------------
+
+None
+
+Performance Impact
+------------------
+
+The ScaleIO-Cinder storage clusters provide high performance block storage for
+OpenStack envirnments, and therefore enabling the ScaleIO-Cinder driver in OpenStack
+will greatly improve peformance of OpenStack.
+
+Other deployer impact
+---------------------
+
+None
+
+Developer impact
+----------------
+
+None
+
+Implementation
+==============
+
+The plugin generates the approriate cinder.conf to enable the ScaleIO-Cinder
+cluster within OpenStack. There are scaleio driver and filter required files, the plugin 
+contains the files and will copy them to the correct location.
+
+Cinder-volume service is installed on all Controller nodes and Compute nodes. 
+All instances of cinder-volume have the same “host” parameter in cinder.conf
+file. This is required to achieve ability to manage all volumes in the
+environment by any cinder-volume instance.
+
+Assignee(s)
+-----------
+| Patrick Butler Monterde <Patrick.ButlerMonterde@emc.com>
+| Magdy Salem <magdy.salem@emc.com>
+| Adrián Moreno <Adrian.Moreno@emc.com>
+
+Work Items
+----------
+
+* Implement the Fuel plugin.
+* Implement the Puppet manifests.
+* Testing.
+* Write the documentation.
+
+Dependencies
+============
+
+* Fuel 6.1 and higher.
+
+Testing
+=======
+
+* Prepare a test plan.
+* Test the plugin by deploying environments with all Fuel deployment modes.
+
+Documentation Impact
+====================
+
+* Deployment Guide (how to install the storage backends, how to prepare an
+  environment for installation, how to install the plugin, how to deploy an
+  OpenStack environment with the plugin).
+* User Guide (which features the plugin provides, how to use them in the
+  deployed OpenStack environment).
+* Test Plan.
+* Test Report.
+
--- a/spec/plugin-1-0-0-spec.rst
+++ b/spec/plugin-1-0-0-spec.rst