feat(release): update image promotion to use kpromo

richardcase · richardcase · commit 5fe6b8d34983 · 2023-03-21T12:54:25.000Z
The release process has been updated to use `kpromo` for handling
the image promotion instead of the manual process we had.

Signed-off-by: Richard Case &lt;richard.case@outlook.com&gt;
diff --git a/Makefile b/Makefile
@@ -24,7 +24,7 @@ ARTIFACTS ?= $(REPO_ROOT)/_artifacts
 TOOLS_DIR := hack/tools
 TOOLS_DIR_DEPS := $(TOOLS_DIR)/go.sum $(TOOLS_DIR)/go.mod $(TOOLS_DIR)/Makefile
 TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
-GO_INSTALL := ./scripts/go_install.sh
+
 
 API_DIRS := cmd/clusterawsadm/api api exp/api controlplane/eks/api bootstrap/eks/api iam/api
 API_FILES := $(foreach dir, $(API_DIRS), $(call rwildcard,../../$(dir),*.go))
@@ -59,6 +59,8 @@ KIND := $(TOOLS_BIN_DIR)/kind
 KUSTOMIZE := $(TOOLS_BIN_DIR)/kustomize
 MOCKGEN := $(TOOLS_BIN_DIR)/mockgen
 SSM_PLUGIN := $(TOOLS_BIN_DIR)/session-manager-plugin
