Makefile

# Image URL to use all building/pushing image targets
ARTIFACTORY_SERVER ?= vault.habana.ai
ARTIFACTORY_DOCKER_REPO ?= habana-ai-operator
ARTIFACTORY_DOCKER_CACHE ?= artifactory-kfs.habana-labs.com/docker
ARTIFACTORY_HELM_REPO ?= $(ARTIFACTORY_SERVER)/gaudi-helm
DOCKER_REPO ?= $(ARTIFACTORY_SERVER)/$(ARTIFACTORY_DOCKER_REPO)/cicd
SHORT_SHA=$(shell git rev-parse --short HEAD)
VERSION ?= $(shell git rev-parse --abbrev-ref HEAD | grep -oE 'release/[0-9]+\.[0-9]+\.[0-9]+' || echo '0.0.1-a$(SHORT_SHA)')
NAME ?= habana-ai-operator
UPDATE_TYPE ?= patch
# Set your IMG_NAME as argument to override the default value
IMG_NAME ?= $(DOCKER_REPO)/kubernetes-operator/$(NAME)
IMG ?= $(IMG_NAME):$(VERSION)
TEST_IMG ?= $(ARTIFACTORY_SERVER)/$(ARTIFACTORY_TEST_IMAGE)

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

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

.PHONY: print-version
print-version: ## Print the VERSION variable value
	@echo $(VERSION)

##@ Development

.PHONY: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
	$(CONTROLLER_GEN) rbac:roleName=manager-role crd 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: update
update:
	if [ "$(UPDATE_TYPE)" = "patch" ]; then \
		GO_MINOR=$$(awk '/^go / {split($$2, v, "."); print v[1] "." v[2]; exit}' go.mod) && \
		go get go@$$GO_MINOR && \
		go get toolchain@go$$GO_MINOR; \
	else \
		go get go@latest && \
		go get toolchain@latest; \
	fi
	GO_VERSION=$$(awk '/^go / {print $$2; exit}' go.mod) && \
		sed -i "s/FROM golang:.* AS golang/FROM golang:$$GO_VERSION AS golang/g" Dockerfile
	go get -u ./...

## Remember to 'export GOTOOLCHAIN=auto' before running this target to use the latest Go toolchain.
.PHONY: upgrade
upgrade: update tidy generate fmt vet

.PHONY: fmt
fmt: ## Run go fmt against code.
	go fmt ./...

.PHONY: vet
vet: ## Run go vet against code.
	go vet ./...

.PHONY: tidy
tidy: ## Run go mod tidy.
	go mod tidy

.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 -v $$(go list ./... | grep -v -e /e2e -e /test -e /cmd -e /api)

# 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

.PHONY: fuzz
fuzz:
	go test -fuzz=ClusterPolicy -fuzztime=60m ./test/fuzz

##@ 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 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-arg DOCKER_CACHE=$(ARTIFACTORY_DOCKER_CACHE) \
		--build-arg DOCKER_REPO=$(DOCKER_REPO) \
		--build-arg VERSION="$(VERSION)" \
		--build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
		-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.
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) --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
	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 ## 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: 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 -

##@ Kubernetes Cluster
JF := $(shell if command -v jf >/dev/null 2>&1; then echo jf; else echo jfrog; fi)
JF_CONFIG := $(shell if $(JF) config show setup-jfrog-cli-server >/dev/null 2>&1; then echo setup-jfrog-cli-server; else echo kfs; fi)
K8S_VERSION ?= 1.28

.PHONY: k8s-setup
k8s-setup:
	$(JF) config use $(JF_CONFIG)
	$(JF) rt dl ${ARTIFACTORY_BIN_REPO}/kubernetes/ . && \
	chmod +x ./kubernetes/install-k8s-multi-os.sh  && \
	cd kubernetes && \
	sudo ./install-k8s-multi-os.sh  -i $(K8S_VERSION) && \
	mkdir -p ~/.kube && \
	sudo cp /etc/kubernetes/admin.conf ~/.kube/config && \
	sudo chown $(shell id -u):$(shell id -g) ~/.kube/config

