Browse code

Merge "Document use of plugins for gate jobs"

Jenkins authored on 2015/03/10 22:25:15
Showing 1 changed files
... ...
@@ -136,6 +136,31 @@ An example would be as follows::
136 136
 
137 137
   enable_plugin ec2api git://git.openstack.org/stackforge/ec2api
138 138
 
139
+Plugins for gate jobs
140
+---------------------
141
+
142
+All OpenStack plugins that wish to be used as gate jobs need to exist
143
+in OpenStack's gerrit. Both ``openstack`` namespace and ``stackforge``
144
+namespace are fine. This allows testing of the plugin as well as
145
+provides network isolation against upstream git repository failures
146
+(which we see often enough to be an issue).
147
+
148
+Ideally plugins will be implemented as ``devstack`` directory inside
149
+the project they are testing. For example, the stackforge/ec2-api
150
+project has it's pluggin support in it's tree.
151
+
152
+In the cases where there is no "project tree" per say (like
153
+integrating a backend storage configuration such as ceph or glusterfs)
154
+it's also allowed to build a dedicated
155
+``stackforge/devstack-plugin-FOO`` project to house the plugin.
156
+
157
+Note jobs must not require cloning of repositories during tests.
158
+Tests must list their repository in the ``PROJECTS`` variable for
159
+`devstack-gate
160
+<https://git.openstack.org/cgit/openstack-infra/devstack-gate/tree/devstack-vm-gate-wrap.sh>`_
161
+for the repository to be available to the test.  Further information
162
+is provided in the project creator's guide.
163
+
139 164
 Hypervisor
140 165
 ==========
141 166