Docs: explain why we push deployer twice

Signed-off-by: Maël Valais <[email protected]>

Author: maelvls

cloudbuild.yaml

@@ -2,7 +2,12 @@ timeout: 1800s # 30m
 substitutions:
   _CLUSTER_NAME: cluster-1
   _CLUSTER_LOCATION: europe-west2-b
-  _APP_VERSION: 1.1.0-gcm.1
+  # The deployer version must always be a minor version at any time since
+  # the Marketplace UI will only accept minor tags for the deployer.
+  _DEPLOYER_VERSION: "1.1"
+  # The _APP_VERSION must be equal to the value set on the publishedVersion
+  # field in schema.yaml.
+  _APP_VERSION: "1.1.0-gcm.1"
   _SOLUTION_NAME: jetstack-secure-for-cert-manager
 steps:
   - id: pull-ubbagent
@@ -58,7 +63,8 @@ steps:
     waitFor:
       - "-"
 
-  - id: build-deployer
+  # We push a deployer:1.1.0-gcm.1 for our debugging purposes.
+  - id: build-deployer-using-app-version
     name: gcr.io/cloud-builders/docker
     args:
       - build
@@ -67,13 +73,32 @@ steps:
       - "."
     waitFor: ["set-data-test-schema-default-values"]
 
-  - id: push-deployer
+  - id: push-deployer-using-app-version
     name: gcr.io/cloud-builders/docker
     args:
       - push
       - gcr.io/$PROJECT_ID/${_SOLUTION_NAME}/deployer:${_APP_VERSION}
     waitFor:
-      - build-deployer
+      - build-deployer-using-app-version
+
+  # The tag deployer:1.1 (for example) is the actual "important" image
+  # since it is the one that will be used in the Marketplace UI.
+  - id: tag-deployer-using-minor-version
+    name: gcr.io/cloud-builders/docker
+    args:
+      - tag
+      - gcr.io/$PROJECT_ID/${_SOLUTION_NAME}/deployer:${_APP_VERSION}
+      - gcr.io/$PROJECT_ID/${_SOLUTION_NAME}/deployer:${_DEPLOYER_VERSION}
+    waitFor:
+      - build-deployer-using-app-version
+
+  - id: push-deployer-using-minor-version
+    name: gcr.io/cloud-builders/docker
+    args:
+      - push
+      - gcr.io/$PROJECT_ID/${_SOLUTION_NAME}/deployer:${_APP_VERSION}
+    waitFor:
+      - tag-deployer-using-minor-version
 
   - id: gcloud-credentials
     name: gcr.io/cloud-builders/gcloud

docs/TESTING-DEPLOYER.md

@@ -20,16 +20,19 @@ the image embeds:
 - The `helm` tool,
 - The Helm charts for cert-manager, google-cas-issuer and preflight.
 
-The deployer image looks like this:
+There are two deployer tags:
 
 ```sh
+# The main moving tag required by the Marketplace UI:
 marketplace.gcr.io/jetstack-public/jetstack-secure-for-cert-manager/deployer:1.1
+
+# A static tag for debugging purposes:
+marketplace.gcr.io/jetstack-public/jetstack-secure-for-cert-manager/deployer:1.1.0-gcm.1
 ```
 
-We provide one single tag for the deployer image. That is due to the fact
-that the Marketplace UI only works with minor versions (e.g., `1.1`). If we
-were to push other tags (e.g., `1.1.0` or `1.1.0-gcm.1`), they would not be
-used anyways:
+The minor tag `1.1` (for example) is the tag that the Marketplace UI needs.
+The other tags (e.g., `1.1.0` or `1.1.0-gcm.1`) cannot be used for the
+Marketplace UI:
 
 > A version should correspond to a minor version (e.g. `1.0`) according to
 > semantic versioning  (not a patch version, such as `1.1.0`). Update the
@@ -41,9 +44,9 @@ In the below screenshot, we see that both the deployer tags `1.1.0` and
 
 <img src="https://user-images.githubusercontent.com/2195781/110091031-491bed00-7d98-11eb-8522-ddc91913d010.png" width="500" alt="Only the minor version 1.1 should be pushed, not 1.1.0 or 1.1.0-gcm.1. This screenshot is stored in this issue: https://github.com/jetstack/jetstack-secure-gcm/issues/21">
 
-Important: although we only push the minor tag for the deployer image, we
-still push "full" tags for all the other images. For example, let us
-imagine that `deployer:1.1` was created with this `schema.yaml`:
+Note that we only push full tags (e.g., `1.1.0-gcm.1`) for all the other
+images. For example, let us imagine that `deployer:1.1` was created with
+this `schema.yaml`:
 
 ```yaml
 # schema.yaml
@@ -82,6 +85,7 @@ As a recap about image tags, here is what the tags look like now, taking
 ```sh
 # The deployer image is built and pushed in cloudbuild.yaml:
 gcr.io/jetstack-public/jetstack-secure-for-cert-manager/deployer:1.1
+gcr.io/jetstack-public/jetstack-secure-for-cert-manager/deployer:1.1.0-gcm.1
 
 # These images are manually pushed (see below command):
 gcr.io/jetstack-public/jetstack-secure-for-cert-manager:1.1.0-gcm.1 # this is cert-manager-controller