Add capibmadm tool related targets (#1168)

Signed-off-by: Prajyot-Parab <[email protected]>

Author: Prajyot-Parab

Dockerfile

@@ -15,16 +15,22 @@
 # limitations under the License.
 
 # Build the manager binary
-FROM golang:1.20.3 as builder
+FROM golang:1.20.3 as toolchain
 
+# Run this with docker build --build_arg $(go env GOPROXY) to override the goproxy
+ARG goproxy=https://proxy.golang.org,direct
+ENV GOPROXY=$goproxy
+
+FROM toolchain 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
-ENV GOPROXY https://proxy.golang.org,direct
-RUN go mod download
+RUN  --mount=type=cache,target=/root/.local/share/golang \
+     --mount=type=cache,target=/go/pkg/mod \
+     go mod download
 
 # Copy the go source
 COPY main.go main.go
@@ -36,13 +42,17 @@ COPY util/ util/
 
 # Build
 ARG ARCH
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} GO111MODULE=on go build -ldflags "-extldflags '-static'" -a -o manager main.go
+ARG LDFLAGS
+RUN --mount=type=cache,target=/root/.cache/go-build \
+    --mount=type=cache,target=/go/pkg/mod \
+    --mount=type=cache,target=/root/.local/share/golang \
+    CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} GO111MODULE=on go build -ldflags "${LDFLAGS} -extldflags '-static'"  -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
 FROM gcr.io/distroless/static:nonroot
 WORKDIR /
 COPY --from=builder /workspace/manager .
-USER nonroot:nonroot
-
+# Use uid of nonroot user (65532) because kubernetes expects numeric user when applying pod security policies
+USER 65532
 ENTRYPOINT ["/manager"]

Makefile

@@ -26,6 +26,7 @@ CRD_OPTIONS ?= "crd:crdVersions=v1"
 # Directories.
 REPO_ROOT := $(shell git rev-parse --show-toplevel)
 ARTIFACTS ?= $(REPO_ROOT)/_artifacts
+BIN_DIR := bin
 TOOLS_DIR := hack/tools
 TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
 GO_INSTALL = ./scripts/go_install.sh
@@ -55,11 +56,17 @@ PULL_BASE_REF ?= $(RELEASE_TAG) # PULL_BASE_REF will be provided by Prow
 RELEASE_ALIAS_TAG ?= $(PULL_BASE_REF)
 RELEASE_DIR := out
 
+# image name used to build the cmd/capibmadm
+TOOLCHAIN_IMAGE := toolchain
+
 TAG ?= dev
 ARCH ?= amd64
 ALL_ARCH ?= amd64 ppc64le arm64
 PULL_POLICY ?= Always
 
+# Set build time variables including version details
+LDFLAGS := $(shell ./hack/version.sh)
+
 KUBEBUILDER_ENVTEST_KUBERNETES_VERSION ?= 1.24.1
 
 # main controller
@@ -94,9 +101,16 @@ all: manager
 
 ##@ build:
 
+.PHONY: binaries
+binaries: manager capibmadm ## Builds and installs all binaries
+
+.PHONY: capibmadm
+capibmadm: ## Build the capibmadm binary into the ./bin folder
+	go build -ldflags "$(LDFLAGS)" -o $(BIN_DIR)/capibmadm ./cmd/capibmadm
+
 # Build manager binary
 manager: generate fmt vet ## Build the manager binary into the ./bin folder
-	go build -o bin/manager main.go
+	go build -ldflags "${LDFLAGS} -extldflags '-static'" -o $(BIN_DIR)/manager main.go
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 run: generate fmt vet
@@ -245,6 +259,10 @@ $(RELEASE_DIR):
 $(ARTIFACTS):
 	mkdir -p $@
 
+.PHONY: build-toolchain
+build-toolchain: ## Build the toolchain
+	docker build --target toolchain -t $(TOOLCHAIN_IMAGE) .
+
 .PHONY: list-staging-releases
 list-staging-releases: ## List staging images for image promotion
 	@echo $(CORE_IMAGE_NAME):
@@ -271,6 +289,7 @@ release: clean-release check-release-tag $(RELEASE_DIR)  ## Build and push conta
 	git checkout "${RELEASE_TAG}"
 	CORE_CONTROLLER_IMG=$(PROD_REGISTRY)/$(CORE_IMAGE_NAME) $(MAKE) release-manifests
 	$(MAKE) release-templates
+	$(MAKE) release-binaries
 
 .PHONY: release-manifests
 release-manifests: ## Build the manifests to publish with a release
