bug 1355482: document taskcluster releng implementation and release promotion - add in depth balrog docs. r=aki
authorBen Hearsum <bhearsum@mozilla.com>
Tue, 10 Apr 2018 15:24:57 -0400
changeset 818044 dec00d3c30382406bd317eef08f06f4e92a36561
parent 818043 ac6334f8adba11e22f4b4739358dc95766cc5916
child 818045 1fa4dd2b1af77871f991677c4d27ea3ce0be8ee3
push id116246
push userbmo:tom@mozilla.com
push dateFri, 13 Jul 2018 20:48:08 +0000
reviewersaki
bugs1355482
milestone60.1.1
bug 1355482: document taskcluster releng implementation and release promotion - add in depth balrog docs. r=aki
taskcluster/docs/kinds.rst
taskcluster/docs/release-promotion.rst
--- a/taskcluster/docs/kinds.rst
+++ b/taskcluster/docs/kinds.rst
@@ -157,25 +157,19 @@ Docker repository
 
 The task definition used to create the image-building tasks is given in
 ``image.yml`` in the kind directory, and is interpreted as a :doc:`YAML
 Template <yaml-templates>`.
 
 balrog
 ------
 
-Balrog is the Mozilla Update Server. Jobs of this kind are submitting information
-which assists in telling Firefox that an update is available for the related job.
-
-balrog-l10n
------------
-
-Balrog is the Mozilla Update Server. Jobs of this kind are submitting information
-which assists in telling Firefox that an update is available for the localized
-job involved.
+Balrog tasks are responsible for submitting metadata to our update server (Balrog).
+They are typically downstream of a beetmover job that moves signed MARs somewhere
+(eg: beetmover and beetmover-l10n for releases, beetmover-repackage for nightlies).
 
 beetmover
 ---------
 
 Beetmover, takes specific artifacts, "Beets", and pushes them to a location outside
 of Taskcluster's task artifacts, (archive.mozilla.org as one place) and in the
 process determines the final location and a "pretty" name (versioned product name)
 
@@ -224,30 +218,37 @@ Artifact is then used by push-apk.
 
 push-apk
 --------
 PushApk publishes Android packages onto Google Play Store. Jobs of this kind take
 all the signed multi-locales (aka "multi") APKs for a given release and upload them
 all at once.
 
 release-balrog-submit-toplevel
-----------------------
-Push a top-level release blob to Balrog.
+------------------------------
+Toplevel tasks are responsible for submitting metadata to Balrog that is not specific to any
+particular platform+locale. For example: fileUrl templates, versions, and platform aliases.
+
+Toplevel tasks are also responsible for updating test channel rules to point at the Release
+being generated.
 
 release-secondary-balrog-submit-toplevel
-----------------------
-Push a top-level RC release blob to Balrog.
+----------------------------------------
+Performs the same function as `release-balrog-submit-toplevel`, but against the beta channel
+during RC builds.
 
 release-balrog-scheduling
-----------------------
-Schedule a release to go live in Balrog.
+-------------------------
+Schedules a Release for shipping in Balrog. If a `release_eta` was provided when starting the Release,
+it will be scheduled to go live at that day and time.
 
 release-secondary-balrog-scheduling
-----------------------
-Schedule an RC release to go live in Balrog.
+-----------------------------------
+Performs the same function as `release-balrog-scheduling`, except for the beta channel as part of RC
+Releases.
 
 release-binary-transparency
 ---------------------------
 Binary transparency creates a publicly verifiable log of binary shas for downstream
 release auditing. https://wiki.mozilla.org/Security/Binary_Transparency
 
 release-snap-repackage
 ----------------------
@@ -304,20 +305,16 @@ Submit to S3 the artifacts produced by t
 release-final-verify
 --------------------
 Verifies the contents and package of release update MARs.
 
 release-secondary-final-verify
 ------------------------------
 Verifies the contents and package of release update MARs for RC releases.
 
-release-secondary-balrog-publishing
----------------------
-Schedule an RC release to go live in Balrog. Usually this will happen on the beta channel, to a smaller audience, before the RC goes live on the release channel.
-
 release-sign-and-push-langpacks
 -------------------------------
 Sign a langpack XPI and publishes it onto addons.mozilla.org.
 
 release-beetmover-signed-langpacks
 ----------------------------------
 Publishes signed langpacks to archive.mozilla.org
 
--- a/taskcluster/docs/release-promotion.rst
+++ b/taskcluster/docs/release-promotion.rst
@@ -41,8 +41,9 @@ limited rollout percentage or are depend
 fully ship.
 
 In-depth relpro guide
 ---------------------
 
 .. toctree::
 
     release-promotion-action
+    balrog