Sanitize Kustomizations

.gitignore

@@ -25,3 +25,4 @@ build
 *.swo
 *~
 clientconfig
+.vscode/

Makefile

@@ -137,15 +137,15 @@ endif
 kind-e2e-test: build kustomize docker-build create-kind-multicluster kind-load-image-multi e2e-test
 
 single-up: build kustomize docker-build create-kind-cluster kind-load-image cert-manager
-	$(KUSTOMIZE) build scripts/control_plane | kubectl apply -f -
+	$(KUSTOMIZE) build aux-config/control_plane | kubectl apply -f -
 
 multi-up: build kustomize docker-build create-kind-multicluster kind-load-image-multi cert-manager-multi
 ## install the control plane
 	kubectl config use-context kind-k8ssandra-0
-	$(KUSTOMIZE) build scripts/control_plane | kubectl apply -f -
+	$(KUSTOMIZE) build aux-config/control_plane | kubectl apply -f -
 ## install the data plane
 	kubectl config use-context kind-k8ssandra-1
-	$(KUSTOMIZE) build scripts/data_plane | kubectl apply -f -
+	$(KUSTOMIZE) build aux-config/data_plane | kubectl apply -f -
 ## Create a client config
 	make create-client-config
 ## Restart the control plane

aux-config/control_plane/kustomization.yaml

@@ -0,0 +1,2 @@
+resources:
+- ../default

scripts/data_plane/kustomization.yaml → aux-config/data_plane/kustomization.yaml

@@ -1,5 +1,5 @@
 resources:
-- github.com/k8ssandra/k8ssandra-operator/config/default?ref=main
+- ../default
 
 patchesJson6902:
 - patch: |-
@@ -10,8 +10,4 @@ patchesJson6902:
     group: apps
     kind: Deployment
     name: k8ssandra-operator
-    version: v1
-
-images:
-- name: k8ssandra/k8ssandra-operator
-  newTag: latest
+    version: v1

aux-config/default/cass-operator/kustomization.yaml

@@ -0,0 +1,4 @@
+namespace: default
+resources:
+- github.com/k8ssandra/cass-operator/config/default?ref=v1.8.0-rc.1
+# namePrefix: cass-operator- # Can be removed in this case because cass-operator already has a namePrefix defined in the repo.

aux-config/default/kustomization.yaml

@@ -0,0 +1,3 @@
+resources:
+- ./cass-operator
+- ../../config/default

config/default/kustomization.yaml

@@ -17,7 +17,6 @@ namespace: default
 #  -
 
 resources:
-- ../cass-operator
 - ../crd
 - ../rbac
 - ../manager

docs/install/kustomize-structure.md

@@ -0,0 +1,37 @@
+# About the kustomization structure
+
+The kustomization directories are slightly more complex than the average operator due to the dependancy on `cass-operator`. We deploy `cass-operator` using the manifests from Github to ensure that we remain up to date.
+
+## Objectives
+
+We want to achieve the following:
+
+1. Minimal modifications to the `config/` directory initially created by `operator-sdk`.
+2. All remote operator manifests are pulled from their home GH repositories, not kept locally.
+3. All local operator manifests come directly from `config/`.
+
+## Design
+
+The kustomization directories are as follows. Any kustomizations not generated by `operator-sdk` are stored in `aux-config/` rather than the templated `config/` directory. This is where we deploy k8ssandra-operator from when we want to include all its dependancies. 
+
+```
+   ┌──────────────┐                 ┌───────────────┐
+   │ control_plane│                 │ cass-operator │
+   └─────────────┬┘                 └──────▲────────┘
+                 │                         │
+                 │          ┌───────┐      │
+                 └──────────►default├──────┤
+                            └───▲───┘      │
+    ┌─────────────┐             │          │
+    │  data_plane ├─────────────┘          │
+    └─────────────┘                        │
+                                           │
+                               ┌───────────▼─────────────────────┐
+                               │k8ssandra-operator/config/default│
+                               └────┬───────────┬────────────┬───┘
+                                    │           │            │
+                                    │           │            │
+                                ┌───▼───┐   ┌───▼───┐   ┌────▼──┐
+                                │ rbac  │   │ crd   │   │manager│
+                                └───────┘   └───────┘   └───────┘
+```