openstack
/
devstack
Code Issues Proposed changes

Merge "Document use of plugins for gate jobs"

This commit is contained in:
Jenkins 2015-03-10 13:25:15 +00:00 committed by Gerrit Code Review
parent b8c74c1108 db1152c96e
commit d8b66662d5
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/plugins.rst
View File

@ -136,6 +136,31 @@ An example would be as follows::
enable_plugin ec2api git://git.openstack.org/stackforge/ec2api
Plugins for gate jobs
---------------------
All OpenStack plugins that wish to be used as gate jobs need to exist
in OpenStack's gerrit. Both ``openstack`` namespace and ``stackforge``
namespace are fine. This allows testing of the plugin as well as
provides network isolation against upstream git repository failures
(which we see often enough to be an issue).
Ideally plugins will be implemented as ``devstack`` directory inside
the project they are testing. For example, the stackforge/ec2-api
project has it's pluggin support in it's tree.
In the cases where there is no "project tree" per say (like
integrating a backend storage configuration such as ceph or glusterfs)
it's also allowed to build a dedicated
``stackforge/devstack-plugin-FOO`` project to house the plugin.
Note jobs must not require cloning of repositories during tests.
Tests must list their repository in the ``PROJECTS`` variable for
`devstack-gate
<https://git.openstack.org/cgit/openstack-infra/devstack-gate/tree/devstack-vm-gate-wrap.sh>`_
for the repository to be available to the test. Further information
is provided in the project creator's guide.
Hypervisor
==========