merge

Signed-off-by: James Milligan <[email protected]>

Author: james-milligan

.github/workflows/pr-checks.yml

@@ -4,10 +4,14 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - '**.md'
   pull_request:
+    paths-ignore:
+      - '**.md'
 env:
   # Default minimum version of Go to support.
-  DEFAULT_GO_VERSION: 1.18
+  DEFAULT_GO_VERSION: 1.19
 
 permissions:
   contents: read
@@ -68,8 +72,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-        with:
-          submodules: recursive
       - name: Set up QEMU
         uses: docker/setup-qemu-action@master
         with:
@@ -78,11 +80,12 @@ jobs:
         id: buildx
         uses: docker/setup-buildx-action@master
       - name: Build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
+          builder: ${{ steps.buildx.outputs.name }}
           context: .
           outputs: type=docker,dest=${{ github.workspace }}/open-feature-operator-local.tar
-          tags: open-feature-operator-local:test
+          tags: open-feature-operator-local:${{ github.sha }}
       - name: Run Trivy vulnerability scanner
         uses: aquasecurity/trivy-action@master
         with:
@@ -95,3 +98,39 @@ jobs:
         uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: "trivy-results.sarif"
+      - name: Upload image as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: open-feature-operator-local-${{ github.sha }}
+          path: ${{ github.workspace }}/open-feature-operator-local.tar
+
+  e2e-test:
+    runs-on: ubuntu-latest
+    needs: docker-local
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ env.DEFAULT_GO_VERSION }}
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Download image
+        uses: actions/download-artifact@v3
+        with:
+          name: open-feature-operator-local-${{ github.sha }}
+          path: ${{ github.workspace }}
+      - name: Load open-feature-operator image into docker
+        run: |
+          docker load --input ${{ github.workspace }}/open-feature-operator-local.tar
+      - name: Create k8s Kind Cluster
+        uses: helm/[email protected]
+        with:
+          config: ./test/e2e/kind-cluster.yml
+          cluster_name: open-feature-operator-test
+      - name: Load open-feature-operator image into Kind cluster
+        run: |
+          kind load docker-image open-feature-operator-local:${{ github.sha }} --name open-feature-operator-test
+      - name: Run e2e test
+        run: |
+          IMG=open-feature-operator-local:${{ github.sha }} make deploy-operator
+          IMG=open-feature-operator-local:${{ github.sha }} make e2e-test

.github/workflows/pr-lint.yml

@@ -18,6 +18,6 @@ jobs:
     name: Validate PR title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v4
+      - uses: amannn/action-semantic-pull-request@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-please.yml

@@ -6,8 +6,11 @@ on:
       - main
 
 env:
+  # Default minimum version of Go to support.
+  DEFAULT_GO_VERSION: 1.19
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
+  GITHUB_PAGES_BRANCH: gh-pages
 
 permissions:
   contents: read
@@ -66,7 +69,7 @@ jobs:
         uses: docker/setup-buildx-action@master
 
       - name: Build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           builder: ${{ steps.buildx.outputs.name }}
           context: .
@@ -110,12 +113,12 @@ jobs:
         - name: Setup go
           uses: actions/setup-go@v3
           with:
-            go-version: '1.17.11'
+            go-version: ${{ env.DEFAULT_GO_VERSION }}
         - run: |
             make update-flagd
             go mod tidy
             make controller-gen
-            make helm-package
+            IMG=ghcr.io/open-feature/open-feature-operator:${{ needs.release-please.outputs.release_tag_name }} make helm-package
             IMG=ghcr.io/open-feature/open-feature-operator:${{ needs.release-please.outputs.release_tag_name }} make release-manifests
 
         - uses: anchore/sbom-action@v0
@@ -127,7 +130,47 @@ jobs:
           with:
             tag_name: ${{ needs.release-please.outputs.release_tag_name }}
             files: |
-              config/webhook/certificate.yaml
               config/rendered/release.yaml
               config/samples/end-to-end.yaml
               open-feature-operator-sbom.spdx.json
+
+  release-charts:
+    needs: release-please
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    if: ${{ needs.release-please.outputs.release_created }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ env.GITHUB_PAGES_BRANCH }}
+
+      - name: Setup go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ env.DEFAULT_GO_VERSION }}
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Merge release to gh-pages
+        run: git merge ${{ needs.release-please.outputs.release_tag_name }}
+
+      - name: Generate helm charts
+        run: IMG=ghcr.io/open-feature/open-feature-operator:${{ needs.release-please.outputs.release_tag_name }} make helm-package
+
+      - name: Commit files
+        run: |
+          git add charts/
+          git add index.yaml
+          git commit -s -m "chore: released charts ${{ needs.release-please.outputs.release_tag_name }}"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ env.GITHUB_PAGES_BRANCH }}

.gitignore

@@ -4,7 +4,6 @@ config/manager/manager.yaml
 config/manager/kustomization.yaml
 schemas
 .vscode
-open-feature-operator
 of-agent
 # Binaries for programs and plugins
 *.exe

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.17"
+  ".": "0.2.20"
 }

CHANGELOG.md

@@ -1,6 +1,28 @@
 # Changelog
 
