Makefile

# Image URL to use all building/pushing image targets
IMG ?= controller:latest
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.27.1

# 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 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

## Set crd:maxDescLen=0 to solve the problem of crd too long.
## Ref: https://github.com/kubernetes-sigs/kubebuilder/issues/1140
.PHONY: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
	$(CONTROLLER_GEN) rbac:roleName=manager-role crd:maxDescLen=0 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 ./... -coverprofile cover.out

##@ Build

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

.PHONY: run
run: manifests generate fmt vet ## Run a controller from your host.
	go run ./cmd/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.
	$(CONTAINER_TOOL) build -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 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
.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
	- $(CONTAINER_TOOL) buildx create --name doris-operator-builder
	-# $(CONTAINER_TOOL) buildx create --name doris-operator-builder --config=buildkitd.toml
	$(CONTAINER_TOOL) buildx use doris-operator-builder
	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm doris-operator-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 -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: ## 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 -

##@ Build 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

## Tool Versions
KUSTOMIZE_VERSION ?= v5.0.1
CONTROLLER_TOOLS_VERSION ?= v0.12.0

.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 || GOBIN=$(LOCALBIN) GO111MODULE=on go install sigs.k8s.io/kustomize/kustomize/v5@$(KUSTOMIZE_VERSION)

.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


##@ Generate deployment resources under /deploy

# doris-operator version
OPR_VER ?=

# Generate deploy/kustomize
.PHONY: gen-deploy-kustomize
gen-deploy-kustomize: __check_opr_ver manifests kustomize
	sed -i '' "s/newTag:.*/newTag: $(OPR_VER)/g" deploy/kustomize/kustomization.yaml
	$(KUSTOMIZE) build config/crd > deploy/kustomize/crds.yaml
	$(KUSTOMIZE) build config/rbac > deploy/kustomize/rbac.yaml
	$(KUSTOMIZE) build config/manager > deploy/kustomize/manager.yaml
	cp config/default/manager_auth_proxy_patch.yaml deploy/kustomize/manager_auth_proxy.yaml
	$(KUSTOMIZE) build deploy/kustomize > deploy/kustomize/kustomized.yaml

__check_opr_ver:
	@if [ -z "$(OPR_VER)" ]; then \
		echo "ERROR: OPR_VER(doris operator version) is not specified."; \
		exit 1; \
	fi


HELMIFY ?= $(LOCALBIN)/helmify

# Install helmify
.PHONY: helmify
helmify:
	test -s $(HELMIFY) || GOBIN=$(LOCALBIN) go install github.com/arttor/helmify/cmd/helmify@v0.4.6

# Init Helm chart from Kustomize
.PHONY: init-deploy-helm
init-deploy-helm: manifests kustomize helmify
	$(KUSTOMIZE) build config/default | $(HELMIFY) -crd-dir deploy/helm/doris-operator

# Generate Helm chart from Kustomize
.PHONY: gen-deploy-helm
gen-deploy-helm: __check_opr_ver manifests kustomize helmify
	sed -i '' "s/image: ghcr\.io\/linsoss\/doris-operator:.*/image: ghcr\.io\/linsoss\/doris-operator:$(OPR_VER)/g" deploy/helm/doris-operator/values.yaml
	sed -i '' "s/version:.*/version: $(OPR_VER)/g" deploy/helm/doris-operator/Chart.yaml
	sed -i '' "s/appVersion:.*/appVersion: v$(OPR_VER)/g" deploy/helm/doris-operator/Chart.yaml
	mkdir -p deploy/helm/tmp/
	$(KUSTOMIZE) build config/default | $(HELMIFY) -crd-dir deploy/helm/tmp
	rsync -a --delete deploy/helm/tmp/crds deploy/helm/doris-operator/
	rm -rf deploy/helm/tmp

##@ Publish packages, Need to log in to ghcr.io in advance:
## docker login ghcr.io -u xxx -p xxx
## helm registry login -u xxx -p xxx ghcr.io

# Build and publish Doris component images
.PHONY: publish-doris-img
DORIS_VER ?=
publish-doris-img:
	@if [ -z "$(DORIS_VER)" ]; then \
		echo "ERROR: DORIS_VER is not specified."; \
		exit 1; \
	fi
	@echo "begin to publish doris:$(DORIS_VER) to ghcr.io"
	docker buildx create --name doris-builder --use --platform linux/amd64,linux/arm64
	@cd images && \
		echo "building doris-fe:$(DORIS_VER)" && \
		docker buildx build --platform linux/amd64,linux/arm64 -t ghcr.io/linsoss/doris-fe:$(DORIS_VER) -f fe/Dockerfile . --push && \
		echo "building doris-broker:$(DORIS_VER)" && \
		docker buildx build --platform linux/amd64,linux/arm64 -t ghcr.io/linsoss/doris-broker:$(DORIS_VER) -f broker/Dockerfile . --push $$ \
		echo "building doris-be:$(DORIS_VER)" && \
		docker buildx build --platform linux/amd64,linux/arm64 -t ghcr.io/linsoss/doris-be:$(DORIS_VER) -f be/Dockerfile . --push && \
		echo "building doris-cn:$(DORIS_VER)" && \
		docker buildx build --platform linux/amd64,linux/arm64 -t ghcr.io/linsoss/doris-cn:$(DORIS_VER) -f cn/Dockerfile . --push
	docker buildx rm doris-builder


# Build and publish Doris operator packages
.PHONY: publish-operator
OPR_VER ?=
publish-operator: __check_opr_ver gen-deploy-kustomize gen-deploy-helm
	@echo "build doris-operator:$(OPR_VER) image"
	@$(MAKE) docker-buildx IMG=ghcr.io/linsoss/doris-operator:$(OPR_VER)
	@echo "publish kustomize package"
	flux push artifact oci://ghcr.io/linsoss/kustomize/doris-operator:$(OPR_VER) \
      --path="./deploy/kustomize" \
      --source="https://github.com/linsoss/doris-operator.git" \
      --revision="$(git branch --show-current)@sha1:$(git rev-parse HEAD)"
	@echo "publish helm package"
	cd deploy/helm && \
    	helm package --version $(OPR_VER) doris-operator && \
    	helm push doris-operator-$(OPR_VER).tgz oci://ghcr.io/linsoss/helm && \
    	rm -f doris-operator-$(OPR_VER).tgz


##@ Website development
WEBSITE_DIR ?= website

# Prepare website pnpm environment, require pnpm installed.
.PHONY: website-env
website-env:
	cd website && pnpm install

# Copy docs contents to website directory
.PHONY: website-sync
website-sync:
	rsync -a --delete docs ${WEBSITE_DIR}/content/
	rsync -a --delete examples ${WEBSITE_DIR}/content/

# Run website in dev mode
.PHONY: website-dev
website-dev: website-sync
	cd ${WEBSITE_DIR} && pnpm run dev

# Clean website build resources
.PHONY: website-clean
website-clean:
	cd ${WEBSITE_DIR} && pnpm run clean