Makefile

##@ Dependencies

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

## Tool Versions
KUSTOMIZE_VERSION ?= v5.7.1
CONTROLLER_TOOLS_VERSION ?= v0.19.0
ENVTEST_VERSION ?= latest
KUBEBUILDER_VERSION ?= v4.10.1
CRD_REF_DOCS_VERSION ?= v0.2.0
FAILLINT_VERSION ?= v1.15.0
GOLANGCI_LINT_VERSION ?= v1.63.4
GOIMPORTS_VERSION ?= v0.38.0
HUGO_VERSION ?= v0.152.2
MAGE_VERSION ?= v1.15.0
MDOX_VERSION ?= v0.9.1-0.20220713110358-25b9abcf90a0

## Tool Binaries
KUBECTL ?= kubectl
KUSTOMIZE ?= $(LOCALBIN)/kustomize-$(KUSTOMIZE_VERSION)
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen-$(CONTROLLER_TOOLS_VERSION)
ENVTEST ?= $(LOCALBIN)/setup-envtest-$(ENVTEST_VERSION)
KUBEBUILDER ?= $(LOCALBIN)/kubebuilder-$(KUBEBUILDER_VERSION)
CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs-$(CRD_REF_DOCS_VERSION)
FAILLINT ?= $(LOCALBIN)/faillint-$(FAILLINT_VERSION)
GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION)
GOIMPORTS ?= $(LOCALBIN)/goimports-$(GOIMPORTS_VERSION)
HUGO ?= $(LOCALBIN)/hugo-$(HUGO_VERSION)
MAGE ?= $(LOCALBIN)/mage-$(MAGE_VERSION)
MDOX ?= $(LOCALBIN)/mdox-$(MDOX_VERSION)

.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: kubebuilder
kubebuilder: $(KUBEBUILDER) ## Download kubebuilder locally if necessary.
$(KUBEBUILDER): $(LOCALBIN)
	$(call go-install-tool,$(KUBEBUILDER),sigs.k8s.io/kubebuilder/v4,$(KUBEBUILDER_VERSION))

.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: faillint
faillint: $(FAILLINT) ## Download faillint locally if necessary.
$(FAILLINT): $(LOCALBIN)
	$(call go-install-tool,$(FAILLINT),github.com/fatih/faillint,$(FAILLINT_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/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))

.PHONY: goimports
goimports: $(GOIMPORTS) ## Download goimports locally if necessary.
$(GOIMPORTS): $(LOCALBIN)
	$(call go-install-tool,$(GOIMPORTS),golang.org/x/tools/cmd/goimports,$(GOIMPORTS_VERSION))

.PHONY: hugo
hugo: $(HUGO) ## Download hugo locally if necessary.
$(HUGO): $(LOCALBIN)
	$(call go-install-tool,$(HUGO),github.com/gohugoio/hugo,$(HUGO_VERSION),-tags=extended,withdeploy)

.PHONY: mage
mage: $(MAGE) ## Download mage locally if necessary.
$(MAGE): $(LOCALBIN)
	$(call go-install-tool,$(MAGE),github.com/magefile/mage,$(MAGE_VERSION))

.PHONY: mdox
mdox: $(MDOX) ## Download mdox locally if necessary.
$(MDOX): $(LOCALBIN)
	$(call go-install-tool,$(MDOX),github.com/bwplotka/mdox,$(MDOX_VERSION))

# 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 (ideally with version)
# $2 - package url which can be installed
# $3 - specific version of package
# $4 - additional flags for go install
define go-install-tool
@[ -f $(1) ] || { \
set -e; \
package=$(2)@$(3) ;\
echo "Downloading $${package}" ;\
GOBIN=$(LOCALBIN) go install $${package} $${4} ;\
mv "$$(echo "$(1)" | sed "s/-$(3)$$//")" $(1) ;\
}
endef

WEBSITE_BASE_URL ?= https://thanos-operator.dev

