Makefile - druid-operator - Git at Google

 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
 # regarding copyright ownership.  The ASF licenses this file
 # to you 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.
 #

 # IMG TAG
 IMG_TAG ?= "latest"
 TEST_IMG_TAG ?= "test"
 # Image URL to use all building/pushing image targets
 IMG ?= "datainfrahq/druid-operator"
 # Local Image URL to be pushed to kind registery
 IMG_KIND ?= "localhost:5001/druid-operator"
 # NAMESPACE for druid operator e2e
 NAMESPACE_DRUID_OPERATOR ?= "druid-operator-system"
 # NAMESPACE for zk operator e2e
 NAMESPACE_ZK_OPERATOR ?= "zk-operator"
 # NAMESPACE for zk operator e2e
 NAMESPACE_MINIO_OPERATOR ?= "minio-operator"
 # MinIO version to install. Specific version is set to avoid breaking changes
 # using latest version. This version is tested with the operator.
 MINIO_VERSION ?= "6.0.4"
 # NAMESPACE for druid app e2e
 NAMESPACE_DRUID ?= "druid"
 # Set to false to skip the Apache RAT license audit
 ENABLE_RAT ?= true
 # Helm chart packaging defaults
 HELM_CHART_DIR ?= chart
 HELM_DIST_DIR ?= dist/helm
 HELM_REPO_URL ?= https://apache.github.io/druid-operator
 HELM_EXISTING_INDEX ?=
 HELM_CHART_NAME ?= $(shell awk '/^name:/{print $$2;exit}' $(HELM_CHART_DIR)/Chart.yaml)
 HELM_CHART_VERSION ?= $(shell awk '/^version:/{print $$2;exit}' $(HELM_CHART_DIR)/Chart.yaml)
 HELM_PACKAGE_FILE ?= $(HELM_DIST_DIR)/$(HELM_CHART_NAME)-$(HELM_CHART_VERSION).tgz

 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.26.0

 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
 GOBIN=$(shell go env GOPATH)/bin
 else
 GOBIN=$(shell go env GOBIN)
 endif

 # 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
 .SHELLFLAGS = -ec

 .PHONY: all
 all: build

 ##@ General

 # The help target prints out all targets with their descriptions organized
 # beneath their categories. The categories are represented by '##@' and the
 # target descriptions by '##'. The awk commands is responsible for reading the
 # entire set of makefiles included in this invocation, looking for lines of the
 # file as xyz: ## something, and then pretty-format the target and help. Then,
 # if there's a line with ##@ something, that gets pretty-printed as a category.
 # More info on the usage of ANSI control characters for terminal formatting:
 # https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
 # More info on the awk command:
 # http://linuxcommand.org/lc3_adv_awk.php

 .PHONY: help
 help: ## Display this help.
 	@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)

 ##@ Development

 .PHONY: kind
 kind: ## Bootstrap Kind Locally
 	sh e2e/kind.sh

 define APACHE_YAML_HEADER
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
 # regarding copyright ownership.  The ASF licenses this file
 # to you 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.
 #
 endef
 export APACHE_YAML_HEADER

 .PHONY: manifests
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) crd:generateEmbeddedObjectMeta=true rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 	$(CONTROLLER_GEN) crd:generateEmbeddedObjectMeta=true paths="./..." output:crd:artifacts:config=chart/crds/
 	@for f in config/crd/bases/druid.apache.org_*.yaml chart/crds/druid.apache.org_*.yaml config/rbac/role.yaml; do \
 		tmp=$$(mktemp) && \
 		{ printf '%s\n' "$$APACHE_YAML_HEADER"; cat $$f; } > $$tmp && \
 		mv $$tmp $$f; \
 	done

 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."

 .PHONY: fmt
 fmt: ## Run go fmt against code.
 	go fmt ./...

 .PHONY: vet
 vet: ## Run go vet against code.
 	go vet ./...

 ##@ Test
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out

 .PHONY: e2e
 e2e: ## Runs e2e tests
 	e2e/e2e.sh

 ifeq ($(ENABLE_RAT),true)
 .PHONY: rat
 rat: rat-jar ## Run Apache RAT license audit (set ENABLE_RAT=false to skip).
 	java -jar $(RAT_JAR) \
 	  --input-exclude-std GIT \
 	  --input-exclude "**/*.png" \
 	  --input-exclude "**/*.sum" \
 	  --input-exclude "**/*.sh" \
 	  --input-exclude "**/zz_generated.*.go" \
 	  --input-exclude "**/PROJECT" \
 	  --input-exclude "cover.out" \
 	  --input-exclude "dist/**" \
 	  -- .
 else
 .PHONY: rat
 rat: ## Run Apache RAT license audit (set ENABLE_RAT=false to skip).
 	@echo "Skipping Apache RAT license audit (ENABLE_RAT=false)"
 endif

 .PHONY: docker-build-local-test
 docker-build-local-test: ## Build docker image with the manager for test on kind.
 	docker build -t ${IMG_KIND}:${TEST_IMG_TAG} -f e2e/Dockerfile-testpod .

 .PHONY: docker-push-local-test
 docker-push-local-test: ## Push docker image with the manager to kind registry.
 	docker push ${IMG_KIND}:${TEST_IMG_TAG}

 .PHONY: kind-load-local-test
 kind-load-local-test: ## Load test docker image into kind cluster directly (no registry mirror needed).
 	kind load docker-image ${IMG_KIND}:${TEST_IMG_TAG}

 .PHONY: deploy-testjob
 deploy-testjob: ## Run a wikipedia test pod
 	kubectl create job wiki-test --image=${IMG_KIND}:${TEST_IMG_TAG}  -- sh /wikipedia-test.sh
 	JOB_ID="wiki-test" bash e2e/monitor-task.sh

 .PHONY: deploy-testingestionjob
 deploy-testingestionjob: ## wait for the druidIngestion to complete and then verify dataset
 	kubectl create job ingestion-test --image=${IMG_KIND}:${TEST_IMG_TAG}  -- sh /druid-ingestion-test.sh ${TASK_ID}
 	JOB_ID="ingestion-test" bash e2e/monitor-task.sh

 .PHONY: helm-install-druid-operator
 helm-install-druid-operator: ## Helm install to deploy the druid operator
 	helm upgrade --install \
 	--namespace ${NAMESPACE_DRUID_OPERATOR} \
 	--create-namespace \
 	${NAMESPACE_DRUID_OPERATOR} chart/ \
 	--set image.repository=${IMG_KIND} \
 	--set image.tag=${IMG_TAG}

 .PHONY: helm-minio-install
 helm-minio-install: ## Helm deploy minio operator and minio
 	helm repo add minio https://operator.min.io/
 	helm repo update minio
 	helm upgrade --install \
 	--namespace ${NAMESPACE_MINIO_OPERATOR} \
 	--create-namespace \
 	 ${NAMESPACE_MINIO_OPERATOR} minio/operator \
 	--version ${MINIO_VERSION} \
 	-f e2e/configs/minio-operator-override.yaml
 	helm upgrade --install \
 	--namespace ${NAMESPACE_DRUID} \
 	--version ${MINIO_VERSION} \
 	--create-namespace \
   	${NAMESPACE_DRUID}-minio minio/tenant \
 	-f e2e/configs/minio-tenant-override.yaml

 ##@ Build

 .PHONY: build
 build: manifests generate fmt vet ## Build manager binary.
 	go build -o bin/manager main.go

 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
 	go run ./main.go

 # If you wish built the manager image targeting other platforms you can use the --platform flag.
 # (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
 # More info: https://docs.docker.com/develop/develop-images/build_enhancements/
 .PHONY: docker-build
 docker-build: test ## Build docker image with the manager.
 	docker build -t ${IMG}:${IMG_TAG} .

 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
 	docker push ${IMG}:${IMG_TAG}

 .PHONY: docker-build-local
 docker-build-local: ## Build docker image with the manager for kind registry.
 	docker build -t ${IMG_KIND}:${IMG_TAG} .

 .PHONY: docker-push-local
 docker-push-local: ## Push docker image with the manager to kind registry.
 	docker push ${IMG_KIND}:${IMG_TAG}

 .PHONY: kind-load-local
 kind-load-local: ## Load docker image into kind cluster directly (no registry mirror needed).
 	kind load docker-image ${IMG_KIND}:${IMG_TAG}

 # PLATFORMS defines the target platforms for  the manager image be build to provide support to multiple
 # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
 # - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
 # - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
 # - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
 # To properly provided solutions that supports more than one platform you should use this option.
 PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 .PHONY: docker-buildx
 docker-buildx: test ## Build and push docker image for the manager for cross-platform support
 	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
 	- docker buildx create --name project-v3-builder
 	docker buildx use project-v3-builder
 	- docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG}:${IMG_TAG} -f Dockerfile.cross .
 	- docker buildx rm project-v3-builder
 	rm Dockerfile.cross

 ##@ Deployment

 ifndef ignore-not-found
   ignore-not-found = false
 endif

 .PHONY: install
 install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
 	$(KUSTOMIZE) build config/crd | kubectl apply --server-side -f -

 .PHONY: uninstall
 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.
 	$(KUSTOMIZE) build config/crd | kubectl delete --ignore-not-found=$(ignore-not-found) -f -

 .PHONY: deploy
 deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
 	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}:${IMG_TAG}
 	$(KUSTOMIZE) build config/default | kubectl apply --server-side -f -

 .PHONY: undeploy
 undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
 	$(KUSTOMIZE) build config/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -

 ##@ Helm
 .PHONY: helm-generate
 helm-generate: ## Generate the Helm chart directory
 	$(KUSTOMIZE) build config/crd > chart/crds/druid.apache.org_druids.yaml

 .PHONY: helm-lint
 helm-lint: ## Lint Helm chart.
 	helm lint ./chart

 .PHONY: helm-template
 helm-template: ## Run Helm template.
 	helm -n druid-operator-system template --create-namespace ${NAMESPACE_DRUID_OPERATOR} ./chart --debug

 .PHONY: helm-package
 helm-package: ## Package the Helm chart and update a local Helm repository index.
 	@mkdir -p $(HELM_DIST_DIR)
 	@rm -f $(HELM_PACKAGE_FILE)
 	@echo "Packaging $(HELM_CHART_NAME) chart version $(HELM_CHART_VERSION) into $(HELM_DIST_DIR)"
 	helm package $(HELM_CHART_DIR) --destination $(HELM_DIST_DIR)
 	@tar -tzf $(HELM_PACKAGE_FILE) | grep -Eq '^[^/]+/LICENSE$$'
 	@tar -tzf $(HELM_PACKAGE_FILE) | grep -Eq '^[^/]+/NOTICE$$'
 	@if [ -n "$(HELM_EXISTING_INDEX)" ] && [ -f "$(HELM_EXISTING_INDEX)" ]; then \
 		echo "Merging repo index with $(HELM_EXISTING_INDEX)"; \
 		helm repo index $(HELM_DIST_DIR) --url $(HELM_REPO_URL) --merge $(HELM_EXISTING_INDEX); \
 	else \
 		echo "Generating fresh repo index for $(HELM_REPO_URL)"; \
 		helm repo index $(HELM_DIST_DIR) --url $(HELM_REPO_URL); \
 	fi
 	@echo "Helm chart artifacts are available under $(HELM_DIST_DIR)"

 ##@ Documentation

 .PHONY: api-docs
 api-docs: gen-crd-api-reference-docs ## Generate API reference documentation
 	$(GEN_CRD_API_REFERENCE_DOCS) -api-dir=./apis/druid/v1alpha1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api_specifications/druid.md

 ##@ Build Dependencies

 ## Location to install dependencies to
 LOCALBIN ?= $(shell pwd)/bin
 $(LOCALBIN):
 	mkdir -p $(LOCALBIN)

 ## Tool Binaries
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 GEN_CRD_API_REFERENCE_DOCS = $(LOCALBIN)/gen-crd-api-reference-docs
 ENVTEST ?= $(LOCALBIN)/setup-envtest
 RAT_JAR ?= $(LOCALBIN)/apache-rat.jar

 ## Tool Versions
 KUSTOMIZE_VERSION ?= v3.8.7
 CONTROLLER_TOOLS_VERSION ?= v0.20.1
 GEN_CRD_API_REF_VERSION ?= v0.3.0
 RAT_VERSION ?= 0.17

 KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 .PHONY: kustomize
 kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
 $(KUSTOMIZE): $(LOCALBIN)
 	@if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version | grep -q $(KUSTOMIZE_VERSION); then \
 		echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \
 		rm -rf $(LOCALBIN)/kustomize; \
 	fi
 	test -s $(LOCALBIN)/kustomize || { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }

 .PHONY: controller-gen
 controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
 $(CONTROLLER_GEN): $(LOCALBIN)
 	test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION) || \
 	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)

 .PHONY: envtest
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest

 .PHONY: gen-crd-api-reference-docs
 gen-crd-api-reference-docs: $(GEN_CRD_API_REFERENCE_DOCS)
 $(GEN_CRD_API_REFERENCE_DOCS): $(LOCALBIN)
 	GOBIN=$(LOCALBIN) go install github.com/ahmetb/gen-crd-api-reference-docs@$(GEN_CRD_API_REF_VERSION)

 .PHONY: rat-jar
 rat-jar: $(RAT_JAR) ## Download Apache RAT jar locally if necessary.
 $(RAT_JAR): | $(LOCALBIN)
 	mkdir -p /tmp/rat-download && \
 	curl -sSL "https://archive.apache.org/dist/creadur/apache-rat-$(RAT_VERSION)/apache-rat-$(RAT_VERSION)-bin.tar.gz" \
 	  -o /tmp/rat-download/rat.tar.gz && \
 	tar -xzf /tmp/rat-download/rat.tar.gz -C /tmp/rat-download && \
 	mv /tmp/rat-download/apache-rat-$(RAT_VERSION)/apache-rat-$(RAT_VERSION).jar $(RAT_JAR) && \
 	rm -rf /tmp/rat-download
	#
	# Licensed to the Apache Software Foundation (ASF) under one
	# or more contributor license agreements. See the NOTICE file
	# distributed with this work for additional information
	# regarding copyright ownership. The ASF licenses this file
	# to you 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.
	#

	# IMG TAG
	IMG_TAG ?= "latest"
	TEST_IMG_TAG ?= "test"
	# Image URL to use all building/pushing image targets
	IMG ?= "datainfrahq/druid-operator"
	# Local Image URL to be pushed to kind registery
	IMG_KIND ?= "localhost:5001/druid-operator"
	# NAMESPACE for druid operator e2e
	NAMESPACE_DRUID_OPERATOR ?= "druid-operator-system"
	# NAMESPACE for zk operator e2e
	NAMESPACE_ZK_OPERATOR ?= "zk-operator"
	# NAMESPACE for zk operator e2e
	NAMESPACE_MINIO_OPERATOR ?= "minio-operator"
	# MinIO version to install. Specific version is set to avoid breaking changes
	# using latest version. This version is tested with the operator.
	MINIO_VERSION ?= "6.0.4"
	# NAMESPACE for druid app e2e
	NAMESPACE_DRUID ?= "druid"
	# Set to false to skip the Apache RAT license audit
	ENABLE_RAT ?= true
	# Helm chart packaging defaults
	HELM_CHART_DIR ?= chart
	HELM_DIST_DIR ?= dist/helm
	HELM_REPO_URL ?= https://apache.github.io/druid-operator
	HELM_EXISTING_INDEX ?=
	HELM_CHART_NAME ?= $(shell awk '/^name:/{print $$2;exit}' $(HELM_CHART_DIR)/Chart.yaml)
	HELM_CHART_VERSION ?= $(shell awk '/^version:/{print $$2;exit}' $(HELM_CHART_DIR)/Chart.yaml)
	HELM_PACKAGE_FILE ?= $(HELM_DIST_DIR)/$(HELM_CHART_NAME)-$(HELM_CHART_VERSION).tgz

	# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
	ENVTEST_K8S_VERSION = 1.26.0

	# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
	ifeq (,$(shell go env GOBIN))
	GOBIN=$(shell go env GOPATH)/bin
	else
	GOBIN=$(shell go env GOBIN)
	endif

	# 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
	.SHELLFLAGS = -ec

	.PHONY: all
	all: build

	##@ General

	# The help target prints out all targets with their descriptions organized
	# beneath their categories. The categories are represented by '##@' and the
	# target descriptions by '##'. The awk commands is responsible for reading the
	# entire set of makefiles included in this invocation, looking for lines of the
	# file as xyz: ## something, and then pretty-format the target and help. Then,
	# if there's a line with ##@ something, that gets pretty-printed as a category.
	# More info on the usage of ANSI control characters for terminal formatting:
	# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
	# More info on the awk command:
	# http://linuxcommand.org/lc3_adv_awk.php

	.PHONY: help
	help: ## Display this help.
	@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)

	##@ Development

	.PHONY: kind
	kind: ## Bootstrap Kind Locally
	sh e2e/kind.sh

	define APACHE_YAML_HEADER
	#
	# Licensed to the Apache Software Foundation (ASF) under one
	# or more contributor license agreements. See the NOTICE file
	# distributed with this work for additional information
	# regarding copyright ownership. The ASF licenses this file
	# to you 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.
	#
	endef
	export APACHE_YAML_HEADER

	.PHONY: manifests
	manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
	$(CONTROLLER_GEN) crd:generateEmbeddedObjectMeta=true rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
	$(CONTROLLER_GEN) crd:generateEmbeddedObjectMeta=true paths="./..." output:crd:artifacts:config=chart/crds/
	@for f in config/crd/bases/druid.apache.org_.yaml chart/crds/druid.apache.org_.yaml config/rbac/role.yaml; do \
	tmp=$$(mktemp) && \
	{ printf '%s\n' "$$APACHE_YAML_HEADER"; cat $$f; } > $$tmp && \
	mv $$tmp $$f; \
	done

	.PHONY: generate
	generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."

	.PHONY: fmt
	fmt: ## Run go fmt against code.
	go fmt ./...

	.PHONY: vet
	vet: ## Run go vet against code.
	go vet ./...

	##@ Test
	.PHONY: test
	test: manifests generate fmt vet envtest ## Run tests.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out

	.PHONY: e2e
	e2e: ## Runs e2e tests
	e2e/e2e.sh

	ifeq ($(ENABLE_RAT),true)
	.PHONY: rat
	rat: rat-jar ## Run Apache RAT license audit (set ENABLE_RAT=false to skip).
	java -jar $(RAT_JAR) \
	--input-exclude-std GIT \
	--input-exclude "*/.png" \
	--input-exclude "*/.sum" \
	--input-exclude "*/.sh" \
	--input-exclude "*/zz_generated..go" \
	--input-exclude "**/PROJECT" \
	--input-exclude "cover.out" \
	--input-exclude "dist/**" \
	-- .
	else
	.PHONY: rat
	rat: ## Run Apache RAT license audit (set ENABLE_RAT=false to skip).
	@echo "Skipping Apache RAT license audit (ENABLE_RAT=false)"
	endif

	.PHONY: docker-build-local-test
	docker-build-local-test: ## Build docker image with the manager for test on kind.
	docker build -t ${IMG_KIND}:${TEST_IMG_TAG} -f e2e/Dockerfile-testpod .

	.PHONY: docker-push-local-test
	docker-push-local-test: ## Push docker image with the manager to kind registry.
	docker push ${IMG_KIND}:${TEST_IMG_TAG}

	.PHONY: kind-load-local-test
	kind-load-local-test: ## Load test docker image into kind cluster directly (no registry mirror needed).
	kind load docker-image ${IMG_KIND}:${TEST_IMG_TAG}

	.PHONY: deploy-testjob
	deploy-testjob: ## Run a wikipedia test pod
	kubectl create job wiki-test --image=${IMG_KIND}:${TEST_IMG_TAG} -- sh /wikipedia-test.sh
	JOB_ID="wiki-test" bash e2e/monitor-task.sh

	.PHONY: deploy-testingestionjob
	deploy-testingestionjob: ## wait for the druidIngestion to complete and then verify dataset
	kubectl create job ingestion-test --image=${IMG_KIND}:${TEST_IMG_TAG} -- sh /druid-ingestion-test.sh ${TASK_ID}
	JOB_ID="ingestion-test" bash e2e/monitor-task.sh

	.PHONY: helm-install-druid-operator
	helm-install-druid-operator: ## Helm install to deploy the druid operator
	helm upgrade --install \
	--namespace ${NAMESPACE_DRUID_OPERATOR} \
	--create-namespace \
	${NAMESPACE_DRUID_OPERATOR} chart/ \
	--set image.repository=${IMG_KIND} \
	--set image.tag=${IMG_TAG}

	.PHONY: helm-minio-install
	helm-minio-install: ## Helm deploy minio operator and minio
	helm repo add minio https://operator.min.io/
	helm repo update minio
	helm upgrade --install \
	--namespace ${NAMESPACE_MINIO_OPERATOR} \
	--create-namespace \
	${NAMESPACE_MINIO_OPERATOR} minio/operator \
	--version ${MINIO_VERSION} \
	-f e2e/configs/minio-operator-override.yaml
	helm upgrade --install \
	--namespace ${NAMESPACE_DRUID} \
	--version ${MINIO_VERSION} \
	--create-namespace \
	${NAMESPACE_DRUID}-minio minio/tenant \
	-f e2e/configs/minio-tenant-override.yaml

	##@ Build

	.PHONY: build
	build: manifests generate fmt vet ## Build manager binary.
	go build -o bin/manager main.go

	.PHONY: run
	run: manifests generate fmt vet ## Run a controller from your host.
	go run ./main.go

	# If you wish built the manager image targeting other platforms you can use the --platform flag.
	# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
	# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
	.PHONY: docker-build
	docker-build: test ## Build docker image with the manager.
	docker build -t ${IMG}:${IMG_TAG} .

	.PHONY: docker-push
	docker-push: ## Push docker image with the manager.
	docker push ${IMG}:${IMG_TAG}

	.PHONY: docker-build-local
	docker-build-local: ## Build docker image with the manager for kind registry.
	docker build -t ${IMG_KIND}:${IMG_TAG} .

	.PHONY: docker-push-local
	docker-push-local: ## Push docker image with the manager to kind registry.
	docker push ${IMG_KIND}:${IMG_TAG}

	.PHONY: kind-load-local
	kind-load-local: ## Load docker image into kind cluster directly (no registry mirror needed).
	kind load docker-image ${IMG_KIND}:${IMG_TAG}

	# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
	# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
	# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
	# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
	# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
	# To properly provided solutions that supports more than one platform you should use this option.
	PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
	.PHONY: docker-buildx
	docker-buildx: test ## Build and push docker image for the manager for cross-platform support
	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
	- docker buildx create --name project-v3-builder
	docker buildx use project-v3-builder
	- docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG}:${IMG_TAG} -f Dockerfile.cross .
	- docker buildx rm project-v3-builder
	rm Dockerfile.cross

	##@ Deployment

	ifndef ignore-not-found
	ignore-not-found = false
	endif

	.PHONY: install
	install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
	$(KUSTOMIZE) build config/crd \| kubectl apply --server-side -f -

	.PHONY: uninstall
	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.
	$(KUSTOMIZE) build config/crd \| kubectl delete --ignore-not-found=$(ignore-not-found) -f -

	.PHONY: deploy
	deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}:${IMG_TAG}
	$(KUSTOMIZE) build config/default \| kubectl apply --server-side -f -

	.PHONY: undeploy
	undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
	$(KUSTOMIZE) build config/default \| kubectl delete --ignore-not-found=$(ignore-not-found) -f -

	##@ Helm
	.PHONY: helm-generate
	helm-generate: ## Generate the Helm chart directory
	$(KUSTOMIZE) build config/crd > chart/crds/druid.apache.org_druids.yaml

	.PHONY: helm-lint
	helm-lint: ## Lint Helm chart.
	helm lint ./chart

	.PHONY: helm-template
	helm-template: ## Run Helm template.
	helm -n druid-operator-system template --create-namespace ${NAMESPACE_DRUID_OPERATOR} ./chart --debug

	.PHONY: helm-package
	helm-package: ## Package the Helm chart and update a local Helm repository index.
	@mkdir -p $(HELM_DIST_DIR)
	@rm -f $(HELM_PACKAGE_FILE)
	@echo "Packaging $(HELM_CHART_NAME) chart version $(HELM_CHART_VERSION) into $(HELM_DIST_DIR)"
	helm package $(HELM_CHART_DIR) --destination $(HELM_DIST_DIR)
	@tar -tzf $(HELM_PACKAGE_FILE) \| grep -Eq '^[^/]+/LICENSE$$'
	@tar -tzf $(HELM_PACKAGE_FILE) \| grep -Eq '^[^/]+/NOTICE$$'
	@if [ -n "$(HELM_EXISTING_INDEX)" ] && [ -f "$(HELM_EXISTING_INDEX)" ]; then \
	echo "Merging repo index with $(HELM_EXISTING_INDEX)"; \
	helm repo index $(HELM_DIST_DIR) --url $(HELM_REPO_URL) --merge $(HELM_EXISTING_INDEX); \
	else \
	echo "Generating fresh repo index for $(HELM_REPO_URL)"; \
	helm repo index $(HELM_DIST_DIR) --url $(HELM_REPO_URL); \
	fi
	@echo "Helm chart artifacts are available under $(HELM_DIST_DIR)"

	##@ Documentation

	.PHONY: api-docs
	api-docs: gen-crd-api-reference-docs ## Generate API reference documentation
	$(GEN_CRD_API_REFERENCE_DOCS) -api-dir=./apis/druid/v1alpha1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api_specifications/druid.md

	##@ Build Dependencies

	## Location to install dependencies to
	LOCALBIN ?= $(shell pwd)/bin
	$(LOCALBIN):
	mkdir -p $(LOCALBIN)

	## Tool Binaries
	KUSTOMIZE ?= $(LOCALBIN)/kustomize
	CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
	GEN_CRD_API_REFERENCE_DOCS = $(LOCALBIN)/gen-crd-api-reference-docs
	ENVTEST ?= $(LOCALBIN)/setup-envtest
	RAT_JAR ?= $(LOCALBIN)/apache-rat.jar

	## Tool Versions
	KUSTOMIZE_VERSION ?= v3.8.7
	CONTROLLER_TOOLS_VERSION ?= v0.20.1
	GEN_CRD_API_REF_VERSION ?= v0.3.0
	RAT_VERSION ?= 0.17

	KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
	.PHONY: kustomize
	kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
	$(KUSTOMIZE): $(LOCALBIN)
	@if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version \| grep -q $(KUSTOMIZE_VERSION); then \
	echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \
	rm -rf $(LOCALBIN)/kustomize; \
	fi
	test -s $(LOCALBIN)/kustomize \|\| { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) \| bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }

	.PHONY: controller-gen
	controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
	$(CONTROLLER_GEN): $(LOCALBIN)
	test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version \| grep -q $(CONTROLLER_TOOLS_VERSION) \|\| \
	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)

	.PHONY: envtest
	envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
	$(ENVTEST): $(LOCALBIN)
	test -s $(LOCALBIN)/setup-envtest \|\| GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest

	.PHONY: gen-crd-api-reference-docs
	gen-crd-api-reference-docs: $(GEN_CRD_API_REFERENCE_DOCS)
	$(GEN_CRD_API_REFERENCE_DOCS): $(LOCALBIN)
	GOBIN=$(LOCALBIN) go install github.com/ahmetb/gen-crd-api-reference-docs@$(GEN_CRD_API_REF_VERSION)

	.PHONY: rat-jar
	rat-jar: $(RAT_JAR) ## Download Apache RAT jar locally if necessary.
	$(RAT_JAR): \| $(LOCALBIN)
	mkdir -p /tmp/rat-download && \
	curl -sSL "https://archive.apache.org/dist/creadur/apache-rat-$(RAT_VERSION)/apache-rat-$(RAT_VERSION)-bin.tar.gz" \
	-o /tmp/rat-download/rat.tar.gz && \
	tar -xzf /tmp/rat-download/rat.tar.gz -C /tmp/rat-download && \
	mv /tmp/rat-download/apache-rat-$(RAT_VERSION)/apache-rat-$(RAT_VERSION).jar $(RAT_JAR) && \
	rm -rf /tmp/rat-download