##@ Helm
.PHONY: helm
helm: manifests kustomize helm-bin helmify yq
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/default | $(HELMIFY) -crd-dir $(NAME)
	[ ! -d helm ] || rm -rf helm
	mv $(NAME) helm
	cp hack/helm/clusterpolicy.yaml helm/templates
	cp hack/helm/gaudi-nodefeaturerule.yaml helm/templates
	cat hack/helm/values.yaml >> helm/values.yaml

.PHONY: helm-package
helm-package: helm
	$(HELM) package --version $(word 2,$(subst :, ,${IMG})) --app-version $(word 2,$(subst :, ,${IMG})) helm

.PHONY: helm-push
helm-push: helm-package
	$(JF) rt u --build-name=helm --build-number=$(VERSION) $(NAME)*.tgz $(ARTIFACTORY_HELM_REPO)/$(NAME)/$(NAME)-$(VERSION).tgz

.PHONY: create-namespace
create-namespace:
	$(KUBECTL) create namespace $(NAME) --dry-run=client -o yaml | $(KUBECTL) apply -f -
	$(MAKE) label-openshift-namespace

.PHONY: create-proxy-configmap
create-proxy-configmap:
ifdef HTTP_PROXY
	$(KUBECTL) create configmap proxy \
		--from-literal=http_proxy=$(HTTP_PROXY) \
		--from-literal=https_proxy=$(HTTPS_PROXY) \
		--from-literal=no_proxy=${NO_PROXY} \
		--from-literal=HTTP_PROXY=$(HTTP_PROXY) \
		--from-literal=HTTPS_PROXY=$(HTTPS_PROXY) \
		--from-literal=NO_PROXY=${NO_PROXY} \
		-n $(NAME) --dry-run=client -o yaml | $(KUBECTL) apply -f -
else
	$(KUBECTL) delete configmap proxy -n $(NAME) --ignore-not-found
endif

.PHONY: helm-install-local
helm-install-local: helm create-namespace create-proxy-configmap
ifdef HTTP_PROXY
	$(HELM) install $(NAME) helm/. --version $(VERSION) -n $(NAME) --set clusterpolicy.proxy.config_map_name=proxy
else
	$(HELM) install $(NAME) helm/. --version $(VERSION) -n $(NAME)
endif

.PHONY: helm-install
helm-install: helm-bin create-namespace create-proxy-configmap
	$(HELM) repo add $(ARTIFACTORY_HELM_REPO) https://$(ARTIFACTORY_SERVER)/artifactory/api/helm/$(ARTIFACTORY_HELM_REPO)
	$(HELM) repo update
ifdef HTTP_PROXY
	$(HELM) install $(NAME) $(ARTIFACTORY_HELM_REPO)/$(NAME) --version $(VERSION) -n $(NAME) --set clusterpolicy.proxy.config_map_name=proxy
else
	$(HELM) install $(NAME) $(ARTIFACTORY_HELM_REPO)/$(NAME) --version $(VERSION) -n $(NAME)
endif

.PHONY: helm-uninstall
helm-uninstall: helm-bin
	$(HELM) uninstall $(NAME) -n $(NAME)

.PHONY: label-openshift-namespace
label-openshift-namespace:
	$(KUBECTL) label namespace $(NAME) pod-security.kubernetes.io/enforce=privileged --overwrite
	$(KUBECTL) label namespace $(NAME) pod-security.kubernetes.io/audit=privileged --overwrite
	$(KUBECTL) label namespace $(NAME) pod-security.kubernetes.io/warn=privileged --overwrite

##@ Dependencies

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

