summaryrefslogtreecommitdiff
path: root/devstack/README.rst
diff options
context:
space:
mode:
authorPeter Stachowski <peter@tesora.com>2015-07-30 20:12:26 +0000
committerPeter Stachowski <peter@tesora.com>2015-07-30 20:49:34 +0000
commit3557e2b181456ce23bf41c7101e040bf519f940a (patch)
treeee539f03883403ba7cf01bec74461ab78b247429 /devstack/README.rst
parentde608f2c9471ea342021336732b31b7567fbedd3 (diff)
downloadtrove-3557e2b181456ce23bf41c7101e040bf519f940a.tar.gz
Have devstack plugin install Trove client
Using the Trove devstack plugin was dependent on having the python-troveclient also enabled. This change modifies the plugin.sh file to install the client correctly, thus removing the need of separately enabling a plugin for it. Variables were set up in the devstack settings file, which can be overridden as desired. A README.rst file was added with instructions on how to set up the plugin in devstack. Change-Id: If5a76360249827c19759a5c90dc00f70c59c32cc
Diffstat (limited to 'devstack/README.rst')
-rw-r--r--devstack/README.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/devstack/README.rst b/devstack/README.rst
new file mode 100644
index 00000000..a84ddfab
--- /dev/null
+++ b/devstack/README.rst
@@ -0,0 +1,45 @@
+===========================
+ Enabling Trove in DevStack
+===========================
+
+To enable Trove in DevStack, perform the following steps:
+
+::
+
+ Note: The python-troveclient is automatically installed. If you need to
+ control how the client gets installed, set the TROVECLIENT_REPO,
+ TROVECLIENT_DIR and TROVECLIENT_BRANCH environment variables appropriately.
+
+
+Download DevStack
+=================
+
+.. sourcecode:: bash
+
+ export DEVSTACK_DIR=~/devstack
+ git clone git://git.openstack.org/openstack-dev/devstack.git $DEVSTACK_DIR
+
+Enable the Trove plugin
+=======================
+
+Enable the plugin by adding the following section to ``$DEVSTACK_DIR/local.conf``
+
+.. sourcecode:: bash
+
+ [[local|localrc]]
+ enable_plugin trove git://git.openstack.org/openstack/trove
+
+Optionally, a git refspec (branch or tag or commit) may be provided as follows:
+
+.. sourcecode:: bash
+
+ [[local|localrc]]
+ enable_plugin trove git://git.openstack.org/openstack/trove <refspec>
+
+Run the DevStack utility
+========================
+
+.. sourcecode:: bash
+
+ cd $DEVSTACK_DIR
+ ./stack.sh