chore: set version and git commit ref as ldflag for build

.golangci.yml

@@ -14,14 +14,16 @@ linters-settings:
  - standard
  - default
  - prefix(github.com/tsuru/nginx-operator)
+ - blank
+ - dot
 
 issues:
  exclude-rules:
  # GCI does not handle well the kubebuilder annotations e.g. "// +kubebuilder:scaffold:imports".
  # Issue tracked at https://github.com/daixiang0/gci/issues/135.
- - path: main.go
- linters:
- - gci
+  - path: main.go
+  linters:
+  - gci
 
 linters:
  enable:

Dockerfile

@@ -1,17 +1,15 @@
 # Build the manager binary
 FROM golang:1.20 as builder
-
 WORKDIR /workspace
-
 # Copy the Go Modules and Go source code
 COPY ./ ./
-
 # 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
 RUN go mod download
-
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on make build
+ARG VERSION=main
+ARG GIT_COMMIT=HEAD
+RUN make build
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

Makefile

@@ -3,7 +3,7 @@ DOCKER ?= docker
 # Docker image name
 IMAGE ?= tsuru/nginx-operator
 # Docker image revision
-TAG ?= dev
+TAG ?= ${VERSION}
 
 KUBECTL ?= kubectl
 
@@ -14,6 +14,12 @@ else
 GOBIN=$(shell go env GOBIN)
 endif
 
+VERSION ?= main
+GIT_COMMIT ?= $(shell git rev-list -1 HEAD)
+
+GO_BUILD_FLAGS = GO111MODULE=on CGO_ENABLED=0
+GO_LDFLAGS = "-X=github.com/tsuru/nginx-operator/version.Version=$(VERSION) -X=github.com/tsuru/nginx-operator/version.GitCommit=$(GIT_COMMIT)"
+
 .PHONY: test
 test: generate
  go test -race -cover ./...
@@ -27,7 +33,7 @@ build: manager
 
 .PHONY: manager
 manager: generate
- go build -o bin/nginx-operator main.go
+ ${GO_BUILD_FLAGS} go build -ldflags $(GO_LDFLAGS) -o bin/nginx-operator main.go
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 .PHONY: run
@@ -53,7 +59,7 @@ deploy: manifests kustomize
 # Build the docker image
 .PHONY: docker-build
 docker-build:
- $(DOCKER) build . -t $(IMAGE):$(TAG)
+ $(DOCKER) build --build-arg VERSION=${VERSION} --build-arg GIT_COMMIT=${GIT_COMMIT} . -t $(IMAGE):$(TAG)
 
 # Push the docker image
 .PHONY: docker-push

go.mod

