| # VERSION defines the project version for the bundle. |
| # Update this value when you upgrade the version of your project. |
| # To re-generate a bundle for another specific version without changing the standard setup, you can: |
| # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2) |
| # - use environment variables to overwrite this value (e.g export VERSION=0.0.2) |
| VERSION ?= 2.0.0-snapshot |
| |
| # 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) |
| |
| # IMAGE_TAG_BASE defines the docker.io namespace and part of the image name for remote images. |
| # This variable is used to construct full image tags for bundle and catalog images. |
| # |
| # For example, running 'make bundle-build bundle-push catalog-build catalog-push' will build and push both |
| # kiegroup.org/kogito-serverless-operator-bundle:$VERSION and kiegroup.org/kogito-serverless-operator-catalog:$VERSION. |
| IMAGE_TAG_BASE ?= quay.io/kiegroup/kogito-serverless-operator |
| |
| # 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 ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION) |
| |
| # BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command |
| BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS) |
| |
| # Container runtime engine used for building the images |
| BUILDER ?= podman |
| |
| # 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 ?= false |
| ifeq ($(USE_IMAGE_DIGESTS), true) |
| BUNDLE_GEN_FLAGS += --use-image-digests |
| endif |
| |
| # Image URL to use all building/pushing image targets |
| IMG ?= $(IMAGE_TAG_BASE):$(VERSION) |
| # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. |
| ENVTEST_K8S_VERSION = 1.23 |
| |
| # 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 |
| |
| # Setting SHELL to bash allows bash commands to be executed by recipes. |
| # This is a requirement for 'setup-envtest.sh' in the test target. |
| # 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-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: 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: build |
| build: generate fmt vet ## Build manager binary. |
| go build -o bin/manager main.go |
| |
| .PHONY: build-4-debug |
| build-4-debug: generate fmt vet ## Build manager binary with debug options. |
| go build -gcflags="all=-N -l" -o bin/manager main.go |
| |
| .PHONY: run |
| run: manifests generate fmt vet ## Run a controller from your host. |
| go run ./main.go |
| |
| .PHONY: debug |
| debug: build-4-debug ## Run a controller from your host from binary |
| ./bin/manager |
| |
| .PHONY: docker-build |
| docker-build: test ## Build docker image with the manager. |
| docker build -t ${IMG} . |
| |
| .PHONY: podman-build |
| podman-build: test ## Build container image with the manager. |
| podman 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>> than 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 |
| |
| .PHONY: podman-push |
| podman-push: ## Push container image with the manager. |
| podman push ${PODMAN_PUSH_PARAMS} ${IMG} |
| |
| .PHONY: container-build |
| container-build: test ## Build the container image |
| $(BUILDER) build -t ${IMG} . |
| |
| .PHONY: container-push |
| container-push: ## Push the container image |
| $(BUILDER) push ${CONTAINER_PUSH_PARAMS} ${IMG} |
| |
| ##@ 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: generate-deploy |
| generate-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 > operator.yaml |
| |
| .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 ?= v4.5.2 |
| CONTROLLER_TOOLS_VERSION ?= v0.9.2 |
| |
| KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" |
| .PHONY: kustomize |
| kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. |
| $(KUSTOMIZE): $(LOCALBIN) |
| test -s $(LOCALBIN)/kustomize || GO111MODULE=on GOBIN=$(LOCALBIN) go install sigs.k8s.io/kustomize/kustomize/v4@$(KUSTOMIZE_VERSION) |
| |
| .PHONY: controller-gen |
| controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. |
| $(CONTROLLER_GEN): $(LOCALBIN) |
| test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION) |
| |
| .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@latest |
| |
| .PHONY: bundle |
| bundle: manifests kustomize install-operator-sdk ## Generate bundle manifests and metadata, then validate generated files. |
| operator-sdk generate kustomize manifests -q |
| cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG) |
| $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS) |
| operator-sdk bundle validate ./bundle |
| |
| .PHONY: bundle-build |
| bundle-build: ## Build the bundle image. |
| $(BUILDER) build -f bundle.Dockerfile -t $(BUNDLE_IMG) . |
| |
| .PHONY: bundle-push |
| bundle-push: ## Push the bundle image. |
| $(MAKE) contianer-push IMG=$(BUNDLE_IMG) |
| |
| .PHONY: opm |
| OPM = ./bin/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.19.1/$${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 ?= $(IMAGE_TAG_BASE)-catalog:v$(VERSION) |
| |
| # 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 $(BUILDER) --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) container-push IMG=$(CATALOG_IMG) |
| |
| .PHONY: clean |
| clean: |
| rm -rf bin/ |
| |
| .PHONY: bump-version |
| new_version = "" |
| bump-version: |
| ./hack/bump-version.sh $(new_version) |
| |
| install-operator-sdk: |
| ./hack/ci/install-operator-sdk.sh |
| |
| .PHONY: addheaders |
| addheaders: |
| ./hack/addheaders.sh |
| |
| .PHONY: generate-all |
| generate-all: generate generate-deploy bundle |
| |
| .PHONY: test-e2e # You will need to have a Minikube/Kind cluster up in running to run this target |
| test-e2e: install-operator-sdk |
| go test ./test/e2e/* -v -ginkgo.v |