## Tool Binaries
KUBECTL ?= kubectl
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)
HELMIFY ?= $(LOCALBIN)/helmify-$(HELMIFY_VERSION)
HELM ?= $(LOCALBIN)/helm-$(HELM_VERSION)
OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk-$(OPERATOR_SDK_VERSION)
YQ ?= $(LOCALBIN)/yq-$(YQ_VERSION)

## Tool Versions
KUSTOMIZE_VERSION ?= v5.8.0
CONTROLLER_TOOLS_VERSION ?= v0.20.0
ENVTEST_VERSION ?= release-0.22
GOLANGCI_LINT_VERSION ?= v2.8.0
HELMIFY_VERSION ?= latest
HELM_VERSION ?= v3.19.5
OPERATOR_SDK_VERSION ?= v1.42.0
YQ_VERSION ?= v4.50.1


.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/v2/cmd/golangci-lint,${GOLANGCI_LINT_VERSION})

.PHONY: helmify
helmify: $(HELMIFY) ## Download helmify locally if necessary.
$(HELMIFY): $(LOCALBIN)
	$(call go-install-tool,$(HELMIFY),github.com/arttor/helmify/cmd/helmify,$(HELMIFY_VERSION))

.PHONY: helm-bin
helm-bin: $(HELM) ## Download helm locally if necessary.
$(HELM): $(LOCALBIN)
	$(call go-install-tool,$(HELM),helm.sh/helm/v3/cmd/helm,$(HELM_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

.PHONY: test-operator
test-operator: kustomize
	cd test/e2e/k8s; $(KUSTOMIZE) edit set image controller=$(TEST_IMG); \
	$(KUSTOMIZE) build . | $(KUBECTL) apply -f -

OPERATOR_SDK_URL ?= https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)

.PHONY: operator-sdk
operator-sdk:
	@if [ ! -f $(OPERATOR_SDK) ]; then \
		set -e ;\
		mkdir -p $(dir $(OPERATOR_SDK)) ;\
		OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
		curl -sSLo $(OPERATOR_SDK) $(OPERATOR_SDK_URL)/operator-sdk_$${OS}_$${ARCH}; \
		chmod +x $(OPERATOR_SDK) ;\
	fi

YQ_URL ?= https://github.com/mikefarah/yq/releases/download/$(YQ_VERSION)

.PHONY: yq
yq:
	@if [ ! -f $(YQ) ]; then \
		set -e ;\
		mkdir -p $(dir $(YQ)) ;\
		OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
		curl -sSLo $(YQ) $(YQ_URL)/yq_$${OS}_$${ARCH}; \
		chmod +x $(YQ) ;\
	fi

# OLM Bundle
MAJOR_VERSION ?= $(shell echo $(VERSION) | cut -d. -f1)
MINOR_VERSION ?= $(shell echo $(VERSION) | cut -d. -f2)
PATCH_VERSION ?= $(shell echo $(VERSION) | cut -d. -f3)
PATCH_BUILD ?= $(shell echo $(PATCH_VERSION) | cut -d- -f2)

CHANNELS ?= stable,$(MAJOR_VERSION).$(MINOR_VERSION)
DEFAULT_CHANNEL ?= stable
MIN_OPENSHIFT_VERSION ?= 4.12
MAX_OPENSHIFT_VERSION ?= 4.21
OPENSHIFT_MIN_OLM_VERSION := 1.9.0
OPENSHIFT_MAX_OLM_VERSION := $(VERSION)

# BUNDLE_IMG defines the image:tag used for the bundle.
# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
BUNDLE_IMG ?= $(subst :,-bundle:,$(IMG))

# BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)

# USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
# You can enable this value if you would like to use SHA Based Digests
# To enable set flag to true
USE_IMAGE_DIGESTS ?= true
ifeq ($(USE_IMAGE_DIGESTS), true)
        BUNDLE_GEN_FLAGS += --use-image-digests
endif

ifeq ($(MIN_OPENSHIFT_VERSION),)
$(error MIN_OPENSHIFT_VERSION variable is empty)
else ifeq ($(MAX_OPENSHIFT_VERSION),)
$(error MAX_OPENSHIFT_VERSION variable is empty)
else ifeq ($(MIN_OPENSHIFT_VERSION),$(MAX_OPENSHIFT_VERSION))
OPENSHIFT_VERSIONS_LABEL := =v$(MIN_OPENSHIFT_VERSION)
else ifeq ($(shell awk -v min=$(MIN_OPENSHIFT_VERSION) -v max=$(MAX_OPENSHIFT_VERSION) 'BEGIN {print (max > min) ? "True" : "False"}'),True)
OPENSHIFT_VERSIONS_LABEL := v$(MIN_OPENSHIFT_VERSION)-v$(MAX_OPENSHIFT_VERSION)
else
$(error MAX_OPENSHIFT_VERSION variable is less than MIN_OPENSHIFT_VERSION variable)
endif

# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
# To re-generate a bundle for other specific channels without changing the standard setup, you can:
# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=candidate,fast,stable)
# - use environment variables to overwrite this value (e.g export CHANNELS="candidate,fast,stable")
ifneq ($(origin CHANNELS), undefined)
BUNDLE_CHANNELS := --channels=$(CHANNELS)
endif

# DEFAULT_CHANNEL defines the default channel used in the bundle.
# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
# To re-generate a bundle for any other default channel without changing the default setup, you can:
# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
ifneq ($(origin DEFAULT_CHANNEL), undefined)
BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
endif
BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)