+YQ := $(TOOLS_BIN_DIR)/yq
+KPROMO := $(TOOLS_BIN_DIR)/kpromo
 CLUSTERAWSADM_SRCS := $(call rwildcard,.,cmd/clusterawsadm/*.*)
 
 PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
@@ -74,6 +76,12 @@ else
 	export GOPATH := $(shell go env GOPATH)
 endif
 
+USER_FORK ?= $(shell git config --get remote.origin.url | cut -d/ -f4) # only works on https://github.com/<username>/cluster-api.git style URLs
+ifeq ($(USER_FORK),)
+USER_FORK := $(shell git config --get remote.origin.url | cut -d: -f2 | cut -d/ -f1) # for git@github.com:<username>/cluster-api.git style URLs
+endif
+IMAGE_REVIEWERS ?= $(shell ./hack/get-project-maintainers.sh ${YQ})
+
 # Release variables
 
 STAGING_REGISTRY ?= gcr.io/k8s-staging-cluster-api-aws
@@ -569,6 +577,10 @@ release-manifests: ## Release manifest files
 release-changelog: $(GH) ## Generates release notes using Github release notes.
 	./hack/releasechangelog.sh -v $(VERSION) -p $(PREVIOUS_VERSION) -o $(GH_ORG_NAME) -r $(GH_REPO_NAME) -c $(CORE_CONTROLLER_PROMOTED_IMG) > $(RELEASE_DIR)/CHANGELOG.md
 
+.PHONY: promote-images
+promote-images: $(KPROMO) $(YQ)
+	$(KPROMO) pr --project cluster-api-provider-aws --tag $(RELEASE_TAG) --reviewers "$(IMAGE_REVIEWERS)" --fork $(USER_FORK) --image cluster-api-aws-controller
+
 .PHONY: release-binaries
 release-binaries: ## Builds the binaries to publish with a release
 	RELEASE_BINARY=./cmd/clusterawsadm GOOS=linux GOARCH=amd64 $(MAKE) release-binary
diff --git a/common.mk b/common.mk
@@ -28,6 +28,8 @@ TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
 UID := $(shell id -u)
 GID := $(shell id -g)
 
+GO_INSTALL := $(ROOT_DIR_RELATIVE)/scripts/go_install.sh
+
 rwildcard=$(foreach d,$(wildcard $(1:=/*)),$(call rwildcard,$d,$2) $(filter $(subst *,%,$2),$d))
 
 # Hosts running SELinux need :z added to volume mounts
diff --git a/docs/book/src/development/imagepromo1.png b/docs/book/src/development/imagepromo1.png
diff --git a/docs/book/src/development/releasing.md b/docs/book/src/development/releasing.md
@@ -21,27 +21,34 @@
 
 ## Promote container images from staging to production
 
-Promote the container images by following the steps below. (For background information, see [this](https://github.com/kubernetes/k8s.io/tree/main/k8s.gcr.io#image-promoter).)
+Promote the container images from the staging registry to the production registry (`registry.k8s.io/cluster-api-provider-aws`) by following the steps below.
 
-1.  Navigate to the the staging repository [dashboard](https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-aws/GLOBAL).
-1.  Choose the _top level_ [cluster-api-aws-controller](https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-aws/GLOBAL/cluster-api-aws-controller?gcrImageListsize=30) image. Only the top level image provides the multi-arch manifest, rather than one for a specific architecture.
-1.  Wait for an image to appear with the tagged release version:
-    ![image promotion](./imagepromo1.png)
-1.  Click on the `Copy full image name` icon.
-1.  Create your own fork of `kubernetes/k8s.io` in GitHub.
-1.  Clone and pull down the latest from [kubernetes/k8s.io](https://github.com/kubernetes/k8s.io).
-1.  Create a new branch in your fork of `kubernetes/k8s.io`.
-1.  In your `kubernetes/k8s.io` branch edit `k8s.gcr.io/images/k8s-staging-cluster-api-aws/images.yaml` and add an try for the version using the pasted value from earlier. For example: `"sha256:06ce7b97f9fe116df65c293deef63981dec3e33dec9984b8a6dd0f7dba21bb32": ["v0.6.4"]`
-1.  Create a PR with your change, following [this PR](https://github.com/kubernetes/k8s.io/pull/1565) as example.
-1.  Wait for the PR to be approved (typically by CAPA maintainers authorized to merge PRs into the k8s.io repository) and merged.
+1. Navigate to the the staging repository [dashboard](https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-aws/GLOBAL).
+2. Choose the _top level_ [cluster-api-aws-controller](https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-aws/GLOBAL/cluster-api-aws-controller?gcrImageListsize=30) image. Only the top level image provides the multi-arch manifest, rather than one for a specific architecture.
+3. Wait for an image to appear with the tagged release version.
+4. If you don't have a GitHub token, create one by going to your GitHub settings, in [Personal access tokens](https://github.com/settings/tokens). Make sure you give the token the `repo` scope.
+5. Create a PR to promote the images:
+    ```bash
+    export GITHUB_TOKEN=<your GH token>
+    make promote-images
+    ```
+    **Notes**:
+     * `kpromo` uses `git@github.com:...` as remote to push the branch for the PR. If you don't have `ssh` set up you can configure
+       git to use `https` instead via `git config --global url."https://github.com/".insteadOf git@github.com:`.
+     * This will automatically create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the CAPA maintainers.
+6. Wait for the PR to be approved (typically by CAPA maintainers authorized to merge PRs into the k8s.io repository) and merged.
+7. Verify the images are available in the production registry:
+    ```bash
+    docker pull registry.k8s.io/cluster-api-provider-aws/cluster-api-aws-controller:${RELEASE_TAG}
+    ```
 
 ## Create release artifacts, and a GitHub draft release
 
-1.  Again, make sure your repo is clean by git standards.
-1.  Export the current branch `export BRANCH=release-1.5` (`export BRANCH=main`)and run `make release`.
-1.  Run `make create-gh-release` to create a draft release on Github, copying the generated release notes from `out/CHANGELOG.md` into the draft.
-1.  Run `make upload-gh-artifacts` to upload artifacts from .out/ directory. You may run into API limit errors, so verify artifacts at next step.
-1.  Verify that all the files below are attached to the drafted release:
+1. Again, make sure your repo is clean by git standards.
+1. Export the current branch `export BRANCH=release-1.5` (`export BRANCH=main`)and run `make release`.
+1. Run `make create-gh-release` to create a draft release on Github, copying the generated release notes from `out/CHANGELOG.md` into the draft.
+1. Run `make upload-gh-artifacts` to upload artifacts from .out/ directory. You may run into API limit errors, so verify artifacts at next step.
+1. Verify that all the files below are attached to the drafted release:
     1. `clusterawsadm-darwin-amd64`
     1. `clusterawsadm-linux-amd64`
     1. `infrastructure-components.yaml`
@@ -54,11 +61,11 @@ Promote the container images by following the steps below. (For background infor
     1. `eks-controlplane-components.yaml`
     1. `eks-bootstrap-components.yaml`
     1. `metadata.yaml`
-1.  Finalise the release notes by editing the draft release.
+1. Finalise the release notes by editing the draft release.
 
 ## Publish the draft release
 
-1.  Make sure image promotion is complete before publishing the release draft. The promotion job logs can be found [here](https://testgrid.k8s.io/sig-k8s-infra-k8sio#post-k8sio-image-promo) and you can also try and pull the images (i.e. ``docker pull registry.k8s.io/cluster-api-aws/cluster-api-aws-controller:v0.6.4`).
-1.  Publish release. Use the pre-release option for release
+1. Make sure image promotion is complete before publishing the release draft. The promotion job logs can be found [here](https://testgrid.k8s.io/sig-k8s-infra-k8sio#post-k8sio-image-promo) and you can also try and pull the images (i.e. ``docker pull registry.k8s.io/cluster-api-aws/cluster-api-aws-controller:v0.6.4`).
+1. Publish release. Use the pre-release option for release
      candidate versions of Cluster API Provider AWS.
-1.  Email `kubernetes-sig-cluster-lifecycle@googlegroups.com` to announce the release.
+1. Email `kubernetes-sig-cluster-lifecycle@googlegroups.com` to announce the release.
diff --git a/hack/get-project-maintainers.sh b/hack/get-project-maintainers.sh
@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+if [[ "${TRACE-0}" == "1" ]]; then
+    set -o xtrace
+fi
+
+if [ -z "${1}" ]; then
+  echo "must provide path to yq as first parameter"
+  exit 1
+fi
+
+KEYS=()
+while IFS='' read -r line; do KEYS+=("$line"); done < <(${1} e '.aliases["cluster-api-aws-maintainers"][]' OWNERS_ALIASES)
+echo "${KEYS[@]/#/@}"
diff --git a/hack/tools/Makefile b/hack/tools/Makefile
@@ -19,6 +19,7 @@ UNAME := $(shell uname -s)
 
 # Directories.
 BIN_DIR := bin
+BIN_DIR_ABS := $(abspath $(BIN_DIR))
 SHARE_DIR := share
 
 OS := $(shell go env GOOS)
@@ -154,6 +155,26 @@ $(PLANTUML): plantuml.Dockerfile ../../versions.mk
 	docker build --build-arg PLANTUML_VERSION=$(PLANTUML_VERSION)  . -f plantuml.Dockerfile -t "plantuml-builder"
 	touch $@
 
+KPROMO_BIN := kpromo
+KPROMO :=  $(abspath $(BIN_DIR)/$(KPROMO_BIN)-$(KPROMO_VER))
+KPROMO_PKG := sigs.k8s.io/promo-tools/v3/cmd/kpromo
+
+.PHONY: $(KPROMO_BIN)
+$(KPROMO_BIN): $(KPROMO) ## Build a local copy of kpromo
+
+$(KPROMO):
+	GOBIN=$(BIN_DIR_ABS) $(GO_INSTALL) $(KPROMO_PKG) $(KPROMO_BIN) ${KPROMO_VERSION}
+
+YQ_BIN := yq
+YQ :=  $(abspath $(BIN_DIR)/$(YQ_BIN)-$(YQ_VERSION))
+YQ_PKG := github.com/mikefarah/yq/v4
+
+.PHONY: $(YQ_BIN)
+$(YQ_BIN): $(YQ) ## Build a local copy of yq
+
+$(YQ):
+	GOBIN=$(BIN_DIR_ABS) $(GO_INSTALL) $(YQ_PKG) $(YQ_BIN) ${YQ_VERSION}
+
 ## ------------------------------------------------------------------------------------------------
 ## AWS Session Manager Plugin Installation. Currently support Linux and MacOS AMD64 architectures.
 ## ------------------------------------------------------------------------------------------------
diff --git a/scripts/go_install.sh b/scripts/go_install.sh
@@ -40,6 +40,6 @@ fi
 rm "${GOBIN}/${2}"* || true
 
 # install the golang module specified as the first argument
-go install -tags tools "${1}@${3}"
+go install "${1}@${3}"
 mv "${GOBIN}/${2}" "${GOBIN}/${2}-${3}"
 ln -sf "${GOBIN}/${2}-${3}" "${GOBIN}/${2}"
diff --git a/versions.mk b/versions.mk
@@ -17,3 +17,5 @@ PLANTUML_VERSION := 1.2020.16
 GH_VERSION := 2.7.0
 CERT_MANAGER_VERSION := v1.10.1
 CAPI_VERSION := v1.3.5
+KPROMO_VERSION := v3.5.1
+YQ_VERSION := v4.25.2
