zuul/zuul
Code Issues Proposed changes
5d7e93be95
zuul/doc/source/client.rst
Antoine Musso 6aa898464f Sphinx doc for zuul {promote,show} 
The Zuul client documentation was missing entries for the promote and
show sub commands.

Change-Id: Ia5501886984c8be2f900389bd65c166e093d416d
2014-06-30 21:35:26 +02:00

1.0 KiB
Raw Blame History

title

Zuul Client

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:

zuul --help

The following subcommands are supported:

Enqueue

zuul enqueue --help

Example:

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

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

Promote

zuul promote --help

Example:

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

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

Show

zuul show --help

Example:

zuul show running-jobs