Makefile

REPO ?= rancher
COVERAGE ?= false
VERSION ?= $(shell git describe --tags --always --dirty --match="v[0-9]*")

## Dependencies

GOLANGCI_LINT_VERSION := v2.11.3
GINKGO_VERSION ?= v2.28.1
GINKGO_FLAGS ?= -v -r --coverprofile=cover.out --coverpkg=./...
ENVTEST_VERSION ?= v0.0.0-20250505003155-b6c5897febe5
ENVTEST_K8S_VERSION := 1.31.0
CRD_REF_DOCS_VER ?= v0.2.0

GOLANGCI_LINT ?= go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
GINKGO ?= go run github.com/onsi/ginkgo/v2/ginkgo@$(GINKGO_VERSION)
CRD_REF_DOCS := go run github.com/elastic/crd-ref-docs@$(CRD_REF_DOCS_VER)
PANDOC := $(shell which pandoc 2> /dev/null)

ENVTEST ?= go run sigs.k8s.io/controller-runtime/tools/setup-envtest@$(ENVTEST_VERSION)
ENVTEST_DIR ?= $(shell pwd)/.envtest

E2E_LABEL_FILTER ?= e2e

export KUBEBUILDER_ASSETS ?= $(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(ENVTEST_DIR) -p path)


.PHONY: all
all: version generate build package ## Run 'make' or 'make all' to run 'version', 'generate', 'build' and 'package'

.PHONY: version
version: ## Print the current version
	@echo $(VERSION)

.PHONY: build
build:	## Build the the K3k binaries (k3k, k3k-kubelet and k3kcli)
	@VERSION=$(VERSION) COVERAGE=$(COVERAGE) ./scripts/build

.PHONY: package
package: package-k3k package-k3k-kubelet	## Package the k3k and k3k-kubelet Docker images

.PHONY: package-%
package-%:
	docker build -f package/Dockerfile.$* \
		-t $(REPO)/$*:$(VERSION) \
		-t $(REPO)/$*:latest  \
		-t $(REPO)/$*:dev .

.PHONY: push
push: push-k3k push-k3k-kubelet		## Push the K3k images to the registry

.PHONY: push-%
push-%:
	docker push $(REPO)/$*:$(VERSION)
	docker push $(REPO)/$*:latest
	docker push $(REPO)/$*:dev

.PHONY: test
test:	## Run all the tests
	$(GINKGO) $(GINKGO_FLAGS) --label-filter=$(label-filter)

.PHONY: test-unit
test-unit:	## Run the unit tests (skips the e2e and integration tests)
	$(GINKGO) $(GINKGO_FLAGS) --skip-file=tests/*

.PHONY: test-kubelet
test-kubelet:	## Run the k3k-kubelet controller tests (tests/integration/k3k-kubelet)
	$(GINKGO) $(GINKGO_FLAGS) tests/integration/k3k-kubelet

.PHONY: test-policy
test-policy:	## Run the policy controller tests (tests/integration/policy)
	$(GINKGO) $(GINKGO_FLAGS) tests/integration/policy

.PHONY: test-cluster
test-cluster:	## Run the cluster controller tests (tests/integration/cluster)
	$(GINKGO) $(GINKGO_FLAGS) tests/integration/cluster

.PHONY: test-integration
test-integration:	## Run the controller tests that use envtest (tests/integration)
	$(GINKGO) $(GINKGO_FLAGS) tests/integration

.PHONY: test-e2e
test-e2e:	## Run the e2e tests
	$(GINKGO) $(GINKGO_FLAGS) --label-filter="$(E2E_LABEL_FILTER)" tests/e2e

.PHONY: test-cli
test-cli:	## Run the cli tests
	$(GINKGO) $(GINKGO_FLAGS) --flake-attempts=3 tests/cli

.PHONY: generate
generate:	## Generate the CRDs specs
	go generate ./...

.PHONY: docs
docs: docs-crds docs-cli	## Build the CRDs and CLI docs

.PHONY: docs-crds
docs-crds:	## Build the CRDs docs
	$(CRD_REF_DOCS) --config=./docs/crds/config.yaml \
		--renderer=markdown \
		--source-path=./pkg/apis/k3k.io/v1beta1 \
		--output-path=./docs/crds/crds.md

	$(CRD_REF_DOCS) --config=./docs/crds/config.yaml \
		--renderer=asciidoctor \
		--templates-dir=./docs/crds/templates/asciidoctor \
		--source-path=./pkg/apis/k3k.io/v1beta1 \
		--output-path=./docs/crds/crds.adoc

.PHONY: docs-cli
docs-cli:	## Build the CLI docs
ifeq (, $(PANDOC))
	$(error "pandoc not found in PATH.")
endif
	@./scripts/generate-cli-docs

.PHONY: lint
lint:	## Find any linting issues in the project
	$(GOLANGCI_LINT) run --timeout=5m

.PHONY: fmt
fmt:	## Format source files in the project
ifndef CI
	$(GOLANGCI_LINT) fmt ./...
endif

.PHONY: validate
validate: generate docs fmt ## Validate the project checking for any dependency or doc mismatch
	$(GINKGO) unfocus
	go mod tidy
	go mod verify
	git status --porcelain 
	git --no-pager diff --exit-code

.PHONY: install
install:	## Install K3k with Helm on the targeted Kubernetes cluster
	helm upgrade --install --namespace k3k-system --create-namespace \
		--set controller.extraEnv[0].name=DEBUG \
		--set-string controller.extraEnv[0].value=true \
		--set controller.image.repository=$(REPO)/k3k \
		--set controller.image.tag=$(VERSION) \
		--set agent.shared.image.repository=$(REPO)/k3k-kubelet \
		--set agent.shared.image.tag=$(VERSION) \
		k3k ./charts/k3k/

.PHONY: help
help:	## Show this help.
	@egrep -h '\s##\s' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-30s\033[0m %s\n", $$1, $$2}'