Makefile

# VERSION defines the project version for the bundle.
# Update this value when you upgrade the version of your project.
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
ifeq ($(VERSION),)
VERSION := $(shell git tag --list "v[0-9]*.[0-9]*.[0-9]*" --sort=-v:refname | head -n1 | cut -c 2-)
ifeq ($(VERSION),)
VERSION := 0.0.0
endif
FULL_VERSION := v$(VERSION)-$(shell git rev-parse --short HEAD)
else
FULL_VERSION := v$(VERSION)
endif

# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
# To re-generate a bundle for other specific channels without changing the standard setup, you can:
# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=candidate,fast,stable)
# - use environment variables to overwrite this value (e.g export CHANNELS="candidate,fast,stable")
CHANNELS ?= stable
BUNDLE_CHANNELS := --channels=$(CHANNELS)

# DEFAULT_CHANNEL defines the default channel used in the bundle.
# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
# To re-generate a bundle for any other default channel without changing the default setup, you can:
# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
DEFAULT_CHANNEL ?= stable
BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)

IMAGE_REPO ?= ghcr.io/clickhouse

# IMAGE_TAG_BASE defines the docker.io namespace and part of the image name for remote images.
# This variable is used to construct full image tags for bundle and catalog images.
#
# For example, running 'make bundle-build bundle-push catalog-build catalog-push' will build and push both
# ghcr.io/clickhouse/clickhouse-operator-bundle:$VERSION and ghcr.io/clickhouse/clickhouse-operator-catalog:$VERSION.
IMAGE_TAG_BASE ?= $(IMAGE_REPO)/clickhouse-operator

# BUNDLE_IMG defines the image:tag used for the bundle.
# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:$(FULL_VERSION)

# BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)

# USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
# You can enable this value if you would like to use SHA Based Digests
# To enable set flag to true
USE_IMAGE_DIGESTS ?= false
ifeq ($(USE_IMAGE_DIGESTS), true)
	BUNDLE_GEN_FLAGS += --use-image-digests
endif

# Set the Operator SDK version to use. By default, what is installed on the system is used.
# This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
OPERATOR_SDK_VERSION ?= v1.42.0
OPERATOR_MANAGER_VERSION ?= v1.62.0
# Image URL to use all building/pushing image targets
IMG ?= ${IMAGE_TAG_BASE}:${FULL_VERSION}
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION ?= 1.33.0

# HELM_IMG defines the image used for the helm chart oci-based repo.
HELM_IMG ?= $(IMAGE_REPO)/clickhouse-operator-helm

# 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

# CONTAINER_TOOL defines the container tool to be used for building images.
# Be aware that the target commands are only tested with Docker which is
# scaffolded by default. However, you might want to replace it to use other
# tools. (i.e. podman)
CONTAINER_TOOL ?= docker

# 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 command 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: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases

.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 ./...

.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 $$(go list ./... | grep -v /e2e | grep -v /helm) \
	--ginkgo.v

.PHONY: test-ci
test-ci: manifests generate fmt vet envtest ## Run tests in CI env.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e | grep -v /helm) \
	-v -count=1 -race -coverprofile cover.out --ginkgo.v --ginkgo.junit-report=report/junit-report.xml

fuzz-keeper: generate # Run keeper spec fuzz tests
	go test -run=^$$ -fuzz=FuzzClusterSpec -fuzztime 60s ./internal/controller/keeper

fuzz-clickhouse: generate # Run clickhouse spec fuzz tests
	go test -run=^$$ -fuzz=FuzzClusterSpec -fuzztime 60s ./internal/controller/clickhouse

fuzz: fuzz-keeper fuzz-clickhouse ## Run all fuzz tests

# Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
.PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
test-e2e: ## Run all e2e tests.
	go test ./test/e2e/ -test.timeout 30m --ginkgo.v

.PHONY: test-keeper-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
test-keeper-e2e: ## Run keeper e2e tests.
	go test ./test/e2e/ --ginkgo.label-filter keeper -test.timeout 30m --ginkgo.v --ginkgo.junit-report=report/junit-report.xml

.PHONY: test-clickhouse-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
test-clickhouse-e2e: ## Run clickhouse e2e tests.
	go test ./test/e2e/ --ginkgo.label-filter clickhouse -test.timeout 30m --ginkgo.v --ginkgo.junit-report=report/junit-report.xml

