Browse code

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

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