Add support for arm64 container build (#506)

Author: afritzler

.github/workflows/publish-docker.yml

@@ -67,9 +67,8 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           context: .
-          #TODO: Fix linux/arm64 build
-          platforms: linux/amd64 #,linux/arm64
+          platforms: linux/amd64 ,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-          target: ${{ matrix.image.target }}
+          target: ${{ matrix.image.target }}

Dockerfile

@@ -2,38 +2,78 @@
 FROM --platform=$BUILDPLATFORM golang:1.23-bookworm AS builder
 
 WORKDIR /workspace
+
 # Copy the Go Modules manifests
-COPY go.mod go.mod
-COPY go.sum go.sum
-# cache deps before building and copying source so that we don't need to re-download as much
-# and so that source changes don't invalidate our downloaded layer
+COPY go.mod go.sum ./
+
+# Cache dependencies before copying source code
 RUN --mount=type=cache,target=/root/.cache/go-build \
     --mount=type=cache,target=/go/pkg \
     go mod download
 
-# Copy the go source
+# Copy the Go source code
 COPY api/ api/
 COPY internal/ internal/
 COPY cmd/ cmd/
 COPY hack/ hack/
 
 ARG TARGETOS
 ARG TARGETARCH
+ARG BUILDPLATFORM
+ENV BUILDARCH=${BUILDPLATFORM##*/}
 
+# Install common dependencies
 RUN apt-get update && apt-get install -y --no-install-recommends \
-    qemu-utils ca-certificates libvirt-clients libcephfs-dev librbd-dev librados-dev libc-bin gcc \
+    qemu-user-static qemu-utils ca-certificates \
+    libvirt-clients libcephfs-dev librbd-dev librados-dev libc-bin \
+    gcc g++ \
     && update-ca-certificates \
     && rm -rf /var/lib/apt/lists/*
 
-# Build
-RUN --mount=type=cache,target=/root/.cache/go-build \
-    --mount=type=cache,target=/go/pkg \
-    CGO_ENABLED=1 GOOS=$TARGETOS GOARCH=$TARGETARCH GO111MODULE=on go build -ldflags="-s -w" -a -o libvirt-provider ./cmd/libvirt-provider/main.go
+# Install cross-compiler for ARM64 if building for arm64 on an amd64 host
+RUN if [ "$TARGETARCH" = "arm64" ] && [ "$BUILDARCH" = "amd64" ]; then \
+      dpkg --add-architecture arm64 && \
+      apt-get update && apt-get install -y --no-install-recommends \
+      gcc-aarch64-linux-gnu librbd-dev:arm64 librados-dev:arm64 libc6-dev:arm64; \
+    fi
+
+# Install cross-compiler for AMD64 if building for amd64 on an arm64 host
+RUN if [ "$TARGETARCH" = "amd64" ] && [ "$BUILDARCH" = "arm64" ]; then \
+      apt update && \
+      apt-get install -y --no-install-recommends \
+      gcc-x86-64-linux-gnu; \
+    fi
+
+# Set compiler and linker flags based on target architecture
+ENV CC=""
+ENV CGO_LDFLAGS=""
+
+RUN if [ "$TARGETARCH" != "$BUILDARCH" ] && [ "$TARGETARCH" = "arm64" ]; then \
+      export CC="/usr/bin/aarch64-linux-gnu-gcc"; \
+      export CGO_LDFLAGS="-L/usr/lib/aarch64-linux-gnu -Wl,-lrados -Wl,-lrbd"; \
+    elif [ "$TARGETARCH" != "$BUILDARCH" ] && [ "$TARGETARCH" = "amd64" ]; then \
+      export CC="/usr/bin/x86_64-linux-gnu-gcc"; \
+      export CGO_LDFLAGS="-L/usr/lib/x86_64-linux-gnu -Wl,-lrados -Wl,-lrbd"; \
+    else \
+      export CC="/usr/bin/gcc"; \
+      export CGO_LDFLAGS=""; \
+    fi && \
+    CGO_ENABLED=1 GOOS=$TARGETOS GOARCH=$TARGETARCH \
+    CC="$CC" CGO_LDFLAGS="$CGO_LDFLAGS" \
+    go build -ldflags="-s -w -linkmode=external" -o libvirt-provider ./cmd/libvirt-provider/main.go
 
 # Install irictl-machine
 RUN --mount=type=cache,target=/root/.cache/go-build \
     --mount=type=cache,target=/go/pkg \
-    CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH GO111MODULE=on go install github.com/ironcore-dev/ironcore/irictl-machine/cmd/irictl-machine@main
+    CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH GO111MODULE=on \
+    go install github.com/ironcore-dev/ironcore/irictl-machine/cmd/irictl-machine@main
+
+# Ensure the binary is in a common location
+RUN if [ "$TARGETARCH" = "$BUILDARCH" ]; then \
+        mv /go/bin/irictl-machine /workspace/irictl-machine; \
+    else \
+        mv /go/bin/linux_$TARGETARCH/irictl-machine /workspace/irictl-machine; \
+    fi
 
 # Since we're leveraging apt to pull in dependencies, we use `gcr.io/distroless/base` because it includes glibc.
 FROM gcr.io/distroless/base-debian11 AS distroless-base
@@ -42,12 +82,15 @@ FROM gcr.io/distroless/base-debian11 AS distroless-base
 FROM distroless-base AS distroless-amd64
 ENV LIB_DIR_PREFIX=x86_64
 ENV LIB_DIR_PREFIX_MINUS=x86-64
+ENV LIB_DIR_SUFFIX_NUMBER=2
+ENV LIB_DIR=lib64
 
 # The distroless arm64 image has a target triplet of aarch64
 FROM distroless-base AS distroless-arm64
 ENV LIB_DIR_PREFIX=aarch64
 ENV LIB_DIR_PREFIX_MINUS=aarch64
-
+ENV LIB_DIR_SUFFIX_NUMBER=1
+ENV LIB_DIR=lib
 
 FROM busybox:1.37.0-uclibc AS busybox
 FROM distroless-$TARGETARCH  AS libvirt-provider
@@ -84,14 +127,14 @@ COPY --from=builder /lib/${LIB_DIR_PREFIX}-linux-gnu/librados.so.2 \
 /lib/${LIB_DIR_PREFIX}-linux-gnu/libselinux.so.1 \
 /lib/${LIB_DIR_PREFIX}-linux-gnu/libpthread.so.0 \
 /lib/${LIB_DIR_PREFIX}-linux-gnu/libpcre2-8.so.0 /lib/${LIB_DIR_PREFIX}-linux-gnu/
-RUN mkdir -p /lib64
-COPY --from=builder /lib64/ld-linux-${LIB_DIR_PREFIX_MINUS}.so.2 /lib64/
+RUN mkdir -p /${LIB_DIR}
+COPY --from=builder /${LIB_DIR}/ld-linux-${LIB_DIR_PREFIX_MINUS}.so.${LIB_DIR_SUFFIX_NUMBER} /${LIB_DIR}/
 RUN mkdir -p /usr/lib/${LIB_DIR_PREFIX}-linux-gnu/ceph/
 COPY --from=builder /usr/lib/${LIB_DIR_PREFIX}-linux-gnu/ceph/libceph-common.so.2 /usr/lib/${LIB_DIR_PREFIX}-linux-gnu/ceph
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 
 COPY --from=builder /workspace/libvirt-provider /libvirt-provider
-COPY --from=builder /go/bin/irictl-machine /irictl-machine
+COPY --from=builder /workspace/irictl-machine /irictl-machine
 
 USER 65532:65532
 

Makefile

@@ -7,21 +7,9 @@ ENVTEST_K8S_VERSION = 1.28
 # Docker image name for the mkdocs based local development setup
 MKDOCS_IMG=onmetal/libvirt-provider-docs
 
-# Code depend on OS
-TARGET_OS ?= linux
-TARGET_ARCH ?= amd64
-CGO_ENABLED ?= 1
-
 LIBVIRT_PROVIDER_BIN=$(LOCALBIN)/libvirt-provider
 LIBVIRT_PROVIDER_BIN_SOURCE=./cmd/libvirt-provider
 
-GITHUB_PAT_PATH ?=
-ifeq (,$(GITHUB_PAT_PATH))
-GITHUB_PAT_MOUNT ?=
-else
-GITHUB_PAT_MOUNT ?= --secret id=github_pat,src=$(GITHUB_PAT_PATH)
-endif
-
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
 GOBIN=$(shell go env GOPATH)/bin
@@ -35,6 +23,8 @@ endif
 # tools. (i.e. podman)
 CONTAINER_TOOL ?= docker
 
+TARGET_OS ?= linux
+TARGET_ARCH ?= $(shell uname -m)
 CONTAINER_BUILDARGS ?= --platform $(TARGET_OS)/$(TARGET_ARCH)
 
 # Setting SHELL to bash allows bash commands to be executed by recipes.
@@ -86,15 +76,15 @@ fmt: ## Run go fmt against code.
 
 .PHONY: vet
 vet: ## Run go vet against code.
-	GOOS=$(TARGET_OS) CGO_ENABLED=$(CGO_ENABLED) go vet ./...
+	go vet ./...
 
 .PHONY: lint
 lint: golangci-lint ## Run golangci-lint against code.
-	GOOS=$(TARGET_OS) CGO_ENABLED=$(CGO_ENABLED) $(GOLANGCI_LINT) run
+	CGO_ENABLED=1 $(GOLANGCI_LINT) run
 
 .PHONY: lint-fix
 lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
-	GOOS=$(TARGET_OS) CGO_ENABLED=$(CGO_ENABLED) $(GOLANGCI_LINT) run --fix
+	CGO_ENABLED=1 $(GOLANGCI_LINT) run --fix
 
 .PHONY: check
 check: manifests generate fmt check-license lint test ## Generate manifests, code, lint, check licenses, test
@@ -122,7 +112,7 @@ clean-docs: ## Remove all local mkdocs Docker images (cleanup).
 
 .PHONY: build
 build: manifests generate fmt vet add-license lint ## Build the binary
-	GOOS=$(TARGET_OS) GOARCH=$(TARGET_ARCH) CGO_ENABLED=$(CGO_ENABLED) go build -o $(LIBVIRT_PROVIDER_BIN) $(LIBVIRT_PROVIDER_BIN_SOURCE)
+	CGO_ENABLED=1 go build -o $(LIBVIRT_PROVIDER_BIN) $(LIBVIRT_PROVIDER_BIN_SOURCE)
 
 .PHONY: run
 run: manifests generate fmt vet ## Run the binary
@@ -133,7 +123,7 @@ run: manifests generate fmt vet ## Run the binary
 
 .PHONY: docker-build
 docker-build: ## Build docker image with partitionlet
-	$(CONTAINER_TOOL) build $(CONTAINER_BUILDARGS) -t ${IMG} $(GITHUB_PAT_MOUNT) .
+	$(CONTAINER_TOOL) build $(CONTAINER_BUILDARGS) -t ${IMG} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.