The Gatekeeper, or a project gating system
Go to file
Paul Belanger 7641d80462 Update hacking dependency
Sync with openstack global requirements for hacking. This allows us to
properly use pbr 2.0.0.

Change-Id: Ia20a1d743e34641e1ff1719e8527f1ee67c8ab3e
Signed-off-by: Paul Belanger <>
2017-03-01 13:22:44 -05:00
doc Add Drivers to documentation 2017-01-20 05:43:31 -08:00
etc Plumb zookeeper config settings into zuul-scheduler 2017-02-21 11:12:04 -05:00
playbooks Copy logs to launcher 2017-02-26 14:07:43 -05:00
tests Plumb job variables through to ansible 2017-02-28 07:43:39 -08:00
tools Storyboard: Support invalid tasks in update script 2017-02-27 13:24:02 -08:00
zuul Plumb job variables through to ansible 2017-02-28 07:43:39 -08:00
.gitignore Merge master into feature/zuulv3 2016-02-12 14:10:03 +11:00
.gitreview Set default branch to feature/zuulv3 2015-12-07 11:28:01 -08:00
.mailmap Fix pep8 E127 violations 2012-09-26 14:23:10 +00:00
.testr.conf Tests: store debug logs on error 2017-02-06 10:10:48 -08:00
.zuul.yaml Copy logs to launcher 2017-02-26 14:07:43 -05:00
LICENSE Initial commit. 2012-05-29 14:49:32 -07:00 Migrate to pbr. 2013-06-25 19:04:30 +00:00
NEWS.rst Fix two typos on zuul documentation 2015-07-28 22:16:32 +09:00
README.rst Add roadmap to README 2016-12-06 10:55:55 -08:00
TESTING.rst Support multiple triggers 2013-08-01 11:56:52 -07:00
bindep.txt Add Zookeeper to tests 2016-12-20 14:14:15 -08:00
requirements.txt Add Zookeeper to tests 2016-12-20 14:14:15 -08:00
setup.cfg Rename zuul-server zuul-scheduler 2017-02-15 15:11:30 -08:00 Partial sync with OpenStack requirements. 2013-09-25 15:30:37 -07:00
test-requirements.txt Update hacking dependency 2017-03-01 13:22:44 -05:00
tox.ini Tests: store debug logs on error 2017-02-06 10:10:48 -08:00



Zuul is a project gating system developed for the OpenStack Project.

We are currently engaged in a significant development effort in preparation for the third major version of Zuul. We call this effort Zuul v3 and it is described in more detail below.


We are currently engaged in a significant development effort in preparation for the third major version of Zuul. We call this effort Zuul v3 and it is described in this file in the feature/zuulv3 branch of this repo.

To browse the latest code, see: To clone the latest code, use git clone git://

Bugs are handled at:!/project/679

Code reviews are, as you might expect, handled by gerrit at

Use git review to submit patches (after creating a Gerrit account that links to your launchpad account). Example:

# Do your commits
$ git review
# Enter your username if prompted

Zuul v3

The Zuul v3 effort involves significant changes to Zuul, and its companion program, Nodepool. The intent is for Zuul to become more generally useful outside of the OpenStack community. This is the best way to get started with this effort:

  1. Read the Zuul v3 spec:

    We use specification documents like this to describe large efforts where we want to make sure that all the participants are in agreement about what will happen and generally how before starting development. These specs should contain enough information for people to evaluate the proposal generally, and sometimes include specific details that need to be agreed upon in advance. They are living documents which can change as work gets underway. However, every change or detail does not need to be reflected in the spec --most work is simply done with patches (and revised if necessary in code review).

  2. Read the Nodepool build-workers spec:

  3. Review any proposed updates to these specs:

    Some of the information in the specs may be effectively superceded by changes here, which are still undergoing review.

  4. Read documentation on the internal data model and testing:

    The general philosophy for Zuul tests is to perform functional testing of either the individual component or the entire end-to-end system with external systems (such as Gerrit) replaced with fakes. Before adding additional unit tests with a narrower focus, consider whether they add value to this system or are merely duplicative of functional tests.

  5. Review open changes:

    We find that the most valuable code reviews are ones that spot problems with the proposed change, or raise questions about how that might affect other systems or subsequent work. It is also a great way to stay involved as a team in work performed by others (for instance, by observing and asking questions about development while it is in progress). We try not to sweat the small things and don't worry too much about style suggestions or other nitpicky things (unless they are relevant -- for instance, a -1 vote on a change that introduces a yaml change out of character with existing conventions is useful because it makes the system more user-friendly; a -1 vote on a change which uses a sub-optimal line breaking strategy is probably not the best use of anyone's time).

  6. Join #zuul on Freenode. Let others (especially jeblair who is trying to coordinate and prioritize work) know what you would like to work on.

  7. Check storyboard for status of current work items:!/board/41

Once you are up to speed on those items, it will be helpful to know the following:

  • Zuul v3 includes some substantial changes to Zuul, and in order to implement them quickly and simultaneously, we temporarily disabled most of the test suite. That test suite still has relevance, but tests are likely to need updating individually, with reasons ranging from something simple such as a test-framework method changing its name, to more substantial issues, such as a feature being removed as part of the v3 work. Each test will need to be evaluated individually. Feel free to, at any time, claim a test name in this story and work on re-enabling it:!/story/2000773

  • Because of the importance of external systems, as well as the number of internal Zuul components, actually running Zuul in a development mode quickly becomes unweildy (imagine uploading changes to Gerrit repeatedly while altering Zuul source code). Instead, the best way to develop with Zuul is in fact to write a functional test. Construct a test to fully simulate the series of events you want to see, then run it in the foreground. For example:

    .tox/py27/bin/python -m tests.test_scheduler.TestScheduler.test_jobs_launched

    See TESTING.rst for more information.

  • There are many occasions, when working on sweeping changes to Zuul v3, we left notes for future work items in the code marked with "TODOv3". These represent potentially serious missing functionality or other issues which must be resolved before an initial v3 release (unlike a more conventional TODO note, these really can not be left indefinitely). These present an opportunity to identify work items not otherwise tracked. The names associated with TODO or TODOv3 items do not mean that only that person can address them -- they simply reflect who to ask to explain the item in more detail if it is too cryptic. In your own work, feel free to leave TODOv3 notes if a change would otherwise become too large or unweildy.


  • Implement Zookeeper for Nodepool builders and begin using this in OpenStack Infra
  • Implement Zookeeper for Nodepool launchers
  • Implement a shim to translate Zuul v2 demand into Nodepool Zookeeper launcher requests
  • Begin using Zookeeper based Nodepool launchers with Zuul v2.5 in OpenStack Infra
  • Begin using Zuul v3 to run jobs for Zuul itself
  • Move OpenStack Infra to use Zuul v3
  • Implement Github support
  • Begin using Zuul v3 to run tests on Ansible repos
  • Implement support in Nodepool for non-OpenStack clouds
  • Add native container support to Zuul / Nodepool