updating documentation on devstack usage
The docs contain the older, non-plugin registry based, instructions for activating sahara in devstack. This change also adds a small convenience readme file to the devstack directory to help make it clear how to integrate the plugin. * fixing devstack documentation * adding a convenience readme to the plugin directory * changing tox bashate tests to ignore the readme Change-Id: I58e604479de39f52a516fa6b428dfdc958b3b92d
This commit is contained in:
parent
9bd777b3cf
commit
8ed4398260
|
@ -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 <refspec>
|
||||
|
||||
3. run ``stack.sh``
|
|
@ -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 <some_git_refspec>
|
||||
|
||||
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:
|
||||
|
|
2
tox.ini
2
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 =
|
||||
|
|
Loading…
Reference in New Issue