Store build info in the images and add version subcommands

phisco · gabriele-wolfox · mnencia · web-flow · commit f19927d40e90 · 2021-05-25T18:22:01.000+02:00
Co-authored-by: Gabriele Quaresima &lt;gabriele.quaresima@enterprisedb.com&gt;
Co-authored-by: Marco Nenciarini &lt;marco.nenciarini@enterprisedb.com&gt;
diff --git a/.github/workflows/continuous-delivery.yml b/.github/workflows/continuous-delivery.yml
@@ -156,6 +156,9 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v2.3.4
+        with:
+          # To identify the commit we need the history and all teh tags.
+          fetch-depth: 0
       -
         name: Build meta
         id: build-meta
@@ -179,9 +182,17 @@ jobs:
           else
             labels='quay.expires-after=7d'
           fi
+          commit_sha=${{ github.event.pull_request.head.sha || github.sha }}
+          commit_date=$(git log -1 --pretty=format:'%ad' --date short "${commit_sha}")
+          # use git describe to get the nearest tag and use that to build the version (e.g. 1.4.0+dev24 or 1.4.0)
+          commit_version=$(git describe --tags --match 'v*' "${commit_sha}"| sed -e 's/^v//; s/-g[0-9a-f]\+$//; s/-\([0-9]\+\)$/+dev\1/')
+          commit_short=$(git rev-parse --short "${commit_sha}")
           echo "::set-output name=images::${images}"
           echo "::set-output name=tags::${tags}"
           echo "::set-output name=labels::${labels}"
+          echo "::set-output name=date::${commit_date}"
+          echo "::set-output name=version::${commit_version}"
+          echo "::set-output name=commit::${commit_short}"
       -
         name: Docker meta
         id: docker-meta
@@ -219,6 +230,10 @@ jobs:
           # Available architecture on UBI8 are: linux/amd64, linux/arm64, linux/ppc64le
           platforms: linux/amd64
           push: true
+          build-args: |
+            DATE=${{ steps.build-meta.outputs.date }}
+            COMMIT=${{ steps.build-meta.outputs.commit }}
+            VERSION=${{ steps.build-meta.outputs.version }}
           tags: ${{ steps.docker-meta.outputs.tags }}
           labels: ${{ steps.build-meta.outputs.labels }}
       -
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -17,6 +17,12 @@ builds:
 - id: kubectl-cnp
   binary: kubectl-cnp
   main: cmd/kubectl-cnp/main.go
+  ldflags:
+  - -s
+  - -w
+  - -X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildVersion={{.Version}}
+  - -X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildCommit={{.ShortCommit}}
+  - -X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildDate={{.CommitDate}}
   goos:
   - darwin
   - linux
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,8 @@
 # Build the manager binary
 FROM registry.access.redhat.com/ubi8/go-toolset:1.14.7-15 as builder
+ARG VERSION="dev"
+ARG COMMIT="none"
+ARG DATE="unknown"
 
 # We do not use root
 USER 1001
@@ -19,10 +22,16 @@ RUN go mod download
 COPY --chown=1001 . /workspace
 
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager ./cmd/manager
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager -ldflags \
+    "-s -w \
+    -X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildVersion=\"$VERSION\" \
+    -X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildCommit=\"$COMMIT\" \
+    -X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildDate=\"$DATE\"" \
+    ./cmd/manager
 
 # Use UBI Minimal image as base https://developers.redhat.com/products/rhel/ubi
 FROM registry.access.redhat.com/ubi8/ubi-minimal
+ARG VERSION="dev"
 
 ENV SUMMARY="Cloud Native PostgreSQL Operator Container Image." \
     DESCRIPTION="This Docker image contains Cloud Native PostgreSQL Operator \
@@ -40,7 +49,7 @@ LABEL summary="$SUMMARY" \
       name="Cloud Native PostgreSQL Operator" \
       vendor="EnterpriseDB Corporation" \
       url="https://www.enterprisedb.com/" \
-      version="1.4.0" \
+      version="$VERSION" \
       release="1"
 
 COPY licenses /licenses
