James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 1 | :title: Launchers |
| 2 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 3 | .. _Gearman: http://gearman.org/ |
Antoine Musso | d06f2a6 | 2012-11-16 17:40:58 +0100 | [diff] [blame] | 4 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 5 | .. _`Gearman Plugin`: |
| 6 | https://wiki.jenkins-ci.org/display/JENKINS/Gearman+Plugin |
| 7 | |
Joshua Hesketh | 6a0a618 | 2014-03-13 13:23:30 +1100 | [diff] [blame^] | 8 | .. _`Turbo-Hipster`: |
| 9 | http://git.openstack.org/cgit/stackforge/turbo-hipster/ |
| 10 | |
| 11 | .. _`Turbo-Hipster Documentation`: |
| 12 | http://turbo-hipster.rtfd.org/ |
| 13 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 14 | .. _launchers: |
Antoine Musso | d06f2a6 | 2012-11-16 17:40:58 +0100 | [diff] [blame] | 15 | |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 16 | Launchers |
| 17 | ========= |
| 18 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 19 | Zuul has a modular architecture for launching jobs. Currently, the |
| 20 | only supported module interfaces with Gearman_. This design allows |
| 21 | any system to run jobs for Zuul simply by interfacing with a Gearman |
| 22 | server. The recommended way of integrating a new job-runner with Zuul |
| 23 | is via this method. |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 24 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 25 | If Gearman is unsuitable, Zuul may be extended with a new launcher |
| 26 | module. Zuul makes very few assumptions about the interface to a |
| 27 | launcher -- if it can trigger jobs, cancel them, and receive success |
| 28 | or failure reports, it should be able to be used with Zuul. Patches |
| 29 | to this effect are welcome. |
| 30 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 31 | Zuul Parameters |
| 32 | --------------- |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 33 | |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 34 | Zuul will pass some parameters with every job it launches. These are |
| 35 | for workers to be able to get the repositories into the state they are |
| 36 | intended to be tested in. Builds can be triggered either by an action |
| 37 | on a change or by a reference update. Both events share a common set |
| 38 | of parameters and more specific parameters as follows: |
Antoine Musso | e0f5bb4 | 2014-03-04 11:30:37 +0100 | [diff] [blame] | 39 | |
| 40 | Common parameters |
| 41 | ~~~~~~~~~~~~~~~~~ |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 42 | |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 43 | **ZUUL_UUID** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 44 | Zuul provided key to link builds with Gerrit events. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 45 | **ZUUL_REF** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 46 | Zuul provided ref that includes commit(s) to build. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 47 | **ZUUL_COMMIT** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 48 | The commit SHA1 at the head of ZUUL_REF. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 49 | **ZUUL_PROJECT** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 50 | The project that triggered this build. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 51 | **ZUUL_PIPELINE** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 52 | The Zuul pipeline that is building this job. |
Arx Cruz | b1b010d | 2013-10-28 19:49:59 -0200 | [diff] [blame] | 53 | **ZUUL_URL** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 54 | The URL for the zuul server as configured in zuul.conf. |
Joshua Hesketh | ba8776a | 2014-01-12 14:35:40 +0800 | [diff] [blame] | 55 | A test runner may use this URL as the basis for fetching |
Arx Cruz | b1b010d | 2013-10-28 19:49:59 -0200 | [diff] [blame] | 56 | git commits. |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 57 | |
Antoine Musso | e0f5bb4 | 2014-03-04 11:30:37 +0100 | [diff] [blame] | 58 | Change related parameters |
| 59 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 60 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 61 | The following additional parameters will only be provided for builds |
| 62 | associated with changes (i.e., in response to patchset-created or |
| 63 | comment-added events): |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 64 | |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 65 | **ZUUL_BRANCH** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 66 | The target branch for the change that triggered this build. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 67 | **ZUUL_CHANGE** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 68 | The Gerrit change ID for the change that triggered this build. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 69 | **ZUUL_CHANGE_IDS** |
| 70 | All of the Gerrit change IDs that are included in this build (useful |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 71 | when the DependentPipelineManager combines changes for testing). |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 72 | **ZUUL_PATCHSET** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 73 | The Gerrit patchset number for the change that triggered this build. |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 74 | |
Antoine Musso | e0f5bb4 | 2014-03-04 11:30:37 +0100 | [diff] [blame] | 75 | Reference updated parameters |
| 76 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 77 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 78 | The following additional parameters will only be provided for |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 79 | post-merge (ref-updated) builds: |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 80 | |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 81 | **ZUUL_OLDREV** |
| 82 | The SHA1 of the old revision at this ref (recall the ref name is |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 83 | in ZUUL_REF). |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 84 | **ZUUL_NEWREV** |
| 85 | The SHA1 of the new revision at this ref (recall the ref name is |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 86 | in ZUUL_REF). |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 87 | **ZUUL_SHORT_OLDREV** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 88 | The shortened (7 character) SHA1 of the old revision. |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 89 | **ZUUL_SHORT_NEWREV** |
Łukasz Jernaś | 048acb4 | 2014-03-02 18:49:41 +0100 | [diff] [blame] | 90 | The shortened (7 character) SHA1 of the new revision. |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 91 | |
Antoine Musso | e0f5bb4 | 2014-03-04 11:30:37 +0100 | [diff] [blame] | 92 | Unset revisions default to 00000000000000000000000000000000. |
| 93 | |
| 94 | Examples: |
| 95 | |
| 96 | When a reference is created:: |
| 97 | |
| 98 | ZUUL_OLDREV=00000000000000000000000000000000 |
| 99 | ZUUL_NEWREV=123456789abcdef123456789abcdef12 |
| 100 | ZUUL_SHORT_OLDREV=0000000 |
| 101 | ZUUL_SHORT_NEWREV=1234567 |
| 102 | |
| 103 | When a reference is deleted:: |
| 104 | |
| 105 | ZUUL_OLDREV=123456789abcdef123456789abcdef12 |
| 106 | ZUUL_NEWREV=00000000000000000000000000000000 |
| 107 | ZUUL_SHORT_OLDREV=1234567 |
| 108 | ZUUL_SHORT_NEWREV=0000000 |
| 109 | |
| 110 | And finally a reference being altered:: |
| 111 | |
| 112 | ZUUL_OLDREV=123456789abcdef123456789abcdef12 |
| 113 | ZUUL_NEWREV=abcdef123456789abcdef123456789ab |
| 114 | ZUUL_SHORT_OLDREV=1234567 |
| 115 | ZUUL_SHORT_NEWREV=abcdef1 |
| 116 | |
| 117 | Your jobs can check whether the parameters are ``000000`` to act |
| 118 | differently on each kind of event. |
| 119 | |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 120 | Gearman |
| 121 | ------- |
| 122 | |
| 123 | Gearman_ is a general-purpose protocol for distributing jobs to any |
| 124 | number of workers. Zuul works with Gearman by sending specific |
| 125 | information with job requests to Gearman, and expects certain |
| 126 | information to be returned on completion. This protocol is described |
| 127 | in `Zuul-Gearman Protocol`_. |
| 128 | |
| 129 | In order for Zuul to run any jobs, you will need a running Gearman |
| 130 | server. Zuul includes a Gearman server, and it is recommended that it |
| 131 | be used as it supports the following features needed by Zuul: |
| 132 | |
| 133 | * Canceling jobs in the queue (admin protocol command "cancel job"). |
| 134 | * Strict FIFO queue operation (gearmand's round-robin mode may be |
| 135 | sufficient, but is untested). |
| 136 | |
| 137 | To enable the built-in server, see the ``gearman_server`` section of |
| 138 | ``zuul.conf``. Be sure that the host allows connections from Zuul and |
| 139 | any workers (e.g., Jenkins masters) on TCP port 4730, and nowhere else |
| 140 | (as the Gearman protocol does not include any provision for |
| 141 | authentication). |
| 142 | |
| 143 | Gearman Jenkins Plugin |
| 144 | ~~~~~~~~~~~~~~~~~~~~~~ |
| 145 | |
| 146 | The `Gearman Jenkins Plugin`_ makes it easy to use Jenkins with Zuul |
| 147 | by providing an interface between Jenkins and Gearman. In this |
| 148 | configuration, Zuul asks Gearman to run jobs, and Gearman can then |
| 149 | distribute those jobs to any number of Jenkins systems (including |
| 150 | multiple Jenkins masters). |
| 151 | |
| 152 | The `Gearman Plugin`_ can be installed in Jenkins in order to |
| 153 | facilitate Jenkins running jobs for Zuul. Install the plugin and |
| 154 | configure it with the hostname or IP address of your Gearman server |
| 155 | and the port on which it is listening (4730 by default). It will |
| 156 | automatically register all known Jenkins jobs as functions that Zuul |
| 157 | can invoke via Gearman. |
| 158 | |
| 159 | Any number of masters can be configured in this way, and Gearman will |
| 160 | distribute jobs to all of them as appropriate. |
| 161 | |
| 162 | No special Jenkins job configuration is needed to support triggering |
| 163 | by Zuul. |
| 164 | |
| 165 | The Gearman Plugin will ensure the `Zuul Parameters`_ are supplied as |
| 166 | Jenkins build parameters, so they will be available for use in the job |
| 167 | configuration as well as to the running job as environment variables. |
| 168 | |
Antoine Musso | e0f5bb4 | 2014-03-04 11:30:37 +0100 | [diff] [blame] | 169 | Jenkins git plugin configuration |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 170 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
Antoine Musso | e0f5bb4 | 2014-03-04 11:30:37 +0100 | [diff] [blame] | 171 | |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 172 | In order to test the correct build, configure the Jenkins Git SCM |
| 173 | plugin as follows:: |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 174 | |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 175 | Source Code Management: |
| 176 | Git |
| 177 | Repositories: |
| 178 | Repository URL: <your Gerrit or Zuul repository URL> |
| 179 | Advanced: |
| 180 | Refspec: ${ZUUL_REF} |
| 181 | Branches to build: |
| 182 | Branch Specifier: ${ZUUL_COMMIT} |
James E. Blair | e281901 | 2013-06-28 17:17:26 -0400 | [diff] [blame] | 183 | Advanced: |
| 184 | Clean after checkout: True |
James E. Blair | cdd0007 | 2012-06-08 19:17:28 -0700 | [diff] [blame] | 185 | |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 186 | That should be sufficient for a job that only builds a single project. |
| 187 | If you have multiple interrelated projects (i.e., they share a Zuul |
| 188 | Change Queue) that are built together, you may be able to configure |
| 189 | the Git plugin to prepare them, or you may chose to use a shell script |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 190 | instead. As an example, the OpenStack project uses the following |
| 191 | script to prepare the workspace for its integration testing: |
James E. Blair | 81515ad | 2012-10-01 18:29:08 -0700 | [diff] [blame] | 192 | |
K Jonathan Harker | 97e457e | 2013-02-26 13:29:38 -0800 | [diff] [blame] | 193 | https://github.com/openstack-infra/devstack-gate/blob/master/devstack-vm-gate-wrap.sh |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 194 | |
Joshua Hesketh | 6a0a618 | 2014-03-13 13:23:30 +1100 | [diff] [blame^] | 195 | Turbo Hipster Worker |
| 196 | ~~~~~~~~~~~~~~~~~~~~ |
| 197 | |
| 198 | As an alternative to Jenkins, `Turbo-Hipster`_ is a small python |
| 199 | project designed specifically as a zuul job worker which can be |
| 200 | registered with gearman as a job runner. Please see the |
| 201 | `Turbo-Hipster Documentation`_ for details on how to set it up. |
| 202 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 203 | Zuul-Gearman Protocol |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 204 | ~~~~~~~~~~~~~~~~~~~~~ |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 205 | |
| 206 | This section is only relevant if you intend to implement a new kind of |
| 207 | worker that runs jobs for Zuul via Gearman. If you just want to use |
| 208 | Jenkins, see `Gearman Jenkins Plugin`_ instead. |
| 209 | |
| 210 | The Zuul protocol as used with Gearman is as follows: |
| 211 | |
| 212 | Starting Builds |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 213 | ^^^^^^^^^^^^^^^ |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 214 | |
| 215 | To start a build, Zuul invokes a Gearman function with the following |
| 216 | format: |
| 217 | |
| 218 | build:FUNCTION_NAME |
| 219 | |
| 220 | where **FUNCTION_NAME** is the name of the job that should be run. If |
| 221 | the job should run on a specific node (or class of node), Zuul will |
| 222 | instead invoke: |
| 223 | |
| 224 | build:FUNCTION_NAME:NODE_NAME |
| 225 | |
| 226 | where **NODE_NAME** is the name or class of node on which the job |
| 227 | should be run. This can be specified by setting the ZUUL_NODE |
Antoine Musso | 7c5db97 | 2013-09-26 11:48:26 +0200 | [diff] [blame] | 228 | parameter in a parameter-function (see :ref:`includes` section in |
| 229 | :ref:`zuulconf`). |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 230 | |
| 231 | Zuul sends the ZUUL_* parameters described in `Zuul Parameters`_ |
| 232 | encoded in JSON format as the argument included with the |
| 233 | SUBMIT_JOB_UNIQ request to Gearman. A unique ID (equal to the |
| 234 | ZUUL_UUID parameter) is also supplied to Gearman, and is accessible as |
| 235 | an added Gearman parameter with GRAB_JOB_UNIQ. |
| 236 | |
| 237 | When a Gearman worker starts running a job for Zuul, it should |
| 238 | immediately send a WORK_DATA packet with the following information |
| 239 | encoded in JSON format: |
| 240 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 241 | **name** |
| 242 | The name of the job. |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 243 | |
| 244 | **number** |
| 245 | The build number (unique to this job). |
| 246 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 247 | **manager** |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 248 | A unique identifier associated with the Gearman worker that can |
| 249 | abort this build. See `Stopping Builds`_ for more information. |
| 250 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 251 | **url** (optional) |
| 252 | The URL with the status or results of the build. Will be used in |
| 253 | the status page and the final report. |
| 254 | |
Joshua Hesketh | ba8776a | 2014-01-12 14:35:40 +0800 | [diff] [blame] | 255 | To help with debugging builds a worker may send back some optional |
| 256 | metadata: |
| 257 | |
| 258 | **worker_name** (optional) |
| 259 | The name of the worker. |
| 260 | |
| 261 | **worker_hostname** (optional) |
| 262 | The hostname of the worker. |
| 263 | |
| 264 | **worker_ips** (optional) |
| 265 | A list of IPs for the worker. |
| 266 | |
| 267 | **worker_fqdn** (optional) |
| 268 | The FQDN of the worker. |
| 269 | |
| 270 | **worker_program** (optional) |
| 271 | The program name of the worker. For example Jenkins or turbo-hipster. |
| 272 | |
| 273 | **worker_version** (optional) |
| 274 | The version of the software running the job. |
| 275 | |
| 276 | **worker_extra** (optional) |
| 277 | A dictionary of any extra metadata you may want to pass along. |
| 278 | |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 279 | It should then immediately send a WORK_STATUS packet with a value of 0 |
| 280 | percent complete. It may then optionally send subsequent WORK_STATUS |
| 281 | packets with updated completion values. |
| 282 | |
| 283 | When the build is complete, it should send a final WORK_DATA packet |
| 284 | with the following in JSON format: |
| 285 | |
| 286 | **result** |
| 287 | Either the string 'SUCCESS' if the job succeeded, or any other value |
| 288 | that describes the result if the job failed. |
| 289 | |
| 290 | Finally, it should send either a WORK_FAIL or WORK_COMPLETE packet as |
| 291 | appropriate. A WORK_EXCEPTION packet will be interpreted as a |
| 292 | WORK_FAIL, but the exception will be logged in Zuul's error log. |
| 293 | |
| 294 | Stopping Builds |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 295 | ^^^^^^^^^^^^^^^ |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 296 | |
| 297 | If Zuul needs to abort a build already in progress, it will invoke the |
| 298 | following function through Gearman: |
| 299 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 300 | stop:MANAGER_NAME |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 301 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 302 | Where **MANAGER_NAME** is the name of the manager worker supplied in |
| 303 | the initial WORK_DATA packet when the job started. This is used to |
| 304 | direct the stop: function invocation to the correct Gearman worker |
| 305 | that is capable of stopping that particular job. The argument to the |
| 306 | function should be the following encoded in JSON format: |
| 307 | |
| 308 | **name** |
| 309 | The job name of the build to stop. |
| 310 | |
| 311 | **number** |
| 312 | The build number of the build to stop. |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 313 | |
| 314 | The original job is expected to complete with a WORK_DATA and |
| 315 | WORK_FAIL packet as described in `Starting Builds`_. |
| 316 | |
| 317 | Build Descriptions |
Joshua Hesketh | e898716 | 2014-03-13 13:05:33 +1100 | [diff] [blame] | 318 | ^^^^^^^^^^^^^^^^^^ |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 319 | |
| 320 | In order to update the job running system with a description of the |
| 321 | current state of all related builds, the job runner may optionally |
| 322 | implement the following Gearman function: |
| 323 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 324 | set_description:MANAGER_NAME |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 325 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 326 | Where **MANAGER_NAME** is used as described in `Stopping Builds`_. |
| 327 | The argument to the function is the following encoded in JSON format: |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 328 | |
James E. Blair | 3c483cf | 2013-06-04 16:30:43 -0700 | [diff] [blame] | 329 | **name** |
| 330 | The job name of the build to describe. |
| 331 | |
| 332 | **number** |
| 333 | The build number of the build to describe. |
James E. Blair | 1f4c2bb | 2013-04-26 08:40:46 -0700 | [diff] [blame] | 334 | |
| 335 | **html_description** |
| 336 | The description of the build in HTML format. |