openstack/devstack
Code Issues Proposed changes

update plugin doc

Browse Source 
After doing a couple of external plugins I found that basically things
don't work unless you enable_service in the settings file. Document
that as a requirement, and clean up the rest of the docs around the
external plugins to be consistent with that.

Change-Id: I13aee7dbf112ce9663e8338b555a208327f89b61
This commit is contained in:
Sean Dague 2015-02-09 15:17:27 -05:00
parent 7ec3772d5f
commit 33127a1287
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/plugins.rst
View File

@ -107,19 +107,24 @@ directory. Inside this directory there can be 2 files.
sourced very early in the process. This is helpful if other plugins sourced very early in the process. This is helpful if other plugins
might depend on this one, and need access to global variables to do might depend on this one, and need access to global variables to do
their work. their work.
Your settings should include any ``enable_service`` lines required
by your plugin. This is especially important if you are kicking off
services using ``run_process`` as it only works with enabled
services.
- ``plugin.sh`` - the actual plugin. It will be executed by devstack - ``plugin.sh`` - the actual plugin. It will be executed by devstack
during it's run. The run order will be done in the registration during it's run. The run order will be done in the registration
order for these plugins, and will occur immediately after all in order for these plugins, and will occur immediately after all in
tree extras.d dispatch at the phase in question. The plugin.sh tree extras.d dispatch at the phase in question. The plugin.sh
looks like the extras.d dispatcher above **except** it should not looks like the extras.d dispatcher above.
include the is_service_enabled conditional. All external plugins are
always assumed to be enabled.
Plugins are registered by adding the following to the localrc section Plugins are registered by adding the following to the localrc section
of ``local.conf``. of ``local.conf``.
They are added in the following format:: They are added in the following format::
[[local|localrc]]
enable_plugin <NAME> <GITURL> [GITREF] enable_plugin <NAME> <GITURL> [GITREF]
- ``name`` - an arbitrary name. (ex: glustfs, docker, zaqar, congress) - ``name`` - an arbitrary name. (ex: glustfs, docker, zaqar, congress)
@ -129,7 +134,7 @@ They are added in the following format::
An example would be as follows:: An example would be as follows::
enable_plugin glusterfs https://github.com/sdague/devstack-plugins glusterfs enable_plugin ec2api git://git.openstack.org/stackforge/ec2api
Hypervisor Hypervisor
========== ==========