SAMPLE_FILE = ./config/samples/habanalabs_v1_clusterpolicy.yaml
TEMPLATE_CLUSTER_SERVICE_VERSION_FILE = ./config/manifests/bases/habana-ai-operator.clusterserviceversion.yaml
BUNDLE_CLUSTER_SERVICE_VERSION_FILE = ./bundle/manifests/$(NAME).clusterserviceversion.yaml
BUNDLE_ANNOTATIONS_FILE = ./bundle/metadata/annotations.yaml

.SAMPLE: sample
sample: helm
	$(HELM) template helm/ --show-only templates/clusterpolicy.yaml > $(SAMPLE_FILE)

.PHONY: bundle
bundle: manifests kustomize operator-sdk sample yq ## Generate bundle manifests and metadata, then validate generated files.
	$(OPERATOR_SDK) generate kustomize manifests -q
	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
	$(YQ) eval '.spec.runtime.configuration.container_engine = "crio"' -i $(SAMPLE_FILE)
	$(YQ) eval '.metadata.annotations."olm.skipRange" = ">=$(OPENSHIFT_MIN_OLM_VERSION) <$(OPENSHIFT_MAX_OLM_VERSION)"' -i $(TEMPLATE_CLUSTER_SERVICE_VERSION_FILE)
	# $(YQ) eval '.spec.replaces = (.spec.version)' -i $(TEMPLATE_CLUSTER_SERVICE_VERSION_FILE)
	$(YQ) eval '.spec.version = "$(VERSION)"' -i $(TEMPLATE_CLUSTER_SERVICE_VERSION_FILE)
	$(KUSTOMIZE) build config/manifests | $(OPERATOR_SDK) generate bundle $(BUNDLE_GEN_FLAGS)
	TEMP_FILE=$$(mktemp) && \
	$(YQ) '.spec.relatedImages' $(BUNDLE_CLUSTER_SERVICE_VERSION_FILE) > $${TEMP_FILE} && \
	$(YQ) '[.spec.driver.driver_loader.images | to_entries | .[] | {"image": .value.repository + ":" + .value.tag, "name": ("driver-loader-" + .key | sub("_"; "-"))}]' $(SAMPLE_FILE) >> $${TEMP_FILE} && \
	$(YQ) eval '[.spec | .. | select(has("image")) | .image | {"image": .repository + ":" + .tag, "name": (.repository | split("/") | .[-1])}]' $(SAMPLE_FILE) >> $${TEMP_FILE} && \
	$(YQ) ".spec.relatedImages *= load(\"$${TEMP_FILE}\")" -i $(BUNDLE_CLUSTER_SERVICE_VERSION_FILE) && \
	$(YQ) eval '.metadata.annotations.containerImage = (.spec.relatedImages.[] | select(.name == "manager") | .image)' -i $(BUNDLE_CLUSTER_SERVICE_VERSION_FILE) && \
	rm $${TEMP_FILE}
	$(OPERATOR_SDK) bundle validate ./bundle
	# Add Openshift Labels
	echo >> $(BUNDLE_ANNOTATIONS_FILE)
	echo '  # OpenShift annotations.' >> $(BUNDLE_ANNOTATIONS_FILE)
	echo '  com.redhat.openshift.versions: "$(OPENSHIFT_VERSIONS_LABEL)"' >> $(BUNDLE_ANNOTATIONS_FILE)
	cat $(BUNDLE_CLUSTER_SERVICE_VERSION_FILE)
	docker run -v ./bundle/manifests:/operator quay.io/operator-framework/operator-manifest-tools:latest pinning pin /operator

