Merge pull request #35 from uselagoon/local-dev

chore: update local development to match other tools

Author: shreddedbacon

.gitignore

@@ -26,3 +26,5 @@ go.work
 *.swp
 *.swo
 *~
+
+local-dev

Makefile

@@ -11,7 +11,110 @@ else
 GOBIN=$(shell go env GOBIN)
 endif
 
-KIND_CLUSTER ?= kind
+KIND_CLUSTER ?= dbaas-controller
+KIND_NETWORK ?= dbaas-controller
+
+KIND_VERSION = v0.25.0
+KUBECTL_VERSION := v1.31.0
+HELM_VERSION := v3.16.1
+GOJQ_VERSION = v0.12.16
+KUSTOMIZE_VERSION := v5.4.3
+
+HELM = $(realpath ./local-dev/helm)
+KUBECTL = $(realpath ./local-dev/kubectl)
+JQ = $(realpath ./local-dev/jq)
+KIND = $(realpath ./local-dev/kind)
+KUSTOMIZE = $(realpath ./local-dev/kustomize)
+
+ARCH := $(shell uname | tr '[:upper:]' '[:lower:]')
+
+.PHONY: local-dev/kind
+local-dev/kind:
+ifeq ($(KIND_VERSION), $(shell kind version 2>/dev/null | sed -nE 's/kind (v[0-9.]+).*/\1/p'))
+	$(info linking local kind version $(KIND_VERSION))
+	ln -sf $(shell command -v kind) ./local-dev/kind
+else
+ifneq ($(KIND_VERSION), $(shell ./local-dev/kind version 2>/dev/null | sed -nE 's/kind (v[0-9.]+).*/\1/p'))
+	$(info downloading kind version $(KIND_VERSION) for $(ARCH))
+	mkdir -p local-dev
+	rm local-dev/kind || true
+	curl -sSLo local-dev/kind https://kind.sigs.k8s.io/dl/$(KIND_VERSION)/kind-$(ARCH)-amd64
+	chmod a+x local-dev/kind
+endif
+endif
+
+.PHONY: local-dev/kustomize
+local-dev/kustomize:
+ifeq ($(KUSTOMIZE_VERSION), $(shell kustomize version 2>/dev/null | sed -nE 's/(v[0-9.]+).*/\1/p'))
+	$(info linking local kustomize version $(KUSTOMIZE_VERSION))
+	ln -sf $(shell command -v kustomize) ./local-dev/kustomize
+else
+ifneq ($(KUSTOMIZE_VERSION), $(shell ./local-dev/kustomize version 2>/dev/null | sed -nE 's/(v[0-9.]+).*/\1/p'))
+	$(info downloading kustomize version $(KUSTOMIZE_VERSION) for $(ARCH))
+	rm local-dev/kustomize || true
+	curl -sSL https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize%2F$(KUSTOMIZE_VERSION)/kustomize_$(KUSTOMIZE_VERSION)_$(ARCH)_amd64.tar.gz | tar -xzC local-dev
+	chmod a+x local-dev/kustomize
+endif
+endif
+
+.PHONY: local-dev/helm
+local-dev/helm:
+ifeq ($(HELM_VERSION), $(shell helm version --short --client 2>/dev/null | sed -nE 's/(v[0-9.]+).*/\1/p'))
+	$(info linking local helm version $(HELM_VERSION))
+	ln -sf $(shell command -v helm) ./local-dev/helm
+else
+ifneq ($(HELM_VERSION), $(shell ./local-dev/helm version --short --client 2>/dev/null | sed -nE 's/(v[0-9.]+).*/\1/p'))
+	$(info downloading helm version $(HELM_VERSION) for $(ARCH))
+	rm local-dev/helm || true
+	curl -sSL https://get.helm.sh/helm-$(HELM_VERSION)-$(ARCH)-amd64.tar.gz | tar -xzC local-dev --strip-components=1 $(ARCH)-amd64/helm
+	chmod a+x local-dev/helm
+endif
+endif
+
+.PHONY: local-dev/jq
+local-dev/jq:
+ifeq ($(GOJQ_VERSION), $(shell gojq -v 2>/dev/null | sed -nE 's/gojq ([0-9.]+).*/v\1/p'))
+	$(info linking local gojq version $(GOJQ_VERSION))
+	ln -sf $(shell command -v gojq) ./local-dev/jq
+else
+ifneq ($(GOJQ_VERSION), $(shell ./local-dev/jq -v 2>/dev/null | sed -nE 's/gojq ([0-9.]+).*/v\1/p'))
+	$(info downloading gojq version $(GOJQ_VERSION) for $(ARCH))
+	rm local-dev/jq || true
+ifeq ($(ARCH), darwin)
+	TMPDIR=$$(mktemp -d) \
+		&& curl -sSL https://github.com/itchyny/gojq/releases/download/$(GOJQ_VERSION)/gojq_$(GOJQ_VERSION)_$(ARCH)_arm64.zip -o $$TMPDIR/gojq.zip \
+		&& (cd $$TMPDIR && unzip gojq.zip) && cp $$TMPDIR/gojq_$(GOJQ_VERSION)_$(ARCH)_arm64/gojq ./local-dev/jq && rm -rf $$TMPDIR
+else
+	curl -sSL https://github.com/itchyny/gojq/releases/download/$(GOJQ_VERSION)/gojq_$(GOJQ_VERSION)_$(ARCH)_amd64.tar.gz | tar -xzC local-dev --strip-components=1 gojq_$(GOJQ_VERSION)_$(ARCH)_amd64/gojq
+	mv ./local-dev/{go,}jq
+endif
+	chmod a+x local-dev/jq
+endif
+endif
+
+.PHONY: local-dev/kubectl
+local-dev/kubectl:
+ifeq ($(KUBECTL_VERSION), $(shell kubectl version --client 2>/dev/null | grep Client | sed -E 's/Client Version: (v[0-9.]+).*/\1/'))
+	$(info linking local kubectl version $(KUBECTL_VERSION))
+	ln -sf $(shell command -v kubectl) ./local-dev/kubectl
+else
+ifneq ($(KUBECTL_VERSION), $(shell ./local-dev/kubectl version --client 2>/dev/null | grep Client | sed -E 's/Client Version: (v[0-9.]+).*/\1/'))
+	$(info downloading kubectl version $(KUBECTL_VERSION) for $(ARCH))
+	rm local-dev/kubectl || true
+	curl -sSLo local-dev/kubectl https://storage.googleapis.com/kubernetes-release/release/$(KUBECTL_VERSION)/bin/$(ARCH)/amd64/kubectl
+	chmod a+x local-dev/kubectl
+endif
+endif
+
+.PHONY: local-dev/tools
+local-dev/tools: local-dev/kind local-dev/kustomize local-dev/kubectl local-dev/jq local-dev/helm 
+
+.PHONY: helm/repos
+helm/repos: local-dev/helm
+	# install repo dependencies required by the charts
+# 	$(HELM) repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+# 	$(HELM) repo add metallb https://metallb.github.io/metallb
+# 	$(HELM) repo update
 
 # 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