.PHONY: test-compat-e2e  # Run compatibility smoke tests across ClickHouse versions.
test-compat-e2e: ## Run compatibility e2e tests.
	go test ./test/e2e/ --ginkgo.label-filter compatibility -test.timeout 30m --ginkgo.v --ginkgo.junit-report=report/junit-report.xml

.PHONY: test-helm  # Run helm chart tests against a Kind k8s instance that is spun up.
test-helm: ginkgo ## Run helm chart tests
	$(GINKGO) run --nodes 4 -p -v --junit-report=report/junit-report.xml test/helm

.PHONY: lint
lint: golangci-lint codespell actionlint ## Run golangci-lint linter, codespell, and actionlint
	$(GOLANGCI_LINT) run
	$(CODESPELL) --config ci/.codespellrc
	$(ACTIONLINT) -config-file ci/actionlint.yaml

.PHONY: golangci-fmt
golangci-fmt: golangci-lint ## Run golangci-lint fmt
	$(GOLANGCI_LINT) fmt

.PHONY: lint-actions
lint-actions: actionlint ## Lint GitHub Actions workflow files
	$(ACTIONLINT) -config-file ci/actionlint.yaml -shellcheck "$(shell which shellcheck)"

.PHONY: lint-fix
lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
	$(GOLANGCI_LINT) run --fix

##@ Helm Chart

.PHONY: generate-helmchart
generate-helmchart: kubebuilder ## Generate helm charts
	$(KUBEBUILDER) edit --plugins=helm/v2-alpha
	rm .github/workflows/test-chart.yml dist/install.yaml

.PHONY: generate-helmchart-ci
generate-helmchart-ci: generate-helmchart ## Generate helm charts and reset some files that will always generate diff
	git checkout dist/chart/templates/cert-manager/
	git checkout dist/chart/templates/manager/
	git checkout dist/chart/templates/metrics/
	git checkout dist/chart/templates/monitoring/
	git checkout dist/chart/templates/webhook/

.PHONY: build-helmchart-dependencies
build-helmchart-dependencies: ## Build helm chart dependencies
	helm dependency build dist/chart

.PHONY: package-helmchart
package-helmchart: build-helmchart-dependencies ## Package helm chart. It will be saved as clickhouse-operator-helm-$(VERSION).tgz
	helm package --version ${VERSION} --app-version v${VERSION} dist/chart

.PHONY: push-helmchart
push-helmchart: package-helmchart ## Push helm image. It will be pushed to the ${IMAGE_REPO}/(helmchart name, same as in Chart.yaml)
	helm push clickhouse-operator-helm-${VERSION}.tgz oci://$(IMAGE_REPO)

##@ Build

GIT_COMMIT ?= $(shell git rev-parse HEAD 2>/dev/null || echo "unknown")
BUILD_TIME ?= $(shell date "+%FT%T")
VERSION_PKG = github.com/ClickHouse/clickhouse-operator/internal/version
GO_LDFLAGS = -ldflags "-X $(VERSION_PKG).Version=$(FULL_VERSION) -X $(VERSION_PKG).GitCommitHash=$(GIT_COMMIT) -X $(VERSION_PKG).BuildTime=$(BUILD_TIME)"

.PHONY: build
build: manifests generate fmt vet ## Build manager binary.
	go build $(GO_LDFLAGS) -o bin/clickhouse-manager cmd/main.go

.PHONY: build-linux-manager
build-linux-manager:
	CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} GO111MODULE=on go build -gcflags="all=-N -l" $(GO_LDFLAGS) -o bin/manager_linux cmd/main.go

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

# If you wish to build 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: ## Build docker image with the manager.
	$(CONTAINER_TOOL) build \
		--build-arg VERSION=$(FULL_VERSION) \
		--build-arg GIT_COMMIT=$(GIT_COMMIT) \
		--build-arg BUILD_TIME=$(BUILD_TIME) \
		-t ${IMG} .

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

# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
# - 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)
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
.PHONY: docker-buildx
docker-buildx: ## 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
	- $(CONTAINER_TOOL) buildx create --name clickhouse-operator-builder
	$(CONTAINER_TOOL) buildx use clickhouse-operator-builder
	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) \
		--build-arg VERSION=$(FULL_VERSION) \
		--build-arg GIT_COMMIT=$(GIT_COMMIT) \
		--build-arg BUILD_TIME=$(BUILD_TIME) \
		--tag ${IMG} -f Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm clickhouse-operator-builder
	rm Dockerfile.cross

