feat: initial release (#1)

Author: raffis

.github/workflows/pr-build.yaml

@@ -8,17 +8,19 @@ on:
       - reopened
 
 jobs:
-  e2e:
+  build:
     runs-on: ubuntu-latest
+    outputs:
+      profiles: ${{ steps.profiles.outputs.matrix }}    
     steps:
       - name: Checkout
-        uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b #v3
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c #v3
       - name: Setup Go
         uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 #v3.5.0
         with:
           go-version: 1.20.x
       - name: Restore Go cache
-        uses: actions/cache@4723a57e26efda3a62cbde1812113b730952852d #v3.2.2
+        uses: actions/cache@627f0f41f6904a5b1efbaed9f96d9eb58e92e920 #v3.2.4
         with:
           path: ~/go/pkg/mod
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
@@ -34,10 +36,10 @@ jobs:
         run: make test
       - name: build
         run: make build
-      - name: Send go coverage report
-        uses: shogo82148/actions-goveralls@31ee804b8576ae49f6dc3caa22591bc5080e7920 #v1.6.0
-        with:
-          path-to-profile: coverage.out
+      #- name: Send go coverage report
+      #  uses: shogo82148/actions-goveralls@31ee804b8576ae49f6dc3caa22591bc5080e7920 #v1.6.0
+      #  with:
+      #    path-to-profile: coverage.out
       - name: Check if working tree is dirty
         run: |
           if [[ $(git diff --stat) != '' ]]; then
@@ -48,19 +50,56 @@ jobs:
       - name: Build container image
         run: |
           make docker-build
+      - name: Create image tarball
+        run: |
+          docker save --output k8sgrowthbook-controller-container.tar k8sgrowthbook-controller:latest
+      - name: Upload image
+        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce #v3.1.2
+        with:
+          name: k8sgrowthbook-controller-container
+          path: k8sgrowthbook-controller-container.tar        
+      - id: profiles
+        name: Determine test profiles
+        run: |
+          profiles=$(ls config/tests/cases | jq -R -s -c 'split("\n")[:-1]')
+          echo $profiles
+          echo "::set-output name=matrix::$profiles"
+
+  e2e-tests:
+    runs-on: ubuntu-latest
+    needs:
+    - build
+    strategy:
+      matrix:
+        profile: ${{ fromJson(needs.build.outputs.profiles) }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c #v3
+      - name: Setup Go
+        uses: actions/setup-go@d0a58c1c4d2b25278816e339b944508c875f3613 #v3.4.0
+        with:
+          go-version: 1.20.x
       - name: Setup Kubernetes
         uses: engineerd/setup-kind@aa272fe2a7309878ffc2a81c56cfe3ef108ae7d0 #v0.5.0
         with:
           version: v0.17.0
+      - name: Download k8sgrowthbook-controller container
+        uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a #v3.0.2
+        with:
+          name: k8sgrowthbook-controller-container
+          path: /tmp
+      - name: Load images
+        run: |
+          docker load --input /tmp/k8sgrowthbook-controller-container.tar
+          docker image ls -a
       - name: Setup Kustomize
         uses: imranismail/setup-kustomize@6691bdeb1b0a3286fb7f70fd1423c10e81e5375f # v2.0.0
       - name: Run test
         run: |
-          make kind-test
+          make kind-test TEST_PROFILE=${{ matrix.profile }}
       - name: Debug failure
         if: failure()
         run: |
-          kubectl -n kube-system describe pods
-          kubectl -n k8sreq-system describe pods
-          kubectl -n k8sreq-system get all
-          kubectl -n k8sreq-system logs deploy/k8sgrowthbook-controller manager
+          kubectl -n k8sgrowthbook-system get pods
+          kubectl -n k8sgrowthbook-system logs deploy/k8sgrowthbook-controller
+          kubectl -n k8sgrowthbook-system get growthbookinstance -o yaml

.gitignore

@@ -7,7 +7,7 @@
 *.dylib
 bin
 /manager
-config/tests/.../charts
+**/charts
 coverage.out
 
 # Test binary, build with `go test -c`

Makefile

@@ -41,7 +41,7 @@ help: ## Display this help.
 
 .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/base/crd/bases
+	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/base/crd/bases output:rbac:artifacts:config=config/base/rbac
 	cp config/base/crd/bases/* chart/k8sgrowthbook-controller/crds/
 
 .PHONY: generate
@@ -105,11 +105,10 @@ kind-test: docker-build ## Deploy including test
 	kind load docker-image ${IMG} --name ${CLUSTER}
 	kubectl -n k8sgrowthbook-system delete pods --all
 	kustomize build config/tests/cases/${TEST_PROFILE} --enable-helm | kubectl --context kind-${CLUSTER} apply -f -	
-	kubectl --context kind-${CLUSTER} -n k8sgrowthbook-system wait --for=condition=Ready pods -l control-plane=controller-manager -l app.kubernetes.io/name=podinfo -l app.kubernetes.io/managed-by!=Helm --timeout=3m
-	kill $$pid
+	kubectl --context kind-${CLUSTER} -n k8sgrowthbook-system wait --for=condition=Ready pods -l control-plane=controller-manager -l app.kubernetes.io/managed-by!=Helm -l verify!=yes --timeout=3m
+	kubectl --context kind-${CLUSTER} -n k8sgrowthbook-system wait --for=jsonpath='{.status.conditions[1].reason}'=PodCompleted pods -l control-plane=controller-manager -l app.kubernetes.io/managed-by!=Helm -l verify=yes --timeout=3m
 
 ##@ Deployment
-
 ifndef ignore-not-found
   ignore-not-found = false
 endif
@@ -134,7 +133,7 @@ undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/confi
 CONTROLLER_GEN = $(GOBIN)/controller-gen
 .PHONY: controller-gen
 controller-gen: ## Download controller-gen locally if necessary.
-	$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.10.0)
+	$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.12.0)
 
 GOLANGCI_LINT = $(GOBIN)/golangci-lint
 .PHONY: golangci-lint

README.md

@@ -9,13 +9,17 @@
 Kubernetes controller for managing growthbook.
 
 Currently supported are `GrowthbookOrganization`, `GrowthbookUser`, `GrowthbookFeature`, `GrowthbookClient` and `GrowthbookInstance` while the later one is the main resource
-referencing organizations and users while organizations select further resources including clients, features and users (organization membership).
+referencing all other resources while organizations select further resources including clients, features and users (organization membership).
 Basically for deploying features and clients a `GrowthbookInstance` as well as at least one `GrowthbooKOrganization` resource needs to be created.
 
 This controller does not deploy growthbook itself. It manages resources for an existing growthbook instance.
 Growthbook currently does not support managing features nor clients within the scope of the rest api. This controller 
 bypasses their api and manages the resources on MongoDB directly.
 
+## Resource relationship
+
+![graph](https://github.com/DoodleScheduling/k8sgrowthbook-controller/blob/master/docs/resource-relationship.jpg.jpg?raw=true)
+
 ## Example Usage
 
 The following manifests configure:
@@ -97,6 +101,7 @@ metadata:
   name: feature-a
   labels:
     growthbook-org: my-org
+    growthbook-instance: my-instance
   namespace: growthbook
 spec:
   description: feature A
@@ -114,6 +119,7 @@ metadata:
   name: feature-b
   labels:
     growthbook-org: my-org
+    growthbook-instance: my-instance
   namespace: growthbook
 spec:
   description: feature B
@@ -131,9 +137,11 @@ metadata:
   name: client-1
   labels:
     growthbook-org: my-org
+    growthbook-instance: my-instance
   namespace: growthbook
 spec:
   description: feature B
+  environment: production
   tags:
   - frontend
   tokenSecret:

api/v1beta1/growthbookclient_types.go

@@ -24,16 +24,17 @@ import (
 
 // GrowthbookClientSpec defines the desired state of GrowthbookClient
 type GrowthbookClientSpec struct {
-	Languages                []string             `json:"languages,omitempty"`
-	Name                     string               `json:"name,omitempty"`
-	Environment              string               `json:"environment,omitempty"`
-	EncryptPayload           bool                 `json:"encryptPayload,omitempty"`
-	Project                  string               `json:"project,omitempty"`
-	IncludeVisualExperiments bool                 `json:"includeVisualExperiments,omitempty"`
-	IncludeDraftExperiments  bool                 `json:"includeDraftExperiments,omitempty"`
-	IncludeExperimentNames   bool                 `json:"includeExperimentNames,omitempty"`
-	ID                       string               `json:"id,omitempty"`
-	TokenSecret              TokenSecretReference `json:"tokenSecret,omitempty"`
+	Languages []string `json:"languages,omitempty"`
+	Name      string   `json:"name,omitempty"`
+	// +kubebuilder:default:=dev
+	Environment              string                `json:"environment,omitempty"`
+	EncryptPayload           bool                  `json:"encryptPayload,omitempty"`
+	Project                  string                `json:"project,omitempty"`
+	IncludeVisualExperiments bool                  `json:"includeVisualExperiments,omitempty"`
+	IncludeDraftExperiments  bool                  `json:"includeDraftExperiments,omitempty"`
+	IncludeExperimentNames   bool                  `json:"includeExperimentNames,omitempty"`
+	ID                       string                `json:"id,omitempty"`
+	TokenSecret              *TokenSecretReference `json:"tokenSecret"`
 }
 
 // GetID returns the client ID which is the resource name if not overwritten by spec.ID
@@ -51,16 +52,14 @@ func (c *GrowthbookClient) GetName() string {
 		return c.Name
 	}
 
-	return c.Spec.ID
+	return c.Spec.Name
 }
 
 // SecretReference is a named reference to a secret which contains user credentials
 type TokenSecretReference struct {
 	// Name referrs to the name of the secret, must be located whithin the same namespace
-	// +required
-	Name string `json:"name,omitempty"`
+	Name string `json:"name"`
 
-	// +optional
 	// +kubebuilder:default:=token
 	TokenField string `json:"tokenField,omitempty"`
 }

api/v1beta1/growthbookfeature_types.go

@@ -29,7 +29,7 @@ type GrowthbookFeatureSpec struct {
 	Tags         []string         `json:"tags,omitempty"`
 	DefaultValue string           `json:"defaultValue,omitempty"`
 	ValueType    FeatureValueType `json:"valueType,omitempty"`
-	// +kubebuilder:default:={{name: production, enabled: true}}
+	// +kubebuilder:default:={{name: dev, enabled: true}}
 	Environments []Environment `json:"environments,omitempty"`
 }
 

api/v1beta1/growthbookinstance_types.go

@@ -26,11 +26,13 @@ type GrowthbookInstanceSpec struct {
 	MongoDB GrowthbookInstanceMongoDB `json:"mongodb,omitempty"`
 
 	// Interval reconciliation
-	// +optional
 	Interval *metav1.Duration `json:"interval,omitempty"`
 
+	// Timeout while reconciling the instance
+	// +kubebuilder:default:="5m"
+	Timeout *metav1.Duration `json:"timeout,omitempty"`
+
 	// Suspend reconciliation
-	// +optional
 	Suspend bool `json:"suspend,omitempty"`
 
 	// ResourceSelector defines a selector to select Growthbook resources associated with this instance
@@ -43,22 +45,7 @@ type GrowthbookInstanceMongoDB struct {
 	URI string `json:"uri,omitempty"`
 
 	// Secret is a secret refernece with the MongoDB credentials
-	Secret *SecretReference `json:"rootSecret"`
-}
-
-// SecretReference is a named reference to a secret which contains user credentials
-type SecretReference struct {
-	// Name referrs to the name of the secret, must be located whithin the same namespace
-	// +required
-	Name string `json:"name"`
-
-	// +optional
-	// +kubebuilder:default:=username
-	UserField string `json:"userField"`
-
-	// +optional
-	// +kubebuilder:default:=password
-	PasswordField string `json:"passwordField"`
+	Secret *SecretReference `json:"rootSecret,omitempty"`
 }
 
 // GrowthbookInstanceStatus defines the observed state of GrowthbookInstance

api/v1beta1/growthbookorganization_types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1beta1
 
 import (
+	"fmt"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -42,7 +44,7 @@ type GrowthbookOrganizationUser struct {
 // GetID returns the organization ID which is the resource name if not overwritten by spec.ID
 func (o *GrowthbookOrganization) GetID() string {
 	if o.Spec.ID == "" {
-		return o.Name
+		return fmt.Sprintf("%s-%s", o.Name, o.Namespace)
 	}
 
 	return o.Spec.ID
@@ -54,7 +56,7 @@ func (o *GrowthbookOrganization) GetName() string {
 		return o.Name
 	}
 
-	return o.Spec.ID
+	return o.Spec.Name
 }
 
 // +kubebuilder:object:root=true

api/v1beta1/growthbookuser_types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1beta1
 
 import (
+	"fmt"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -31,21 +33,21 @@ type GrowthbookUserSpec struct {
 }
 
 // GetID returns the organization ID which is the resource name if not overwritten by spec.ID
-func (o *GrowthbookUser) GetID() string {
-	if o.Spec.ID == "" {
-		return o.Name
+func (u *GrowthbookUser) GetID() string {
+	if u.Spec.ID == "" {
+		return fmt.Sprintf("%s-%s", u.Name, u.Namespace)
 	}
 
-	return o.Spec.ID
+	return u.Spec.ID
 }
 
 // GetName returns the organization name which is the resource name if not overwritten by spec.Name
-func (o *GrowthbookUser) GetName() string {
-	if o.Spec.Name == "" {
-		return o.Name
+func (u *GrowthbookUser) GetName() string {
+	if u.Spec.Name == "" {
+		return u.Name
 	}
 
-	return o.Spec.ID
+	return u.Spec.Name
 }
 
 // +kubebuilder:object:root=true

api/v1beta1/meta.go

@@ -47,3 +47,17 @@ func setResourceCondition(resource conditionalResource, condition string, status
 
 	apimeta.SetStatusCondition(conditions, newCondition)
 }
+
+// SecretReference is a named reference to a secret which contains user credentials
+type SecretReference struct {
+	// Name referrs to the name of the secret, must be located whithin the same namespace
+	Name string `json:"name"`
+
+	// +optional
+	// +kubebuilder:default:=username
+	UserField string `json:"userField,omitempty"`
+
+	// +optional
+	// +kubebuilder:default:=password
+	PasswordField string `json:"passwordField,omitempty"`
+}