Merge "add README.rst content"

2014-10-11 07:41:32 +00:00 · 2014-10-11 07:41:32 +00:00 · 371ecb7900
commit 371ecb7900
parent ccc8b2b120 118aec428d
1 changed files with 45 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@ -0,0 +1,45 @@
+==============
+Cinder Formula
+==============
+
+Install and configure the OpenStack Cinder service.
+
+.. note::
+    See the full `Salt Formulas installation and usage instructions
+    <http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
+
+Available states
+================
+
+.. contents::
+    :local:
+
+``cinder``
+----------
+
+Install the Cinder and enable the service.
+
+``cinder.db``
+-------------
+
+Create the db for Cinder service.
+
+``cinder.keystone``
+-------------------
+
+Init the Cinder user, service and endpoint.
+
+``cinder.server``
+-----------------
+
+Install the Cinder and enable the service.
+
+``cinder.client``
+-----------------
+
+Install the python-cinderclient package.
+
+``cinder.volume``
+-----------------
+
+Install the Cinder Volume Service