docker-buildx-latest: docker-buildx ## Build and push docker image and tag it as latest
	$(CONTAINER_TOOL) buildx imagetools create -t $(IMAGE_TAG_BASE):latest $(IMG)

PLATFORMS_SPLITTED = $(shell echo $(PLATFORMS) | tr "," " ")
.PHONY: docker-save
docker-save: ## Save docker images as a tgz archives.
	for PLATFORM in $(PLATFORMS_SPLITTED); do\
		$(CONTAINER_TOOL) pull --platform=$$PLATFORM $(IMG);\
		$(CONTAINER_TOOL) image save --platform=$$PLATFORM $(IMG) | gzip > clickhouse-operator_$(VERSION)_$$(echo $$PLATFORM | tr "/" "_").tar.gz;\
	done

.PHONY: build-installer
build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
	mkdir -p dist
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/default > dist/install.yaml

##@ 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 -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}
	$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -

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

##@ Dependencies

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

## Tool Binaries
KUBECTL ?= kubectl
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest
GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
GINKGO ?= $(LOCALBIN)/ginkgo
KUBEBUILDER ?= $(LOCALBIN)/kubebuilder
CODESPELL ?= $(LOCALBIN)/codespell
CRD_SCHEMA_CHECKER ?= $(LOCALBIN)/crd-schema-checker
CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
ACTIONLINT ?= $(LOCALBIN)/actionlint

## Tool Versions
KUSTOMIZE_VERSION ?= v5.7.1
CONTROLLER_TOOLS_VERSION ?= v0.20.1
ENVTEST_VERSION ?= release-0.22
GOLANGCI_LINT_VERSION ?= v2.9.0
GINKGO_VERSION ?= v2.28.1
KUBEBUILDER_VERSION ?= v4.12.0
CODESPELL_VERSION ?= 2.4.1
CRD_SCHEMA_CHECKER_VERSION ?= latest
CRD_REF_DOCS_VERSION ?= v0.3.0
ACTIONLINT_VERSION ?= v1.7.7

.PHONY: kustomize
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE): $(LOCALBIN)
	$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))

.PHONY: controller-gen
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
$(CONTROLLER_GEN): $(LOCALBIN)
	$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen,$(CONTROLLER_TOOLS_VERSION))

.PHONY: envtest
envtest: $(ENVTEST) ## Download setup-envtest locally if necessary.
$(ENVTEST): $(LOCALBIN)
	$(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest,$(ENVTEST_VERSION))

.PHONY: golangci-lint
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
$(GOLANGCI_LINT): $(LOCALBIN)
	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))

.PHONY: ginkgo
ginkgo: $(GINKGO) ## Download ginkgo locally if necessary.
$(GINKGO): $(LOCALBIN)
	$(call go-install-tool,$(GINKGO),github.com/onsi/ginkgo/v2/ginkgo,$(GINKGO_VERSION))

.PHONY: kubebuilder
kubebuilder: $(KUBEBUILDER) ## Download kubebuilder locally if necessary.
$(KUBEBUILDER): $(LOCALBIN)
	@test -f $(KUBEBUILDER) || { \
		echo "Downloading kubebuilder $(KUBEBUILDER_VERSION)" ;\
		curl -L -o ${KUBEBUILDER} "https://github.com/kubernetes-sigs/kubebuilder/releases/download/$(KUBEBUILDER_VERSION)/kubebuilder_$(shell go env GOOS)_$(shell go env GOARCH)" ;\
		chmod +x $(KUBEBUILDER) ;\
	}

.PHONY: codespell
codespell: $(CODESPELL) ## Install codespell locally if necessary.
$(CODESPELL): $(LOCALBIN)
	@test -f $(CODESPELL) || { \
		echo "Installing codespell $(CODESPELL_VERSION)" ;\
		python3 -m pip install --target=$(LOCALBIN)/codespell-deps codespell==$(CODESPELL_VERSION) ;\
		echo '#!/bin/bash' > $(CODESPELL) ;\
		echo 'DIR="$$(cd "$$(dirname "$$0")" && pwd)"' >> $(CODESPELL) ;\
		echo 'PYTHONPATH="$$DIR/codespell-deps" "$$DIR/codespell-deps/bin/codespell" "$$@"' >> $(CODESPELL) ;\
		chmod +x $(CODESPELL) ;\
	}

