Browse code

Document use of plugins for gate jobs

Document use of plugins for gate jobs. See also [1]

[1] http://lists.openstack.org/pipermail/openstack-dev/2015-January/054291.html

Change-Id: I9ed82f5d195511fb612517745f93f2a54475091a

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