# Image URL to use all building/pushing image targets
DOCKER_IMAGE_REPO ?= quay.io/thanos/thanos-operator
DOCKER_IMAGE_TAG  ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))-$(shell date +%Y-%m-%d)-$(shell git rev-parse --short HEAD)
IMG ?= ${DOCKER_IMAGE_REPO}:${DOCKER_IMAGE_TAG}
IMG_MAIN ?= ${DOCKER_IMAGE_REPO}:main
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.34.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

# Support gsed on OSX (installed via brew), falling back to sed. On Linux
# systems gsed won't be installed, so will use sed as expected.
SED ?= $(shell which gsed 2>/dev/null || which sed)

# 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

FILES_TO_FMT      	 ?= $(shell find . -path ./vendor -prune -o -name '*.go' -print)
MD_FILES_TO_FORMAT = $(shell ls *.md) $(shell ls docs/*.md)  $(filter-out docs/api-reference/api.md, $(shell ls docs/*/*.md))
MDOX_VALIDATE_CONFIG ?= .mdox.validate.yaml
CRD_REF_DOCS_CONFIG ?= .crd_ref.yaml

.PHONY: all
all: build build-chart docs

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

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

.PHONY: deps
deps: ## Ensures fresh go.mod and go.sum.
	@go mod tidy
	@go mod verify
	@cd magefiles && go mod tidy
	@cd magefiles && go mod verify

.PHONY: format
format: ## Formats Go code.
format: goimports
	@echo ">> formatting code"
	go fmt ./...
	@$(GOIMPORTS) -local github.com/thanos-community/thanos-operator -w $(FILES_TO_FMT)
	cd magefiles && go fmt ./...

.PHONY: vet
vet: ## Run go vet against code.
	go vet ./...
	cd magefiles && go vet ./...

.PHONY: test
test: manifests generate format vet envtest ## Run tests.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test -v $$(go list ./... | grep -v /e2e) -coverprofile cover.out

.PHONY: test-update-golden
test-update-golden: ## Update golden test files.
	go test ./internal/pkg/manifests/... -update
	go test ./config/... -update

# 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:
	go test -timeout=15m -v ./test/e2e/ -v -ginkgo.v

define require_clean_work_tree
	@git update-index -q --ignore-submodules --refresh

    @if ! git diff-files --quiet --ignore-submodules --; then \
        echo >&2 "$1: you have unstaged changes."; \
        git diff-files --name-status -r --ignore-submodules -- >&2; \
        echo >&2 "Please commit or stash them."; \
        exit 1; \
    fi

    @if ! git diff-index --cached --quiet HEAD --ignore-submodules --; then \
        echo >&2 "$1: your index contains uncommitted changes."; \
        git diff-index --cached --name-status -r --ignore-submodules HEAD -- >&2; \
        echo >&2 "Please commit or stash them."; \
        exit 1; \
    fi

endef

.PHONY: lint ## Runs various static analysis against our code.
lint: all
lint: faillint golangci-lint deps
	$(call require_clean_work_tree,"detected not clean main before running lint")
	@echo ">> verifying modules being imported"
	@$(FAILLINT) -paths "fmt.{Print,Printf,Println}" -ignore-tests ./...
	@echo ">> examining all of the Go files"
	@go vet -stdmethods=false ./...
	@echo ">> linting all of the Go files GOGC=${GOGC}"
	@$(GOLANGCI_LINT) run
	$(call require_clean_work_tree,"run make lint file and commit changes.")

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

##@ Docs

define require_clean_work_tree
	@git update-index -q --ignore-submodules --refresh

	@if ! git diff-files --quiet --ignore-submodules --; then \
		echo >&2 "cannot $1: you have unstaged changes."; \
		git diff -r --ignore-submodules -- >&2; \
		echo >&2 "Please commit or stash them."; \
		exit 1; \
	fi

	@if ! git diff-index --cached --quiet HEAD --ignore-submodules --; then \
		echo >&2 "cannot $1: your index contains uncommitted changes."; \
		git diff --cached -r --ignore-submodules HEAD -- >&2; \
		echo >&2 "Please commit or stash them."; \
		exit 1; \
	fi

endef

