Use ko, build amd64 + arm64 controller images (#95)

* Use ko, build amd64 + arm64 controller images

* make ko-build always builds for the local platform

---------

Signed-off-by: Angelos Kolaitis <neoaggelos@gmail.com>

Author: neoaggelos

.github/workflows/release.yml

@@ -17,17 +17,13 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v4
 
-      - name: Log in to the Container registry
-        uses: docker/login-action@v3.2.0
-        with:
-          registry: https://ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Login
+        run: |
+          make ko-login USERNAME=${{ github.actor }} PASSWORD=${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build and push image
+      - name: Build image
         run: |
-          make docker-build TAG=${{ github.ref_name }}
-          make docker-push TAG=${{ github.ref_name }}
+          make ko-push TAG=${{ github.ref_name }}
 
       - name: Build release assets
         run: make dist TAG=${{ github.ref_name }}

Dockerfile

@@ -1,6 +1,15 @@
 # Image URL to use all building/pushing image targets
 TAG ?= latest
-IMG ?= ghcr.io/lxc/cluster-api-provider-incus:$(TAG)
+REGISTRY ?= ghcr.io
+REPO ?= $(REGISTRY)/lxc/cluster-api-provider-incus
+IMG ?= $(REPO):$(TAG)
+
+# Used by ko build
+export KO_DOCKER_REPO = $(REPO)
+
+# PLATFORMS defines the target platforms for the manager image be built.
+PLATFORMS ?= linux/arm64,linux/amd64
+LOCAL_PLATFORM ?= linux/$(shell go env GOARCH)
 
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.31.0
@@ -94,8 +103,8 @@ _SKIP_ARGS := $(foreach arg,$(strip $(E2E_GINKGO_SKIP)),-skip="$(arg)")
 endif
 
 .PHONY: e2e-image
-e2e-image: IMG = ghcr.io/lxc/cluster-api-provider-incus:e2e ## Build controller image for e2e tests
-e2e-image: docker-build
+e2e-image: TAG = e2e ## Build controller image for e2e tests
+e2e-image: ko-build
 
 E2E_DATA_DIR ?= $(REPO_ROOT)/test/e2e/data
 ARTIFACTS ?= $(REPO_ROOT)/_artifacts
@@ -154,33 +163,17 @@ V ?= 0
 run: manifests generate fmt vet ## Run a controller from your host.
 	go run ./cmd/main.go --diagnostics-address=":" --v=${V}
 
-# If you wish to build the manager image targeting other platforms you can use the --platform flag.
-# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
-# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
-.PHONY: docker-build
-docker-build: ## Build docker image with the manager.
-	$(CONTAINER_TOOL) build -t ${IMG} .
-
-.PHONY: docker-push
-docker-push: ## Push docker image with the manager.
-	$(CONTAINER_TOOL) push ${IMG}
-
-# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
-# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
-# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
-# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
-# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
-# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
-PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
-.PHONY: docker-buildx
-docker-buildx: ## Build and push docker image for the manager for cross-platform support
-	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
-	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
-	- $(CONTAINER_TOOL) buildx create --name test-builder
-	$(CONTAINER_TOOL) buildx use test-builder
-	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
-	- $(CONTAINER_TOOL) buildx rm test-builder
-	rm Dockerfile.cross
+.PHONY: ko-build
+ko-build: ko ## Build manager image and load to local docker instance.
+	$(KO) build ./cmd --bare --tags $(TAG) --sbom=none --platform=$(LOCAL_PLATFORM) --local
+
+.PHONY: ko-login
+ko-login: ko ## Configure credentials for pushing images (needs USERNAME and PASSWORD).
+	echo $(PASSWORD) | $(KO) login $(REGISTRY) --username $(USERNAME) --password-stdin
+
+.PHONY: ko-push
+ko-push: ko ## Build and push manager image.
+	$(KO) build ./cmd --bare --tags $(TAG) --sbom=none --platform=$(PLATFORMS)
 
 ##@ Release
 
@@ -231,15 +224,17 @@ KUBECTL ?= kubectl
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
-GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
-GINKGO = $(LOCALBIN)/ginkgo
-IMAGE_BUILDER = $(LOCALBIN)/image-builder
+GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
+GINKGO ?= $(LOCALBIN)/ginkgo
+KO ?= $(LOCALBIN)/ko
+IMAGE_BUILDER ?= $(LOCALBIN)/image-builder
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.5.0
 CONTROLLER_TOOLS_VERSION ?= v0.16.4
 ENVTEST_VERSION ?= release-0.19
 GOLANGCI_LINT_VERSION ?= v1.61.0
+KO_VERSION ?= v0.18.0
 
 .PHONY: image-builder
 image-builder: $(LOCALBIN)
@@ -270,6 +265,11 @@ ginkgo: $(GINKGO) ## Download ginkgo locally if necessary.
 $(GINKGO): $(LOCALBIN)
 	go build -o $@ github.com/onsi/ginkgo/v2/ginkgo
 
+.PHONY: ko
+ko: $(KO) ## Download ko locally if necessary.
+$(KO): $(LOCALBIN)
+	$(call go-install-tool,$(KO),github.com/google/ko,$(KO_VERSION))
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary
 # $2 - package url which can be installed

Makefile

@@ -59,7 +59,7 @@ spec:
         #   type: RuntimeDefault
       containers:
       - command:
-        - /manager
+        - /ko-app/cmd
         args:
           - --leader-elect
           - --health-addr=:9440