1
0
mirror of https://github.com/ko-build/ko.git synced 2025-02-13 19:42:26 +02:00

Document --platform flag in README.md (#211)

This commit is contained in:
Jason Hall 2020-10-14 15:57:15 -04:00 committed by GitHub
parent 2c4d75521e
commit 3691164421
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -431,6 +431,25 @@ kubectl logs kodata
2018/07/19 23:38:29 Hello there
```
## Multi-Platform Images
If `ko` is invoked with `--platform=all`, for any image that it builds that is
based on a multi-architecture image (e.g., the default
`gcr.io/distroless/static:nonroot`, `busybox`, `alpine`, etc.), `ko` will
attempt to build the Go binary using Go's cross-compilation support and produce
a multi-architecture [image
index](https://github.com/opencontainers/image-spec/blob/master/image-index.md)
(aka "manifest list"), with support for each OS and architecture pair supported
by the base image.
If `ko` is invoked with `--platform=<some-OS>/<some-platform>` (e.g.,
`--platform=linux/amd64` or `--platform=linux/arm64`), then it will attempt to
build an image for that OS and architecture only, assuming the base image
supports it.
When `--platform` is not provided, `ko` builds an image with the OS and
architecture based on the build environment's `GOOS` and `GOARCH`.
## Enable Autocompletion
To generate an bash completion script, you can run: