Update to new zuul-gearman protocol.
* Use non-Jenkins terminology "manager" rather than "master".
* Use name+number as the identifier for both stopping builds and
descriptions.
* Expect 'url' parameter instead of 'full_url'.
Change-Id: I1fe9851556618fc6d6deb8906e3f2ee41725c3ad
Reviewed-on: https://review.openstack.org/31726
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
diff --git a/doc/source/launchers.rst b/doc/source/launchers.rst
index a219936..27c8c01 100644
--- a/doc/source/launchers.rst
+++ b/doc/source/launchers.rst
@@ -170,17 +170,20 @@
immediately send a WORK_DATA packet with the following information
encoded in JSON format:
-**full_url**
- The URL with the status or results of the build. Will be used in
- the status page and the final report.
+**name**
+ The name of the job.
**number**
The build number (unique to this job).
-**master**
+**manager**
A unique identifier associated with the Gearman worker that can
abort this build. See `Stopping Builds`_ for more information.
+**url** (optional)
+ The URL with the status or results of the build. Will be used in
+ the status page and the final report.
+
It should then immediately send a WORK_STATUS packet with a value of 0
percent complete. It may then optionally send subsequent WORK_STATUS
packets with updated completion values.
@@ -202,13 +205,19 @@
If Zuul needs to abort a build already in progress, it will invoke the
following function through Gearman:
- stop:MASTER_NAME
+ stop:MANAGER_NAME
-Where **MASTER_NAME** is the name of the master node supplied in the
-initial WORK_DATA packet when the job started. This is used to direct
-the stop: function invocation to the correct Gearman worker that is
-capable of stopping that particular job. The argument to the function
-will be the unique ID of the job that should be stopped.
+Where **MANAGER_NAME** is the name of the manager worker supplied in
+the initial WORK_DATA packet when the job started. This is used to
+direct the stop: function invocation to the correct Gearman worker
+that is capable of stopping that particular job. The argument to the
+function should be the following encoded in JSON format:
+
+**name**
+ The job name of the build to stop.
+
+**number**
+ The build number of the build to stop.
The original job is expected to complete with a WORK_DATA and
WORK_FAIL packet as described in `Starting Builds`_.
@@ -220,14 +229,16 @@
current state of all related builds, the job runner may optionally
implement the following Gearman function:
- set_description:MASTER_NAME
+ set_description:MANAGER_NAME
-Where **MASTER_NAME** is used as described in `Stopping Builds`_. The
-argument to the function is the following encoded in JSON format:
+Where **MANAGER_NAME** is used as described in `Stopping Builds`_.
+The argument to the function is the following encoded in JSON format:
-**unique_id**
- The unique identifier of the build whose description should be
- updated.
+**name**
+ The job name of the build to describe.
+
+**number**
+ The build number of the build to describe.
**html_description**
The description of the build in HTML format.