update plugin doc
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
diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
index 8bb92ed..5d6d3f1 100644
--- a/doc/source/plugins.rst
+++ b/doc/source/plugins.rst
@@ -107,19 +107,24 @@
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
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
during it's run. The run order will be done in the registration
order for these plugins, and will occur immediately after all in
tree extras.d dispatch at the phase in question. The plugin.sh
- looks like the extras.d dispatcher above **except** it should not
- include the is_service_enabled conditional. All external plugins are
- always assumed to be enabled.
+ looks like the extras.d dispatcher above.
Plugins are registered by adding the following to the localrc section
of ``local.conf``.
They are added in the following format::
+ [[local|localrc]]
enable_plugin <NAME> <GITURL> [GITREF]
- ``name`` - an arbitrary name. (ex: glustfs, docker, zaqar, congress)
@@ -129,7 +134,7 @@
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
==========