.PHONY: crd-schema-checker
crd-schema-checker: $(CRD_SCHEMA_CHECKER) ## Download crd-schema-checker locally if necessary.
$(CRD_SCHEMA_CHECKER): $(LOCALBIN)
	$(call go-install-tool,$(CRD_SCHEMA_CHECKER),github.com/openshift/crd-schema-checker/cmd/crd-schema-checker,$(CRD_SCHEMA_CHECKER_VERSION))

.PHONY: actionlint
actionlint: $(ACTIONLINT) ## Download actionlint locally if necessary.
$(ACTIONLINT): $(LOCALBIN)
	$(call go-install-tool,$(ACTIONLINT),github.com/rhysd/actionlint/cmd/actionlint,$(ACTIONLINT_VERSION))

CRD_BASE_REF ?= origin/main
.PHONY: check-crd-compat
check-crd-compat: crd-schema-checker ## Check CRD backward compatibility against $(CRD_BASE_REF).
	@FAILED=0; \
	for crd in config/crd/bases/*.yaml; do \
		echo "Checking $$crd against $(CRD_BASE_REF)..."; \
		BASELINE=$$(mktemp); \
		if ! git show $(CRD_BASE_REF):$$crd > "$$BASELINE" 2>/dev/null; then \
			echo "  No baseline found at $(CRD_BASE_REF):$$crd — skipping (new CRD)"; \
			rm -f "$$BASELINE"; \
			continue; \
		fi; \
		if ! $(CRD_SCHEMA_CHECKER) check-manifests --existing-crd-filename="$$BASELINE" --new-crd-filename="$$crd"; then \
			FAILED=1; \
		fi; \
		rm -f "$$BASELINE"; \
	done; \
	exit $$FAILED

# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
# $1 - target path with name of binary
# $2 - package url which can be installed
# $3 - specific version of package
define go-install-tool
@[ -f "$(1)-$(3)" ] || { \
set -e; \
package=$(2)@$(3) ;\
echo "Downloading $${package}" ;\
rm -f $(1) || true ;\
GOBIN=$(LOCALBIN) go install $${package} ;\
mv $(1) $(1)-$(3) ;\
} ;\
ln -sf $(1)-$(3) $(1)
endef

.PHONY: operator-sdk
OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk
operator-sdk: ## Download operator-sdk locally if necessary.
ifeq (,$(wildcard $(OPERATOR_SDK)))
ifeq (, $(shell which operator-sdk 2>/dev/null))
	@{ \
	set -e ;\
	mkdir -p $(dir $(OPERATOR_SDK)) ;\
	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
	curl -sSLo $(OPERATOR_SDK) https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)/operator-sdk_$${OS}_$${ARCH} ;\
	chmod +x $(OPERATOR_SDK) ;\
	}
else
OPERATOR_SDK = $(shell which operator-sdk)
endif
endif

.PHONY: bundle
bundle: manifests kustomize operator-sdk ## Generate bundle manifests and metadata, then validate generated files.
	$(OPERATOR_SDK) generate kustomize manifests -q
	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
	$(KUSTOMIZE) build config/manifests | $(OPERATOR_SDK) generate bundle $(BUNDLE_GEN_FLAGS)
	$(OPERATOR_SDK) bundle validate ./bundle

.PHONY: bundle-build
bundle-build: ## Build the bundle image.
	docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .

.PHONY: bundle-push
bundle-push: ## Push the bundle image.
	$(MAKE) docker-push IMG=$(BUNDLE_IMG)

.PHONY: bundle-buildx
bundle-buildx: ## Build and push bundle docker image 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\}/' bundle.Dockerfile > bundle.Dockerfile.cross
	- $(CONTAINER_TOOL) buildx create --name clickhouse-operator-bundle-builder
	$(CONTAINER_TOOL) buildx use clickhouse-operator-bundle-builder
	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${BUNDLE_IMG} -f bundle.Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm clickhouse-operator-bundle-builder
	rm bundle.Dockerfile.cross

.PHONY: scorecard
scorecard: operator-sdk
	$(OPERATOR_SDK) scorecard bundle

.PHONY: opm
OPM = $(LOCALBIN)/opm
opm: ## Download opm locally if necessary.
ifeq (,$(wildcard $(OPM)))
ifeq (,$(shell which opm 2>/dev/null))
	@{ \
	set -e ;\
	mkdir -p $(dir $(OPM)) ;\
	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/${OPERATOR_MANAGER_VERSION}/$${OS}-$${ARCH}-opm ;\
	chmod +x $(OPM) ;\
	}
else
OPM = $(shell which opm)
endif
endif

# The image tag given to the resulting catalog image (e.g. make catalog-build CATALOG_IMG=example.com/operator-catalog:v0.2.0).
CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:$(FULL_VERSION)

# Set CATALOG_BASE_IMG to an existing catalog image tag to add $BUNDLE_IMGS to that image.
ifneq ($(origin CATALOG_BASE_IMG), undefined)
FROM_INDEX_OPT := --from-index $(CATALOG_BASE_IMG)
endif

.PHONY: catalog-dockerfile
catalog-dockerfile: opm ## Generate catalog Dockerfile
	rm -f catalog.Dockerfile && $(OPM) generate dockerfile catalog

.PHONY: catalog-template
catalog-template: # Generate catalog template with all bundles from registry
	./ci/generate-catalog-template.sh $(IMAGE_TAG_BASE)-bundle

catalog-render: opm catalog-template ## Genermrate FBC catalog from template
	$(OPM) alpha render-template catalog/clickhouse-operator-template.yaml > catalog/catalog.yaml
	$(OPM) validate catalog

.PHONY: catalog-build
catalog-build: catalog-render catalog-dockerfile ## Build a catalog image using FBC
	$(CONTAINER_TOOL) build -f catalog.Dockerfile -t $(CATALOG_IMG) .

.PHONY: catalog-buildx
catalog-buildx: catalog-render catalog-dockerfile ## Build and push catalog image for cross-platform support
	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' catalog.Dockerfile > catalog.Dockerfile.cross
	- $(CONTAINER_TOOL) buildx create --name clickhouse-operator-catalog-builder
	$(CONTAINER_TOOL) buildx use clickhouse-operator-catalog-builder
	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag $(CATALOG_IMG) -f catalog.Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm clickhouse-operator-catalog-builder
	rm -f catalog.Dockerfile.cross

.PHONY: catalog-push-latest
catalog-push-latest:
	$(CONTAINER_TOOL) buildx imagetools create -t $(IMAGE_TAG_BASE)-catalog:latest $(CATALOG_IMG)

# Push the catalog image.
.PHONY: catalog-push
catalog-push: ## Push a catalog image.
	$(MAKE) docker-push IMG=$(CATALOG_IMG)

##@ Documentation

.PHONY: crd-ref-docs
crd-ref-docs: $(CRD_REF_DOCS) ## Download crd-ref-docs locally if necessary.
$(CRD_REF_DOCS): $(LOCALBIN)
	$(call go-install-tool,$(CRD_REF_DOCS),github.com/elastic/crd-ref-docs,$(CRD_REF_DOCS_VERSION))

.PHONY: docs-generate-api-ref
docs-generate-api-ref: crd-ref-docs ## Generate API reference documentation from CRD types.
	$(CRD_REF_DOCS) \
		--source-path=api/v1alpha1 \
		--config=docs/templates/.crd-ref-docs.yaml \
		--templates-dir=docs/templates \
		--renderer=markdown \
		--output-path=docs/api_reference.md \
		--max-depth=10

.PHONY: docs-lint-vale
docs-lint-vale: ## Run Vale linter on documentation
	@command -v vale >/dev/null 2>&1 || { echo "Vale is required but not installed. https://vale.sh/docs/install"; exit 1; }
	vale --config='.vale.ini' README.md docs

.PHONY: docs-link-check
docs-link-check: ## Run markdown-link-check on documentation
	@command -v markdown-link-check >/dev/null 2>&1 || { echo "markdown-link-check is required but not installed. npm install -g markdown-link-check"; exit 1; }
	markdown-link-check -c ci/.markdown-link-check.json *.md docs

.PHONY: docs-lint
docs-lint: docs-lint-vale docs-link-check ## Run all documentation linters