From 94f1c7dd8d4309b0886047b2d6491e1b7e43d60d Mon Sep 17 00:00:00 2001 From: Sean Malloy Date: Thu, 3 Dec 2020 00:44:19 -0600 Subject: [PATCH] Document Multi-Arch Container Image Usage --- docs/release-guide.md | 2 +- docs/user-guide.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/release-guide.md b/docs/release-guide.md index 9a0adeb14..d780a772e 100644 --- a/docs/release-guide.md +++ b/docs/release-guide.md @@ -20,7 +20,7 @@ 3. Push the release branch to the descheuler repo and ensure branch protection is enabled (not required for patch releases) 4. Tag the repository from the `master` branch (from the `release-1.18` branch for a patch release) and push the tag `VERSION=v0.18.0 git tag -m $VERSION $VERSION; git push origin $VERSION` 5. Checkout the tag you just created and make sure your repo is clean by git's standards `git checkout $VERSION` -6. Build and push the container image to the staging registry `VERSION=$VERSION make push` +6. Build and push the container image to the staging registry `VERSION=$VERSION make push-all` 7. Publish a draft release using the tag you just created 8. Perform the [image promotion process](https://github.com/kubernetes/k8s.io/tree/master/k8s.gcr.io#image-promoter) 9. Publish release diff --git a/docs/user-guide.md b/docs/user-guide.md index 342d75cfe..63a371e25 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -3,6 +3,16 @@ Starting with descheduler release v0.10.0 container images are available in the official k8s container registry. * `k8s.gcr.io/descheduler/descheduler` +Also, starting with descheduler release v0.20.0 multi-arch container images are provided. Currently AMD64 and ARM64 +container images are provided. Multi-arch container images cannot be pulled by [kind](https://kind.sigs.k8s.io) from +a registry. Therefore starting with descheduler release v0.20.0 use the below process to download the official descheduler +image into a kind cluster. +``` +kind create cluster +docker pull k8s.gcr.io/descheduler/descheduler:v0.20.0 +kind load docker-image k8s.gcr.io/descheduler/descheduler:v0.20.0 +``` + ## Policy Configuration Examples The [examples](https://github.com/kubernetes-sigs/descheduler/tree/master/examples) directory has descheduler policy configuration examples.