summaryrefslogtreecommitdiffstats
path: root/aria/multivim-plugin/src/main/python/multivim-plugin/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'aria/multivim-plugin/src/main/python/multivim-plugin/docs/index.rst')
-rw-r--r--aria/multivim-plugin/src/main/python/multivim-plugin/docs/index.rst68
1 files changed, 68 insertions, 0 deletions
diff --git a/aria/multivim-plugin/src/main/python/multivim-plugin/docs/index.rst b/aria/multivim-plugin/src/main/python/multivim-plugin/docs/index.rst
new file mode 100644
index 0000000000..dc229f790b
--- /dev/null
+++ b/aria/multivim-plugin/src/main/python/multivim-plugin/docs/index.rst
@@ -0,0 +1,68 @@
+.. cloudify-cli documentation master file, created by
+ sphinx-quickstart on Thu Jun 12 15:30:03 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Cloudify Openstack Plugin
+=========================
+
+The OpenStack plugin allows users to use an OpenStack based cloud infrastructure for deploying services and applications.
+For more information about OpenStack, please refer to: https://www.openstack.org/.
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ configuration
+ types
+ nova-net
+ examples
+ misc
+ changelog
+
+
+Plugin Requirements
+-------------------
+
+* Python versions:
+
+ * 2.7.x
+* If the plugin is installed from source,
+ then the following system dependencies are required:
+
+ * ``gcc``
+ * ``gcc-c++``
+ * ``python-devel``
+
+
+Compatibility
+-------------
+
+* *Mitaka* official support
+* *Liberty* official support
+* *Kilo* official support
+* *Juno*, *Icehouse* previously supported, not currently tested.
+
+.. attention:: New in 2.0
+
+ The full Keystone URL in :ref:`config` is now required in the ``openstack_config`` ``auth_url`` property: eg ``http://192.0.2.200:5000/v2.0`` or ``http://192.0.2.200:5000/v3``.
+
+The Openstack plugin uses various Openstack clients packages. The versions used in Openstack Plugin are as follows:
+
+* `keystoneauth1 <https://github.com/openstack/keystoneauth>`_ - 2.12.1
+* `Keystone client <https://github.com/openstack/python-keystoneclient>`_ - 3.5.0
+* `Nova client <https://github.com/openstack/python-novaclient>`_ - 7.0.0
+* `Neutron client <https://github.com/openstack/python-neutronclient>`_ - 6.0.0
+* `Cinder client <https://github.com/openstack/python-cinderclient>`_ - 1.9.0
+* `Glance client <https://github.com/openstack/python-glanceclient>`_ - 2.5.0
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+