Add version subcommand

Author: afritzler

.github/workflows/publish-docker.yml

@@ -53,6 +53,10 @@ jobs:
           flavor: |
             latest=${{ github.ref == 'refs/heads/main' }}
 
+      - name: Set short git commit SHA
+        id: vars
+        run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
         with:
@@ -82,3 +86,7 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           target: ${{ matrix.image.target }}
+          build-args: |
+            VERSION=${{ steps.meta.outputs.version }}
+            GIT_COMMIT=${{ steps.vars.sha_short }}
+            BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')

.golangci.yml

@@ -39,6 +39,9 @@ linters:
     - usetesting
     - whitespace
   settings:
+    gomoddirectives:
+      toolchain-forbidden: true
+      go-version-pattern: 1\.\d+(\.0)?$
     revive:
       rules:
         - name: comment-spacings

.license-scan-overrides.jsonl

@@ -3,6 +3,10 @@ FROM --platform=$BUILDPLATFORM golang:1.25.0 AS builder
 ARG TARGETOS
 ARG TARGETARCH
 
+ARG BUILD_DATE
+ARG GIT_COMMIT
+ARG VERSION
+
 WORKDIR /workspace
 # Copy the Go Modules manifests
 COPY go.mod go.mod
@@ -23,12 +27,23 @@ COPY internal/ internal/
 # by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
 RUN --mount=type=cache,target=/root/.cache/go-build \
     --mount=type=cache,target=/go/pkg \
-    CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -ldflags="-s -w" -a -o manager cmd/main.go
+    CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -ldflags="-s -w -X 'main.version=${VERSION}' -X 'main.gitCommit=${GIT_COMMIT}' -X 'main.buildDate=${BUILD_DATE}'" -a -o manager cmd/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details
 FROM gcr.io/distroless/static:nonroot AS manager
-LABEL source_repository="https://github.com/ironcore-dev/metal-operator"
+
+ARG BUILD_DATE
+ARG GIT_COMMIT
+ARG VERSION
+
+LABEL source_repository="https://github.com/ironcore-dev/metal-operator" \
+    org.opencontainers.image.url="https://github.com/ironcore-dev/network-operator" \
+    org.opencontainers.image.created=${BUILD_DATE} \
+    org.opencontainers.image.revision=${GIT_COMMIT} \
+    org.opencontainers.image.version=${VERSION} \
+    org.opencontainers.image.licenses="Apache-2.0"
+
 WORKDIR /
 COPY --from=builder /workspace/manager .
 USER 65532:65532

.license-scan-rules.json

@@ -12,6 +12,12 @@ endif
 GOARCH  := $(shell go env GOARCH)
 GOOS    := $(shell go env GOOS)
 
+VERSION ?= dev
+GIT_COMMIT ?= $(shell git rev-parse --short HEAD)
+BUILD_DATE ?= $(shell date -u +'%Y-%m-%dT%H:%M:%SZ')
+
+LDFLAGS = -ldflags="-X 'main.version=$(VERSION)' -X 'main.gitCommit=$(GIT_COMMIT)' -X 'main.buildDate=$(BUILD_DATE)'"
+
 # CONTAINER_TOOL defines the container tool to be used for building images.
 # Be aware that the target commands are only tested with Docker which is
 # scaffolded by default. However, you might want to replace it to use other
@@ -127,7 +133,7 @@ docs: gen-crd-api-reference-docs ## Run go generate to generate API reference do
 
 .PHONY: build
 build: manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager cmd/main.go
+	go build $(LDFLAGS) -o bin/manager cmd/main.go
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
@@ -143,7 +149,11 @@ helm: manifests kubebuilder
 # 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} .
+	$(CONTAINER_TOOL) build \
+		--build-arg=BUILD_DATE=$(BUILD_DATE) \
+	 	--build-arg=GIT_COMMIT=$(GIT_COMMIT) \
+	 	--build-arg=VERSION=$(VERSION) \
+	 	-t ${IMG} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.

Dockerfile

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Package v1alpha1 contains API Schema definitions for the networking.cloud.sap API group
-// +groupName=networking.cloud.sap
+// +kubebuilder:validation:Required
 // +kubebuilder:object:generate=true
+// +groupName=networking.cloud.sap
 package v1alpha1

Makefile

@@ -2,9 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Package v1alpha1 contains API Schema definitions for the networking.cloud.sap v1alpha1 API group.
-// +kubebuilder:validation:Required
-// +kubebuilder:object:generate=true
-// +groupName=networking.cloud.sap
 package v1alpha1
 
 import (

api/v1alpha1/doc.go

@@ -7,6 +7,7 @@ import (
 	"crypto/tls"
 	"flag"
 	"fmt"
+	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -20,8 +21,6 @@ import (
 	// Set runtime concurrency to match CPU limit imposed by Kubernetes
 	_ "go.uber.org/automaxprocs"
 
-	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
-	// to ensure that exec-entrypoint and run can make use of them.
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/certwatcher"
@@ -44,6 +43,10 @@ import (
 var (
 	scheme   = runtime.NewScheme()
 	setupLog = ctrl.Log.WithName("setup")
+
+	version   = "dev"
+	gitCommit = "none"
+	buildDate = "unknown"
 )
 
 func init() {
@@ -53,6 +56,14 @@ func init() {
 }
 
 func main() {
+	if len(os.Args) > 1 && os.Args[1] == "version" {
+		log.SetFlags(0)
+		log.Printf("Version:   %s", version)
+		log.Printf("Git Commit: %s", gitCommit)
+		log.Printf("Build Date: %s", buildDate)
+		os.Exit(0)
+	}
+
 	var metricsAddr string
 	var metricsCertPath, metricsCertName, metricsCertKey string
 	var webhookCertPath, webhookCertName, webhookCertKey string