Skip to content

Latest commit

 

History

History
144 lines (102 loc) · 5.81 KB

promotion-pull-requests.md

File metadata and controls

144 lines (102 loc) · 5.81 KB
Raw

Creating Promotion Pull Requests

DISCLAIMER: This document was originally written for Release Managers, but can be adapted to be used for any subproject.

Please feel free to propose PRs to adjust the language as needed.

When cutting a new Kubernetes release, we need to publish images to the k8s-staging-kubernetes GCS Bucket and then promote them to the production.

The Image Promotion should be done after Official Stage is completed and there are no errors.

Preparing Environment

First, take the following steps to prepare your environment for promoting images:

  • Install the promotion tooling:

    go install sigs.k8s.io/promo-tools/v4/cmd/kpromo@latest

    Note: If kpromo has not yet published a minor release and you desire to run the actual latest version. Specify it explicitly with the full version, for example: go install sigs.k8s.io/promo-tools/v4/cmd/[email protected].

  • Promoting images will require a GitHub Personal Access Token in order to create a PR on your behalf.

    If you have not already created a token, you can do so by following these instructions and using the appropriate token scopes:

    • public_repo

    Once you have a personal access token, make it available to your environment:

     export GITHUB_TOKEN="ghp-xxxxxxxxxxxxxxxxxxx"

    Note the whitespace preceding the export command (which will prevent the token from being logged in your terminal's history.)

Promoting Images

The images are promoted by using the kpromo pr command.

Usage:
  kpromo pr [flags]

Flags:
      --fork string        the user's fork of kubernetes/k8s.io
  -h, --help               help for pr
  -i, --interactive        interactive mode, asks before every step
      --project string     the name of the project to promote images for (default "kubernetes")
      --reviewers string   the list of GitHub users or teams to assign to the PR (default "@kubernetes/release-engineering")
  -t, --tag strings        version tag of the images we will promote

Example:

kpromo pr -i --fork=<your-github-username> --tag=v1.20.0-rc.0 --tag=v1.21.0-alpha.0

Note: The images that are promoted depend on the release you're cutting:

  • Alpha or Beta release: promote the images for the release you're cutting (e.g. v1.20.0-beta.1)
  • The first RC (e.g. v1.20.0-rc.0): promote the images for the RC and for the next minor alpha release (e.g. v1.21.0-alpha.0)
  • The subsequent RCs (e.g. v1.20.0-rc.1): promote the images for the RC you're cutting (e.g. v1.20.0-rc.0)
  • A stable release (e.g. v1.20.0): promote the images for the release you're cutting and for the RC of the next patch release (e.g. v1.20.1-rc.0)

The following steps are taken by the kpromo pr command:

  • Clone and update your kubernetes/k8s.io fork
  • Update the images manifest (k8s.gcr.io/images/k8s-staging-kubernetes/images.yaml) to add the image digests for specified releases/tags
  • Create a branch and push it to your fork
  • Create a PR in the kubernetes/k8s.io repository with an explicit /hold

Example PRs:

Completing the Image Promotion

Once the kpromo pr command is done take the following steps to complete image promotion and continue the release process:

  • Edit the PR description to add links for GCB jobs for Mock Stage, Mock Release, and Official Stage steps, or a link to the release tracking issue which includes the needed links
  • Once the PR is approved by Release Managers lift the hold and proceed with the release process
  • After the Pull Request is merged and before starting the Official Release step, we need to watch the following Prow Job to succeed. When the latest master ran without errors, then we can continue with Official Release.

Deprecated

cip-mm

cip-mm is deprecated and will be removed in a future release.

These instructions will temporarily remain for existing consumers (as kpromo mm), but please begin to use kpromo pr (which is described in more detail above) instead.

This tool modifies promoter manifests. For now it dumps some filtered subset of a staging GCR and merges those contents back into a given promoter manifest.

Examples

  • Add all images with a matching digest from staging repo gcr.io/k8s-staging-artifact-promoter to a manifest, using the name and tags already existing in the staging repo:

    kpromo mm \
  --base_dir=$HOME/go/src/github.com/kubernetes/k8s.io/k8s.gcr.io  \
  --staging_repo=gcr.io/k8s-staging-artifact-promoter \
  --filter_digest=sha256:7594278deaf6eeaa35caedec81796d103e3c83a26d7beab091a5d25a9ba6aa16

  • Add a single image named "foo" and tagged "1.0" from staging repo gcr.io/k8s-staging-artifact-promoter to a manifest:

    kpromo mm \
  --base_dir=$HOME/go/src/github.com/kubernetes/k8s.io/k8s.gcr.io  \
  --staging_repo=gcr.io/k8s-staging-artifact-promoter \
  --filter_image=cip \
  --filter_tag=1.0

  • Add all images tagged 1.0 from staging repo gcr.io/k8s-staging-artifact-promoter to a manifest:

    kpromo mm \
  --base_dir=$HOME/go/src/github.com/kubernetes/k8s.io/k8s.gcr.io  \
  --staging_repo=gcr.io/k8s-staging-artifact-promoter \
  --filter_image=cip \
  --filter_tag=1.0