Embed operator version into binary

Add version printing into cli and log.

Signed-off-by: Konstantin Khlebnikov <[email protected]>

Author: koct9i

Dockerfile

@@ -1,6 +1,12 @@
+ARG VERSION
+ARG REVISION
+ARG BUILD_DATE
+
 # Build the manager binary
 FROM golang:1.24 AS builder
 
+ARG VERSION
+
 WORKDIR /workspace
 
 # Copy the Go Modules manifests
@@ -18,8 +24,10 @@ COPY api/ api/
 COPY pkg/ pkg/
 COPY controllers/ controllers/
 
+ARG GO_LDFLAGS="-X github.com/ytsaurus/ytsaurus-k8s-operator/pkg/version.version=${VERSION}"
+
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "${GO_LDFLAGS}" -a -o manager main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details
@@ -28,9 +36,9 @@ WORKDIR /
 COPY --from=builder /workspace/manager .
 USER 65532:65532
 
-ARG VERSION=UNSET
-ARG REVISION=UNSET
-ARG BUILD_DATE=UNSET
+ARG VERSION
+ARG REVISION
+ARG BUILD_DATE
 
 LABEL org.opencontainers.image.title="YTsaurus Operator for Kubernetes"
 LABEL org.opencontainers.image.url="https://ytsaurus.tech"

Makefile

@@ -35,21 +35,24 @@ OPERATOR_CHART_NAME = ytop-chart
 OPERATOR_CHART_CRDS = $(OPERATOR_CHART)/templates/crds
 OPERATOR_INSTANCE = ytsaurus-dev
 
+ifdef RELEASE_VERSION
+OPERATOR_VERSION = $(RELEASE_VERSION)
+else
+OPERATOR_VERSION = $(OPERATOR_TAG)
+endif
+
 ifdef RELEASE_SUFFIX
 	OPERATOR_IMAGE_RELEASE=$(OPERATOR_IMAGE)$(RELEASE_SUFFIX)
 	OPERATOR_CHART_NAME_RELEASE=$(OPERATOR_CHART_NAME)$(RELEASE_SUFFIX)
 else
 	OPERATOR_IMAGE_RELEASE=$(OPERATOR_IMAGE)
 	OPERATOR_CHART_NAME_RELEASE=$(OPERATOR_CHART_NAME)
 endif
+
 ## K8s namespace for YTsaurus operator.
 OPERATOR_NAMESPACE = ytsaurus-operator
 
-ifdef RELEASE_VERSION
-DOCKER_BUILD_ARGS += --build-arg VERSION="$(RELEASE_VERSION)"
-else
-DOCKER_BUILD_ARGS += --build-arg VERSION="$(OPERATOR_TAG)"
-endif
+DOCKER_BUILD_ARGS += --build-arg VERSION="$(OPERATOR_VERSION)"
 DOCKER_BUILD_ARGS += --build-arg REVISION="$(shell git rev-parse HEAD)"
 DOCKER_BUILD_ARGS += --build-arg BUILD_DATE="$(shell date -Iseconds -u)"
 
@@ -60,6 +63,8 @@ else
 GOBIN=$(shell go env GOBIN)
 endif
 
+GO_LDFLAGS = -X github.com/ytsaurus/ytsaurus-k8s-operator/pkg/version.version=$(OPERATOR_VERSION)
+
 # Setting SHELL to bash allows bash commands to be executed by recipes.
 # Options are set to exit when a recipe line exits non-zero or a piped command fails.
 SHELL = /usr/bin/env bash -o pipefail
@@ -347,7 +352,7 @@ kind-yt-info:
 
 .PHONY: build
 build: generate-code ## Build manager binary.
-	go build -o bin/manager main.go
+	go build -ldflags "$(GO_LDFLAGS)" -o bin/manager main.go
 
 .PHONY: run
 run: generate-code manifests ## Run a controller from your host.

main.go

@@ -41,6 +41,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
 	ytv1 "github.com/ytsaurus/ytsaurus-k8s-operator/api/v1"
+
+	"github.com/ytsaurus/ytsaurus-k8s-operator/pkg/version"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -61,6 +63,11 @@ func main() {
 	var enableLeaderElection bool
 	var probeAddr string
 	var maxConcurrentReconciles int
+	flag.BoolFunc("version", "print the version", func(s string) error {
+		version.PrintVersion()
+		os.Exit(0)
+		return nil
+	})
 	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
 	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
 	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
@@ -79,6 +86,8 @@ func main() {
 
 	ctx := ctrl.SetupSignalHandler()
 
+	setupLog.Info("Starting ytsaurus operator", "version", version.GetVersion())
+
 	var clusterDomain string
 	if domain := os.Getenv("K8S_CLUSTER_DOMAIN"); domain != "" {
 		clusterDomain = domain

pkg/version/version.go

@@ -0,0 +1,23 @@
+package version
+
+import (
+	"fmt"
+
+	"runtime/debug"
+)
+
+// version provided by ldflags at compile-time
+var version string
+
+func GetVersion() string {
+	if version == "" {
+		if i, ok := debug.ReadBuildInfo(); ok {
+			version = i.Main.Version
+		}
+	}
+	return version
+}
+
+func PrintVersion() {
+	fmt.Println(GetVersion())
+}