# 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.29.0 # 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 # Platform detection for downloading pre-built binaries. GOOS := $(shell go env GOOS) GOARCH := $(shell go env GOARCH) CURL_RETRIES ?= 3 # 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\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: check check: generate manifests generate-api-docs generate-helm-docs @echo "> Checking for uncommitted changes" @if [ -n "$$(git status --porcelain)" ]; then \ echo "ERROR: Git tree is dirty after running validation steps."; \ echo "Please check the diff to identify the step that dirtied the tree."; \ git --no-pager status; \ git --no-pager diff; \ exit 1; \ fi @echo "> Check complete" .PHONY: tilt-up tilt-up: kubectl helm ## Start Tilt for local operator development. @if [ ! -f tilt-settings.yaml ]; then \ echo "WARNING: tilt-settings.yaml not found — using defaults."; \ fi tilt up .PHONY: manifests manifests: controller-gen yq ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. # Use a large maxDescLen to ensure all field comments are included as OpenAPI descriptions # allowDangerousTypes=true is needed for the EndpointPickerConfig from gateway-api-inference-extension which contains float fields $(CONTROLLER_GEN) rbac:roleName=manager-role crd:maxDescLen=100000,allowDangerousTypes=true webhook paths="./..." output:crd:artifacts:config=config/crd/bases echo "Removing name from mainContainer required fields" for file in config/crd/bases/*.yaml; do \ $(YQ) eval '(.. | select(has("mainContainer")) | .mainContainer.required) |= (. - ["name"])' -i --indent 2 $$file || exit 1; \ done echo "Removing containers from extraPodSpec required fields" for file in config/crd/bases/*.yaml; do \ $(YQ) eval '(.. | select(has("extraPodSpec")) | .extraPodSpec.required) |= (. - ["containers"])' -i --indent 2 $$file || exit 1; \ done echo "Fixing PluginSpec parameters field: json.RawMessage needs x-kubernetes-preserve-unknown-fields instead of type: string" for file in config/crd/bases/*.yaml; do \ $(YQ) eval '(.. | select(has("parameters")) | .parameters | select(has("format") and .format == "byte")) |= (del(.format) | del(.type) | .x-kubernetes-preserve-unknown-fields = true)' -i --indent 2 $$file || exit 1; \ done echo "Fixing profilingJob template metadata: controller-gen emits bare type: object for metav1.ObjectMeta, add x-kubernetes-preserve-unknown-fields so labels/annotations are accepted" for file in config/crd/bases/*.yaml; do \ $(YQ) eval '(.. | select(has("profilingJob")) | .profilingJob.properties.template.properties.metadata)."x-kubernetes-preserve-unknown-fields" = true' -i --indent 2 $$file || exit 1; \ done echo "Adding NVIDIA header to CRD files" for file in config/crd/bases/*.yaml; do \ if ! head -20 "$$file" | grep -q "NVIDIA CORPORATION"; then \ { printf '%s\n' \ '# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.' \ '# SPDX-License-Identifier: Apache-2.0' \ ''; \ cat "$$file"; \ } > "$$file.tmp" && mv "$$file.tmp" "$$file"; \ fi; \ done echo "Adding helm.sh/resource-policy: keep annotation to CRD files" for file in config/crd/bases/*.yaml; do \ if ! $(YQ) eval '.metadata.annotations."helm.sh/resource-policy"' "$$file" | grep -q "keep"; then \ $(YQ) eval '.metadata.annotations."helm.sh/resource-policy" = "keep"' -i "$$file"; \ fi; \ done echo "Copying CRD files to operator Helm chart crds/ directory" mkdir -p ../helm/charts/platform/components/operator/crds/ cp config/crd/bases/*.yaml ../helm/charts/platform/components/operator/crds/ echo "Adding NVIDIA header to RBAC files" for file in config/rbac/*.yaml; do \ if [ -f "$$file" ] && ! head -20 "$$file" | grep -q "NVIDIA CORPORATION"; then \ { printf '%s\n' \ '# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.' \ '# SPDX-License-Identifier: Apache-2.0' \ ''; \ cat "$$file"; \ } > "$$file.tmp" && mv "$$file.tmp" "$$file"; \ fi; \ done .PHONY: generate generate: controller-gen generate-pydantic ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt_" paths="./..." .PHONY: generate-pydantic generate-pydantic: ## Generate Python Pydantic models from v1beta1 Go types (requires Python 3 + pydantic) @python3 -c "import pydantic" 2>/dev/null || { echo "Error: pydantic not found. Install with: pip install pydantic"; exit 1; } @echo "Generating Pydantic models from v1beta1 DGDR types..." @python3 api/scripts/generate_pydantic_from_go.py @echo "Running Pydantic validation tests..." @python3 api/scripts/validate_pydantic_models.py .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 /test | grep -v /api | grep -v /cmd) -coverprofile cover.out # 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 ./test/e2e/ -v -ginkgo.v .PHONY: lint lint: golangci-lint ## Run golangci-lint linter & yamllint $(GOLANGCI_LINT) run .PHONY: lint-fix lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes $(GOLANGCI_LINT) run --fix ##@ Build .PHONY: build build: manifests generate fmt vet helmify-chart ## 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 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-context snapshot=../snapshot -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=> 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 project-v3-builder $(CONTAINER_TOOL) buildx use project-v3-builder - $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --build-context snapshot=../snapshot --tag ${IMG} -f Dockerfile.cross . - $(CONTAINER_TOOL) buildx rm project-v3-builder rm Dockerfile.cross .PHONY: build-installer build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment. mkdir -p dist @if [ -d "config/crd" ]; then \ $(KUSTOMIZE) build config/crd > dist/install.yaml; \ fi echo "---" >> dist/install.yaml # Add a document separator before appending 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 kubectl ## Install CRDs into the K8s cluster specified in ~/.kube/config. $(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f - .PHONY: uninstall uninstall: manifests kustomize kubectl ## 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 kubectl ## 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 kubectl ## 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 - GPU_OPERATOR_NAMESPACE ?= gpu-operator GPU_OPERATOR_EXTRA_HELM_ARGS ?= .PHONY: install-gpu-operator install-gpu-operator: helm ## Install NVIDIA GPU Operator if not already present. @if $(HELM) list -n $(GPU_OPERATOR_NAMESPACE) -q 2>/dev/null | grep -q '^gpu-operator$$'; then \ echo "GPU Operator is already installed — skipping."; \ else \ echo "Installing NVIDIA GPU Operator..."; \ $(HELM) repo add nvidia https://helm.ngc.nvidia.com/nvidia --force-update; \ $(HELM) repo update nvidia; \ $(HELM) upgrade --install gpu-operator nvidia/gpu-operator \ --namespace $(GPU_OPERATOR_NAMESPACE) --create-namespace \ $(GPU_OPERATOR_EXTRA_HELM_ARGS) \ --wait --timeout=600s; \ echo "GPU Operator installed successfully."; \ fi .PHONY: install-gpu-operator-no-driver install-gpu-operator-no-driver: ## Install NVIDIA GPU Operator, skipping driver install (for AKS, etc. that provide their own). $(MAKE) install-gpu-operator GPU_OPERATOR_EXTRA_HELM_ARGS="--set driver.enabled=false --set toolkit.enabled=false --set operator.runtimeClass=nvidia-container-runtime" ##@ Cleanup # Namespace and Helm release used by Tilt dev-loop (matches Tiltfile defaults). DYNAMO_NAMESPACE ?= dynamo-system DYNAMO_HELM_RELEASE ?= dynamo # Grace period (seconds) before force-deleting stuck resources. TEARDOWN_GRACE_PERIOD ?= 30 .PHONY: tilt-down tilt-down: ## Stop Tilt and remove all Tilt-managed resources. @echo "Stopping Tilt..." @tilt down 2>/dev/null || echo "Tilt was not running — skipping." .PHONY: clean-tilt clean-tilt: tilt-down ## Stop Tilt, remove its build artifacts, and delete the dev namespace. @echo "Removing Tilt build artifacts..." @rm -rf tilt_bin @echo "Deleting Tilt dev namespace $(DYNAMO_NAMESPACE)..." @$(KUBECTL) delete namespace $(DYNAMO_NAMESPACE) --ignore-not-found --timeout=$(TEARDOWN_GRACE_PERIOD)s 2>/dev/null || { \ echo "WARNING: namespace $(DYNAMO_NAMESPACE) stuck terminating — force-removing finalizers..."; \ $(KUBECTL) get namespace $(DYNAMO_NAMESPACE) -o json \ | sed 's/"kubernetes"//' \ | $(KUBECTL) replace --raw "/api/v1/namespaces/$(DYNAMO_NAMESPACE)/finalize" -f - 2>/dev/null || true; \ } .PHONY: clean-dynamo-crds clean-dynamo-crds: kubectl ## Delete all Dynamo CRDs (these survive helm uninstall due to resource-policy: keep). @echo "Deleting Dynamo custom resources..." @for crd in $$($(KUBECTL) get crd -o name 2>/dev/null | grep 'nvidia.com' | sed 's|customresourcedefinition.apiextensions.k8s.io/||'); do \ echo " Deleting all $$crd instances..."; \ $(KUBECTL) delete "$$crd" --all -A --timeout=$(TEARDOWN_GRACE_PERIOD)s 2>/dev/null || { \ echo " Timed out — stripping finalizers from remaining $$crd instances..."; \ $(KUBECTL) get "$$crd" -A -o jsonpath='{range .items[*]}{.metadata.namespace}{" "}{.metadata.name}{"\n"}{end}' 2>/dev/null | \ while read -r ns name; do \ [ -z "$$name" ] && continue; \ $(KUBECTL) patch "$$crd" "$$name" -n "$$ns" --type=merge -p '{"metadata":{"finalizers":null}}' 2>/dev/null || true; \ done; \ $(KUBECTL) delete "$$crd" --all -A --force --grace-period=0 2>/dev/null || true; \ }; \ done @echo "Deleting Dynamo CRDs..." @$(KUBECTL) get crd -o name 2>/dev/null | grep 'nvidia.com' | xargs -r $(KUBECTL) delete --timeout=$(TEARDOWN_GRACE_PERIOD)s 2>/dev/null || \ $(KUBECTL) get crd -o name 2>/dev/null | grep 'nvidia.com' | xargs -r $(KUBECTL) delete --force --grace-period=0 2>/dev/null || \ echo "No Dynamo CRDs found or already removed." .PHONY: clean-dynamo-helm clean-dynamo-helm: helm ## Uninstall Dynamo Helm releases and delete their namespaces. @echo "Uninstalling Dynamo Helm releases..." @$(HELM) uninstall $(DYNAMO_HELM_RELEASE) --namespace $(DYNAMO_NAMESPACE) --wait --timeout=120s 2>/dev/null || \ $(HELM) uninstall $(DYNAMO_HELM_RELEASE) --namespace $(DYNAMO_NAMESPACE) --no-hooks 2>/dev/null || \ echo "No Helm release '$(DYNAMO_HELM_RELEASE)' in namespace '$(DYNAMO_NAMESPACE)' — skipped." @$(HELM) uninstall dynamo-platform --namespace dynamo --wait --timeout=120s 2>/dev/null || \ $(HELM) uninstall dynamo-platform --namespace dynamo --no-hooks 2>/dev/null || \ echo "No Helm release 'dynamo-platform' in namespace 'dynamo' — skipped." @echo "Deleting Dynamo namespaces..." @for ns in $(DYNAMO_NAMESPACE) dynamo; do \ if $(KUBECTL) get namespace "$$ns" >/dev/null 2>&1; then \ echo " Deleting namespace $$ns..."; \ $(KUBECTL) delete namespace "$$ns" --timeout=$(TEARDOWN_GRACE_PERIOD)s 2>/dev/null || { \ echo " WARNING: namespace $$ns stuck terminating — force-removing finalizers..."; \ $(KUBECTL) get namespace "$$ns" -o json \ | sed 's/"kubernetes"//' \ | $(KUBECTL) replace --raw "/api/v1/namespaces/$$ns/finalize" -f - 2>/dev/null || true; \ }; \ fi; \ done .PHONY: clean-gpu-operator clean-gpu-operator: helm ## Uninstall the NVIDIA GPU Operator and delete its namespace. @if $(HELM) list -n $(GPU_OPERATOR_NAMESPACE) -q 2>/dev/null | grep -q '^gpu-operator$$'; then \ echo "Uninstalling GPU Operator..."; \ $(HELM) uninstall gpu-operator --namespace $(GPU_OPERATOR_NAMESPACE) --wait --timeout=120s 2>/dev/null || \ $(HELM) uninstall gpu-operator --namespace $(GPU_OPERATOR_NAMESPACE) --no-hooks; \ echo "Deleting GPU Operator namespace $(GPU_OPERATOR_NAMESPACE)..."; \ $(KUBECTL) delete namespace $(GPU_OPERATOR_NAMESPACE) --ignore-not-found --timeout=$(TEARDOWN_GRACE_PERIOD)s 2>/dev/null || { \ echo "WARNING: namespace $(GPU_OPERATOR_NAMESPACE) stuck terminating — force-removing finalizers..."; \ $(KUBECTL) get namespace $(GPU_OPERATOR_NAMESPACE) -o json \ | sed 's/"kubernetes"//' \ | $(KUBECTL) replace --raw "/api/v1/namespaces/$(GPU_OPERATOR_NAMESPACE)/finalize" -f - 2>/dev/null || true; \ }; \ echo "GPU Operator removed."; \ else \ echo "GPU Operator is not installed — skipping."; \ fi .PHONY: clean-cluster clean-cluster: kubectl helm ## Remove ALL Dynamo resources from the cluster and local build artifacts. @echo "" @echo "================================================================" @echo " Dynamo Full Cluster Cleanup" @echo "================================================================" @echo "" $(MAKE) clean-dynamo-crds $(MAKE) clean-tilt $(MAKE) clean-dynamo-helm $(MAKE) clean-gpu-operator $(MAKE) clean-bin @echo "" @echo "================================================================" @echo " Cluster is clean." @echo "================================================================" @echo "" ##@ Dependencies ## Location to install dependencies to LOCALBIN ?= $(CURDIR)/bin $(LOCALBIN): mkdir -p $(LOCALBIN) .PHONY: clean-bin clean-bin: ## Remove all downloaded tool binaries. rm -rf $(LOCALBIN) ## Prefer project-local binaries over system-wide ones. export PATH := $(LOCALBIN):$(PATH) ## Tool Versions KUBECTL_VERSION ?= v1.31.4 HELM_VERSION ?= v3.17.3 YQ_VERSION ?= v4.45.4 KUSTOMIZE_VERSION ?= v5.5.0 CONTROLLER_TOOLS_VERSION ?= v0.16.4 ENVTEST_VERSION ?= release-0.19 GOLANGCI_LINT_VERSION ?= v1.64.8 ## Tool Binaries KUBECTL ?= $(LOCALBIN)/kubectl-$(KUBECTL_VERSION) HELM ?= $(LOCALBIN)/helm-$(HELM_VERSION) YQ ?= $(LOCALBIN)/yq-$(YQ_VERSION) KUSTOMIZE ?= $(LOCALBIN)/kustomize-$(KUSTOMIZE_VERSION) CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen-$(CONTROLLER_TOOLS_VERSION) ENVTEST ?= $(LOCALBIN)/setup-envtest-$(ENVTEST_VERSION) GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION) ## ---------- Binary download targets ---------- .PHONY: kubectl kubectl: $(KUBECTL) ## Download kubectl locally if necessary. $(KUBECTL): mkdir -p $(LOCALBIN) rm -f $(LOCALBIN)/kubectl-* curl --retry $(CURL_RETRIES) -fsL \ https://dl.k8s.io/release/$(KUBECTL_VERSION)/bin/$(GOOS)/$(GOARCH)/kubectl \ -o $(KUBECTL) ln -sf $(KUBECTL) $(LOCALBIN)/kubectl chmod +x $(KUBECTL) $(LOCALBIN)/kubectl .PHONY: helm helm: $(HELM) ## Download helm locally if necessary. $(HELM): mkdir -p $(LOCALBIN) rm -f $(LOCALBIN)/helm-* curl --retry $(CURL_RETRIES) -fsSL https://get.helm.sh/helm-$(HELM_VERSION)-$(GOOS)-$(GOARCH).tar.gz \ | tar xzf - --strip-components=1 -C $(LOCALBIN) $(GOOS)-$(GOARCH)/helm mv $(LOCALBIN)/helm $(HELM) ln -sf $(HELM) $(LOCALBIN)/helm chmod +x $(HELM) $(LOCALBIN)/helm .PHONY: yq yq: $(YQ) ## Download yq locally if necessary. $(YQ): mkdir -p $(LOCALBIN) rm -f $(LOCALBIN)/yq-* curl --retry $(CURL_RETRIES) -fsL \ https://github.com/mikefarah/yq/releases/download/$(YQ_VERSION)/yq_$(GOOS)_$(GOARCH) \ -o $(YQ) ln -sf $(YQ) $(LOCALBIN)/yq chmod +x $(YQ) $(LOCALBIN)/yq .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/cmd/golangci-lint,${GOLANGCI_LINT_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 define go-install-tool @[ -f $(1) ] || { \ set -e; \ package=$(2)@$(3) ;\ echo "Downloading $${package}" ;\ GOBIN=$(LOCALBIN) go install $${package} ;\ mv "$$(echo "$(1)" | sed "s/-$(3)$$//")" $(1) ;\ } endef ######################### Helmify HELMIFY ?= $(LOCALBIN)/helmify .PHONY: helmify helmify: $(HELMIFY) ## Download helmify locally if necessary. $(HELMIFY): $(LOCALBIN) test -s $(LOCALBIN)/helmify || GOBIN=$(LOCALBIN) go install github.com/arttor/helmify/cmd/helmify@v0.4.16 helmify-chart: manifests kustomize helmify $(KUSTOMIZE) build config/default | $(HELMIFY) -image-pull-secrets charts/dynamo-kubernetes-operator ######################### CRD Reference Docs CRD_REF_DOCS_VERSION ?= v0.3.0 CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs .PHONY: crd-ref-docs crd-ref-docs: $(CRD_REF_DOCS) ## Download crd-ref-docs locally if necessary. $(CRD_REF_DOCS): $(LOCALBIN) @echo "Installing crd-ref-docs $(CRD_REF_DOCS_VERSION)" @GOBIN=$(LOCALBIN) go install github.com/elastic/crd-ref-docs@$(CRD_REF_DOCS_VERSION) @echo "✅ crd-ref-docs $(CRD_REF_DOCS_VERSION) installed successfully" .PHONY: generate-api-docs generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRDs @echo "📚 Generating CRD API reference documentation..." @mkdir -p docs @$(CRD_REF_DOCS) \ --source-path=api \ --config=docs/crd-ref-docs-config.yaml \ --renderer=markdown \ --output-path=./docs/api_reference.md @echo "✅ Generated API reference at ./docs/api_reference.md" # concatenate header.md, api_reference.md, and footer.md cat docs/header.md ./docs/api_reference.md docs/footer.md > ../../docs/kubernetes/api-reference.md rm ./docs/api_reference.md @echo "✅ Concatenated header.md, api_reference.md, and footer.md" # Fix duplicate anchors: crd-ref-docs generates identical anchors for same-named types # across API versions; prepend "v1beta1 " to affected v1beta1 headings and links. python3 docs/fix-api-anchors.py ../../docs/kubernetes/api-reference.md HELM_CHART_DIR := ../helm/charts/platform .PHONY: generate-helm-docs generate-helm-docs: ## Generate Helm chart README from values.yaml and template @$(MAKE) -C $(HELM_CHART_DIR) generate-helm-docs .PHONY: coverage coverage: test go tool cover -func=cover.out