diff --git a/Makefile b/Makefile
@@ -13,6 +13,13 @@ CONTROLLER_IMG = quay.io/enterprisedb/cloud-native-postgresql-testing:${IMAGE_TA
 endif
 endif
 
+COMMIT := $(shell git rev-parse --short HEAD || echo unknown)
+DATE := $(shell git log -1 --pretty=format:'%ad' --date short)
+VERSION := $(shell git describe --tags --match 'v*' | sed -e 's/^v//; s/-g[0-9a-f]\+$$//; s/-\([0-9]\+\)$$/+dev\1/')
+LDFLAGS= "-X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildVersion=${VERSION} $\
+-X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildCommit=${COMMIT} $\
+-X github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions.buildDate=${DATE}"
+
 BUILD_IMAGE ?= true
 POSTGRES_IMAGE_NAME ?= quay.io/enterprisedb/postgresql:13
 KUSTOMIZE_VERSION ?= v3.5.4
@@ -48,8 +55,8 @@ e2e-test-k3d:
 
 # Build binaries
 build: generate fmt vet
-	go build -o bin/manager ./cmd/manager
-	go build -o bin/kubectl-cnp ./cmd/kubectl-cnp
+	go build -o bin/manager -ldflags ${LDFLAGS} ./cmd/manager
+	go build -o bin/kubectl-cnp -ldflags ${LDFLAGS} ./cmd/kubectl-cnp
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 run: generate fmt vet manifests
@@ -101,8 +108,9 @@ generate: controller-gen
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
 # Build the docker image
-docker-build: test
-	docker build . -t ${CONTROLLER_IMG}
+docker-build: #test
+	docker build . -t ${CONTROLLER_IMG} --build-arg VERSION=${VERSION} --build-arg COMMIT=${COMMIT} \
+					--build-arg DATE=${DATE}
 
 # Push the docker image
 docker-push:
diff --git a/cmd/kubectl-cnp/main.go b/cmd/kubectl-cnp/main.go
@@ -18,6 +18,7 @@ import (
 	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/plugin/promote"
 	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/plugin/restart"
 	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/plugin/status"
+	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/versions"
 )
 
 func main() {
@@ -38,6 +39,7 @@ func main() {
 	rootCmd.AddCommand(promote.NewCmd())
 	rootCmd.AddCommand(certificate.NewCmd())
 	rootCmd.AddCommand(restart.NewCmd())
+	rootCmd.AddCommand(versions.NewCmd())
 
 	if err := rootCmd.Execute(); err != nil {
 		os.Exit(1)
diff --git a/cmd/manager/main.go b/cmd/manager/main.go
@@ -18,6 +18,7 @@ import (
 	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/manager/instance"
 	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/manager/walarchive"
 	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/manager/walrestore"
+	"github.com/EnterpriseDB/cloud-native-postgresql/internal/cmd/versions"
 
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 )
@@ -41,6 +42,7 @@ func main() {
 	cmd.AddCommand(instance.NewCmd())
 	cmd.AddCommand(walarchive.NewCmd())
 	cmd.AddCommand(walrestore.NewCmd())
+	cmd.AddCommand(versions.NewCmd())
 
 	if err := cmd.Execute(); err != nil {
 		os.Exit(1)
diff --git a/hack/release.sh b/hack/release.sh
@@ -74,9 +74,6 @@ sed -i -e "/Version *= *.*/Is/\".*\"/\"${release_version}\"/" \
     -e "/DefaultOperatorImageName *= *.*/Is/\"\(.*\):.*\"/\"\1:${release_version}\"/" \
     pkg/versions/versions.go
 
-sed -i -e "s/version=\".*\"/version=\"${release_version}\"/" \
-    Dockerfile
-
 sed -i "s/postgresql-operator-[0-9.]*.yaml/postgresql-operator-${release_version}.yaml/g" \
     docs/src/installation_upgrade.md
 
@@ -93,7 +90,6 @@ rm -fr "${CONFIG_TMP_DIR}"
 git checkout -b "release/v${release_version}"
 git add \
     pkg/versions/versions.go \
-    Dockerfile \
     docs/src/installation_upgrade.md \
     "${release_manifest}"
 git commit -sm "Version tag to ${release_version}"
diff --git a/hack/setup-cluster.sh b/hack/setup-cluster.sh
@@ -95,12 +95,12 @@ install_kind() {
 }
 
 build_and_load_operator_k3d() {
-    docker build -t "${CONTROLLER_IMG}" "${ROOT_DIR}"
+    make -C "${ROOT_DIR}" CONTROLLER_IMG="${CONTROLLER_IMG}" docker-build
     k3d image import "${CONTROLLER_IMG}" -c "${CLUSTER_NAME}"
 }
 
 build_and_load_operator_kind() {
-    docker build -t "${CONTROLLER_IMG}" "${ROOT_DIR}"
+    make -C "${ROOT_DIR}" CONTROLLER_IMG="${CONTROLLER_IMG}" docker-build
     kind load -v 1 docker-image --name "${CLUSTER_NAME}" "${CONTROLLER_IMG}"
 }
 
diff --git a/internal/cmd/manager/bootstrap/cmd.go b/internal/cmd/manager/bootstrap/cmd.go
@@ -14,6 +14,7 @@ import (
 
 	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/fileutils"
 	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/management/log"
+	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions"
 )
 
 // NewCmd create a new cobra command
@@ -24,7 +25,10 @@ func NewCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			dest := args[0]
 
-			log.Log.Info("Installing the manager executable", "destination", dest)
+			log.Log.Info("Installing the manager executable",
+				"destination", dest,
+				"version", versions.Version,
+				"build", versions.Info)
 			err := fileutils.CopyFile(cmd.Root().Name(), dest)
 			if err != nil {
 				panic(err)
diff --git a/internal/cmd/manager/controller/controller.go b/internal/cmd/manager/controller/controller.go
@@ -84,7 +84,9 @@ func init() {
 func RunController(metricsAddr, configMapName string, enableLeaderElection bool) error {
 	ctx := context.Background()
 
-	setupLog.Info("Starting Cloud Native PostgreSQL Operator", "version", versions.Version)
+	setupLog.Info("Starting Cloud Native PostgreSQL Operator",
+		"version", versions.Version,
+		"build", versions.Info)
 	setupLog.Info("Listening for changes", "watchNamespace", configuration.Current.WatchNamespace)
 
 	managerOptions := ctrl.Options{
diff --git a/internal/cmd/manager/instance/run/cmd.go b/internal/cmd/manager/instance/run/cmd.go
@@ -23,6 +23,7 @@ import (
 	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/management/postgres/logpipe"
 	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/management/postgres/metricsserver"
 	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/management/postgres/webserver"
+	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions"
 )
 
 // NewCmd creates the "instance run" subcommand
@@ -64,6 +65,10 @@ func NewCmd() *cobra.Command {
 func runSubCommand(ctx context.Context, instance *postgres.Instance) error {
 	var err error
 
+	log.Log.Info("Starting Cloud Native PostgreSQL Instance Manager",
+		"version", versions.Version,
+		"build", versions.Info)
+
 	reconciler, err := controller.NewInstanceReconciler(instance)
 	if err != nil {
 		log.Log.Error(err, "Error while starting reconciler")
diff --git a/internal/cmd/versions/cmd.go b/internal/cmd/versions/cmd.go
@@ -0,0 +1,27 @@
+/*
+This file is part of Cloud Native PostgreSQL.
+
+Copyright (C) 2019-2021 EnterpriseDB Corporation.
+*/
+
+// Package versions builds the version subcommand for both manager and plugins
+package versions
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+
+	"github.com/EnterpriseDB/cloud-native-postgresql/pkg/versions"
+)
+
+// NewCmd is a cobra command printing build information
+func NewCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "Prints version, commit sha and date of the build",
+		Run: func(cmd *cobra.Command, args []string) {
+			fmt.Printf("Build: %+v", versions.Info)
+		},
+	}
+}
diff --git a/pkg/versions/versions.go b/pkg/versions/versions.go
@@ -4,19 +4,40 @@ This file is part of Cloud Native PostgreSQL.
 Copyright (C) 2019-2021 EnterpriseDB Corporation.
 */
 
-// Package versions contains the version the Cloud Native PostgreSQL
-// operator and the software used by it
+// Package versions contains the version of the Cloud Native PostgreSQL operator and the software
+// that is used by it
 package versions
 
 const (
 	// Version is the version of the operator
 	Version = "1.4.0"
 
-	// DefaultImageName is the image used by default by the operator to create
-	// pods.
+	// DefaultImageName is the default image used by the operator to create pods
 	DefaultImageName = "quay.io/enterprisedb/postgresql:13.2"
 
-	// DefaultOperatorImageName used to bootstrap the controller in the Pods running
-	// PostgreSQL
+	// DefaultOperatorImageName is the default operator image used by the controller in the pods running PostgreSQL
 	DefaultOperatorImageName = "quay.io/enterprisedb/cloud-native-postgresql:1.4.0"
 )
+
+// BuildInfo is a struct containing all the info about the build
+type BuildInfo struct {
+	Version, Commit, Date string
+}
+
+var (
+	// buildVersion injected during the build
+	buildVersion = "dev"
+
+	// buildCommit injected during the build
+	buildCommit = "none"
+
+	// buildDate injected during the build
+	buildDate = "unknown"
+
+	// Info contains the build info
+	Info = BuildInfo{
+		Version: buildVersion,
+		Commit:  buildCommit,
+		Date:    buildDate,
+	}
+)

Original file line number	Diff line number	Diff line change
`@@ -95,12 +95,12 @@ install_kind() {`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`build_and_load_operator_k3d() {`
`98`		`- docker build -t "${CONTROLLER_IMG}" "${ROOT_DIR}"`
	`98`	`+ make -C "${ROOT_DIR}" CONTROLLER_IMG="${CONTROLLER_IMG}" docker-build`
`99`	`99`	`k3d image import "${CONTROLLER_IMG}" -c "${CLUSTER_NAME}"`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`build_and_load_operator_kind() {`
`103`		`- docker build -t "${CONTROLLER_IMG}" "${ROOT_DIR}"`
	`103`	`+ make -C "${ROOT_DIR}" CONTROLLER_IMG="${CONTROLLER_IMG}" docker-build`
`104`	`104`	`kind load -v 1 docker-image --name "${CLUSTER_NAME}" "${CONTROLLER_IMG}"`
`105`	`105`	`}`
`106`	`106`