Building Multi-arch images with Manifests

[dims]

In 1.12, a variety of images used in a typical kubernetes installation
have started to using manifests to better support environments with arm
or ppc64le architectures. For example all images used with kubeadm by
default have manifests, another would be all the tests in the
conformance test suite. Here we capture the best practices for everyone
to start using manifests in their own workflows.

[k8sio-netlify-preview-bot]

Deploy preview for kubernetes-io-vnext-staging processing.

Built with commit ed5ec29

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5baa0a7ab13fb17fa6a4d372

[dims]

cc @yujuhong @Random-Liu @mkumatag @ixdy

[k8sio-netlify-preview-bot]

Deploy preview for kubernetes-io-vnext-staging processing.

Built with commit 6179e11

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5baa50d967610c7c6df028f5

[neolit123]

thanks for the writeup @dims 👍
added a couple of minor comments.

[zparnold]

/assign

…

On Tue, Sep 25, 2018, 6:52 AM Lubomir I. Ivanov ***@***.***> wrote: ***@***.**** commented on this pull request. thanks for the writeup @dims <https://github.com/dims> 👍 added a couple of minor comments. ------------------------------ In content/en/docs/concepts/containers/images.md <#10379 (comment)>: > + +Docker CLI now supports the following command `docker manifest` with sub commands like `create`, `annotate` and `push`, these commands can be used to build and push the manifests. You can use `docker manifest inspect` to view the manifest. + +Please see docker documentation here: +https://docs.docker.com/edge/engine/reference/commandline/manifest/ + +See examples on how we use this in our build harness: +https://cs.k8s.io/?q=docker%20manifest%20(create%7Cpush%7Cannotate)&i=nope&files=&repos= + +These commands rely on and are implemented purely on the docker CLI. You will need to either edit the `$HOME/.docker/config.json` and set `experimental` key to `enabled` or you can just set `DOCKER_CLI_EXPERIMENTAL` environment variable to `enabled` when you call the CLI commands. + +**Please use Docker *18.06* or above**, versions below that either have bugs or do not support the experimental command line option. Example docker/cli#1135 causes problems under containerd + +If you run into trouble with uploading stale manifests, just clean up the older manifests in `$HOME/.docker/manifests` to start fresh. + +For Kubernetes, we have typically minted images with suffix `-$(ARCH)` (example - `-amd64`), So for backward compatability, please generate the older images with suffixes. The idea is to generate say `pause` image which has the manifest for all the arch(es) and say `pause-amd64` which is backwards compatible for older yamls which may have hard coded the images with suffixes. Over time we can get rid of all the old usages. minted i never understood what this verb means. :) , So for backward compatability, 'so' should be lower case. older yamls older configurations or older YAML files ? Over time we can get rid of all the old usages. about this, probably best to keep the -arch support (backwards compat) indefinitely. it gives a way to pull an exact arch image. 👍 ------------------------------ In content/en/docs/concepts/containers/images.md <#10379 (comment)>: > @@ -34,6 +34,24 @@ pull image policy of `Always` correspondingly. Note that you should avoid using `:latest` tag, see [Best Practices for Configuration](/docs/concepts/configuration/overview/#container-images) for more information. +## Building Multi-arch images with Manifests + +Docker CLI now supports the following command `docker manifest` with sub commands like `create`, `annotate` and `push`, these commands can be used to build and push the manifests. You can use `docker manifest inspect` to view the manifest. + +Please see docker documentation here: +https://docs.docker.com/edge/engine/reference/commandline/manifest/ + +See examples on how we use this in our build harness: +https://cs.k8s.io/?q=docker%20manifest%20(create%7Cpush%7Cannotate)&i=nope&files=&repos= + +These commands rely on and are implemented purely on the docker CLI. You will need to either edit the `$HOME/.docker/config.json` and set `experimental` key to `enabled` or you can just set `DOCKER_CLI_EXPERIMENTAL` environment variable to `enabled` when you call the CLI commands. docker CLI -> Docker CLI — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#10379 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AE81SFlWXT-2-wt6i0IhebnPeZu2wttgks5uejURgaJpZM4W4S4y> .

[zparnold]

/approve
/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zparnold

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [zparnold]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[yujuhong]

Thanks for adding the warning!