The Gatekeeper, or a project gating system
Go to file
Tobias Henkel 60b5e174db
Add spec for enhanced regional executor distribution
When running large distributed deployments it can be desirable to keep
traffic as local as possible. To facilitate this zuul supports zoning
of zuul-executors. Using zones executors only process jobs on nodes
that are running in the same zone. This works well in many
cases. However there is currently a limitation around live log
streaming that makes it impossible to use this feature in certain
environments.

Live log streaming via zuul-web or zuul-fingergw requires that each
executor is directly addressable from zuul-web or zuul-fingergw. This
is not the case if

* zuul-executors are behind a NAT. In this case one would need to
  create a NAT rule per executor on different ports which can become a
  maintenance nightmare.

* zuul-executors run in a different Kubernetes or OpenShift. In this
  case one would need a Ingress/Route or NodePort per executor which
  also makes maintenance really hard.

Change-Id: Iecff1b05a93b34c2a80d18df21eafdcc46f6fdfa
2021-03-31 09:18:43 +02:00
doc Add spec for enhanced regional executor distribution 2021-03-31 09:18:43 +02:00
etc authentication config: add optional max_validity_time, skew 2019-12-10 16:39:29 +01:00
playbooks tutorial: Rework quick-start and prepare for other tutorials 2021-01-11 17:02:38 +01:00
releasenotes/notes Required SQL reporters 2021-02-03 13:41:55 -08:00
tests Add a test for fail-fast in the dependent pipeline 2021-02-05 13:48:02 -08:00
tools tools: Deprecate encrypt_secret.py, document zuul-client encrypt 2020-12-09 11:30:59 +00:00
web Merge "UI: Remove stretchable link from build and buildset table" 2021-02-05 17:45:30 +00:00
zuul Merge "Required SQL reporters" 2021-02-05 18:13:30 +00: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 Revert "Revert "Create zuul/web/static on demand"" 2020-07-07 19:53:33 +02: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 tutorial: Rework quick-start and prepare for other tutorials 2021-01-11 17:02:38 +01:00
COPYING Update README and add GPL license 2018-03-19 09:25:52 -07:00
Dockerfile Squash some RUN layers in Dockerfile 2020-12-11 11:25:26 -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 Fix bindep.txt: clean remaining python3.7 2020-09-29 17:16:22 +02:00
reno.yaml Add reno configuration settings 2020-07-22 08:45:46 -07:00
requirements.txt Merge "Bump pyjwt to 2.0.0" 2021-01-23 01:35:22 +00:00
setup.cfg Decouple mypy from tox 2020-12-09 17:04:45 +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 Decouple mypy from tox 2020-12-09 17:04:45 +00: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.