Fix up docker build scripts (linkerd#6781)

A few small improvements to our docker build scripts: * Centralized the list of docker images to a DOCKER_IMAGES variable defined in _docker.sh * Build scripts now honor the TAG variable, if defined * Unused docker-images script has been removed We also update the `--control-plane-version` Linkerd install flag to affect the policy controller version as well. Taken together, this enables the following workflow for building and deploying changes to individual Linkerd components. For example, suppose you wish to deploy changes which only affect the controller image: ```console # Begin by building all images at main with a dev tag > TAG=alex-dev bin/docker-build # OR begin by retagging all images from a recent release > bin/docker-retag-all edge-21.8.4 alex-dev # Make changes and then rebuild specific component > TAG=alex-dev bin/docker-build-controller # Load images into kind > TAG=alex-dev bin/image-load --kind --cluster alex # Install Linkerd > bin/linkerd install --control-plane-version alex-dev --proxy-version alex-dev | k apply -f - ``` Signed-off-by: Alex Leong <[email protected]>
abhijeetgauravm · Sep 1, 2021 · 8f15683 · 8f15683
1 parent ecd3970
commit 8f15683
Show file tree

Hide file tree

Showing 31 changed files with 81 additions and 91 deletions.
diff --git a/bin/_docker.sh b/bin/_docker.sh
@@ -26,6 +26,22 @@ export DOCKER_PUSH=${DOCKER_PUSH:-}
 # Default supported docker image architectures
 export SUPPORTED_ARCHS=${SUPPORTED_ARCHS:-linux/amd64,linux/arm64,linux/arm/v7}
 
+# Splitting of DOCKER_IMAGES variable is desired.
+# shellcheck disable=SC2206
+export DOCKER_IMAGES=(${DOCKER_IMAGES:-
+    cli-bin
+    cni-plugin
+    controller
+    policy-controller
+    metrics-api
+    debug
+    grafana
+    proxy
+    web
+    jaeger-webhook
+    tap
+})
+
 docker_repo() {
     repo=$1
 

diff --git a/bin/docker-build-cli-bin b/bin/docker-build-cli-bin
@@ -16,14 +16,13 @@ rootdir=$( cd "$bindir"/.. && pwd )
 . "$bindir"/_tag.sh
 
 dockerfile=$rootdir/cli/Dockerfile
-tag=$(head_root_tag)
 
 # shellcheck disable=SC2046
-docker_build cli-bin "$tag" "$dockerfile" \
-    --build-arg LINKERD_VERSION="$tag" \
+docker_build cli-bin "${TAG:-$(head_root_tag)}" "$dockerfile" \
+    --build-arg LINKERD_VERSION="${TAG:-$(head_root_tag)}" \
     --target="$DOCKER_TARGET"
 
-IMG=$(docker_repo cli-bin):$tag
+IMG=$(docker_repo cli-bin):${TAG:-$(head_root_tag)}
 ID=$(docker create "$IMG")
 
 # copy the newly built linkerd cli binaries to the local system

diff --git a/bin/docker-build-cni-plugin b/bin/docker-build-cni-plugin
@@ -17,4 +17,4 @@ rootdir=$( cd "$bindir"/.. && pwd )
 
 dockerfile=$rootdir/cni-plugin/Dockerfile
 
-docker_build cni-plugin "$(head_root_tag)" "$dockerfile"
+docker_build cni-plugin "${TAG:-$(head_root_tag)}" "$dockerfile"
diff --git a/bin/docker-build-controller b/bin/docker-build-controller
@@ -16,5 +16,4 @@ rootdir=$( cd "$bindir"/.. && pwd )
 . "$bindir"/_tag.sh
 
 dockerfile=$rootdir/controller/Dockerfile
-tag=$(head_root_tag)
-docker_build controller "$tag" "$dockerfile" --build-arg LINKERD_VERSION="$tag"
+docker_build controller "${TAG:-$(head_root_tag)}" "$dockerfile" --build-arg LINKERD_VERSION="${TAG:-$(head_root_tag)}"
diff --git a/bin/docker-build-debug b/bin/docker-build-debug
@@ -17,4 +17,4 @@ rootdir=$( cd "$bindir"/.. && pwd )
 
 dockerfile=$rootdir/Dockerfile-debug
 
-docker_build debug "$(head_root_tag)" "$dockerfile"
+docker_build debug "${TAG:-$(head_root_tag)}" "$dockerfile"
diff --git a/bin/docker-build-grafana b/bin/docker-build-grafana
@@ -17,4 +17,4 @@ rootdir=$( cd "$bindir"/.. && pwd )
 
 dockerfile=$rootdir/grafana/Dockerfile
 
-docker_build grafana "$(head_root_tag)" "$dockerfile"
+docker_build grafana "${TAG:-$(head_root_tag)}" "$dockerfile"
diff --git a/bin/docker-build-jaeger-webhook b/bin/docker-build-jaeger-webhook
@@ -16,6 +16,5 @@ rootdir=$( cd "$bindir"/.. && pwd )
 . "$bindir"/_tag.sh
 
 dockerfile=$rootdir/jaeger/injector/Dockerfile
-tag=$(head_root_tag)
-docker_build jaeger-webhook "$tag" "$dockerfile" --build-arg LINKERD_VERSION="$tag"
+docker_build jaeger-webhook "${TAG:-$(head_root_tag)}" "$dockerfile" --build-arg LINKERD_VERSION="${TAG:-$(head_root_tag)}"
 
diff --git a/bin/docker-build-metrics-api b/bin/docker-build-metrics-api
@@ -16,6 +16,5 @@ rootdir=$( cd "$bindir"/.. && pwd )
 . "$bindir"/_tag.sh
 
 dockerfile=$rootdir/viz/metrics-api/Dockerfile
-tag=$(head_root_tag)
-docker_build metrics-api "$tag" "$dockerfile"
+docker_build metrics-api "${TAG:-$(head_root_tag)}" "$dockerfile"
 
diff --git a/bin/docker-build-policy-controller b/bin/docker-build-policy-controller
@@ -19,6 +19,5 @@ if [ "$DOCKER_TARGET" = 'multi-arch' ]; then
     exit 1
 fi
 
-tag=$(head_root_tag)
 ROOTDIR=$( cd "$bindir"/../policy-controller && pwd )
-docker_build policy-controller "$tag" "$ROOTDIR/amd64.dockerfile"
+docker_build policy-controller "${TAG:-$(head_root_tag)}" "$ROOTDIR/amd64.dockerfile"
diff --git a/bin/docker-build-proxy b/bin/docker-build-proxy
@@ -25,9 +25,8 @@ get_extra_options() {
     echo "$options"
 }
 
-tag=$(head_root_tag)
 # We want wordsplit for the extra options here:
 # shellcheck disable=SC2046
-docker_build proxy "$tag" "$dockerfile" \
-  --build-arg "LINKERD_VERSION=$tag" \
+docker_build proxy "${TAG:-$(head_root_tag)}" "$dockerfile" \
+  --build-arg "LINKERD_VERSION=${TAG:-$(head_root_tag)}" \
   $(get_extra_options)
diff --git a/bin/docker-build-tap b/bin/docker-build-tap
@@ -16,5 +16,4 @@ rootdir=$( cd "$bindir"/.. && pwd )
 . "$bindir"/_tag.sh
 
 dockerfile=$rootdir/viz/tap/Dockerfile
-tag=$(head_root_tag)
-docker_build tap "$tag" "$dockerfile"
+docker_build tap "${TAG:-$(head_root_tag)}" "$dockerfile"
diff --git a/bin/docker-build-web b/bin/docker-build-web
@@ -16,5 +16,4 @@ rootdir=$( cd "$bindir"/.. && pwd )
 . "$bindir"/_tag.sh
 
 dockerfile=$rootdir/web/Dockerfile
-tag=$(head_root_tag)
-docker_build web "$tag" "$dockerfile" --build-arg LINKERD_VERSION="$tag"
+docker_build web "${TAG:-$(head_root_tag)}" "$dockerfile" --build-arg LINKERD_VERSION="${TAG:-$(head_root_tag)}"
diff --git a/bin/docker-images b/bin/docker-images
diff --git a/bin/docker-pull b/bin/docker-pull
@@ -14,6 +14,6 @@ bindir=$( cd "${BASH_SOURCE[0]%/*}" && pwd )
 # shellcheck source=_docker.sh
 . "$bindir"/_docker.sh
 
-for img in cli-bin cni-plugin controller metrics-api debug grafana proxy web jaeger-webhook tap; do
-    docker_pull $img "$tag"
+for img in "${DOCKER_IMAGES[@]}"; do
+    docker_pull "$img" "$tag"
 done
diff --git a/bin/docker-push b/bin/docker-push
@@ -14,6 +14,6 @@ bindir=$( cd "${BASH_SOURCE[0]%/*}" && pwd )
 # shellcheck source=_docker.sh
 . "$bindir"/_docker.sh
 
-for img in cli-bin cni-plugin controller metrics-api debug grafana proxy web jaeger-webhook tap; do
-    docker_push $img "$tag"
+for img in "${DOCKER_IMAGES[@]}"; do
+    docker_push "$img" "$tag"
 done
diff --git a/bin/docker-retag-all b/bin/docker-retag-all
@@ -13,7 +13,6 @@ bindir=$( cd "${BASH_SOURCE[0]%/*}" && pwd )
 
 # shellcheck source=_docker.sh
 . "$bindir"/_docker.sh
-
-for img in cli-bin cni-plugin controller debug grafana proxy web ; do
-    docker_retag $img "$from" "$to"
+for img in "${DOCKER_IMAGES[@]}" ; do
+    docker_retag "$img" "$from" "$to"
 done
diff --git a/bin/image-load b/bin/image-load
@@ -7,11 +7,14 @@ k3d=""
 cluster=""
 archive=""
 preload=""
-images_default=(proxy controller policy-controller web metrics-api grafana debug cni-plugin jaeger-webhook tap)
 images=()
 
+bindir=$( cd "${BASH_SOURCE[0]%/*}" && pwd )
+# shellcheck source=_docker.sh
+. "$bindir"/_docker.sh
+
 usage() {
-  printf "Load into KinD/k3d the referred Linkerd images. If no images are specified all of them are loaded (%s)\n" "${images_default[*]}"
+  printf "Load into KinD/k3d the referred Linkerd images. If no images are specified all of them are loaded (%s)\n" "${DOCKER_IMAGES[*]}"
   echo ""
   echo "Usage:"
   echo "    bin/image-load [--kind] [--k3d] [--cluster name] [--preload] [--archive] [image] [image]..."
@@ -37,7 +40,7 @@ usage() {
 
 while :
 do
-  case $1 in
+  case ${1:-} in
     -h|--help)
       usage
       exit 0
@@ -59,7 +62,7 @@ do
       archive=1
       ;;
     *)
-      if [ -z "$1" ]; then
+      if [ -z "${1:-}" ]; then
         break
       fi
       if echo "$1" | grep -q '^-.*' ; then
@@ -73,7 +76,7 @@ do
 done
 
 if [ ${#images[@]} -eq 0 ]; then
-  images=("${images_default[@]}")
+  images=("${DOCKER_IMAGES[@]}")
 fi
 
 bindir=$( cd "${0%/*}" && pwd )

diff --git a/bin/install-pr b/bin/install-pr
@@ -104,7 +104,7 @@ then
   fi
   "$bindir"/image-load --"$distro" --archive --cluster "$cluster"
 else
-  for image in cni-plugin controller debug grafana proxy web
+  for image in "${DOCKER_IMAGES[@]}"
   do
     image=$(docker load -i "image-archives/$image.tar" | sed 's/Loaded image: //')
     docker push "$image"

diff --git a/cli/cmd/install_test.go b/cli/cmd/install_test.go
@@ -319,6 +319,7 @@ func testInstallOptionsNoCerts(ha bool) (*charts.Values, error) {
 	values.Proxy.Image.Version = installProxyVersion
 	values.DebugContainer.Image.Version = installDebugVersion
 	values.ControllerImageVersion = installControlPlaneVersion
+	values.PolicyController.Image.Version = installControlPlaneVersion
 	values.HeartbeatSchedule = fakeHeartbeatSchedule()
 
 	return values, nil
@@ -334,6 +335,7 @@ func testInstallValues() (*charts.Values, error) {
 	values.DebugContainer.Image.Version = installDebugVersion
 	values.LinkerdVersion = installControlPlaneVersion
 	values.ControllerImageVersion = installControlPlaneVersion
+	values.PolicyController.Image.Version = installControlPlaneVersion
 	values.HeartbeatSchedule = fakeHeartbeatSchedule()
 
 	identityCert, err := ioutil.ReadFile(filepath.Join("testdata", "valid-crt.pem"))

diff --git a/cli/cmd/options.go b/cli/cmd/options.go
@@ -168,6 +168,7 @@ func makeInstallUpgradeFlags(defaults *l5dcharts.Values) ([]flag.Flag, *pflag.Fl
 			"Tag to be used for the control plane component images",
 			func(values *l5dcharts.Values, value string) error {
 				values.ControllerImageVersion = value
+				values.PolicyController.Image.Version = value
 				return nil
 			}),
 	}

diff --git a/cli/cmd/testdata/install_controlplane_tracing_output.golden b/cli/cmd/testdata/install_controlplane_tracing_output.golden
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,4 @@ rootdir=$( cd "$bindir"/.. && pwd )

		dockerfile=$rootdir/cni-plugin/Dockerfile

		docker_build cni-plugin "$(head_root_tag)" "$dockerfile"
		docker_build cni-plugin "${TAG:-$(head_root_tag)}" "$dockerfile"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,4 @@ rootdir=$( cd "$bindir"/.. && pwd )

		dockerfile=$rootdir/Dockerfile-debug

		docker_build debug "$(head_root_tag)" "$dockerfile"
		docker_build debug "${TAG:-$(head_root_tag)}" "$dockerfile"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,4 @@ rootdir=$( cd "$bindir"/.. && pwd )

		dockerfile=$rootdir/grafana/Dockerfile

		docker_build grafana "$(head_root_tag)" "$dockerfile"
		docker_build grafana "${TAG:-$(head_root_tag)}" "$dockerfile"