@@ -13,13 +13,21 @@ require (
 )
 
 require (
+ cloud.google.com/go v0.81.0 // indirect
+ github.com/Azure/go-autorest v14.2.0+incompatible // indirect
+ github.com/Azure/go-autorest/autorest v0.11.18 // indirect
+ github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect
+ github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
+ github.com/Azure/go-autorest/logger v0.2.1 // indirect
+ github.com/Azure/go-autorest/tracing v0.6.0 // indirect
  github.com/PuerkitoBio/purell v1.1.1 // indirect
  github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
  github.com/beorn7/perks v1.0.1 // indirect
  github.com/cespare/xxhash/v2 v2.1.2 // indirect
  github.com/davecgh/go-spew v1.1.1 // indirect
  github.com/emicklei/go-restful v2.9.5+incompatible // indirect
  github.com/evanphx/json-patch v4.12.0+incompatible // indirect
+ github.com/form3tech-oss/jwt-go v3.2.3+incompatible // indirect
  github.com/fsnotify/fsnotify v1.5.1 // indirect
  github.com/go-logr/zapr v1.2.0 // indirect
  github.com/go-openapi/jsonpointer v0.19.5 // indirect
@@ -49,6 +57,7 @@ require (
  github.com/spf13/pflag v1.0.5 // indirect
  go.uber.org/atomic v1.7.0 // indirect
  go.uber.org/multierr v1.6.0 // indirect
+ golang.org/x/crypto v0.0.0-20220214200702-86341886e292 // indirect
  golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
  golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8 // indirect
  golang.org/x/sys v0.0.0-20220209214540-3681064d5158 // indirect

go.sum

@@ -17,6 +17,7 @@ cloud.google.com/go v0.72.0/go.mod h1:M+5Vjvlc2wnp6tjzE102Dw08nGShTscUx2nZMufOKP
 cloud.google.com/go v0.74.0/go.mod h1:VV1xSbzvo+9QJOxLDaJfTjx5e+MePCpCWwvftOeQmWk=
 cloud.google.com/go v0.78.0/go.mod h1:QjdrLG0uq+YwhjoVOLsS1t7TW8fs36kLs4XO5R5ECHg=
 cloud.google.com/go v0.79.0/go.mod h1:3bzgcEeQlzbuEAYu4mrWhKqWjmpprinYgKJLgKHnbb8=
+cloud.google.com/go v0.81.0 h1:at8Tk2zUz63cLPR0JPWm5vp77pEZmzxEQBEfRKn1VV8=
 cloud.google.com/go v0.81.0/go.mod h1:mk/AM35KwGk/Nm2YSeZbxXdrNK3KZOYHmLkOqC2V6E0=
 cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o=
 cloud.google.com/go/bigquery v1.3.0/go.mod h1:PjpwJnslEMmckchkHFfq+HTD2DmtT67aNFKH1/VBDHE=
@@ -38,12 +39,19 @@ cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RX
 cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
 github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=
+github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs=
 github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24=
+github.com/Azure/go-autorest/autorest v0.11.18 h1:90Y4srNYrwOtAgVo3ndrQkTYn6kf1Eg/AjTFJ8Is2aM=
 github.com/Azure/go-autorest/autorest v0.11.18/go.mod h1:dSiJPy22c3u0OtOKDNttNgqpNFY/GeWa7GH/Pz56QRA=
+github.com/Azure/go-autorest/autorest/adal v0.9.13 h1:Mp5hbtOePIzM8pJVRa3YLrWWmZtoxRXqUEzCfJt3+/Q=
 github.com/Azure/go-autorest/autorest/adal v0.9.13/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M=
+github.com/Azure/go-autorest/autorest/date v0.3.0 h1:7gUk1U5M/CQbp9WoqinNzJar+8KY+LPI6wiWrP/myHw=
 github.com/Azure/go-autorest/autorest/date v0.3.0/go.mod h1:BI0uouVdmngYNUzGWeSYnokU+TrmwEsOqdt8Y6sso74=
+github.com/Azure/go-autorest/autorest/mocks v0.4.1 h1:K0laFcLE6VLTOwNgSxaGbUcLPuGXlNkbVvq4cW4nIHk=
 github.com/Azure/go-autorest/autorest/mocks v0.4.1/go.mod h1:LTp+uSrOhSkaKrUy935gNZuuIPPVsHlr9DSOxSayd+k=
+github.com/Azure/go-autorest/logger v0.2.1 h1:IG7i4p/mDa2Ce4TRyAO8IHnVhAVF3RFU+ZtXWSmf4Tg=
 github.com/Azure/go-autorest/logger v0.2.1/go.mod h1:T9E3cAhj2VqvPOtCYAvby9aBXkZmbF5NWuPV8+WeEW8=
+github.com/Azure/go-autorest/tracing v0.6.0 h1:TYi4+3m5t6K48TGI9AUdb+IzbnSxvnvUMfuitfgcfuo=
 github.com/Azure/go-autorest/tracing v0.6.0/go.mod h1:+vhtPC754Xsa23ID7GlGsrdKBpUA79WCAKPPZVC2DeU=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
@@ -130,6 +138,7 @@ github.com/evanphx/json-patch v4.12.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQL
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
+github.com/form3tech-oss/jwt-go v3.2.3+incompatible h1:7ZaBxOI7TMoYBfyA3cQHErNNyAWIKUMIwqxEtgHOs5c=
 github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
@@ -503,6 +512,7 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20201002170205-7f63de1d35b0/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.0.0-20220214200702-86341886e292 h1:f+lwQ+GtmgoY+A2YaQxlSOnDjXcQ7ZRLWOHbC6HtRqE=
 golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=

main.go

@@ -21,7 +21,13 @@ import (
 
  nginxv1alpha1 "github.com/tsuru/nginx-operator/api/v1alpha1"
  "github.com/tsuru/nginx-operator/controllers"
+ "github.com/tsuru/nginx-operator/version"
+
  // +kubebuilder:scaffold:imports
+
+ // 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"
 )
 
 var (
@@ -116,7 +122,7 @@ func main() {
  os.Exit(1)
  }
 
- ctrl.Log.Info("starting manager")
+ ctrl.Log.Info("starting manager", "version", version.Version, "commit", version.GitCommit)
 
  if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
  ctrl.Log.Error(err, "problem running manager")

version/version.go

@@ -4,6 +4,10 @@
 
 package version
 
-// Version is the current version of Nginx Operator.
-// NOTE: It's provided during the build phase by ldflags.
-var Version string = "NA"
+var (
+ // Version is the current version of Nginx Operator.
+ Version string = "main"
+
+ // GitCommit is the current Git commit reference.
+ GitCommit string = "N/A"
+)