INPUT_DIR := docs
OUTPUT_DIR := ./website/content/docs
EXTERNAL_GLOB_REL := ../
MDOX_CONFIG_FILE := .mdox.yaml

.PHONY: docs
docs: ## Generates docs for website
docs: mdox
	PATH="${PATH}:$(GOBIN)" $(MDOX) fmt $(MD_FILES_TO_FORMAT)
	@echo ">> generating docs for website (Input: $(INPUT_DIR), Output: $(OUTPUT_DIR))"
	export INPUT_DIR="$(INPUT_DIR)"; \
	export OUTPUT_DIR="$(OUTPUT_DIR)"; \
	export EXTERNAL_GLOB_REL="$(EXTERNAL_GLOB_REL)"; \
	\
	rm -rf "$(OUTPUT_DIR)"; \
	\
	PATH="${PATH}:$(GOBIN)" $(MDOX) transform --log.level=debug --config-file=$(MDOX_CONFIG_FILE)
	$(MAKE) generate-api-docs

.PHONY: generate-api-docs
generate-api-docs: ## Generate documentation from CRD
generate-api-docs: crd-ref-docs generate format
	$(CRD_REF_DOCS) --source-path=./api --renderer=markdown --output-path=./website/content/docs/api-reference --output-mode=group --config=$(CRD_REF_DOCS_CONFIG)
	mv ./website/content/docs/api-reference/monitoring.thanos.io.md ./website/content/docs/api-reference/api.md
	$(CRD_REF_DOCS) --source-path=./api --renderer=markdown --output-path=./docs/api-reference --output-mode=group --config=$(CRD_REF_DOCS_CONFIG)
	mv ./docs/api-reference/monitoring.thanos.io.md ./docs/api-reference/api.md
	$(SED) -i'' '/^# API Reference */d' ./website/content/docs/api-reference/api.md
	@tmpfile=$$(mktemp); \
	printf "%s\n" "---" >> $$tmpfile; \
	printf "%s\n" 'title: "API Reference"' >> $$tmpfile; \
	printf "%s\n" 'description: ""' >> $$tmpfile; \
	printf "%s\n" 'summary: ""' >> $$tmpfile; \
	printf "%s\n" 'slug: api.md' >> $$tmpfile; \
	printf "%s\n" 'date: 2023-09-07T16:13:18+02:00' >> $$tmpfile; \
	printf "%s\n" 'lastmod: 2023-09-07T16:13:18+02:00' >> $$tmpfile; \
	printf "%s\n" 'draft: false' >> $$tmpfile; \
	printf "%s\n" 'weight: 40' >> $$tmpfile; \
	printf "%s\n" 'toc: true' >> $$tmpfile; \
	printf "%s\n" "---" >> $$tmpfile; \
	cat ./website/content/docs/api-reference/api.md >> $$tmpfile; \
	mv $$tmpfile ./website/content/docs/api-reference/api.md

.PHONY: check-docs
check-docs: ## Checks docs against discrepancy with flags, links, white noise.
check-docs: build docs mdox
	@echo ">> checking docs"
	PATH="${PATH}:$(GOBIN)" $(MDOX) fmt -l --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT)
	$(call require_clean_work_tree,'run make docs and commit changes')

##@ Build

.PHONY: build
build: manifests generate format vet ## Build manager binary.
	@VERSION=$$(cat VERSION) && \
	REVISION=$$(git rev-parse HEAD) && \
	BRANCH=$$(git rev-parse --abbrev-ref HEAD) && \
	BUILDUSER=$$(whoami)@$$HOSTNAME && \
	BUILDDATE=$$(date +%Y%m%d-%H:%M:%S) && \
	go build -o bin/manager \
		-ldflags="-s -w \
		-X github.com/prometheus/common/version.Version=$$VERSION \
		-X github.com/prometheus/common/version.Revision=$$REVISION \
		-X github.com/prometheus/common/version.Branch=$$BRANCH \
		-X github.com/prometheus/common/version.BuildUser=$$BUILDUSER \
		-X github.com/prometheus/common/version.BuildDate=$$BUILDDATE" \
		cmd/main.go

