diff --git a/devstack/README.rst b/devstack/README.rst new file mode 100644 index 0000000000..99df00416b --- /dev/null +++ b/devstack/README.rst @@ -0,0 +1,21 @@ +====================== + Enabling in Devstack +====================== + +1. Download DevStack + +2. Add this repo as an external repository in ``local.conf`` + +.. sourcecode:: bash + + [[local|localrc]] + enable_plugin sahara git://git.openstack.org/openstack/sahara + +Optionally, a git refspec may be provided as follows: + +.. sourcecode:: bash + + [[local|localrc]] + enable_plugin sahara git://git.openstack.org/openstack/sahara + +3. run ``stack.sh`` diff --git a/doc/source/devref/devstack.rst b/doc/source/devref/devstack.rst index 9f432d66b6..7fc1cdb831 100644 --- a/doc/source/devref/devstack.rst +++ b/doc/source/devref/devstack.rst @@ -93,7 +93,15 @@ Ubuntu 12.04 system. # OFFLINE=True # Enable Sahara - enable_service sahara + enable_plugin sahara git://git.openstack.org/openstack/sahara + +In cases where you need to specify a git refspec (branch, tag, or commit hash) +for the sahara in-tree devstack plugin (or sahara repo), it should be +appended after the git repo URL as follows: + +.. sourcecode:: bash + + enable_plugin sahara git://git.openstack.org/openstack/sahara 3. Sahara can send notifications to Ceilometer, if Ceilometer is enabled. If you want to enable Ceilometer add the following lines to ``local.conf`` file: diff --git a/tox.ini b/tox.ini index 1d631898c8..d4b25fbfa1 100644 --- a/tox.ini +++ b/tox.ini @@ -44,7 +44,7 @@ commands = bash -c "find sahara -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null" # Run bashate checks bash -c "find sahara -iname '*.sh' -print0 | xargs -0 bashate -v" - bash -c "find devstack -type f -print0 | xargs -0 bashate -v" + bash -c "find devstack -not -name README.rst -type f -print0 | xargs -0 bashate -v" [testenv:doc8] deps =