@@ -67,29 +170,52 @@ 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) -coverprofile cover.out
 
 .PHONY: create-kind-cluster
-create-kind-cluster:
-	@if ! kind get clusters | grep -q $(KIND_CLUSTER); then \
-		docker network inspect $(KIND_CLUSTER) >/dev/null 2>&1 || docker network create $(KIND_CLUSTER); \
-		kind create cluster --wait=60s --name=$(KIND_CLUSTER) --config=kind-config.yaml; \
-	else \
-		echo "Cluster $(KIND_CLUSTER) already exists"; \
-	fi
+create-kind-cluster: local-dev/tools helm/repos
+	docker network inspect $(KIND_NETWORK) >/dev/null || docker network create $(KIND_NETWORK) \
+		&& LAGOON_KIND_CIDR_BLOCK=$$(docker network inspect $(KIND_NETWORK) | $(JQ) '. [0].IPAM.Config[0].Subnet' | tr -d '"') \
+		&& export KIND_NODE_IP=$$(echo $${LAGOON_KIND_CIDR_BLOCK%???} | awk -F'.' '{print $$1,$$2,$$3,240}' OFS='.') \
+		&& export KIND_EXPERIMENTAL_DOCKER_NETWORK=$(KIND_NETWORK) \
+ 		&& $(KIND) create cluster --wait=60s --name=$(KIND_CLUSTER) --config=test-resources/test-suite.kind-config.yaml
+
+# Create a kind cluster locally and run the test e2e test suite against it
+.PHONY: kind/test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up locally
+kind/test-e2e: create-kind-cluster kind/re-test-e2e
 
-.PHONY: delete-kind-cluster
-delete-kind-cluster:
-	kind delete cluster --name=$(KIND_CLUSTER) && docker network rm $(KIND_CLUSTER)
+.PHONY: local-kind/test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up locally
+kind/re-test-e2e:
+	export KIND_PATH=$(KIND) && \
+	export KUBECTL_PATH=$(KUBECTL) && \
+	export KIND_CLUSTER=$(KIND_CLUSTER) && \
+	LAGOON_KIND_CIDR_BLOCK=$$(docker network inspect $(KIND_NETWORK) | $(JQ) '. [0].IPAM.Config[0].Subnet' | tr -d '"') && \
+	export KIND_NODE_IP=$$(echo $${LAGOON_KIND_CIDR_BLOCK%???} | awk -F'.' '{print $$1,$$2,$$3,240}' OFS='.') && \
+	$(KIND) export kubeconfig --name=$(KIND_CLUSTER) && \
+	$(MAKE) test-e2e
+
+.PHONY: clean
+kind/clean:
+	$(KIND) delete cluster --name=$(KIND_CLUSTER) && docker network rm $(KIND_NETWORK)
 
 # Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
