From d4619e27f39d8f6ac9512426b7d73a78ec671189 Mon Sep 17 00:00:00 2001 From: Jack Francis Date: Wed, 28 Sep 2022 15:23:59 -0700 Subject: [PATCH] docs: add more detail about reviewing image promotion PR --- docs/book/src/developers/development.md | 2 +- docs/book/src/developers/releasing.md | 11 +++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/book/src/developers/development.md b/docs/book/src/developers/development.md index 41097ac0c8b..8e4aeddeb35 100644 --- a/docs/book/src/developers/development.md +++ b/docs/book/src/developers/development.md @@ -522,7 +522,7 @@ With the following environment variables defined, you can build a CAPZ cluster f | Environment Variable | Value | |----------------------|--------| | `E2E_ARGS` | `-kubetest.use-ci-artifacts` | -| `KUBERNETES_VERSION` | `latest` - extract Kubernetes version from https://dl.k8s.io/ci/latest.txt (main's HEAD)
`latest-1.21` - extract Kubernetes version from https://dl.k8s.io/ci/latest-1.21.txt (release branch's HEAD) | +| `KUBERNETES_VERSION` | `latest` - extract Kubernetes version from https://dl.k8s.io/ci/latest.txt (main's HEAD)
`latest-1.25` - extract Kubernetes version from https://dl.k8s.io/ci/latest-1.25.txt (release branch's HEAD) | | `WINDOWS_FLAVOR` | Optional, can be `containerd` or `containerd-2022`, when not specified dockershim is used | | `KUBETEST_WINDOWS_CONFIG` | Optional, can be `upstream-windows-serial-slow.yaml`, when not specified `upstream-windows.yaml` is used | | `WINDOWS_CONTAINERD_URL` | Optional, can be any url to a `tar.gz` file containing binaries for containerd in the same format as upstream package | diff --git a/docs/book/src/developers/releasing.md b/docs/book/src/developers/releasing.md index a10bbfaac14..1b237333b0e 100644 --- a/docs/book/src/developers/releasing.md +++ b/docs/book/src/developers/releasing.md @@ -89,13 +89,19 @@ This will automatically trigger a [Github Action](https://github.com/kubernetes- ### Promote image to prod repo -- Images are built by the [post push images job](https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-azure#post-cluster-api-provider-azure-push-images). This will push the image to a [staging repository](https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-azure/GLOBAL/cluster-api-azure-controller?rImageListsize=30). +- Images are built by the [post push images job](https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-azure#post-cluster-api-provider-azure-push-images). This will push the image to a [staging repository][staging-repository]. - 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. - Wait for the above job to complete for the tag commit and for the image to exist in the staging directory, then create a PR to promote the image and tag: - `export GITHUB_TOKEN=` - `make promote-images` -This will automatically create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the CAPZ maintainers. Example PR: https://github.com/kubernetes/k8s.io/pull/3007. +This will automatically create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the CAPZ maintainers. Example PR: https://github.com/kubernetes/k8s.io/pull/4284. + +For reviewers of the above-created PR, to confirm that the resultant image SHA-to-tag addition is valid, you can check against the [staging repository][staging-repository]. + +Using [the above example PR](https://github.com/kubernetes/k8s.io/pull/4284), to verify that the image identified by SHA `d0636fad7f4ced58b5385615a53b7cb2053f79c4788bd299e0ac9e46a25b5053` has the expected `v1.4.3`, tag, you would inspect the image metadata by viewing it in the Google Container Registry UI: + +- https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-azure/global/cluster-api-azure-controller@sha256:d0636fad7f4ced58b5385615a53b7cb2053f79c4788bd299e0ac9e46a25b5053 ### Release in GitHub @@ -144,3 +150,4 @@ Here is a reference PR that applied the required test job changes following the [semver]: https://semver.org/#semantic-versioning-200 [template]: /docs/release-notes-template.md [versioning]: #versioning +[staging-repository]: https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api-azure/GLOBAL/cluster-api-azure-controller?rImageListsize=30