Example: Kuadrant controller

examples/kuadrant/color_policy.go → examples/color_policy/color_policy.go

@@ -1,4 +1,4 @@
-package kuadrant
+package color_policy
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

examples/kuadrant/color_policy_test.go → examples/color_policy/color_policy_test.go

@@ -1,6 +1,6 @@
 //go:build unit
 
-package kuadrant
+package color_policy
 
 import (
 	"testing"

examples/kuadrant/integration_test.go → examples/color_policy/integration_test.go

@@ -1,6 +1,6 @@
 //go:build integration
 
-package kuadrant
+package color_policy
 
 import (
 	"encoding/json"

examples/kuadrant/merge_strategies.go → examples/color_policy/merge_strategies.go

@@ -1,4 +1,4 @@
-package kuadrant
+package color_policy
 
 import (
 	"github.com/samber/lo"

examples/kuadrant/.gitignore

@@ -0,0 +1,2 @@
+bin
+topology.dot

examples/kuadrant/Makefile

@@ -0,0 +1,69 @@
+# 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
+
+MKFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
+PROJECT_PATH := $(patsubst %/,%,$(dir $(MKFILE_PATH)))
+
+##@ 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
+
+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%-30s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+.PHONY: project-path
+project-path: ## Print the project path.
+	@echo $(PROJECT_PATH)
+
+##@ Tools
+
+# go-install-tool will 'go install' any package $2 and install it to $1.
+PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
+define go-install-tool
+@[ -f $(1) ] || { \
+set -e ;\
+TMP_DIR=$$(mktemp -d) ;\
+cd $$TMP_DIR ;\
+go mod init tmp ;\
+echo "Downloading $(2)" ;\
+GOBIN=$(PROJECT_DIR)/bin go install $(2) ;\
+rm -rf $$TMP_DIR ;\
+}
+endef
+
+CONTROLLER_GEN = $(PROJECT_PATH)/bin/controller-gen
+$(CONTROLLER_GEN):
+	$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected])
+
+.PHONY: controller-gen
+controller-gen: $(CONTROLLER_GEN)  ## Download controller-gen locally if necessary.
+
+##@ Development
+
+.PHONY: generate
+generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
+	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
+
+.PHONY: manifests
+manifests: controller-gen ## Generate CustomResourceDefinition objects.
+	$(CONTROLLER_GEN) crd paths="./apis/v1alpha2;./apis/v1beta3" output:crd:artifacts:config=config/crds
+
+.PHONY: install
+install: manifests ## Install CRDs into a cluster.
+	kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.1.0/standard-install.yaml
+	kubectl apply -f config/crds
+
+.PHONY: run
+run: generate ## Run the controller.
+	go run *.go