| # 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. |
| |
| # Image URL to use all building/pushing image targets |
| IMG ?= doris-operator:latest |
| # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. |
| ENVTEST_K8S_VERSION = 1.26.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 |
| |
| LATEST_TAG=$(shell git describe --tags `git rev-list --tags --max-count=1` 2>/dev/null) |
| #LATEST_TAG=$(shell git describe --tags --abbrev=0 2>/dev/null) |
| LATEST_COMMIT=$(shell git rev-parse --short HEAD 2>/dev/null) |
| |
| BUILD_DATE=$(shell date +"%Y%m%d-%T") |
| ifeq (,$(LATEST_TAG)) |
| VERSION="UNKNOWN" |
| else |
| VERSION=$(shell echo $(LATEST_TAG) | tr -d "v") |
| endif |
| |
| LDFLAGS="-s -X \"main.VERSION=$(VERSION)\" -X \"main.COMMIT=$(LATEST_COMMIT)\" -X \"main.BUILD_DATE=$(BUILD_DATE)\"" |
| |
| |
| # 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: manifests |
| manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. |
| $(CONTROLLER_GEN) rbac:roleName=manager-doris crd:generateEmbeddedObjectMeta=true webhook paths="./api/doris/..." output:crd:artifacts:config=config/crd/bases |
| $(CONTROLLER_GEN) rbac:roleName=manager-doris crd:generateEmbeddedObjectMeta=true webhook paths="./api/doris/..." output:crd:artifacts:config=helm-charts/doris-operator/crds |
| $(CONTROLLER_GEN) rbac:roleName=manager-doris crd:generateEmbeddedObjectMeta=true webhook paths="./api/disaggregated/..." output:crd:artifacts:config=config/crd/bases |
| $(CONTROLLER_GEN) rbac:roleName=manager-doris crd:generateEmbeddedObjectMeta=true webhook paths="./api/disaggregated/..." output:crd:artifacts:config=helm-charts/doris-operator/crds |
| cp config/crd/bases/doris.selectdb.com_dorisclusters.yaml config/crd/bases/doris.apache.com_dorisclusters.yaml |
| mv helm-charts/doris-operator/crds/doris.selectdb.com_dorisclusters.yaml helm-charts/doris-operator/crds/doris.apache.com_dorisclusters.yaml |
| cat config/crd/bases/doris.selectdb.com_dorisclusters.yaml > config/crd/bases/crds.yaml |
| cat config/crd/bases/disaggregated.cluster.doris.com_dorisdisaggregatedclusters.yaml >> config/crd/bases/crds.yaml |
| |
| .PHONY: generate |
| generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. |
| $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./api/doris/..." |
| $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./api/disaggregated/..." |
| |
| .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: helm |
| helm: #replace variable |
| ifeq ($(shell uname),Darwin) |
| sed -i "" "s/{operatorVersion}/$(VERSION)/g" helm-charts/doris/Chart.yaml |
| sed -i "" "s/{operatorVersion}/$(VERSION)/g" helm-charts/doris-operator/Chart.yaml |
| sed -i "" "s/{operatorVersion}/$(VERSION)/g" helm-charts/doris-disaggregated/Chart.yaml |
| else |
| sed -i "s/{operatorVersion}/$(VERSION)/g" helm-charts/doris/Chart.yaml |
| sed -i "s/{operatorVersion}/$(VERSION)/g" helm-charts/doris-operator/Chart.yaml |
| sed -i "s/{operatorVersion}/$(VERSION)/g" helm-charts/doris-disaggregated/Chart.yaml |
| endif |
| |
| .PHONY: build |
| build: manifests generate vet helm ## Build manager binary. |
| go build -ldflags=$(LDFLAGS) -o bin/dorisoperator cmd/operator/main.go |
| go build -ldflags=$(LDFLAGS) -o bin/dorisctl cmd/dorisctl/main.go |
| go build -o bin/doris-debug cmd/doris-debug/main.go |
| |
| .PHONY: run |
| run: manifests generate fmt vet ## Run a controller from your host. |
| go run -ldflags=$(LDFLAGS) cmd/operator/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} . |
| |
| .PHONY: docker-push |
| docker-push: ## Push docker image with the manager. |
| docker 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,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} -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 -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 |
| KUSTOMIZE ?= $(LOCALBIN)/kustomize |
| CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen |
| ENVTEST ?= $(LOCALBIN)/setup-envtest |
| |
| ## Tool Versions |
| KUSTOMIZE_VERSION ?= v5.0.0 |
| CONTROLLER_TOOLS_VERSION ?= v0.16.4 |
| |
| 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) --output install_kustomize.sh && bash install_kustomize.sh $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); rm install_kustomize.sh; } |
| |
| .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) |
| |
| GEN_DOCS=$(GOBIN)/gen-crd-api-reference-docs |
| .PHONY: gen-tool |
| gen-tool: ## Download gen-crd-api-reference-docs locally if necessary. |
| $(call go-get-tool,$(GEN_DOCS),github.com/ahmetb/gen-crd-api-reference-docs@v0.3.0) |
| |
| .PHONY: gen-api |
| gen-api: gen-tool |
| $(GEN_DOCS) -api-dir "./api/doris/v1" -config "./hack/gen-api/config.json" -template-dir "./hack/gen-api/template" -out-file "doc/api.md" |
| $(GEN_DOCS) -api-dir "./api/disaggregated/v1" -config "./hack/gen-api/config.json" -template-dir "./hack/gen-api/template" -out-file "doc/disaggregated_api.md" |
| |
| .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@release-0.18 |
| |
| .PHONY: pre-release |
| pre-release: manifests generate gen-api build |
| |
| # go-get-tool will 'go get' any package $2 and install it to $1. |
| PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST)))) |
| |
| define go-get-tool |
| @[ -f $(1) ] || { \ |
| set -e ;\ |
| TMP_DIR=$$(mktemp -d) ;\ |
| echo $TMP_DIR; \ |
| cd $$TMP_DIR ;\ |
| go mod init tmp ;\ |
| echo "Downloading $(2)" ;\ |
| GOBIN=$(GOBIN) go install $(2) ;\ |
| rm -rf $$TMP_DIR ;\ |
| } |
| endef |
| |