summaryrefslogtreecommitdiff
path: root/doc/source/config
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2022-06-22 21:54:52 +0000
committerGerrit Code Review <review@openstack.org>2022-06-22 21:54:52 +0000
commite7263fffb5a5fc60f7b7e54eaa7a3408280ef811 (patch)
tree33842d8673597c06d00534cd5e778cd6ee8e39ed /doc/source/config
parent2f5a21a49634a39fc9d8ea840d878eea32b4170d (diff)
parent7fc94effe7910c61ee755106b2aa51c18ce2b1a8 (diff)
downloadzuul-e7263fffb5a5fc60f7b7e54eaa7a3408280ef811.tar.gz
Merge "Add global semaphore support"
Diffstat (limited to 'doc/source/config')
-rw-r--r--doc/source/config/job.rst16
-rw-r--r--doc/source/config/semaphore.rst4
2 files changed, 12 insertions, 8 deletions
diff --git a/doc/source/config/job.rst b/doc/source/config/job.rst
index 541a1b7df..87806727f 100644
--- a/doc/source/config/job.rst
+++ b/doc/source/config/job.rst
@@ -219,14 +219,14 @@ Here is an example of two job definitions:
.. attr:: semaphores
- The name of a :ref:`semaphore` (or list of them) which should be
- acquired and released when the job begins and ends. If the
- semaphore is at maximum capacity, then Zuul will wait until it
- can be acquired before starting the job. The format is either a
- string, a dictionary, or a list of either of those in the case
- of multiple semaphores. If it's a string it references a
- semaphore using the default value for
- :attr:`job.semaphores.resources-first`.
+ The name of a :ref:`semaphore` (or list of them) or
+ :ref:`global_semaphore` which should be acquired and released
+ when the job begins and ends. If the semaphore is at maximum
+ capacity, then Zuul will wait until it can be acquired before
+ starting the job. The format is either a string, a dictionary,
+ or a list of either of those in the case of multiple
+ semaphores. If it's a string it references a semaphore using the
+ default value for :attr:`job.semaphores.resources-first`.
If multiple semaphores are requested, the job will not start
until all have been acquired, and Zuul will wait until all are
diff --git a/doc/source/config/semaphore.rst b/doc/source/config/semaphore.rst
index 74440ae79..91bfc9a4d 100644
--- a/doc/source/config/semaphore.rst
+++ b/doc/source/config/semaphore.rst
@@ -15,6 +15,10 @@ project as long as the value is the same. This is to aid in branch
maintenance, so that creating a new branch based on an existing branch
will not immediately produce a configuration error.
+Zuul also supports global semaphores (see :ref:`global_semaphore`)
+which may only be created by the Zuul administrator, but can be used
+to coordinate resources across multiple tenants.
+
Semaphores are never subject to dynamic reconfiguration. If the value
of a semaphore is changed, it will take effect only when the change
where it is updated is merged. However, Zuul will attempt to validate