Logo
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
      • Keycloak Tutorial
        • Update /etc/hosts
        • Restart Zuul Containers
        • Start Keycloak
        • Log Into Zuul
  • 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 Room
      • Optional Next Steps
        • Optional: Save Encryption Keys
        • Optional: Register with an Identity Provider
        • Optional: Join an IRC Room
  • User Reference
    • Configuration Syntax
      • Security Contexts
      • Configuration Loading
      • Regular Expressions
      • 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
    • Keycloak Tutorial
      • Update /etc/hosts
      • Restart Zuul Containers
      • Start Keycloak
      • Log Into Zuul
  • 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
    • OpenID Connect Integration Examples
      • Configuring Google Authentication
        • Prerequisites
        • Setting up credentials with Google
          • Create OAuth client ID
          • Configure Zuul
        • Further Reading
      • Configuring Keycloak Authentication
        • Prerequisites
        • Setting up Keycloak
          • Create a client
          • Create a client scope
          • (Optional) Set up a social identity provider
        • Setting up Zuul
        • Further Reading
      • Debugging
    • 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
        • export-keys
        • import-keys
        • copy-keys
        • delete-keys
        • delete-state
  • 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
        • Liveness Probes
    • 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
          • Authentication
        • 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
        • 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
      • ZooKeeper
        • Overview
        • Driver Event Ingestion
          • Active Event Gathering
          • Passive Event Gathering
        • Configuration Storage
        • Executor and Merger Queues
        • Zookeeper Map
      • 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.11.0
        • New Features
        • Upgrade Notes
      • 4.10.4
        • Bug Fixes
      • 4.10.3
        • Bug Fixes
      • 4.10.2
        • Bug Fixes
      • 4.10.1
        • New Features
        • Bug Fixes
      • 4.10.0
        • Upgrade Notes
      • 4.9.0
        • New Features
        • Upgrade Notes
      • 4.8.1
        • Upgrade Notes
        • Bug Fixes
      • 4.8.0
        • New Features
      • 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
  • »
  • User How-to Guides
  • View page source

User How-to Guides

  • Cross Project Gating
  • Project Testing Interface
  • Badges
  • Chatting with Matrix
Previous Next

© Copyright 2012-2022, Zuul project contributors.

Built with Sphinx using a theme provided by Read the Docs.
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