diff --git a/Documentation/OS-Deployment-with-existing-ScaleIO/Fuel Plugins for ScaleIO.pptx b/doc/OS-Deployment-with-existing-ScaleIO/Fuel Plugins for ScaleIO.pptx similarity index 100% rename from Documentation/OS-Deployment-with-existing-ScaleIO/Fuel Plugins for ScaleIO.pptx rename to doc/OS-Deployment-with-existing-ScaleIO/Fuel Plugins for ScaleIO.pptx diff --git a/Documentation/OS-Deployment-with-existing-ScaleIO/README.md b/doc/OS-Deployment-with-existing-ScaleIO/README.md similarity index 100% rename from Documentation/OS-Deployment-with-existing-ScaleIO/README.md rename to doc/OS-Deployment-with-existing-ScaleIO/README.md diff --git a/doc/content/appendix.rst b/doc/content/appendix.rst new file mode 100644 index 0000000..ee0ccf6 --- /dev/null +++ b/doc/content/appendix.rst @@ -0,0 +1,6 @@ +Appendix +======== + + +#. `ScaleIO OpenStack information `_ +#. `Reference Architecture: EMC Storage Solutions With Mirantis OpenStack `_ diff --git a/doc/content/installation.rst b/doc/content/installation.rst new file mode 100644 index 0000000..2333b3a --- /dev/null +++ b/doc/content/installation.rst @@ -0,0 +1,32 @@ + +Installation Guide +================== + +Install the Plugin +------------------ + +To install the ScaleIO Fuel plugin: + +#. Download it from the `Fuel Plugins Catalog`_ +#. Copy the *rpm* file to the Fuel Master node: + :: + + [root@home ~]# scp fuel-plugin-scaleio-1.0-1.0.0-1.noarch.rpm root@fuel-master:/tmp + +#. Log into Fuel Master node and install the plugin using the + `Fuel CLI `_: + + :: + + [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-1.0-1.0.1-1.noarch.rpm + +#. Verify that the plugin is installed correctly: + :: + + [root@fuel-master ~]# fuel plugins + id | name | version | package_version + ---|-----------------------|---------|---------------- + 9 | fuel-plugin-scaleio | 1.0.0 | 2.0.0 + + +.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/ diff --git a/doc/content/introduction.rst b/doc/content/introduction.rst new file mode 100644 index 0000000..c1c79f0 --- /dev/null +++ b/doc/content/introduction.rst @@ -0,0 +1,59 @@ +EMC ScaleIO Plugin for Fuel 6.1 +=============================== + +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. + +Breaking traditional barriers of storage scalability, ScaleIO scales out to hundreds and thousands of nodes and multiple petabytes of storage. The parallel architecture and distributed volume layout delivers a massively parallel system that deliver I/O operations through a distributed system. As a result, performance can scale linearly with the number of application servers and disks, leveraging fast parallel rebuild and rebalance without interruption to I/O. ScaleIO has been carefully designed and implemented with ScaleIO software components so as to consume minimal computing resources. + +With ScaleIO, any administrator can add, move, or remove servers and capacity on demand during I/O operations. The software responds automatically to any infrastructure change and rebalances data accordingly across the grid nondisruptively. ScaleIO can add capacity on demand, without capacity planning or data migration and grow in small or large increments and pay as you grow, running on any server and with any storage media. + +ScaleIO natively supports all leading Linux distributions and hypervisors. It works agnostically with any solid-state drive (SSD) or hard disk drive (HDD) regardless of type, model, or speed. + +ScaleIO Components +------------------ + +**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)** + +- Abstracts storage media +- Contributes to storage pools +- Performs I/O operations + +**ScaleIO Metadata Manager (MDM)** + +- Not located in the data path +- Provides Monitoring and Configuration management +- Holds cluster-wide component mapping + + +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. + + +Requirements +------------ + +========================= =============== +Requirement Version/Comment +========================= =============== +Fuel 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. + + +Limitations +----------- + +ScaleIO 1.32 does not support Ubuntu. Therefore, as Mirantis 7.0 only supports Ubuntu, this plugin is only compatible with Mirantis 6.1 with CentOS. diff --git a/doc/content/user-guide.rst b/doc/content/user-guide.rst new file mode 100644 index 0000000..ab21e3c --- /dev/null +++ b/doc/content/user-guide.rst @@ -0,0 +1,42 @@ +EMC ScaleIO Fuel Plugin User Guide +================================== + +Once the Fuel ScaleIO plugin has been installed (following +`Installation Guide`_), you can create an *OpenStack* environments that +uses ScaleIO as the block storage backend. + +Prepare infrastructure +---------------------- + +TODO + + +Select Environment +------------------ + +#. Create a new environment with the Fuel UI wizard. Select "Juno on CentOS 6.5" from OpenStack Release dropdown list. At the moment you will see most of options are disabled in the wizard. + + .. image:: images/wizard.png + :width: 80% + +#. Add VMs to the new environment according to `Fuel User Guide `_ and configure them properly. + +#. Go to Settings tab and scroll down to "ScaleIO Fuel Plugin" section. You need to fill all fields with your configuration parameters. If you don't know the purpose of a field you can leave it with its default value. + + .. image:: images/settings.png + :width: 80% + +#. TODO + + +Finish environment configuration +-------------------------------- + +#. Run `network verification check `_ + +#. Press `Deploy button `_ to once you are done with environment configuration. + +#. After deployment is done, you will see in Horizon that all Cinder hosts use ScaleIO as a backend. + + .. image:: images/horizon.png + :width: 80% diff --git a/Documentation/images/fuel-plugin-scaleio-Architecture.jpg b/doc/images/fuel-plugin-scaleio-Architecture.jpg similarity index 100% rename from Documentation/images/fuel-plugin-scaleio-Architecture.jpg rename to doc/images/fuel-plugin-scaleio-Architecture.jpg diff --git a/Documentation/fuel-plugin-scaleio.vsd b/doc/images/fuel-plugin-scaleio.vsd similarity index 100% rename from Documentation/fuel-plugin-scaleio.vsd rename to doc/images/fuel-plugin-scaleio.vsd diff --git a/Documentation/images/.gitkeep b/spec/scaleio-plugin-spec.rst similarity index 100% rename from Documentation/images/.gitkeep rename to spec/scaleio-plugin-spec.rst