chore: adapt Makefile for local dev deployment + introduce report logs for e2e-tests (#359)

Signed-off-by: odubajDT <[email protected]>

Author: odubajDT

.github/scripts/create-reports.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+ignore="--ignore-not-found"
+logsDir="logs"
+
+createResourceReport () {
+    path=$1
+    namespace=$2
+    resource=$3
+    withLogs=$4
+
+    mkdir -p "$path/$resource"
+
+    kubectl get "$resource" -n "$namespace" "$ignore" > "$path/$resource/list-$resource.txt"
+
+    for r in $(kubectl get "$resource" -n "$namespace" "$ignore" -o jsonpath='{.items[*].metadata.name}'); do
+        kubectl describe "$resource/$r" -n "$namespace" > "$path/$resource/$r-describe.txt"
+
+        if $withLogs ; then
+        kubectl logs "$resource/$r" --all-containers=true -n "$namespace" > "$path/$resource/$r-logs.txt"
+        fi
+    done
+}
+
+# Go through each namespace in the cluster
+for namespace in $(kubectl get namespaces -o jsonpath='{.items[*].metadata.name}'); do
+
+    mkdir -p "$logsDir/$namespace"
+    createResourceReport "$logsDir/$namespace" "$namespace" "Pods" true
+    createResourceReport "$logsDir/$namespace" "$namespace" "Deployments" false
+    createResourceReport "$logsDir/$namespace" "$namespace" "Daemonsets" false
+    createResourceReport "$logsDir/$namespace" "$namespace" "Statefulsets" false
+    createResourceReport "$logsDir/$namespace" "$namespace" "Jobs" false
+    createResourceReport "$logsDir/$namespace" "$namespace" "FeatureFlagConfiguration" false
+    createResourceReport "$logsDir/$namespace" "$namespace" "FlagSourceConfiguration" false
+    
+done

.github/workflows/pr-checks.yml

@@ -143,3 +143,14 @@ jobs:
         run: |
           IMG=open-feature-operator-local:${{ github.sha }} make deploy-operator
           IMG=open-feature-operator-local:${{ github.sha }} make e2e-test
+      - name: Create reports
+        if: always()
+        working-directory: ./.github/scripts
+        run: ./create-reports.sh
+
+      - name: Upload cluster logs
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: e2e-tests
+          path: .github/scripts/logs

CONTRIBUTING.md

@@ -18,3 +18,15 @@ Thanks! Issues and pull requests following these guidelines are welcome.
 ### FeatureFlagConfiguration custom resource definition versioning
 Custom resource definitions support multiple versions. The kubebuilder framework exposes a system to seamlessly convert between versions (using a "hub and spoke" model) maintaining backwards compatibility. It does this by injecting conversion webhooks that call our defined convert functions. The hub version of the `FeatureFlagConfiguration` custom resource definition (the version to which all other versions are converted) is `v1alpha1`.
 Follow [this tutorial](https://book.kubebuilder.io/multiversion-tutorial/conversion-concepts.html) to implement a new version of the custom resource definition.
+
+### Local build
+The operator can be build and deployed to your cluster by using a single command:
+
+```
+make build-deploy-operator TAG=myTag RELEASE_REGISTRY=docker.io/user1 RELEASE_NAME=myImgName
+```
+
+Which will result in building the operator image `docker.io/user1/myImgName:myTag`, uploading it to your image registry
+and deploying to your cluster. Please be aware that it is using the cluster your current kube-context is pointing to.
+
+**Note:** All bash variables are optional, the default values are set and will result in an image `ghcr.io/openfeature/operator:latest`

Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM --platform=$BUILDPLATFORM golang:1.19-alpine AS builder
+FROM --platform=$BUILDPLATFORM golang:1.20.1-alpine3.16 AS builder
 
 WORKDIR /workspace
 ARG TARGETOS

Makefile

@@ -1,6 +1,9 @@
-
-# Image URL to use all building/pushing image targets
-IMG ?= controller:latest
+RELEASE_REGISTRY?=ghcr.io/openfeature
+TAG?=latest
+RELEASE_NAME?=operator
+RELEASE_IMAGE?=$(RELEASE_NAME):$(TAG)
+ARCH?=amd64
+IMG?=$(RELEASE_REGISTRY)/$(RELEASE_IMAGE)
 # customize overlay to be used in the build, DEFAULT or HELM
 KUSTOMIZE_OVERLAY ?= DEFAULT
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
@@ -89,12 +92,20 @@ run: manifests generate fmt vet ## Run a controller from your host.
 	go run ./main.go
 
 .PHONY: docker-build
-docker-build: update-flagd  ## Build docker image with the manager.
-	docker buildx build --platform="linux/amd64,linux/arm64" -t ${IMG} . --push
+docker-build: update-flagd clean  ## Build docker image with the manager.
+	DOCKER_BUILDKIT=1 docker build \
+		-t $(IMG)-$(ARCH)  \
+		--platform linux/$(ARCH) \
+		.
+	docker tag $(IMG)-$(ARCH) $(IMG)
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
-	docker push ${IMG}
+	docker push $(IMG)
+
+.PHONY: clean
+clean:
+	rm -rf ./bin
 
 ##@ Deployment
 
@@ -112,7 +123,7 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified
 
 .PHONY: release-manifests
 release-manifests: manifests kustomize
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
 	mkdir -p config/rendered/
 	@if [ ${KUSTOMIZE_OVERLAY} = DEFAULT ]; then\
 		echo building default overlay;\
@@ -125,20 +136,27 @@ release-manifests: manifests kustomize
 
 .PHONY: deploy
 deploy: generate manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
 	$(KUSTOMIZE) build config/default | kubectl apply -f -
 
 .PHONY: undeploy
 undeploy: generate ## 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 -
 
+.PHONY: deploy-operator
 deploy-operator:
 	kubectl create ns 'open-feature-operator-system' --dry-run=client -o yaml | kubectl apply -f -
-	kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.yaml
+	kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.11.0/cert-manager.yaml
 	kubectl wait --for=condition=Available=True deploy --all -n 'cert-manager'
 	make deploy
 	kubectl wait --for=condition=Available=True deploy --all -n 'open-feature-operator-system'
 
+.PHONY: build-deploy-operator
+build-deploy-operator:
+	make docker-build
+	make docker-push
+	make deploy-operator
+
 deploy-demo:
 	kubectl apply -f https://raw.githubusercontent.com/open-feature/playground/main/config/k8s/end-to-end.yaml
 	kubectl wait -l app=open-feature-demo --for=condition=Available=True deploy