@@ -285,6 +304,7 @@ release-staging: ## Build and push container images to the staging bucket
 	$(MAKE) release-alias-tag
 	$(MAKE) staging-manifests
 	$(MAKE) release-templates
+	$(MAKE) release-binaries
 	$(MAKE) upload-staging-artifacts
 
 .PHONY: staging-manifests
@@ -304,6 +324,31 @@ release-alias-tag: ## Add the release alias tag to the last build tag
 release-templates: $(RELEASE_DIR) ## Generate release templates
 	cp templates/cluster-template*.yaml $(RELEASE_DIR)/
 
+.PHONY: release-binaries
+release-binaries: ## Builds the binaries to publish with a release
+	RELEASE_BINARY=./cmd/capibmadm GOOS=linux GOARCH=ppc64le $(MAKE) release-binary
+	RELEASE_BINARY=./cmd/capibmadm GOOS=linux GOARCH=amd64 $(MAKE) release-binary
+	RELEASE_BINARY=./cmd/capibmadm GOOS=linux GOARCH=arm64 $(MAKE) release-binary
+	RELEASE_BINARY=./cmd/capibmadm GOOS=darwin GOARCH=amd64 $(MAKE) release-binary
+	RELEASE_BINARY=./cmd/capibmadm GOOS=darwin GOARCH=arm64 $(MAKE) release-binary
+	RELEASE_BINARY=./cmd/capibmadm GOOS=windows GOARCH=amd64 EXT=.exe $(MAKE) release-binary
+	RELEASE_BINARY=./cmd/capibmadm GOOS=windows GOARCH=arm64 EXT=.exe $(MAKE) release-binary
+
+.PHONY: release-binary
+release-binary: $(RELEASE_DIR) build-toolchain ## Release binary
+	docker run \
+		--rm \
+		-e CGO_ENABLED=0 \
+		-e GOOS=$(GOOS) \
+		-e GOARCH=$(GOARCH) \
+		--mount=source=gocache,target=/go/pkg/mod \
+		--mount=source=gocache,target=/root/.cache/go-build \
+		-v "$$(pwd):/workspace" \
+		-w /workspace \
+		$(TOOLCHAIN_IMAGE) \
+		go build -ldflags '$(LDFLAGS) -extldflags "-static"' \
+		-o $(RELEASE_DIR)/$(notdir $(RELEASE_BINARY))-$(GOOS)-$(GOARCH)$(EXT) $(RELEASE_BINARY)
+
 IMAGE_PATCH_DIR := $(ARTIFACTS)/image-patch
 
 $(IMAGE_PATCH_DIR): $(ARTIFACTS)
@@ -347,7 +392,7 @@ image-patch-kustomization-without-webhook: $(IMAGE_PATCH_DIR) $(GOJQ)
 
 .PHONY: docker-build
 docker-build: docker-pull-prerequisites ## Build the docker image for controller-manager
-	docker build --build-arg ARCH=$(ARCH) . -t $(CORE_CONTROLLER_IMG)-$(ARCH):$(TAG)
+	docker build --build-arg ARCH=$(ARCH) --build-arg LDFLAGS="$(LDFLAGS)" . -t $(CORE_CONTROLLER_IMG)-$(ARCH):$(TAG)
 
 .PHONY: docker-push
 docker-push: ## Push the docker image
@@ -484,6 +529,7 @@ clean: ## Remove all generated files
 .PHONY: clean-bin
 clean-bin: ## Remove all generated binaries
 	rm -rf $(TOOLS_BIN_DIR)
+	rm -rf $(BIN_DIR)
 
 .PHONY: clean-book
 clean-book: ## Remove all generated GitBook files

cmd/capibmadm/cmd/powervs/powervs.go

@@ -17,6 +17,9 @@ limitations under the License.
 package powervs
 
 import (
+	"fmt"
+	"os"
+
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/powervs/image"
@@ -31,6 +34,14 @@ func Commands() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "powervs",
 		Short: "Commands for operations on PowerVS resources",
+		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+			apiKey := os.Getenv(options.IBMCloudAPIKeyEnvName)
+			if apiKey == "" {
+				return fmt.Errorf("ibmcloud api key is not provided, set %s environmental variable", options.IBMCloudAPIKeyEnvName)
+			}
+			options.GlobalOptions.IBMCloudAPIKey = apiKey
+			return nil
+		},
 	}
 
 	cmd.PersistentFlags().StringVar(&options.GlobalOptions.ServiceInstanceID, "service-instance-id", "", "PowerVS service instance id (Required)")

cmd/capibmadm/cmd/root.go

