The Gatekeeper, or a project gating system
Go to file
James E. Blair fbb17e1f35 Decrypt secrets on the executors
Rather than decrypting secrets on the scheduler and sending them
to the executors unencrypted, now that the private keys are in ZK
and the executors have access to them, we can defer decryption to
the executors.  This means that when we move the build requests
from gearman to ZK, we avoid storing decrypted secrets in ZK.

We accomplish this by serializing the entire secret (parts or all
of which may be encrypted or plaintext) to YAML in the scheduler
and deserializing the YAML into a Secret object on the executor.
We do this because we already have support for indicating an
encrypted value via custom YAML tags.

This means that the build request (which is currently transmitted
via gearman and soon to be via ZK) serializes the rest of the job
to JSON.  This means we're storing a serialized-to-YAML secret as
a scalar value in a serialized-to-JSON data structure.  There's
nothing technically wrong with this, and it is the minimal version
of this change, however it's slightly unusual and may result in
a little extra work.  We may want to consider serializing the
entire job request as YAML instead.

Change-Id: I6d94c1d8da8b68e5fb60c27e73039155a02fb485
2021-05-06 14:20:26 -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 Decrypt secrets on the executors 2021-05-06 14:20:26 -07:00
tools Really retry yarn installs 2021-05-05 11:59:28 -07:00
web Merge "web: add benchmark test for build output" 2021-03-13 11:48:23 +00:00
zuul Decrypt secrets on the executors 2021-05-06 14:20:26 -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.