From 552e1549ba9077826b8173fcad613d916b3775e3 Mon Sep 17 00:00:00 2001 From: Oz N Tiram Date: Tue, 29 Jun 2021 22:28:27 +0200 Subject: [PATCH] Build: improve documentation of build artifacts As described in #100596 this can surprise newcomers. This adds a paragraph which explains where are the build artifacts are and how to use the docker images produced by the build system. --- build/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/build/README.md b/build/README.md index 02f75e271ef..aae79da4bf4 100644 --- a/build/README.md +++ b/build/README.md @@ -44,6 +44,12 @@ There are 3 different containers instances that are run from this image. The fi All Docker names are suffixed with a hash derived from the file path (to allow concurrent usage on things like CI machines) and a version number. When the version number changes all state is cleared and clean build is started. This allows the build infrastructure to be changed and signal to CI systems that old artifacts need to be deleted. +## Build artifacts +The build system output all its products to a top level directory in the source repository named `_output`. +These include the binary compiled packages (e.g. kubectl, kube-scheduler etc.) and archived Docker images. +If you intend to run a component with a docker image you will need to import it from this directory with +the appropriate command (e.g. `docker import _output/release-images/amd64/kube-scheduler.tar k8s.io/kube-scheduler:$(git describe)`). + ## Releasing The [`build/release.sh`](release.sh) script will build a release. It will build binaries, run tests, (optionally) build runtime Docker images. @@ -78,4 +84,4 @@ example, you could use the following one-liner: ```bash SOURCE_DATE_EPOCH=$(git show -s --format=format:%ct HEAD) -``` \ No newline at end of file +```