-## [0.2.17](https://github.com/open-feature/open-feature-operator/compare/v0.2.16...v0.2.17) (2022-11-03)
+## [0.2.20](https://github.com/open-feature/open-feature-operator/compare/v0.2.19...v0.2.20) (2022-11-18)
+
+
+### Bug Fixes
+
+* **deps:** update module sigs.k8s.io/controller-runtime to v0.13.1 ([edeffcd](https://github.com/open-feature/open-feature-operator/commit/edeffcd3ef6fe9a8d52d0d5c414512ef8cd80629))
+
+## [0.2.19](https://github.com/open-feature/open-feature-operator/compare/v0.2.18...v0.2.19) (2022-11-15)
+
+
+### Features
+
+* introduced v1beta1 of featureflagconfiguration CRD with conversion webhook to v1alpha1 ([a45bdef](https://github.com/open-feature/open-feature-operator/commit/a45bdef5eec87738ce731af5825daffeb69eb6cb))
+* structured the featureflagconfiguration CRD ([b056c7c](https://github.com/open-feature/open-feature-operator/commit/b056c7cdd76f4653c1a728342687beaa8279e314))
+
+## [0.2.18](https://github.com/open-feature/open-feature-operator/compare/v0.2.17...v0.2.18) (2022-11-10)
+
+
+### Bug Fixes
+
+* nil pointer dereference ([#216](https://github.com/open-feature/open-feature-operator/issues/216)) ([d975066](https://github.com/open-feature/open-feature-operator/commit/d975066f96a5f9caf8af8d513076480a33943257))
+
+## [0.2.17](https://github.com/open-feature/open-feature-operator/compare/v0.2.16...v0.2.17) (2022-11-07)
 
 
 ### Bug Fixes

CODEOWNERS

@@ -1,3 +1,3 @@
 # These owners will be the default owners for everything in
 # the repo. Unless a later match takes precedence
-* @AlexsJones @beeme1mr
+* @AlexsJones @beeme1mr @skyerus

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+## Guidelines
+
+Welcome!
+
+There are a few things to consider before contributing to open-feature-operator.
+
+Firstly, there's [a code of conduct](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md).
+TLDR: be respectful.
+
+Any contributions are expected to include tests. These can be validated with `make test` or the automated github workflow will run them on PR creation.
+
+The go version in the `go.mod` is the currently supported version of go.
+
+Thanks! Issues and pull requests following these guidelines are welcome.
+
+## Development
+
+### 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.

Makefile

@@ -1,10 +1,12 @@
 
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest
+# 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.
-FLAGD_VERSION=v0.2.5
-CHART_VERSION=v0.2.17# x-release-please-version
-ENVTEST_K8S_VERSION = 1.23
+FLAGD_VERSION=v0.2.7
+CHART_VERSION=v0.2.20# x-release-please-version
+ENVTEST_K8S_VERSION = 1.25
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -64,6 +66,13 @@ vet: ## Run go vet against code.
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
 
+## Requires the operator to be deployed
+.PHONY: e2e-test
+e2e-test: manifests generate fmt vet
+	kubectl -n open-feature-operator-system apply -f ./test/e2e/e2e.yml
+	kubectl wait --for=condition=Available=True deploy --all -n 'open-feature-operator-system'
+	./test/e2e/run.sh
+
 .PHONY: lint
 lint:
 	go install -v github.com/golangci/golangci-lint/cmd/golangci-lint@latest
@@ -105,7 +114,14 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified
 release-manifests: manifests kustomize
 	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
 	mkdir -p config/rendered/
-	$(KUSTOMIZE) build config/default > config/rendered/release.yaml
+	@if [ ${KUSTOMIZE_OVERLAY} = DEFAULT ]; then\
+		echo building default overlay;\
+        $(KUSTOMIZE) build config/default > config/rendered/release.yaml;\
+    fi
+	@if [ ${KUSTOMIZE_OVERLAY} = HELM ]; then\
+		echo building helm overlay;\
+        $(KUSTOMIZE) build config/overlays/helm > chart/open-feature-operator/templates/rendered.yaml;\
+    fi
 
 .PHONY: deploy
 deploy: generate manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
@@ -138,7 +154,7 @@ ENVTEST ?= $(LOCALBIN)/setup-envtest
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v4.5.7
-CONTROLLER_TOOLS_VERSION ?= v0.8.0
+CONTROLLER_TOOLS_VERSION ?= v0.10.0
 
 KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 .PHONY: kustomize
@@ -166,9 +182,12 @@ $(HELM): $(LOCALBIN)
 	[ -e "$(HELM)" ] && rm -rf "$(HELM)" || true
 	cd $(LOCALBIN) && curl -s $(HELM_INSTALLER) | tar -xzf - -C $(LOCALBIN)
 
-helm-package: generate release-manifests helm
-	cp config/rendered/release.yaml chart/templates/rendered.yaml
-	$(HELM) package --version $(CHART_VERSION) chart 
-	mkdir -p charts && mv ofo-*.tgz charts
+.PHONY: set-helm-overlay
+set-helm-overlay:
+	${eval KUSTOMIZE_OVERLAY = HELM}
+
+helm-package: set-helm-overlay generate release-manifests helm
+	$(HELM) package --version $(CHART_VERSION) chart/open-feature-operator
+	mkdir -p charts && mv open-feature-operator-*.tgz charts
 	$(HELM) repo index --url https://open-feature.github.io/open-feature-operator/charts charts
 	mv charts/index.yaml index.yaml

PROJECT

@@ -14,4 +14,15 @@ resources:
   kind: FeatureFlagConfiguration
   path: github.com/open-feature/open-feature-operator/apis/core/v1alpha1
   version: v1alpha1
+  webhooks:
+    conversion: true
+    webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: openfeature.dev
+  group: core
+  kind: FeatureFlagConfiguration
+  path: github.com/open-feature/open-feature-operator/apis/core/v1alpha2
+  version: v1alpha2
 version: "3"