The Gatekeeper, or a project gating system
Go to file
Simon Westphahl abaa8e29f8 Implement API for caching raw config files in ZK
The content of config files will be saved in Zookeeper using the
following path schema:

    /zuul/config/cache/<project-cname>/<branch>/<filename>

The canonocal project name, branch and filename are escaped using 'plus
quote' to avoid issues with '/' as part of the names.

The list of extra config files/dirs the cache is valid for will be
stored in the root node of the project-branch cache.

In order not to store any duplicated data in Zookeeper, the unparsed
files cache is global and shared by all tenants. Because of that it
needs to be read/write locked on a per project basis. Locks will be
stored separate from the cache content in order to avoid any conflicts
e.g. when a branch cache is deleted:

    /zuul/config/lock/<project-cname>

As we need a consistent view of the unparsed config, Zookeeper must be
accessed directly instead of using a TreeCache. Unfortunately, with the
TreeCache there is no reliable way to determine if ALL changes of a
(sub-)tree have been synced to the cache. This is the case as the tree
cache uses data watches internally, which are created as the sync
progresses. Because of that we don't have a guarantee that tree events
are totally ordered.

Change-Id: I215eb26774cd0d53892e6a152bc1011fb72193da
2021-05-19 17:05:06 -07:00
doc Merge "Add artifacts to MQTT reporter" 2021-05-03 18:52:44 +00:00
etc Move key_store_password to keystore section in zuul.conf 2021-04-14 06:42:44 -07:00
playbooks Use ssh-keyscan -4 in quick-start 2021-04-19 16:06:08 -07:00
releasenotes/notes Merge "Add artifacts to MQTT reporter" 2021-05-03 18:52:44 +00:00
tests Implement API for caching raw config files in ZK 2021-05-19 17:05:06 -07:00
tools Retry yarn package installs 2021-05-03 11:26:52 -07:00
web Merge "web: add benchmark test for build output" 2021-03-13 11:48:23 +00:00
zuul Implement API for caching raw config files in ZK 2021-05-19 17:05:06 -07:00
.coveragerc Revert "Revert "Switch to stestr"" 2018-05-17 08:33:40 -07:00
.dockerignore Add web/node_modules to dockerignore 2019-01-27 11:23:45 +01:00
.gitignore Use ZooKeeper TLS in tests 2021-03-08 06:49:57 -08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:25:28 +00:00
.mailmap Fix pep8 E127 violations 2012-09-26 14:23:10 +00:00
.stestr.conf Revert "Revert "Switch to stestr"" 2018-05-17 08:33:40 -07:00
.zuul.yaml Use ZooKeeper TLS in tests 2021-03-08 06:49:57 -08:00
COPYING Update README and add GPL license 2018-03-19 09:25:52 -07:00
Dockerfile Noop change to Dockerfile to trigger image builds 2021-02-19 13:09:18 -08:00
LICENSE Initial commit. 2012-05-29 14:49:32 -07:00
MANIFEST.in Optimize canMerge using graphql 2020-02-28 09:43:56 +01:00
README.rst Support nodes setting 'auto' python-path 2019-09-19 10:28:53 +10:00
TESTING.rst Docs: fix stestr run example 2020-01-21 10:36:07 +01:00
bindep.txt Use ZooKeeper TLS in tests 2021-03-08 06:49:57 -08:00
reno.yaml Add reno configuration settings 2020-07-22 08:45:46 -07:00
requirements.txt Include database requirements by default 2021-02-23 16:38:47 -05:00
setup.cfg Merge "Include database requirements by default" 2021-03-09 23:24:34 +00:00
setup.py Partial sync with OpenStack requirements. 2013-09-25 15:30:37 -07:00
test-requirements.txt Optimize canMerge using graphql 2020-02-28 09:43:56 +01:00
tox.ini Retry yarn package installs 2021-05-03 11:26:52 -07:00

README.rst

Zuul

Zuul is a project gating system.

The latest documentation for Zuul v3 is published at: https://zuul-ci.org/docs/zuul/

If you are looking for the Edge routing service named Zuul that is related to Netflix, it can be found here: https://github.com/Netflix/zuul

If you are looking for the Javascript testing tool named Zuul, it can be found here: https://github.com/defunctzombie/zuul

Getting Help

There are two Zuul-related mailing lists:

zuul-announce

A low-traffic announcement-only list to which every Zuul operator or power-user should subscribe.

zuul-discuss

General discussion about Zuul, including questions about how to use it, and future development.

You will also find Zuul developers in the #zuul channel on Freenode IRC.

Contributing

To browse the latest code, see: https://opendev.org/zuul/zuul To clone the latest code, use git clone https://opendev.org/zuul/zuul

Bugs are handled at: https://storyboard.openstack.org/#!/project/zuul/zuul

Suspected security vulnerabilities are most appreciated if first reported privately following any of the supported mechanisms described at https://zuul-ci.org/docs/zuul/user/vulnerabilities.html

Code reviews are handled by gerrit at https://review.opendev.org

After creating a Gerrit account, use git review to submit patches. Example:

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

Join #zuul on Freenode to discuss development or usage.

License

Zuul is free software. Most of Zuul is licensed under the Apache License, version 2.0. Some parts of Zuul are licensed under the General Public License, version 3.0. Please see the license headers at the tops of individual source files.

Python Version Support

Zuul requires Python 3. It does not support Python 2.

Since Zuul uses Ansible to drive CI jobs, Zuul can run tests anywhere Ansible can, including Python 2 environments.