-.PHONY: github/test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up inside github action.
-github/test-e2e:
+.PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up inside github action.
+test-e2e:
 	go test ./test/e2e/ -v -ginkgo.v
 
-# Create a kind cluster locally and run the test e2e test suite against it
-.PHONY: local-kind/test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up locally
-local-kind/test-e2e: create-kind-cluster
+# Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
+.PHONY: github/test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up inside github action.
+github/test-e2e: local-dev/tools test-e2e
+
+.PHONY: kind/set-kubeconfig
+kind/set-kubeconfig:
 	export KIND_CLUSTER=$(KIND_CLUSTER) && \
-	kind export kubeconfig --name=$(KIND_CLUSTER) && \
-	go test ./test/e2e/ -v -ginkgo.v
+	$(KIND) export kubeconfig --name=$(KIND_CLUSTER)
+
+.PHONY: kind/logs-dbaas-controller
+kind/logs-dbaas-controller:
+	export KIND_CLUSTER=$(KIND_CLUSTER) && \
+	$(KIND) export kubeconfig --name=$(KIND_CLUSTER) && \
+	$(KUBECTL) -n dbaas-controller-system logs -f \
+		$$($(KUBECTL) -n dbaas-controller-system  get pod -l control-plane=controller-manager -o jsonpath="{.items[0].metadata.name}") \
+		-c manager
 
 .PHONY: lint
 lint: golangci-lint ## Run golangci-lint linter & yamllint
@@ -138,7 +264,7 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	rm Dockerfile.cross
 
 .PHONY: build-installer
-build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+build-installer: manifests generate local-dev/kustomize ## Generate a consolidated YAML with CRDs and deployment.
 	mkdir -p dist
 	@if [ -d "config/crd" ]; then \
 		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
@@ -154,20 +280,20 @@ ifndef ignore-not-found
 endif
 
 .PHONY: install
-install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
+install: manifests local-dev/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.
+uninstall: manifests local-dev/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.
+deploy: manifests local-dev/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.
+undeploy: local-dev/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 -
 
 ##@ Dependencies
@@ -178,23 +304,15 @@ $(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)
 
 ## Tool Versions
-KUSTOMIZE_VERSION ?= v5.3.0
-CONTROLLER_TOOLS_VERSION ?= v0.16.0
+CONTROLLER_TOOLS_VERSION ?= v0.16.5
 ENVTEST_VERSION ?= latest
 GOLANGCI_LINT_VERSION ?= v1.54.2
 
-.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)

config/crd/bases/crd.lagoon.sh_databaserequests.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: databaserequests.crd.lagoon.sh
 spec:
   group: crd.lagoon.sh

config/crd/bases/crd.lagoon.sh_mongodbproviders.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: mongodbproviders.crd.lagoon.sh
 spec:
   group: crd.lagoon.sh

config/crd/bases/crd.lagoon.sh_relationaldatabaseproviders.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.0
+    controller-gen.kubebuilder.io/version: v0.16.5
   name: relationaldatabaseproviders.crd.lagoon.sh
 spec:
   group: crd.lagoon.sh

config/rbac/role.yaml

@@ -15,17 +15,6 @@ rules:
   - ""
   resources:
   - secrets
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - ""
-  resources:
   - services
   verbs:
   - create
@@ -39,57 +28,7 @@ rules:
   - crd.lagoon.sh
   resources:
   - databaserequests
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - crd.lagoon.sh
-  resources:
-  - databaserequests/finalizers
-  verbs:
-  - update
-- apiGroups:
-  - crd.lagoon.sh
-  resources:
-  - databaserequests/status
-  verbs:
-  - get
-  - patch
-  - update
-- apiGroups:
-  - crd.lagoon.sh
-  resources:
   - mongodbproviders
-  verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
-  - update
-  - watch
-- apiGroups:
-  - crd.lagoon.sh
-  resources:
-  - mongodbproviders/finalizers
-  verbs:
-  - update
-- apiGroups:
-  - crd.lagoon.sh
-  resources:
-  - mongodbproviders/status
-  verbs:
-  - get
-  - patch
-  - update
-- apiGroups:
-  - crd.lagoon.sh
-  resources:
   - relationaldatabaseproviders
   verbs:
   - create
@@ -102,12 +41,16 @@ rules:
 - apiGroups:
   - crd.lagoon.sh
   resources:
+  - databaserequests/finalizers
+  - mongodbproviders/finalizers
   - relationaldatabaseproviders/finalizers
   verbs:
   - update
 - apiGroups:
   - crd.lagoon.sh
   resources:
+  - databaserequests/status
+  - mongodbproviders/status
   - relationaldatabaseproviders/status
   verbs:
   - get

test-resources/test-suite.kind-config.yaml

@@ -0,0 +1,2 @@
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4