@@ -29,8 +29,8 @@ import (
 	logf "sigs.k8s.io/cluster-api/cmd/clusterctl/log"
 
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/powervs"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/version"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/vpc"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
 )
 
 func init() {
@@ -43,19 +43,12 @@ func rootCommand() *cobra.Command {
 		Use:   "capibmadm",
 		Short: "Kubernetes Cluster API Provider IBM Cloud Management Utility",
 		Long:  `capibmadm provides helpers for completing the prerequisite operations for creating IBM Cloud Power VS or VPC clusters.`,
-		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-			apiKey := os.Getenv(options.IBMCloudAPIKeyEnvName)
-			if apiKey == "" {
-				return fmt.Errorf("ibmcloud api key is not provided, set %s environmental variable", options.IBMCloudAPIKeyEnvName)
-			}
-			options.GlobalOptions.IBMCloudAPIKey = apiKey
-			return nil
-		},
 	}
 
 	cmd.PersistentFlags().AddGoFlagSet(flag.CommandLine)
 	cmd.AddCommand(powervs.Commands())
 	cmd.AddCommand(vpc.Commands())
+	cmd.AddCommand(version.Commands(os.Stdout))
 
 	return cmd
 }

cmd/capibmadm/cmd/version/doc.go

@@ -0,0 +1,18 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package version contains the capibmadm version command.
+package version

cmd/capibmadm/cmd/version/version.go

@@ -0,0 +1,86 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package version
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+
+	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
+	"gopkg.in/yaml.v2"
+
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/version"
+)
+
+// Version provides the version information of capibmadm.
+type Version struct {
+	ClientVersion *version.Info `json:"ibmcloudProviderVersion"`
+}
+
+// Commands provides the version information capibmadm.
+func Commands(out io.Writer) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "version",
+		Short: "Print version of capibmadm",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return runVersion(out, cmd)
+		},
+	}
+
+	cmd.Flags().StringP("output", "o", "", "The output format of the result. Supported printer types: short, yaml, json")
+
+	return cmd
+}
+
+func runVersion(out io.Writer, cmd *cobra.Command) error {
+	clientVersion := version.Get()
+	v := Version{
+		ClientVersion: &clientVersion,
+	}
+
+	const flag = "output"
+	of, err := cmd.Flags().GetString(flag)
+	if err != nil {
+		return errors.Wrapf(err, "error accessing flag %s for command %s", flag, cmd.Name())
+	}
+
+	switch of {
+	case "":
+		fmt.Fprintf(out, "capibmadm version: %#v\n", *v.ClientVersion)
+	case "short":
+		fmt.Fprintf(out, "%s\n", v.ClientVersion.GitVersion)
+	case "yaml":
+		y, err := yaml.Marshal(&v)
+		if err != nil {
+			return err
+		}
+		fmt.Fprint(out, string(y))
+	case "json":
+		y, err := json.MarshalIndent(&v, "", "  ")
+		if err != nil {
+			return err
+		}
+		fmt.Fprintln(out, string(y))
+	default:
+		return errors.Errorf("invalid output format: %s", of)
+	}
+
+	return nil
+}

cmd/capibmadm/cmd/vpc/vpc.go

@@ -18,6 +18,9 @@ limitations under the License.
 package vpc
 
 import (
+	"fmt"
+	"os"
+
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/vpc/image"
@@ -30,6 +33,14 @@ func Commands() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "vpc",
 		Short: "Commands for operations on VPC resources",
+		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+			apiKey := os.Getenv(options.IBMCloudAPIKeyEnvName)
+			if apiKey == "" {
+				return fmt.Errorf("ibmcloud api key is not provided, set %s environmental variable", options.IBMCloudAPIKeyEnvName)
+			}
+			options.GlobalOptions.IBMCloudAPIKey = apiKey
+			return nil
+		},
 	}
 
 	cmd.PersistentFlags().StringVar(&options.GlobalOptions.VPCRegion, "region", options.GlobalOptions.VPCRegion, "IBM cloud vpc region. (Required)")

go.mod

@@ -26,6 +26,7 @@ require (
 	github.com/stretchr/testify v1.8.2
 	golang.org/x/crypto v0.8.0
 	golang.org/x/text v0.9.0
+	gopkg.in/yaml.v2 v2.4.0
 	k8s.io/api v0.26.1
 	k8s.io/apiextensions-apiserver v0.26.1
 	k8s.io/apimachinery v0.26.1
@@ -143,7 +144,6 @@ require (
 	google.golang.org/protobuf v1.28.1 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apiserver v0.26.1 // indirect
 	k8s.io/cluster-bootstrap v0.25.0 // indirect