Skip to content

Commit aa77632

Browse files
committed
Document --platform flag in README.md
1 parent 27676b1 commit aa77632

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,19 @@ kubectl logs kodata
439439
2018/07/19 23:38:29 Hello there
440440
```
441441

442+
## Multi-Platform Images
443+
444+
If `ko` is invoked with `--platform=all`, for any image that it builds that is
445+
based on a multi-architecture image (e.g., the default
446+
`gcr.io/distroless/static:nonroot`, `busybox`, `alpine`, etc.), `ko` will
447+
attempt to build the Go binary using Go's cross-compilation support and produce
448+
a multi-architecture image, with support for each architecture supported by the
449+
base image.
450+
451+
If `ko` is invoked with `--platform=<some-platform>` (e.g., `--platform=amd64`
452+
or `--platform=arm64`), then it will attempt to build an image for that
453+
architecture only, assuming the base image supports it.
454+
442455
## Enable Autocompletion
443456

444457
To generate an bash completion script, you can run:

0 commit comments

Comments
 (0)