Updated User Guide with new figures, content, and formatting.

Change-Id: I4323f94b031efc51135f67b3506f0236b9d77fda

doc/content/appendix.rst

@@ -1,7 +1,10 @@
+.. raw:: pdf
+
+   PageBreak
+
 Appendix
 ========
 
-
 #. `ScaleIO OpenStack information <https://community.emc.com/docs/DOC-44337>`_
 #. `Reference Architecture: EMC Storage Solutions With Mirantis OpenStack <https://community.emc.com/docs/DOC-44819>`_
 #. `OpenStack @EMC Cheat Sheet <https://community.emc.com/docs/DOC-46246>`_

doc/content/guide.rst

@@ -1,5 +1,9 @@
-ScaleIO Fuel Plugin User Guide
-==================================
+.. raw:: pdf
+
+   PageBreak
+
+User Guide
+==========
 
 Once the Fuel ScaleIO plugin has been installed (following
 `Installation Guide`_), you can create an *OpenStack* environments that
@@ -23,6 +27,10 @@ Each node shall have at least 2 CPUs, 4GB RAM, 200GB disk, 4 Network interfaces.
 #. Private Network
 #. Management Network
 
+Controllers 1, 2, and 3 will be used as ScaleIO MDMs, being the primary, secondary, and tie-breaker, respectively. Moreover, they will also host the ScaleIO Gateway in HA mode.
+
+All nodes are used as ScaleIO SDS and, therefore, contribute to the default storage pool.
+
 
 Select Environment
 ------------------
@@ -38,7 +46,7 @@ Select Environment
 Plugin configuration
 --------------------
 
-#. Go to the Settings tab and scroll down to "ScaleIO Fuel Plugin" section. You need to fill all fields with your preferred ScaleIO configuration. If you don't know the purpose of a field you can leave it with its default value.
+#. Go to the Settings tab and scroll down to "ScaleIO plugin" section. You need to fill all fields with your preferred ScaleIO configuration. If you do not know the purpose of a field you can leave it with its default value.
 
     .. image:: images/settings.png
        :width: 80%
@@ -63,7 +71,7 @@ Finish environment configuration
 
 #. After deployment is done, you will see a message indicating the result of the deployment.
 
-    .. image:: images/deploy_result.png
+    .. image:: images/deploy-result.png
        :width: 80%
 
 
@@ -72,44 +80,36 @@ ScaleIO verification
 
 Once the OpenStack cluster is setup, we can make use of ScaleIO volumes. This is an example about how to attach a volume to a running VM.
 
-#. Login into the OpenStack Cluster:
+#. Login into the OpenStack cluster:
 
-#. Review the block storage services by navigating to the "Admin -> System -> System Information" section. You should see the ScaleIO volume.
+#. 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%
 
-#. Review the System Volumes by navigating to "Admin -> System -> Volumes". You should see the ScaleIO volume type:
+#. 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: 80%
 
 #. Open the ScaleIO Control Panel and verify that it successfully reflects the ScaleIO resources:
 
-    .. image:: images/scaleio_cp.png
+    .. image:: images/scaleio-cp.png
        :width: 80%
 
 #. Click on the "Backend" tab and verify all SDS nodes:
 
-    .. image:: images/scaleio_sds.png
+    .. image:: images/scaleio-sds.png
        :width: 80%
 
-#. Create a new OpenStack volume using the ScaleIO volume type.
-
-    .. image:: images/new-volume.png
-       :width: 80%
-
-#. Review the newly created volume.
-
-    .. image:: images/review-new-volume.png
-       :width: 80%
+#. 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.
 
     .. image:: images/sio-volume-defined.png
-       :width: 80%
+       :width: 40%
 
 #. Once the volume is attached to a VM, the ScaleIO Control Panel will reflect the mapping.
 
     .. image:: images/sio-volume-mapped.png
-       :width: 80%
+       :width: 40%

doc/content/installation.rst

@@ -1,4 +1,8 @@
 
+.. raw:: pdf
+
+   PageBreak
+
 Installation Guide
 ==================
 
@@ -11,14 +15,16 @@ To install the ScaleIO Fuel plugin:
 #. Copy the *rpm* file to the Fuel Master node:
    ::
 
-      [root@home ~]# scp fuel-plugin-scaleio-0.3-0.3.0-1.noarch.rpm root@fuel-master:/tmp
+      [root@home ~]# scp fuel-plugin-scaleio-0.3-0.3.0-1.noarch.rpm
+      root@fuel-master:/tmp
 
 #. Log into Fuel Master node and install the plugin using the
    `Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli>`_:
 
    ::
 
-      [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-scaleio-0.3-0.3.0-1.noarch.rpm
+      [root@fuel-master ~]# fuel plugins --install
+      /tmp/fuel-plugin-scaleio-0.3-0.3.0-1.noarch.rpm
 
 #. Verify that the plugin is installed correctly:
    ::

doc/content/introduction.rst

@@ -1,5 +1,5 @@
-ScaleIO Plugin for Fuel 6.1
-===============================
+Introduction
+============
 
 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.
 
@@ -13,28 +13,19 @@ ScaleIO natively supports all leading Linux distributions and hypervisors. It wo
 
 ScaleIO Components
 ------------------
+**ScaleIO Data Client (SDC)** is a lightweight block device driver that exposes ScaleIO shared block volumes to applications. The SDS runs on the same server as the application. This enables the application to issue a IO request and the SDC fulfills it regardless of where the particular blocks physically reside. The SDC communicates with other nodes over TCP/IP-based protocol, so it is fully routable.
 
-**ScaleIO Data Client (SDC)**
-- Acts as Block Device Driver
-- Exposes volumes to applications
-- Service must run to provide access to volumes
-- Over TCP/IP
+**ScaleIO Data Service (SDS)** owns local storage that contributes to the ScaleIO storage pools. An instance of the SDS runs on every node that contributes some, or all its storage space (HDDs, SSDs) to the aggregated pool of storage within the ScaleIO virtual SAN. The role of the SDS is to actually perform the back-end IO operations as requested by an SDC.
 
-**ScaleIO Data Service (SDS)**
-- Abstracts storage media
-- Contributes to storage pools
-- Performs I/O operations
+**ScaleIO Metadata Manager (MDM)** manages the metadata, SDC, SDS, devices mapping, volumes, snapshots, system capacity including device allocations and/or release of capacity, errors and failures, and system rebuild tasks including rebalancing. The MDM uses a Active/Passive with a tiebreaker component where the primary node is Active, and the secondary is Passive. The data repository is stored in both Active and Passive. Currently, an MDM can manage up to 1024 servers. When several MDMs are present, an SDC may be managed by several MDMs, whereas an SDS can only belong to one MDM. If the MDM does not detect the heartbeat from one SDS, it will initiate a forward-rebuild.
 
-**ScaleIO Metadata Manager (MDM)**
-- Not located in the data path
-- Provides Monitoring and Configuration management
-- Holds cluster-wide component mapping
+**ScaleIO Gateway** is the HTTP/HTTPS REST endpoint. It is the primary endpoint used by OpenStack to actuate commands against ScaleIO. Due to its stateless nature, we can have multiples instances and easily balance the load.
 
 
 ScaleIO Cinder Driver
 ---------------------
 
-ScaleIO includes a Cinder driver, which interfaces between ScaleIO and OpenStack, and presents volumes to OpenStack as block devices which are available for block storage. It also includes an OpenStack Nova driver, for handling compute and instance volume related operations. The ScaleIO driver executes the volume operations by communicating with the backend ScaleIO MDM through the ScaleIO REST Gateway.
+ScaleIO includes a Cinder driver, which interfaces between ScaleIO and OpenStack, and presents volumes to OpenStack as block devices which are available for block storage. It also includes an OpenStack Nova driver, for handling compute and instance volume related operations. The ScaleIO driver executes the volume operations by communicating with the backend ScaleIO MDM through the ScaleIO Gateway.
 
 
 Requirements

doc/user-guide.rst

@@ -1,14 +1,9 @@
 Guide to the ScaleIO Plugin for Fuel 6.1
-==========================================
-
-Intro
------
+========================================
 
 This document will guide you through the steps of install, configure and use of the ScaleIO Plugin for Fuel
 
-Sections
---------
 .. include:: content/introduction.rst
 .. include:: content/installation.rst
-.. include:: content/user-guide.rst
+.. include:: content/guide.rst
 .. include:: content/appendix.rst