latest
User Tutorials
Admin Tutorials
Quick-Start Installation and Tutorial
Start Zuul Containers
Add Your Gerrit Account
Configure Zuul Pipelines
Test Zuul Pipelines
Configure a Base Job
Further Steps
User How-to Guides
Cross Project Gating
Python
Packaging
Project Testing Interface
Projects layout
org-config
org-jobs
Projects content
Usage
Project tests
Updating PTI test
Cross project gating
Badges
Chatting with Matrix
Why Use Matrix?
Create An Account
Join the #zuul Channel
Optional Next Steps
Optional: Save Encryption Keys
Optional: Register with an Identity Provider
User Reference
Configuration Syntax
Security Contexts
Configuration Loading
Configuration Items
Pipeline
Job
Project
Project Template
Queue
Secret
Nodeset
Semaphore
Pragma
Job Content
Working Directory
Git Repositories
Variables
Site-wide Variables
Job Extra Variables
Secrets
Job Variables
Project Variables
Parent Job Results
Zuul Variables
Change Items
Branch Items
Tag Items
Ref Items
Working Directory
SSH Keys
Nodepool Key
Project Key
Return Values
Returning the log url
Returning artifact URLs
Skipping dependent jobs
Leaving warnings
Leaving file comments
Pausing the job
Build Status
Admin Tutorials
Quick-Start Installation and Tutorial
Start Zuul Containers
Add Your Gerrit Account
Configure Zuul Pipelines
Test Zuul Pipelines
Configure a Base Job
Further Steps
Admin How-to Guides
Installation Reference
Install Zuul
Zuul Components
External Dependencies
Gearman
Nodepool
ZooKeeper
Ansible
Zuul Setup
Starting Zuul
Web Deployment Options
Reverse Proxy
Static Offload
Sub directory serving
White Labeled Tenant
Static External
Zuul From Scratch
Environment Setup
Installation
Configuration
Nodepool
Zuul
Starting Services
Use Zuul Jobs
Setup Your Repo
Troubleshooting
Gearman Jobs
Thread Dumps and Profiling
ZooKeeper Administration
Configuration
Encrypted Connections
Admin Reference
Tenant Configuration
Tenant
Access Rule
Access Rule Templating
Database Configuration
Connection Configuration
Connections
Drivers
Gerrit
Connection Configuration
Trigger Configuration
Reporter Configuration
Requirements Configuration
Reference Pipelines Configuration
Checks Plugin Support (Experimental)
GitHub
Configure GitHub
Web-Hook
Application
Connection Configuration
Trigger Configuration
Reporter Configuration
Requirements Configuration
Reference pipelines configuration
Branch protection rules
Reference pipelines
Pagure
Configure Pagure
Connection Configuration
Trigger Configuration
Reporter Configuration
Requirements Configuration
Reference pipelines configuration
GitLab
Configure GitLab
web-hooks
API
Connection Configuration
Trigger Configuration
Reporter Configuration
Requirements Configuration
Reference pipelines configuration
Git
Connection Configuration
Trigger Configuration
MQTT
Message Schema
Connection Configuration
Reporter Configuration
Elasticsearch
Connection Configuration
Reporter Configuration
SMTP
Connection Configuration
Reporter Configuration
SQL
Connection Configuration
Reporter Configuration
Timer
Trigger Configuration
Zuul
Trigger Configuration
Zuul Client
Configuration
Usage
Autohold
Autohold Delete
Autohold Info
Autohold List
Dequeue
Enqueue
Enqueue-ref
Manual enqueue examples
Promote
Show
tenant-conf-check
create-auth-token
Discussion
Zuul Concepts
Components
Overview
Common
Configuration
Scheduler
Configuration
Operation
Reconfiguration
Merger
Configuration
Operation
Executor
Trusted and Untrusted Playbooks
Configuration
Operation
Ansible and Python 3
Web Server
Configuration
Enabling tenant-scoped access to privileged actions
Driver-specific attributes
HS256
RS256
RS256withJWKS
OpenIDConnect
Operation
Web Client
Configuration
Configuration
Finger Gateway
Configuration
Operation
Project Gating
Testing in parallel
Cross Project Testing
Cross-Project Dependencies
Dependent Pipeline
Independent Pipeline
Multiple Changes
Cycles
Encryption
Tenant Scoped REST API
Important Security Considerations
Configuration
JWT Format
Manually Generating a JWT
Github Checks API
Design decisions
Behaviour in Zuul
Reporting
Trigger
Requirements
Actions / Events
File comments (annotations)
Custom actions
Restrictions and Recommendations
Reference
Monitoring
Statsd reporting
Configuration
Metrics
Prometheus monitoring
Configuration
Metrics
REST API
Developer’s Guide
Data Model
Changes
Filters
Tenants
Other Global Objects
Drivers
Triggers
Testing
Documentation
ReStructuredText Conventions
Code Blocks
Literal Values
Terminology
Zuul Sphinx Directives
zuul:attr::
zuul:value::
zuul:var::
Zuul Sphinx Roles
:zuul:attr:
:zuul:value:
:zuul:var:
Ansible Integration
Restricted Execution
Build Log Support
Zuul Dashboard Javascript
For the impatient who don’t want deal with javascript toolchains
yarn dependency management
Dealing with yarn.lock merge conflicts
React Components and Styling
Development
Deploying
Specifications
Tenant-scoped admin web API
Problem Description
Proposed Change
JWT Validation
Expected Format
Extra Authentication Claims
Authorization Claims
Access Control Configuration
Administration Web API
POST /api/tenant/{tenant}/project/{project}/enqueue
POST /api/tenant/{tenant}/project/{project}/dequeue
POST /api/tenant/{tenant}/project/{project}/autohold
GET /api/user/authorizations
Logging
Zuul Client CLI and Admin Web API
JWT Generation by Zuul
Client CLI
Configuration Changes
Implementation
Assignee(s)
Gerrit Topic
Work Items
Documentation
Security
Testing
Follow-up work
Dependencies
Kubernetes Operator
Custom Resource Definitions
Images
External Dependencies
Zuul Config
Executor job volume
Logging
Circular Dependencies
Proposed change
Implementation
Challenges
Scale out scheduler
Status quo
Target architecture
Driver event ingestion
Active event gathering
Passive event gathering
Store unparsed branch config in Zookeeper
Store pipeline and tenant state in Zookeeper
Mandatory SQL connection
Executor via Zookeeper
Parallelize pipeline processing
Zuul-web changes
Security considerations
Roadmap
Zuul Runner
Zuul Job Execution Context
Test Resources
Required Projects
Ansible Configuration
Playbooks
Secrets
Implementation
Zuul Runner CLI
Enhanced regional distribution of zuul-executors
Problem description
Proposed change
Gearman
Security considerations
Resource Quota per Tenant
Problem Description
Proposed Change
Make Nodepool Tenant Aware
Introduce Tenant Quotas in Nodepool
Implementation Caveats
Use Matrix for Chat
Requirements
Benefits Offered by Matrix
Reasons to Move
Reasons to Stay
Implementation Plan
Potential Future Enhancements
Release Notes
Installing reno
Adding a new release note
Zuul Project Governance
Zuul Maintainers
Zuul Project Lead
Zuul-Jobs Maintainers
Vulnerability Reporting
Create a Private Story in StoryBoard
Report via Encrypted E-mail
Release Notes
4.7.0
New Features
Upgrade Notes
Deprecation Notes
4.6.0
New Features
Security Issues
4.5.1
Bug Fixes
4.5.0
Prelude
4.4.0
New Features
Deprecation Notes
4.3.0
New Features
Upgrade Notes
Deprecation Notes
Bug Fixes
4.2.0
Prelude
4.1.0
New Features
Upgrade Notes
Deprecation Notes
Bug Fixes
4.0.0
Prelude
New Features
Upgrade Notes
Deprecation Notes
Bug Fixes
3.19.1
Security Issues
Bug Fixes
3.19.0
Prelude
New Features
Upgrade Notes
Security Issues
Bug Fixes
3.18.0
New Features
Upgrade Notes
Deprecation Notes
Security Issues
Bug Fixes
3.17.0
New Features
Security Issues
3.16.1
Bug Fixes
3.16.0
New Features
Upgrade Notes
Deprecation Notes
3.15.0
Bug Fixes
3.14.0
New Features
Upgrade Notes
3.13.0
New Features
Upgrade Notes
3.12.0
New Features
Upgrade Notes
Other Notes
3.11.1
Bug Fixes
3.11.0
New Features
Upgrade Notes
3.10.2
New Features
Security Issues
Bug Fixes
3.10.1
Bug Fixes
3.10.0
New Features
Upgrade Notes
3.9.0
New Features
3.8.1
Bug Fixes
3.8.0
New Features
Security Issues
Bug Fixes
3.7.1
Bug Fixes
3.7.0
New Features
Upgrade Notes
3.6.1
Security Issues
3.6.0
New Features
Upgrade Notes
3.5.0
New Features
Upgrade Notes
Security Issues
Bug Fixes
3.4.0
New Features
Upgrade Notes
3.3.1
New Features
Upgrade Notes
Security Issues
Bug Fixes
3.3.0
New Features
Upgrade Notes
Deprecation Notes
3.2.0
New Features
Bug Fixes
3.1.0
New Features
Upgrade Notes
Security Issues
Bug Fixes
3.0.3
New Features
Deprecation Notes
Bug Fixes
3.0.2
New Features
Upgrade Notes
Bug Fixes
3.0.1
New Features
Upgrade Notes
Bug Fixes
Glossary
Zuul
»
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
Symbols
:type: dict (variable of zuul.items[])
<branch> (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>)
<canonical_hostname> (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project)
<Elasticsearch connection> (attribute)
<gerrit connection> (attribute)
<git connection> (attribute)
<github connection> (attribute)
<gitlab connection> (attribute)
<jobname> (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>.job)
<mqtt connection> (attribute)
<mqtt schema> (attribute)
<pagure connection> (attribute)
<phase> (stat of zuul.executor.<executor>.phase)
<pipeline name> (stat of zuul.tenant.<tenant>.pipeline)
<pipeline> (attribute of project)
<project-group> (attribute of tenant.untrusted-projects)
<project> (attribute of tenant.config-projects)
(attribute of tenant.untrusted-projects)
(stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>)
<project>.<resource> (stat of zuul.nodepool.requests.resources.project)
<result> (stat of zuul.executor.<executor>.phase.<phase>)
(stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>.job.<jobname>)
<smtp connection> (attribute)
<sql connection> (attribute)
<state> (stat of zuul.nodepool.requests)
<state>.label.<label> (stat of zuul.nodepool.requests)
<state>.size.<size> (stat of zuul.nodepool.requests)
<state>.total (stat of zuul.nodepool.requests)
<tenant>.<resource> (stat of zuul.nodepool.requests.resources.tenant)
<zone>.accepting (stat of zuul.executors.zone)
<zone>.jobs_queued (stat of zuul.executors.zone)
<zone>.jobs_running (stat of zuul.executors.zone)
<zone>.online (stat of zuul.executors.zone)
A
abstract (attribute of job)
abstract job
accepting (stat of zuul.executors)
(stat of zuul.executors.unzoned)
action (attribute of <mqtt schema>)
(attribute of pipeline.trigger.<github source>)
(attribute of pipeline.trigger.<gitlab source>)
(attribute of pipeline.trigger.<pagure source>)
ActionModule (class in zuul.ansible.base.action.normal)
addEvent() (tests.base.ZuulTestCase method)
addFakeChange() (tests.base.FakeGerritConnection method)
admin-rule (attribute)
admin-rules (attribute of tenant)
all_jobs (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
allow-circular-dependencies (attribute of queue)
allow_authz_override (attribute of auth <authenticator name>)
allow_unzoned (attribute of executor)
allowed-labels (attribute of tenant)
allowed-projects (attribute of job)
allowed-reporters (attribute of tenant)
allowed-triggers (attribute of tenant)
ansible-version (attribute of job)
"">ansible_callback "<name>" (attribute)
ansible_root (attribute of executor)
ansible_setup_timeout (attribute of executor)
api_token (attribute of <github connection>)
(attribute of <gitlab connection>)
(attribute of <pagure connection>)
api_token_name (attribute of <gitlab connection>)
app_id (attribute of <github connection>)
app_key (attribute of <github connection>)
app_name (attribute of <pagure connection>)
approval (attribute of pipeline.<reporter>.<gitlab source>)
(attribute of pipeline.reject.<gerrit source>)
(attribute of pipeline.require.<gerrit source>)
(attribute of pipeline.trigger.<gerrit source>)
approved (attribute of pipeline.require.<gitlab source>)
(value of pipeline.trigger.<gitlab source>.action)
artifact
artifacts (attribute of <mqtt schema>.buildset.builds)
(variable of zuul)
assertBuilds() (tests.base.ZuulTestCase method)
assertHistory() (tests.base.ZuulTestCase method)
assertReportedStat() (tests.base.ZuulTestCase method)
attempts (attribute of job)
(variable of zuul)
auth <authenticator name> (attribute)
auth_type (attribute of <gerrit connection>)
B
base job
BaseTrigger (class in zuul.trigger)
baseurl (attribute of <gerrit connection>)
(attribute of <git connection>)
(attribute of <gitlab connection>)
(attribute of <pagure connection>)
basic (value of <gerrit connection>.auth_type)
branch (attribute of <mqtt schema>)
(attribute of pipeline.trigger.<gerrit source>)
(attribute of pipeline.trigger.<github source>)
(variable of zuul)
,
[1]
(variable of zuul.items[])
branches (attribute of job)
build
Build (class in zuul.model)
build (variable of zuul)
BuildHistory (class in tests.base)
builds (attribute of <mqtt schema>.buildset)
(stat of zuul.executor.<executor>)
buildset
(attribute of <mqtt schema>)
BuildSet (class in zuul.model)
buildset (variable of zuul)
C
ca_certs (attribute of <Elasticsearch connection>)
(attribute of <mqtt connection>)
CallbackModule (class in zuul.ansible.base.callback.zuul_json)
(class in zuul.ansible.base.callback.zuul_stream)
canonical_hostname (attribute of <gerrit connection>)
(attribute of <github connection>)
(attribute of <gitlab connection>)
(attribute of <pagure connection>)
(variable of zuul.items[].project)
(variable of zuul.project)
(variable of zuul.projects{})
canonical_name (variable of zuul.items[].project)
(variable of zuul.project)
(variable of zuul.projects{})
certfile (attribute of <mqtt connection>)
change
(attribute of <mqtt schema>)
Change (class in zuul.model)
change (variable of zuul)
(variable of zuul.artifacts[])
(variable of zuul.items[])
change_url (attribute of <mqtt schema>)
(variable of zuul)
(variable of zuul.items[])
changed (value of pipeline.trigger.<github source>.action)
(value of pipeline.trigger.<gitlab source>.action)
(value of pipeline.trigger.<pagure source>.action)
ChangeQueue (class in zuul.model)
check
(attribute of pipeline.<reporter>.<github source>)
check_run (value of pipeline.trigger.<github source>.event)
checkout (variable of zuul.projects{})
cherry-pick (value of project.merge-mode)
child job
child_jobs (variable of zuul)
ciphers (attribute of <mqtt connection>)
cleanup-run (attribute of job)
client_cert (attribute of <Elasticsearch connection>)
client_id (attribute of auth <authenticator name>)
client_key (attribute of <Elasticsearch connection>)
cloneurl (attribute of <gitlab connection>)
(attribute of <pagure connection>)
closed (value of pipeline.trigger.<github source>.action)
(value of pipeline.trigger.<pagure source>.action)
command_socket (attribute of executor)
(attribute of fingergw)
(attribute of merger)
(attribute of scheduler)
comment (attribute of pipeline.<reporter>.<github source>)
(attribute of pipeline.<reporter>.<gitlab source>)
(attribute of pipeline.<reporter>.<pagure source>)
(attribute of pipeline.reporter.<gerrit reporter>)
(attribute of pipeline.trigger.<gerrit source>)
(attribute of pipeline.trigger.<github source>)
(attribute of pipeline.trigger.<gitlab source>)
(attribute of pipeline.trigger.<pagure source>)
(value of pipeline.trigger.<github source>.action)
(value of pipeline.trigger.<gitlab source>.action)
(value of pipeline.trigger.<pagure source>.action)
commit_id (attribute of <mqtt schema>)
commitConfigUpdate() (tests.base.ZuulTestCase method)
completed (value of pipeline.trigger.<github source>.action)
conditions (attribute of admin-rule)
config-project
config-projects (attribute of tenant)
connection
connection.<connection-name> (stat of zuul.scheduler.eventqueues)
ConnectionInterface (class in zuul.driver)
context (variable of zuul.items[].:type: dict)
cross-project dependency
current-patchset (attribute of pipeline.require.<gerrit source>)
(attribute of pipeline.require.<github source>)
current_changes (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
(stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>)
current_requests (stat of zuul.nodepool.requests)
D
data (attribute of secret)
database (attribute)
dburi (attribute of <sql connection>)
(attribute of database)
debug (attribute of project.<pipeline>)
default (attribute of auth <authenticator name>)
default-ansible-version (attribute of tenant)
default-branch (attribute of project)
default-parent (attribute of tenant)
default_ansible_version (attribute of scheduler)
default_from (attribute of <smtp connection>)
default_hold_expiration (attribute of scheduler)
default_to (attribute of <smtp connection>)
default_username (attribute of executor)
dependencies (attribute of job)
dependent (value of pipeline.manager)
DependentPipelineManager (class in zuul.manager.dependent)
deploy
dequeue (attribute of pipeline)
dequeue-message (attribute of pipeline)
dequeue-on-new-patchset (attribute of pipeline)
description (attribute of job)
(attribute of pipeline)
digest (value of <gerrit connection>.auth_type)
disable-after-consecutive-failures (attribute of pipeline)
disabled (attribute of pipeline)
disallowed-labels (attribute of tenant)
disk_limit_per_job (attribute of executor)
dismissed (value of pipeline.trigger.<github source>.action)
dispatch_handler() (zuul.ansible.base.action.normal.ActionModule method)
driver (attribute of <Elasticsearch connection>)
(attribute of <gerrit connection>)
(attribute of <git connection>)
(attribute of <github connection>)
(attribute of <gitlab connection>)
(attribute of <mqtt connection>)
(attribute of <pagure connection>)
(attribute of <smtp connection>)
(attribute of <sql connection>)
(attribute of auth <authenticator name>)
Driver (class in zuul.driver)
E
elasticsearch (value of <Elasticsearch connection>.driver)
email (attribute of pipeline.require.<gerrit source>.approval)
(attribute of pipeline.require.<github source>.review)
(attribute of pipeline.trigger.<gerrit source>)
end_time (attribute of <mqtt schema>.buildset.builds)
enqueue (attribute of pipeline)
enqueue-message (attribute of pipeline)
enqueue_time (attribute of <mqtt schema>)
event (attribute of pipeline.trigger.<gerrit source>)
(attribute of pipeline.trigger.<git source>)
(attribute of pipeline.trigger.<github source>)
(attribute of pipeline.trigger.<gitlab source>)
(attribute of pipeline.trigger.<pagure source>)
(attribute of pipeline.trigger.zuul)
event_id (variable of zuul)
EventFilter (class in zuul.model)
eventqueues (stat of zuul.scheduler)
exclude (attribute of tenant.untrusted-projects.<project-group>)
(attribute of tenant.untrusted-projects.<project>)
exclude-unprotected-branches (attribute of tenant)
(attribute of tenant.untrusted-projects.<project>)
execute_time (attribute of <mqtt schema>.buildset.builds)
executor
(attribute)
(variable of zuul)
exponential (value of pipeline.window-decrease-type)
(value of pipeline.window-increase-type)
extra-config-paths (attribute of tenant.untrusted-projects.<project>)
extra-vars (attribute of job)
F
fail-fast (attribute of project.<pipeline>)
failJob() (tests.base.RecordingExecutorServer method)
failure (attribute of pipeline)
failure-message (attribute of job)
(attribute of pipeline)
FakeBuild (class in tests.base)
FakeGearmanServer (class in tests.base)
FakeGerritConnection (class in tests.base)
files (attribute of job)
final (attribute of job)
final job
finger_port (attribute of executor)
fingergw (attribute)
flat (value of job.workspace-scheme)
footer-message (attribute of pipeline)
form (value of <gerrit connection>.auth_type)
from (attribute of pipeline.<reporter>.<smtp source>)
G
galaxy (attribute of job.roles)
gate
gcloud_service (value of <gerrit connection>.auth_type)
gearman (attribute)
gearman_server (attribute)
gerrit (value of <gerrit connection>.driver)
GerritTrigger (class in zuul.driver.gerrit.gerrittrigger)
getConnection() (zuul.driver.ConnectionInterface method)
getEventFilters() (zuul.driver.gerrit.gerrittrigger.GerritTrigger method)
(zuul.driver.timer.timertrigger.TimerTrigger method)
(zuul.driver.zuul.zuultrigger.ZuulTrigger method)
(zuul.trigger.BaseTrigger method)
getEventQueue() (tests.base.FakeGerritConnection method)
getRejectSchema() (zuul.driver.SourceInterface method)
getReporter() (zuul.driver.ReporterInterface method)
getReporterSchema() (zuul.driver.ReporterInterface method)
getRequireSchema() (zuul.driver.SourceInterface method)
getSortedBuilds() (tests.base.ZuulTestCase method)
getSource() (zuul.driver.SourceInterface method)
getTrigger() (zuul.driver.TriggerInterface method)
getTriggerEventClass() (zuul.driver.TriggerInterface method)
getTriggerSchema() (zuul.driver.TriggerInterface method)
getUpstreamRepos() (tests.base.ZuulTestCase method)
getWebController() (tests.base.FakeGerritConnection method)
getWorkspaceRepos() (tests.base.FakeBuild method)
git (value of <git connection>.driver)
git_dir (attribute of executor)
(attribute of merger)
git_http_low_speed_limit (attribute of merger)
git_http_low_speed_time (attribute of merger)
git_timeout (attribute of merger)
git_user_email (attribute of merger)
,
[1]
git_user_name (attribute of merger)
,
[1]
github (value of <github connection>.driver)
gitlab (value of <gitlab connection>.driver)
gitweb_url_template (attribute of <gerrit connection>)
gl_merge_request (value of pipeline.trigger.<gitlab source>.event)
gl_push (value of pipeline.trigger.<gitlab source>.event)
golang (value of job.workspace-scheme)
group-vars (attribute of job)
groups (attribute of nodeset)
H
handle_file() (zuul.ansible.base.action.normal.ActionModule method)
handle_find() (zuul.ansible.base.action.normal.ActionModule method)
handle_k8s() (zuul.ansible.base.action.normal.ActionModule method)
handle_known_hosts() (zuul.ansible.base.action.normal.ActionModule method)
handle_stat() (zuul.ansible.base.action.normal.ActionModule method)
handle_zuul_return() (zuul.ansible.base.action.normal.ActionModule method)
hasChanges() (tests.base.FakeBuild method)
hold-following-changes (attribute of job)
host-vars (attribute of job)
hostname (attribute of executor)
(variable of zuul.executor)
hosts (attribute of zookeeper)
I
ignore-deletes (attribute of pipeline.trigger.<gerrit source>)
(attribute of pipeline.trigger.<git source>)
ignore-dependencies (attribute of pipeline)
implied-branch-matchers (attribute of pragma)
implied-branches (attribute of pragma)
include (attribute of tenant.untrusted-projects.<project-group>)
(attribute of tenant.untrusted-projects.<project>)
independent (value of pipeline.manager)
IndependentPipelineManager (class in zuul.manager.independent)
index (attribute of pipeline.<reporter>.<elasticsearch source>)
intermediate (attribute of job)
inventory
inventory_file (variable of zuul.executor)
irrelevant-files (attribute of job)
issuer_id (attribute of auth <authenticator name>)
isWaiting() (tests.base.FakeBuild method)
items (variable of zuul)
J
job
(attribute)
Job (class in zuul.model)
job (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>)
(variable of zuul)
(variable of zuul.artifacts[])
job dependency
job variant
job_dir (attribute of executor)
job_name (attribute of <mqtt schema>.buildset.builds)
JobGraph (class in zuul.model)
jobs (attribute of project.<pipeline>)
jobs_queued (stat of zuul.executors)
(stat of zuul.executors.unzoned)
(stat of zuul.mergers)
jobs_running (stat of zuul.executors)
(stat of zuul.executors.unzoned)
(stat of zuul.mergers)
jobtags (variable of zuul)
K
keepalive (attribute of <gerrit connection>)
(attribute of <mqtt connection>)
keyfile (attribute of <mqtt connection>)
keys_url (attribute)
,
[1]
keystore (attribute)
,
[1]
L
label (attribute of nodeset.nodes)
(attribute of pipeline.<reporter>.<github source>)
(attribute of pipeline.require.<github source>)
(attribute of pipeline.trigger.<github source>)
labeled (value of pipeline.trigger.<github source>.action)
(value of pipeline.trigger.<gitlab source>.action)
labels (attribute of pipeline.require.<gitlab source>)
(attribute of pipeline.trigger.<gitlab source>)
Layout (class in zuul.model)
linear (value of pipeline.window-decrease-type)
(value of pipeline.window-increase-type)
listen_address (attribute of fingergw)
(attribute of gearman_server)
(attribute of web)
,
[1]
load-branch (attribute of tenant.config-projects.<project>)
load_average (stat of zuul.executor.<executor>)
load_multiplier (attribute of executor)
log_config (attribute of executor)
(attribute of fingergw)
(attribute of gearman_server)
(attribute of merger)
(attribute of scheduler)
(attribute of web)
,
[1]
log_root (variable of zuul.executor)
log_url (attribute of <mqtt schema>.buildset.builds)
logState() (tests.base.ZuulTestCase method)
LogStreamer (class in zuul.lib.log_streamer)
LogStreamHandler (class in zuul.web)
M
maintainCache() (tests.base.FakeGerritConnection method)
manage_ansible (attribute of executor)
management (stat of zuul.scheduler.eventqueues)
management_events (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
manager (attribute of pipeline)
match-on-config-updates (attribute of job)
max (attribute of semaphore)
max-job-timeout (attribute of tenant)
max-nodes-per-job (attribute of tenant)
max_hold_expiration (attribute of scheduler)
max_starting_builds (attribute of executor)
max_validity_time (attribute of auth <authenticator name>)
merge (attribute of pipeline.<reporter>.<github source>)
(attribute of pipeline.<reporter>.<gitlab source>)
(attribute of pipeline.<reporter>.<pagure source>)
(value of project.merge-mode)
merge-failure (attribute of pipeline)
merge-failure-message (attribute of pipeline)
merge-mode (attribute of project)
merge-resolve (value of project.merge-mode)
merge_jobs (attribute of executor)
merged (attribute of pipeline.require.<github source>)
(attribute of pipeline.require.<gitlab source>)
(attribute of pipeline.require.<pagure source>)
(value of pipeline.trigger.<gitlab source>.action)
merger
(attribute)
,
[1]
merger.<result> (stat of zuul.executor.<executor>)
message (attribute of <mqtt schema>)
(variable of zuul)
metadata (attribute of <mqtt schema>.buildset.builds.artifacts)
(variable of zuul.artifacts[])
min_avail_hdd (attribute of executor)
min_avail_mem (attribute of executor)
module
zuul.ansible.base.library.command
mqtt (value of <mqtt connection>.driver)
N
name (attribute of <mqtt schema>.buildset.builds.artifacts)
(attribute of admin-rule)
(attribute of job)
(attribute of job.dependencies)
(attribute of job.required-projects)
(attribute of job.roles)
(attribute of job.secrets)
(attribute of job.semaphores)
(attribute of nodeset)
(attribute of nodeset.groups)
(attribute of nodeset.nodes)
(attribute of pipeline)
(attribute of project)
(attribute of queue)
(attribute of secret)
(attribute of semaphore)
(attribute of tenant)
(variable of zuul.artifacts[])
(variable of zuul.items[].project)
(variable of zuul.project)
(variable of zuul.projects{})
namespace (variable of zuul.items[].:type: dict)
newer-than (attribute of pipeline.require.<gerrit source>.approval)
(attribute of pipeline.require.<github source>.review)
newrev (variable of zuul)
,
[1]
,
[2]
newTenantConfig() (tests.base.ZuulTestCase method)
no-jobs (attribute of pipeline)
no-jobs-message (attribute of pipeline)
node
nodes (attribute of nodeset)
(attribute of nodeset.groups)
nodeset
(attribute of job)
(attribute)
O
older-than (attribute of pipeline.require.<gerrit source>.approval)
(attribute of pipeline.require.<github source>.review)
oldrev (variable of zuul)
,
[1]
,
[2]
onChangeEnqueued() (zuul.trigger.BaseTrigger method)
onChangeMerged() (zuul.trigger.BaseTrigger method)
online (stat of zuul.executors)
(stat of zuul.executors.unzoned)
(stat of zuul.mergers)
open (attribute of pipeline.require.<gerrit source>)
(attribute of pipeline.require.<github source>)
(attribute of pipeline.require.<gitlab source>)
(attribute of pipeline.require.<pagure source>)
opened (value of pipeline.trigger.<github source>.action)
(value of pipeline.trigger.<gitlab source>.action)
(value of pipeline.trigger.<pagure source>.action)
override-checkout (attribute of job)
(attribute of job.required-projects)
override_checkout (variable of zuul)
owner (attribute of <mqtt schema>)
P
pagure (value of <pagure connection>.driver)
parent (attribute of job)
parent job
parent-change-enqueued (value of pipeline.trigger.zuul.event)
ParsedConfig (class in zuul.model)
pass-to-parent (attribute of job.secrets)
password (attribute of <gerrit connection>)
(attribute of <mqtt connection>)
(attribute of <smtp connection>)
(attribute of keystore)
,
[1]
patchset (attribute of <mqtt schema>)
(variable of zuul)
(variable of zuul.artifacts[])
(variable of zuul.items[])
pause (stat of zuul.executor.<executor>)
paused_builds (stat of zuul.executor.<executor>)
paused_on_start (attribute of executor)
pct_used_ram (stat of zuul.executor.<executor>)
pct_used_ram_cgroup (stat of zuul.executor.<executor>)
per-branch (attribute of queue)
permission (attribute of pipeline.require.<github source>.review)
pg_pull_request (value of pipeline.trigger.<pagure source>.event)
pg_pull_request_review (value of pipeline.trigger.<pagure source>.event)
pg_push (value of pipeline.trigger.<pagure source>.event)
phase (stat of zuul.executor.<executor>)
pidfile (attribute of executor)
(attribute of fingergw)
(attribute of merger)
(attribute of scheduler)
(attribute of web)
pipeline
(attribute of <mqtt schema>)
(attribute of pipeline.trigger.zuul)
(attribute)
Pipeline (class in zuul.model)
pipeline (variable of zuul)
pipeline manager
pipeline.<reporter>.<elasticsearch source> (attribute)
pipeline.<reporter>.<github source> (attribute)
pipeline.<reporter>.<gitlab source> (attribute)
pipeline.<reporter>.<mqtt> (attribute)
pipeline.<reporter>.<pagure source> (attribute)
pipeline.<reporter>.<smtp source> (attribute)
pipeline.<reporter>.<sql source> (attribute)
pipeline.reject.<gerrit source> (attribute)
pipeline.reject.<github source> (attribute)
pipeline.reporter.<gerrit reporter> (attribute)
pipeline.require.<gerrit source> (attribute)
pipeline.require.<github source> (attribute)
pipeline.require.<gitlab source> (attribute)
pipeline.require.<pagure source> (attribute)
pipeline.trigger.<gerrit source> (attribute)
pipeline.trigger.<git source> (attribute)
pipeline.trigger.<github source> (attribute)
pipeline.trigger.<gitlab source> (attribute)
pipeline.trigger.<pagure source> (attribute)
pipeline.trigger.timer (attribute)
pipeline.trigger.zuul (attribute)
PipelineManager (class in zuul.manager)
pod (variable of zuul.items[].:type: dict)
poll_delay (attribute of <git connection>)
pool_recycle (attribute of <sql connection>)
(attribute of database)
port (attribute of <gerrit connection>)
(attribute of <mqtt connection>)
(attribute of <smtp connection>)
(attribute of fingergw)
(attribute of gearman)
(attribute of gearman_server)
(attribute of statsd)
(attribute of web)
post
post-review (attribute of job)
(attribute of pipeline)
post-run (attribute of job)
post-timeout (attribute of job)
post_review (variable of zuul)
post_timeout (variable of zuul)
postConfig() (zuul.trigger.BaseTrigger method)
pragma (attribute)
pre-run (attribute of job)
precedence (attribute of pipeline)
prefix (attribute of statsd)
printHistory() (tests.base.ZuulTestCase method)
private_key (attribute)
private_key_file (attribute of executor)
process_cpu_seconds_total (stat)
process_open_fds (stat)
process_resident_memory_bytes (stat)
process_start_time_seconds (stat)
process_virtual_memory_bytes (stat)
project
(attribute of <mqtt schema>)
(attribute)
Project (class in zuul.model)
project (stat of zuul.nodepool.requests.resources)
(stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
(variable of zuul)
(variable of zuul.artifacts[])
(variable of zuul.items[])
project gating
project pipeline
project queue
project template
project-change-merged (value of pipeline.trigger.zuul.event)
projects (attribute of tenant.untrusted-projects.<project-group>)
(variable of zuul)
prometheus_addr (attribute of scheduler)
prometheus_port (attribute of scheduler)
promote
protected (attribute of job)
provided artifact
provides (attribute of job)
public_key (attribute)
pull_request (value of pipeline.trigger.<github source>.event)
pull_request_review (value of pipeline.trigger.<github source>.event)
push (value of pipeline.trigger.<github source>.event)
Q
qos (attribute of pipeline.<reporter>.<mqtt>)
queue (attribute of project)
(attribute of project.<pipeline>)
(attribute)
QueueItem (class in zuul.model)
R
rate_limit_logging (attribute of <github connection>)
realm (attribute of auth <authenticator name>)
reconfigure() (zuul.driver.Driver method)
RecordingExecutorServer (class in tests.base)
ref (attribute of <mqtt schema>)
(attribute of pipeline.trigger.<gerrit source>)
(attribute of pipeline.trigger.<git source>)
(attribute of pipeline.trigger.<github source>)
(attribute of pipeline.trigger.<gitlab source>)
(attribute of pipeline.trigger.<pagure source>)
Ref (class in zuul.model)
ref (variable of zuul)
RefFilter (class in zuul.model)
registerScheduler() (zuul.driver.Driver method)
reject (attribute of pipeline)
reject-approval (attribute of pipeline.trigger.<gerrit source>)
relative_priority (attribute of scheduler)
release
release() (tests.base.FakeBuild method)
(tests.base.FakeGearmanServer method)
(tests.base.RecordingExecutorServer method)
reopened (value of pipeline.trigger.<github source>.action)
RepoFiles (class in zuul.model)
reporter
ReporterInterface (class in zuul.driver)
requested (value of pipeline.trigger.<github source>.action)
require (attribute of pipeline)
require-approval (attribute of pipeline.trigger.<gerrit source>)
required (variable of zuul.projects{})
required artifact
required project
required-projects (attribute of job)
requires (attribute of job)
resident_time (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
(stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>)
resources (stat of zuul.nodepool.requests)
(variable of zuul.items[])
resources-first (attribute of job.semaphores)
result (attribute of <mqtt schema>.buildset)
(attribute of <mqtt schema>.buildset.builds)
result_events (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
returnData() (tests.base.RecordingExecutorServer method)
review (attribute of pipeline.<reporter>.<github source>)
(attribute of pipeline.reject.<github source>)
(attribute of pipeline.require.<github source>)
review-body (attribute of pipeline.<reporter>.<github source>)
roles (attribute of job)
root (attribute of web)
run (attribute of job)
run() (zuul.ansible.base.action.normal.ActionModule method)
running (stat of zuul.geard)
running_builds (stat of zuul.executor.<executor>)
S
scheduler
(attribute)
Scheduler (class in zuul.scheduler)
scope (attribute)
score (attribute of pipeline.require.<pagure source>)
secret (attribute of job.secrets)
(attribute)
secrets (attribute of job)
semaphore (attribute of job)
(attribute)
semaphores (attribute of job)
serial (value of pipeline.manager)
server (attribute of <gerrit connection>)
(attribute of <github connection>)
(attribute of <gitlab connection>)
(attribute of <mqtt connection>)
(attribute of <pagure connection>)
(attribute of <smtp connection>)
(attribute of gearman)
(attribute of statsd)
session_timeout (attribute of zookeeper)
setUp() (tests.base.ZuulTestCase method)
shadow (attribute of tenant.untrusted-projects.<project>)
short_name (variable of zuul.items[].project)
(variable of zuul.project)
(variable of zuul.projects{})
simple_layout() (in module tests.base)
skew (attribute of auth <authenticator name>)
smtp (value of <smtp connection>.driver)
soft (attribute of job.dependencies)
source (attribute of tenant)
source_whitelist (attribute of <pagure connection>)
SourceInterface (class in zuul.driver)
speculative execution
sql (value of <sql connection>.driver)
squash-merge (value of project.merge-mode)
src_dir (variable of zuul.items[].project)
(variable of zuul.project)
(variable of zuul.projects{})
src_root (variable of zuul.executor)
sshkey (attribute of <gerrit connection>)
(attribute of <github connection>)
(attribute of <gitlab connection>)
ssl_ca (attribute of gearman)
(attribute of gearman_server)
ssl_cert (attribute of gearman)
(attribute of gearman_server)
ssl_key (attribute of gearman)
(attribute of gearman_server)
start (attribute of gearman_server)
(attribute of pipeline)
start-message (attribute of pipeline)
start_time (attribute of <mqtt schema>.buildset.builds)
starting_builds (stat of zuul.executor.<executor>)
state (attribute of pipeline.trigger.<github source>)
state_dir (attribute of executor)
(attribute of scheduler)
static_cache_expiry (attribute of web)
static_path (attribute of web)
stats_type (attribute of web)
stats_url (attribute of web)
statsd (attribute)
status (attribute of pipeline.<reporter>.<github source>)
(attribute of pipeline.<reporter>.<pagure source>)
(attribute of pipeline.require.<gerrit source>)
(attribute of pipeline.require.<github source>)
(attribute of pipeline.require.<pagure source>)
(attribute of pipeline.trigger.<github source>)
(attribute of pipeline.trigger.<pagure source>)
(value of pipeline.trigger.<github source>.action)
(value of pipeline.trigger.<pagure source>.action)
status-url (attribute of pipeline.<reporter>.<github source>)
(attribute of pipeline.<reporter>.<pagure source>)
status_url (attribute of web)
stop() (zuul.driver.Driver method)
subject (attribute of pipeline.<reporter>.<smtp source>)
submit (attribute of pipeline.reporter.<gerrit reporter>)
submitted (value of pipeline.trigger.<github source>.action)
success (attribute of pipeline)
success-message (attribute of job)
(attribute of pipeline)
supercedent (value of pipeline.manager)
supercedes (attribute of pipeline)
T
table_prefix (attribute of <sql connection>)
(attribute of database)
tag
(attribute of pipeline.trigger.<pagure source>)
(variable of zuul)
tagged (value of pipeline.trigger.<pagure source>.action)
tags (attribute of job)
(attribute of pipeline.require.<pagure source>)
templates (attribute of project)
tenant
(attribute of <mqtt schema>)
(attribute)
Tenant (class in zuul.model)
tenant (stat of zuul.nodepool.requests.resources)
(variable of zuul)
tenant_config (attribute of scheduler)
tenant_config_script (attribute of scheduler)
thumbsdown (value of pipeline.trigger.<pagure source>.action)
thumbsup (value of pipeline.trigger.<pagure source>.action)
time (attribute of pipeline.trigger.timer)
timeout (attribute of job)
(variable of zuul)
TimerTrigger (class in zuul.driver.timer.timertrigger)
tls_ca (attribute of zookeeper)
tls_cert (attribute of zookeeper)
tls_key (attribute of zookeeper)
to (attribute of pipeline.<reporter>.<smtp source>)
toDict() (tests.base.FakeGerritConnection method)
topic (attribute of pipeline.<reporter>.<mqtt>)
total (stat of zuul.geard)
total_changes (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
(stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>)
trigger
(attribute of pipeline)
trigger_events (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>)
trigger_time (attribute of <mqtt schema>)
TriggerEvent (class in zuul.model)
TriggerInterface (class in zuul.driver)
trusted execution context
trusted_ro_paths (attribute of executor)
trusted_rw_paths (attribute of executor)
type (attribute of pipeline.require.<github source>.review)
U
uid_claim (attribute of auth <authenticator name>)
unapproved (value of pipeline.trigger.<gitlab source>.action)
unlabel (attribute of pipeline.<reporter>.<github source>)
unlabeled (value of pipeline.trigger.<github source>.action)
UnparsedAbideConfig (class in zuul.model)
UnparsedConfig (class in zuul.model)
untrusted execution context
untrusted-project
untrusted-projects (attribute of tenant)
untrusted_ro_paths (attribute of executor)
untrusted_rw_paths (attribute of executor)
unzoned (stat of zuul.executors)
uri (attribute of <Elasticsearch connection>)
url (attribute of <mqtt schema>.buildset.builds.artifacts)
(attribute of webclient)
(variable of zuul.artifacts[])
use_ssl (attribute of <Elasticsearch connection>)
use_starttls (attribute of <smtp connection>)
user (attribute of <gerrit connection>)
(attribute of <mqtt connection>)
(attribute of <smtp connection>)
(attribute of fingergw)
username (attribute of pipeline.require.<gerrit source>.approval)
(attribute of pipeline.require.<github source>.review)
(attribute of pipeline.trigger.<gerrit source>)
uuid (attribute of <mqtt schema>)
(attribute of <mqtt schema>.buildset.builds)
(value of <mqtt schema>.buildset)
V
validateWebConfig() (tests.base.FakeGerritConnection method)
variables (attribute of executor)
variant-description (attribute of pipeline)
vars (attribute of job)
(attribute of project)
verify_certs (attribute of <Elasticsearch connection>)
verify_ssl (attribute of <gerrit connection>)
(attribute of <github connection>)
(attribute of webclient)
voting (attribute of <mqtt schema>.buildset.builds)
(attribute of job)
(variable of zuul)
W
wait_time (stat of zuul.tenant.<tenant>.pipeline.<pipeline name>.project.<canonical_hostname>.<project>.<branch>.job.<jobname>)
waiting (stat of zuul.geard)
web (attribute)
,
[1]
,
[2]
web-root (attribute of tenant)
web_url (attribute of <mqtt schema>.buildset.builds)
webclient (attribute)
webhook_token (attribute of <github connection>)
(attribute of <gitlab connection>)
websocket_url (attribute of web)
window (attribute of pipeline)
window-decrease-factor (attribute of pipeline)
window-decrease-type (attribute of pipeline)
window-floor (attribute of pipeline)
window-increase-factor (attribute of pipeline)
window-increase-type (attribute of pipeline)
winrm_cert_key_file (attribute of executor)
winrm_cert_pem_file (attribute of executor)
winrm_operation_timeout_sec (attribute of executor)
winrm_read_timeout_sec (attribute of executor)
work_root (variable of zuul.executor)
Worker (class in zuul.model)
workspace-scheme (attribute of job)
Z
zone (attribute of executor)
(stat of zuul.executors)
zookeeper (attribute)
zuul (attribute of job.roles)
(variable)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
zuul.ansible.base.library.command
module
zuul.event.<driver>.<type> (stat)
zuul.executor.<executor> (stat)
zuul.executors (stat)
zuul.geard (stat)
zuul.mergers (stat)
zuul.nodepool.requests (stat)
zuul.scheduler (stat)
zuul.tenant.<tenant>.event_enqueue_processing_time (stat)
zuul.tenant.<tenant>.event_enqueue_time (stat)
zuul.tenant.<tenant>.management_events (stat)
zuul.tenant.<tenant>.pipeline (stat)
zuul.tenant.<tenant>.trigger_events (stat)
zuul_ref (attribute of <mqtt schema>)
zuul_success (variable)
ZuulTestCase (class in tests.base)
ZuulTrigger (class in zuul.driver.zuul.zuultrigger)
ZuulWeb (class in zuul.web)
Versions
v: latest
latest
4.11.0
4.10.4
4.10.3
4.10.2
4.10.1
4.10.0
4.9.0
4.8.1
4.8.0
4.7.0
4.6.0
4.5.1
4.5.0
4.4.0
4.3.0
4.2.0
4.1.0
4.0.0
3.19.1
3.19.0
3.18.0
3.17.0
3.16.1
3.16.0
3.15.0
3.14.0
3.13.0
3.12.0
3.11.1
3.11.0
3.10.2
3.10.1
3.10.0
3.9.0
3.8.1
3.8.0
3.7.1
3.7.0
3.6.1
3.6.0
3.5.0
3.4.0
3.3.1
3.3.0