Zuul Client

Zuul includes a simple command line client that may be used by administrators to affect Zuul’s behavior while running. It must be run on a host that has access to the Gearman server (e.g., locally on the Zuul host).

Configuration

The client uses the same zuul.conf file as the server, and will look for it in the same locations if not specified on the command line.

Usage

The general options that apply to all subcommands are:

usage: zuul [-h] [-c CONFIG] [-v] [--version]
            {autohold,enqueue,enqueue-ref,promote,show} ...

Zuul Project Gating System Client.

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG             specify the config file
  -v                    verbose output
  --version             show zuul version

commands:
  valid commands

  {autohold,enqueue,enqueue-ref,promote,show}
                        additional help
    autohold            hold nodes for failed job
    enqueue             enqueue a change
    enqueue-ref         enqueue a ref
    promote             promote one or more changes
    show                valid show subcommands

The following subcommands are supported:

Autohold

usage: zuul autohold [-h] --tenant TENANT --project PROJECT --job JOB --reason
                     REASON [--count COUNT]

optional arguments:
  -h, --help         show this help message and exit
  --tenant TENANT    tenant name
  --project PROJECT  project name
  --job JOB          job name
  --reason REASON    reason for the hold
  --count COUNT      number of job runs (default: 1)

Example:

zuul autohold --tenant openstack --project example_project --job example_job --reason "reason text" --count 1

Enqueue

usage: zuul enqueue [-h] --tenant TENANT --trigger TRIGGER --pipeline PIPELINE
                    --project PROJECT --change CHANGE

optional arguments:
  -h, --help           show this help message and exit
  --tenant TENANT      tenant name
  --trigger TRIGGER    trigger name
  --pipeline PIPELINE  pipeline name
  --project PROJECT    project name
  --change CHANGE      change id

Example:

zuul enqueue --tenant openstack --trigger gerrit --pipeline check --project example_project --change 12345,1

Note that the format of change id is <number>,<patchset>.

Promote

usage: zuul promote [-h] --tenant TENANT --pipeline PIPELINE --changes CHANGES
                    [CHANGES ...]

optional arguments:
  -h, --help            show this help message and exit
  --tenant TENANT       tenant name
  --pipeline PIPELINE   pipeline name
  --changes CHANGES [CHANGES ...]
                        change ids

Example:

zuul promote --tenant openstack --pipeline check --changes 12345,1 13336,3

Note that the format of changes id is <number>,<patchset>.

Show

usage: zuul show [-h] {running-jobs} ...

optional arguments:
  -h, --help      show this help message and exit

show:
  {running-jobs}
    running-jobs  show the running jobs

Example:

zuul show running-jobs