.PHONY: bundle-build
bundle-build: ## Build the bundle image.
	docker build -f bundle.Dockerfile --label "com.redhat.openshift.versions=$(OPENSHIFT_VERSIONS_LABEL)" -t $(BUNDLE_IMG) .

.PHONY: bundle-push
bundle-push: ## Push the bundle image.
	$(MAKE) docker-push IMG=$(BUNDLE_IMG)

.PHONY: bundle-install
bundle-install: yq operator-sdk create-namespace ## Install the bundle image.
	$(OPERATOR_SDK) cleanup $(NAME) -n $(NAME)
	$(OPERATOR_SDK) run bundle $(BUNDLE_IMG) -n $(NAME)
	$(KUBECTL) get deployments -n $(NAME) $(NAME)-controller-manager -o jsonpath='{.spec.template.metadata.annotations.alm-examples}' | \
		$(YQ) --input-format json '.[0]' | \
		$(KUBECTL) apply -f -

.PHONY: opm
OPM = $(LOCALBIN)/opm
opm: ## Download opm locally if necessary.
ifeq (,$(wildcard $(OPM)))
ifeq (,$(shell which opm 2>/dev/null))
	@{ \
	set -e ;\
	mkdir -p $(dir $(OPM)) ;\
	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\
	chmod +x $(OPM) ;\
	}
else
OPM = $(shell which opm)
endif
endif

# A comma-separated list of bundle images (e.g. make catalog-build BUNDLE_IMGS=example.com/operator-bundle:v0.1.0,example.com/operator-bundle:v0.2.0).
# These images MUST exist in a registry and be pull-able.
BUNDLE_IMGS ?= $(BUNDLE_IMG)

# The image tag given to the resulting catalog image (e.g. make catalog-build CATALOG_IMG=example.com/operator-catalog:v0.2.0).
CATALOG_IMG ?= $(subst :,-catalog:,$(IMG))

# Set CATALOG_BASE_IMG to an existing catalog image tag to add $BUNDLE_IMGS to that image.
ifneq ($(origin CATALOG_BASE_IMG), undefined)
FROM_INDEX_OPT := --from-index $(CATALOG_BASE_IMG)
endif

# Build a catalog image by adding bundle images to an empty catalog using the operator package manager tool, 'opm'.
# This recipe invokes 'opm' in 'semver' bundle add mode. For more information on add modes, see:
# https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
.PHONY: catalog-build
catalog-build: opm ## Build a catalog image.
	$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)

# Push the catalog image.
.PHONY: catalog-push
catalog-push: ## Push a catalog image.
	$(MAKE) docker-push IMG=$(CATALOG_IMG)