|
| 1 | +# Image URL to use all building/pushing image targets |
| 2 | +IMG ?= controller:latest |
| 3 | +# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. |
| 4 | +ENVTEST_K8S_VERSION = 1.31.0 |
| 5 | + |
| 6 | +# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set) |
| 7 | +ifeq (,$(shell go env GOBIN)) |
| 8 | +GOBIN=$(shell go env GOPATH)/bin |
| 9 | +else |
| 10 | +GOBIN=$(shell go env GOBIN) |
| 11 | +endif |
| 12 | + |
| 13 | +# CONTAINER_TOOL defines the container tool to be used for building images. |
| 14 | +# Be aware that the target commands are only tested with Docker which is |
| 15 | +# scaffolded by default. However, you might want to replace it to use other |
| 16 | +# tools. (i.e. podman) |
| 17 | +CONTAINER_TOOL ?= docker |
| 18 | + |
| 19 | +# Setting SHELL to bash allows bash commands to be executed by recipes. |
| 20 | +# Options are set to exit when a recipe line exits non-zero or a piped command fails. |
| 21 | +SHELL = /usr/bin/env bash -o pipefail |
| 22 | +.SHELLFLAGS = -ec |
| 23 | + |
| 24 | +.PHONY: all |
| 25 | +all: build |
| 26 | + |
| 27 | +##@ General |
| 28 | + |
| 29 | +# The help target prints out all targets with their descriptions organized |
| 30 | +# beneath their categories. The categories are represented by '##@' and the |
| 31 | +# target descriptions by '##'. The awk command is responsible for reading the |
| 32 | +# entire set of makefiles included in this invocation, looking for lines of the |
| 33 | +# file as xyz: ## something, and then pretty-format the target and help. Then, |
| 34 | +# if there's a line with ##@ something, that gets pretty-printed as a category. |
| 35 | +# More info on the usage of ANSI control characters for terminal formatting: |
| 36 | +# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters |
| 37 | +# More info on the awk command: |
| 38 | +# http://linuxcommand.org/lc3_adv_awk.php |
| 39 | + |
| 40 | +.PHONY: help |
| 41 | +help: ## Display this help. |
| 42 | + @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) |
| 43 | + |
| 44 | +##@ Development |
| 45 | + |
| 46 | +.PHONY: manifests |
| 47 | +manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. |
| 48 | + $(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases |
| 49 | + |
| 50 | +.PHONY: generate |
| 51 | +generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. |
| 52 | + $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." |
| 53 | + ./hack/update-codegen.sh |
| 54 | + |
| 55 | +PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST)))) |
| 56 | +# Use same code-generator version as k8s.io/api |
| 57 | +CODEGEN_VERSION := $(shell go list -m -f '{{.Version}}' k8s.io/api) |
| 58 | +CODEGEN = $(shell pwd)/bin/code-generator |
| 59 | +CODEGEN_ROOT = $(shell go env GOMODCACHE)/k8s.io/code-generator@$(CODEGEN_VERSION) |
| 60 | +.PHONY: code-generator |
| 61 | +code-generator: |
| 62 | + @GOBIN=$(PROJECT_DIR)/bin GO111MODULE=on go install k8s.io/code-generator/cmd/client-gen@$(CODEGEN_VERSION) |
| 63 | + cp -f $(CODEGEN_ROOT)/generate-groups.sh $(PROJECT_DIR)/bin/ |
| 64 | + cp -f $(CODEGEN_ROOT)/generate-internal-groups.sh $(PROJECT_DIR)/bin/ |
| 65 | + cp -f $(CODEGEN_ROOT)/kube_codegen.sh $(PROJECT_DIR)/bin/ |
| 66 | + |
| 67 | + |
| 68 | +.PHONY: fmt |
| 69 | +fmt: ## Run go fmt against code. |
| 70 | + go fmt ./... |
| 71 | + |
| 72 | +.PHONY: vet |
| 73 | +vet: ## Run go vet against code. |
| 74 | + go vet ./... |
| 75 | + |
| 76 | +.PHONY: test |
| 77 | +test: manifests generate fmt vet envtest ## Run tests. |
| 78 | + KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out |
| 79 | + |
| 80 | +# Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors. |
| 81 | +.PHONY: test-e2e # Run the e2e tests against a Kind k8s instance that is spun up. |
| 82 | +test-e2e: |
| 83 | + go test ./test/e2e/ -v -ginkgo.v |
| 84 | + |
| 85 | +.PHONY: lint |
| 86 | +lint: golangci-lint ## Run golangci-lint linter |
| 87 | + $(GOLANGCI_LINT) run |
| 88 | + |
| 89 | +.PHONY: lint-fix |
| 90 | +lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes |
| 91 | + $(GOLANGCI_LINT) run --fix |
| 92 | + |
| 93 | +##@ Build |
| 94 | + |
| 95 | +.PHONY: build |
| 96 | +build: manifests generate fmt vet ## Build manager binary. |
| 97 | + go build -o bin/manager cmd/main.go |
| 98 | + |
| 99 | +.PHONY: run |
| 100 | +run: manifests generate fmt vet ## Run a controller from your host. |
| 101 | + go run ./cmd/main.go |
| 102 | + |
| 103 | +# If you wish to build the manager image targeting other platforms you can use the --platform flag. |
| 104 | +# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it. |
| 105 | +# More info: https://docs.docker.com/develop/develop-images/build_enhancements/ |
| 106 | +.PHONY: docker-build |
| 107 | +docker-build: ## Build docker image with the manager. |
| 108 | + $(CONTAINER_TOOL) build -t ${IMG} . |
| 109 | + |
| 110 | +.PHONY: docker-push |
| 111 | +docker-push: ## Push docker image with the manager. |
| 112 | + $(CONTAINER_TOOL) push ${IMG} |
| 113 | + |
| 114 | +# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple |
| 115 | +# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: |
| 116 | +# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/ |
| 117 | +# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/ |
| 118 | +# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail) |
| 119 | +# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option. |
| 120 | +PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le |
| 121 | +.PHONY: docker-buildx |
| 122 | +docker-buildx: ## Build and push docker image for the manager for cross-platform support |
| 123 | + # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile |
| 124 | + sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross |
| 125 | + - $(CONTAINER_TOOL) buildx create --name api-builder |
| 126 | + $(CONTAINER_TOOL) buildx use api-builder |
| 127 | + - $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross . |
| 128 | + - $(CONTAINER_TOOL) buildx rm api-builder |
| 129 | + rm Dockerfile.cross |
| 130 | + |
| 131 | +.PHONY: build-installer |
| 132 | +build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment. |
| 133 | + mkdir -p dist |
| 134 | + cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} |
| 135 | + $(KUSTOMIZE) build config/default > dist/install.yaml |
| 136 | + |
| 137 | +##@ Deployment |
| 138 | + |
| 139 | +ifndef ignore-not-found |
| 140 | + ignore-not-found = false |
| 141 | +endif |
| 142 | + |
| 143 | +.PHONY: install |
| 144 | +install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config. |
| 145 | + $(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f - |
| 146 | + |
| 147 | +.PHONY: uninstall |
| 148 | +uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. |
| 149 | + $(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - |
| 150 | + |
| 151 | +.PHONY: deploy |
| 152 | +deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. |
| 153 | + cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} |
| 154 | + $(KUSTOMIZE) build config/default | $(KUBECTL) apply -f - |
| 155 | + |
| 156 | +.PHONY: undeploy |
| 157 | +undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. |
| 158 | + $(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - |
| 159 | + |
| 160 | +##@ Dependencies |
| 161 | + |
| 162 | +## Location to install dependencies to |
| 163 | +LOCALBIN ?= $(shell pwd)/bin |
| 164 | +$(LOCALBIN): |
| 165 | + mkdir -p $(LOCALBIN) |
| 166 | + |
| 167 | +## Tool Binaries |
| 168 | +KUBECTL ?= kubectl |
| 169 | +KUSTOMIZE ?= $(LOCALBIN)/kustomize |
| 170 | +CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen |
| 171 | +ENVTEST ?= $(LOCALBIN)/setup-envtest |
| 172 | +GOLANGCI_LINT = $(LOCALBIN)/golangci-lint |
| 173 | + |
| 174 | +## Tool Versions |
| 175 | +KUSTOMIZE_VERSION ?= v5.4.3 |
| 176 | +CONTROLLER_TOOLS_VERSION ?= v0.16.1 |
| 177 | +ENVTEST_VERSION ?= release-0.19 |
| 178 | +GOLANGCI_LINT_VERSION ?= v1.59.1 |
| 179 | + |
| 180 | +.PHONY: kustomize |
| 181 | +kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. |
| 182 | +$(KUSTOMIZE): $(LOCALBIN) |
| 183 | + $(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION)) |
| 184 | + |
| 185 | +.PHONY: controller-gen |
| 186 | +controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. |
| 187 | +$(CONTROLLER_GEN): $(LOCALBIN) |
| 188 | + $(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen,$(CONTROLLER_TOOLS_VERSION)) |
| 189 | + |
| 190 | +.PHONY: envtest |
| 191 | +envtest: $(ENVTEST) ## Download setup-envtest locally if necessary. |
| 192 | +$(ENVTEST): $(LOCALBIN) |
| 193 | + $(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest,$(ENVTEST_VERSION)) |
| 194 | + |
| 195 | +.PHONY: golangci-lint |
| 196 | +golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary. |
| 197 | +$(GOLANGCI_LINT): $(LOCALBIN) |
| 198 | + $(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION)) |
| 199 | + |
| 200 | +# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist |
| 201 | +# $1 - target path with name of binary |
| 202 | +# $2 - package url which can be installed |
| 203 | +# $3 - specific version of package |
| 204 | +define go-install-tool |
| 205 | +@[ -f "$(1)-$(3)" ] || { \ |
| 206 | +set -e; \ |
| 207 | +package=$(2)@$(3) ;\ |
| 208 | +echo "Downloading $${package}" ;\ |
| 209 | +rm -f $(1) || true ;\ |
| 210 | +GOBIN=$(LOCALBIN) go install $${package} ;\ |
| 211 | +mv $(1) $(1)-$(3) ;\ |
| 212 | +} ;\ |
| 213 | +ln -sf $(1)-$(3) $(1) |
| 214 | +endef |
0 commit comments