diff --git a/doc/TestPlanforScaleIOFuelPlugin.docx b/doc/TestPlanforScaleIOFuelPlugin.docx index 1c3c662..580f3ec 100644 Binary files a/doc/TestPlanforScaleIOFuelPlugin.docx and b/doc/TestPlanforScaleIOFuelPlugin.docx differ diff --git a/doc/TestPlanforScaleIOFuelPlugin.pdf b/doc/TestPlanforScaleIOFuelPlugin.pdf index af7df8a..8735c23 100644 Binary files a/doc/TestPlanforScaleIOFuelPlugin.pdf and b/doc/TestPlanforScaleIOFuelPlugin.pdf differ diff --git a/doc/TestReportforScaleIOFuelPlugin.docx b/doc/TestReportforScaleIOFuelPlugin.docx index 26c1030..430078d 100644 Binary files a/doc/TestReportforScaleIOFuelPlugin.docx and b/doc/TestReportforScaleIOFuelPlugin.docx differ diff --git a/doc/TestReportforScaleIOFuelPlugin.pdf b/doc/TestReportforScaleIOFuelPlugin.pdf index 1a1c4b6..c8326dd 100644 Binary files a/doc/TestReportforScaleIOFuelPlugin.pdf and b/doc/TestReportforScaleIOFuelPlugin.pdf differ diff --git a/doc/source/conf.py b/doc/source/conf.py index 2b60979..b4f1bad 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,8 +11,8 @@ master_doc = 'index' project = u'The ScaleIO plugin for Fuel' copyright = u'2015, EMC Corporation' -version = '0.3' -release = '0.3.0' +version = '1.0' +release = '1.0-1.0.0-1' exclude_patterns = [] @@ -22,6 +22,12 @@ html_theme = 'classic' html_static_path = ['_static'] latex_documents = [ - ('index', 'ScaleIOPlugin.tex', u'The ScaleIO plugin for Fuel Documentation', + ('index', 'ScaleIO-Plugin_Guide.tex', u'The ScaleIO plugin for Fuel Documentation', u'EMC Corporation', 'manual'), -] \ No newline at end of file +] + +latex_elements = { + 'fncychap': '\\usepackage[Conny]{fncychap}', + 'classoptions': ',openany,oneside', + 'babel' : '\\usepackage[english]{babel}', +} diff --git a/doc/source/guide.rst b/doc/source/guide.rst index e9e7fcb..69a0106 100644 --- a/doc/source/guide.rst +++ b/doc/source/guide.rst @@ -27,6 +27,22 @@ Controllers 1, 2, and 3 will be used as ScaleIO MDMs, being the primary, seconda All nodes are used as ScaleIO SDS and, therefore, contribute to the default storage pool. +.. _scaleiogui: + +Install ScaleIO GUI +------------------- + +It is recommended to install the ScaleIO GUI to easily access and manage the ScaleIO cluster. + +#. Make sure the machine in which you will install the ScaleIO GUI has access to the Controller nodes. +#. Download the ScaleIO for your operating system from the following link: http://www.emc.com/products-solutions/trial-software-download/scaleio.htm +#. Unzip the file and install the ScaleIO GUI component. +#. Once installed, run the application and you will be prompted with the following login window. We will use it once the deployment is completed. + + .. image:: images/scaleio-login.png + :width: 50% + + Select Environment ------------------ @@ -34,7 +50,7 @@ Select Environment #. Create a new environment with the Fuel UI wizard. Select "Juno on CentOS 6.5" from OpenStack Release dropdown list and continue until you finish with the wizard. .. image:: images/wizard.png - :width: 60% + :width: 80% #. Add VMs to the new environment according to `Fuel User Guide `_ and configure them properly. @@ -58,12 +74,12 @@ Finish environment configuration #. Run `network verification check `_ .. image:: images/network.png - :width: 80% + :width: 90% -#. Press `Deploy button `_ to once you are done with environment configuration. +#. Press `Deploy button `_ once you have finished reviewing the environment configuration. .. image:: images/deploy.png - :width: 40% + :width: 60% #. After deployment is done, you will see a message indicating the result of the deployment. @@ -81,14 +97,16 @@ Once the OpenStack cluster is setup, we can make use of ScaleIO volumes. This is #. Review the block storage services by navigating to the "Admin -> System -> System Information" section. You should see the "@ScaleIO" appended to all cinder-volume hosts. .. image:: images/block-storage-services.png - :width: 80% + :width: 90% #. Review the System Volumes by navigating to "Admin -> System -> Volumes". You should see a volume type called "sio_thin" with the following extra specs. .. image:: images/volume-type.png - :width: 50% + :width: 70% -#. Open the ScaleIO Control Panel and verify that it successfully reflects the ScaleIO resources: +#. In the ScaleIO GUI (see :ref:`Install ScaleIO GUI section `), enter the IP address of the primary controller node, username `admin`, and the password you entered in the Fuel UI. + +#. Once logged in, verify that it successfully reflects the ScaleIO resources: .. image:: images/scaleio-cp.png :width: 80% @@ -96,16 +114,16 @@ Once the OpenStack cluster is setup, we can make use of ScaleIO volumes. This is #. Click on the "Backend" tab and verify all SDS nodes: .. image:: images/scaleio-sds.png - :width: 80% + :width: 90% #. Create a new OpenStack volume using the "sio_thin" volume type. -#. In the ScaleIO Control Panel, you will see that there is one volume defined but none have been mapped yet. +#. In the ScaleIO GUI, you will see that there is one volume defined but none have been mapped yet. .. image:: images/sio-volume-defined.png :width: 20% -#. Once the volume is attached to a VM, the ScaleIO Control Panel will reflect the mapping. +#. Once the volume is attached to a VM, the ScaleIO GUI will reflect the mapping. .. image:: images/sio-volume-mapped.png :width: 20% diff --git a/doc/source/images/deploy-result.png b/doc/source/images/deploy-result.png index 63c6488..2b9228b 100644 Binary files a/doc/source/images/deploy-result.png and b/doc/source/images/deploy-result.png differ diff --git a/doc/source/images/scaleio-login.png b/doc/source/images/scaleio-login.png new file mode 100644 index 0000000..e1783aa Binary files /dev/null and b/doc/source/images/scaleio-login.png differ diff --git a/doc/source/index.rst b/doc/source/index.rst index 9bce3fd..92a3160 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,10 +2,8 @@ Guide to the ScaleIO Plugin for Fuel 6.1 ======================================== -This document will guide you through the steps of install, configure and use of the ScaleIO Plugin for Fuel - -User documentation -================== +Plugin Guide +============ .. toctree:: :maxdepth: 2 @@ -14,8 +12,3 @@ User documentation installation guide appendix - -Indices and Tables -================== - -* :ref:`search` diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst index a3de388..0da25cc 100644 --- a/doc/source/introduction.rst +++ b/doc/source/introduction.rst @@ -1,6 +1,12 @@ Introduction ============ +Purpose +------- +This document will guide you through the steps of install, configure and use of the **ScaleIO Plugin** for Fuel. The ScaleIO Plugin is used to deploy and configure a ScaleIO cluster as a backend for an OpenStack environment. + +ScaleIO Overview +---------------- EMC ScaleIO is a software-only server-based storage area network (SAN) that converges storage and compute resources to form a single-layer, enterprise-grade storage product. ScaleIO storage is elastic and delivers linearly scalable performance. Its scale-out server SAN architecture can grow from a few to thousands of servers. ScaleIO uses servers’ direct-attached storage (DAS) and aggregates all disks into a global, shared, block storage. ScaleIO features single-layer compute and storage architecture without requiring additional hardware or cooling/ power/space. @@ -38,7 +44,6 @@ Mirantis OpenStack 6.1 ========================= =============== * This plugin will deploy an EMC ScaleIO 1.32 cluster on the available nodes and replace the default OpenStack volume backend by ScaleIO. -* A minimum of 3 Controller nodes and 1 Compute node are required. Limitations diff --git a/metadata.yaml b/metadata.yaml index fe0f793..b6b85e0 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -5,7 +5,7 @@ title: ScaleIO plugin # Plugin version version: '1.0.0' # Description -description: Deploy and enable EMC ScaleIO as the block storage backend +description: This plugin deploys and enables EMC ScaleIO as the block storage backend # Required fuel version fuel_version: ['6.1'] # Specify license of your plugin