.PHONY: run
run: manifests generate format 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/
# Used for e2e testing.
.PHONY: docker-build
docker-build: ## Build docker image with the manager.
	@VERSION=$$(cat VERSION) && \
	REVISION=$$(git rev-parse HEAD) && \
	BRANCH=$$(git rev-parse --abbrev-ref HEAD) && \
	BUILDUSER=$$(whoami)@$$HOSTNAME && \
	BUILDDATE=$$(date +%Y%m%d-%H:%M:%S) && \
	$(CONTAINER_TOOL) build --load \
		--build-arg VERSION=$$VERSION \
		--build-arg REVISION=$$REVISION \
		--build-arg BRANCH=$$BRANCH \
		--build-arg BUILDUSER=$$BUILDUSER \
		--build-arg BUILDDATE=$$BUILDDATE \
		-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.
# Used for CI pushing.
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 project-v3-builder
	$(CONTAINER_TOOL) buildx use project-v3-builder
	VERSION=$$(cat VERSION) && \
	REVISION=$$(git rev-parse HEAD) && \
	BRANCH=$$(git rev-parse --abbrev-ref HEAD) && \
	BUILDUSER=$$(whoami)@$$HOSTNAME && \
	BUILDDATE=$$(date +%Y%m%d-%H:%M:%S) && \
	$(CONTAINER_TOOL) buildx build --push \
		--platform=$(PLATFORMS) \
		--build-arg VERSION=$$VERSION \
		--build-arg REVISION=$$REVISION \
		--build-arg BRANCH=$$BRANCH \
		--build-arg BUILDUSER=$$BUILDUSER \
		--build-arg BUILDDATE=$$BUILDDATE \
		--tag ${IMG} --tag ${IMG_MAIN} \
		-f Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm project-v3-builder
	rm Dockerfile.cross

##@ Deployment

# Add a bundle.yaml file with CRDs and deployment, with kustomize config.
.PHONY: build-installer
build-installer: manifests generate format kustomize ## Generate a consolidated YAML with CRDs and deployment.
	@echo ">> generating bundle.yaml (override image using IMG_MAIN)"
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG_MAIN}
	$(KUSTOMIZE) build config/default > bundle.yaml
	$(call require_clean_work_tree,'run make build-chart and commit changes')

.PHONY: build-chart
build-chart: build-installer kubebuilder ## Build the helm chart.
	mkdir -p helm
	$(KUBEBUILDER) edit --plugins=helm/v2-alpha --manifests=bundle.yaml --output-dir=./helm
	rm -rf .github/workflows/test-chart.yml
	$(call require_clean_work_tree,'run make build-chart and commit changes')

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.
	@echo ">> deploying controller (override image using IMG_MAIN)"
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG_MAIN}
	$(KUSTOMIZE) build config/default | $(KUBECTL) apply --server-side -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 -

.PHONY: install-example
install-example: manifests kustomize ## Install example definitions to K8s cluster specified in ~/.kube/config.
install-example: ## Installs minio and definitions of all components to be used with the operator.
install-example: ## Ensure you run make install and make deploy in ns of choice before this command
	$(KUBECTL) apply -f test/utils/testdata/
	$(KUSTOMIZE) build config/samples | $(KUBECTL) apply -f -


.PHONY: install-sample
install-sample: install deploy
	$(KUSTOMIZE) build config/samples | $(KUBECTL) apply -f -


.PHONY: uninstall-example
uninstall-example: manifests kustomize ## Uninstall example definitions from K8s cluster specified in ~/.kube/config.
	$(KUBECTL) delete -f test/utils/testdata/
	$(KUSTOMIZE) build config/samples | $(KUBECTL) delete -f -  

##@ Website

.PHONY: website-dev
website-dev: ## Start website development server
website-dev: hugo
	@echo ">> starting website development server"
	@cd website && npm install && "$(HUGO)" serve

.PHONY: website
website: ## Build website for production
website: hugo
	@echo ">> building website for production"
	@cd website && npm install && "$(HUGO)" -b $(WEBSITE_BASE_URL)