chore: standardize controller kustomize implementation

Motivation:

This refactoring aligns the controller's kustomize configuration with best
practices and ensures consistency with other components (backend, frontend).
The primary goals were:
- Remove nested subdirectories (bases/, patches/) to match the flat structure
  used in other base directories
- Ensure components are only included in overlays, not the base
- Improve maintainability through consistent naming conventions
- Better organize resources by their purpose and dependencies

Changes Made:

1. Flattened CRD directory structure:
   - Moved CRD base files from crd/bases/ to crd/
   - Moved patch files from crd/patches/ to crd/
   - Updated all references in Makefile and test files

2. Standardized patch file naming:
   - Renamed cainjection_in_*.yaml → *_cainjection_patch.yaml
   - Renamed webhook_in_*.yaml → *_webhook_patch.yaml
   - Provides consistent naming pattern across all patches

3. Component organization:
   - Moved metrics_service.yaml to prometheus component (only included when
     prometheus is enabled)
   - Moved manager_webhook_patch.yaml to certmanager component (only needed
     when cert-manager is enabled)
   - Extracted namespace.yaml from manager.yaml for explicit definition

4. Updated references:
   - Makefile: Changed controller-gen output path from crd/bases to crd
   - Test files: Updated CRDDirectoryPaths in controller, webhook, and backend
     test suites

5. Removed unused build-installer target:
   - Removed from Makefile and README as it's not used and kustomize provides
     better facilities for vendoring

Expected Manifest Output Differences:

1. webhook-service port now has name attribute:
   - Added `name: webhook` to the port definition
   - This enables replacements to reference the port by name, improving
     maintainability and keeping port values in sync between Service and
     Deployment

2. workspaces-controller-metrics-service is missing:
   - This is expected as metrics_service.yaml was moved to the prometheus
     component
   - The service will only appear when the prometheus component is explicitly
     enabled in an overlay

3. kubeflow-workspaces-istio-config ConfigMap labels:
   - Common labels were added (app.kubernetes.io/managed-by, app.kubernetes.io/name,
     app.kubernetes.io/part-of) due to reordering of components in the overlay
   - The common component is now applied last to ensure its labels are applied
     to all resources consistently

4. All other resources remain functionally equivalent:
   - CRDs, Deployments, Services, RBAC, and webhook configurations are
     unchanged in functionality
   - Only structural and organizational improvements were made

Signed-off-by: Andy Stoneberg <[email protected]>

Author: andyatmiami

workspaces/backend/api/suite_test.go

@@ -82,11 +82,11 @@ var _ = BeforeSuite(func() {
 	ctx, cancel = context.WithCancel(context.Background())
 
 	By("bootstrapping test environment")
-	path := filepath.Join("..", "..", "controller", "config", "crd", "bases")
+	path := filepath.Join("..", "..", "controller", "manifests", "kustomize", "base", "crd")
 	fmt.Println(path)
 	testEnv = &envtest.Environment{
 		CRDDirectoryPaths: []string{
-			filepath.Join("..", "..", "controller", "config", "crd", "bases"),
+			filepath.Join("..", "..", "controller", "manifests", "kustomize", "base", "crd"),
 		},
 		ErrorIfCRDPathMissing: true,
 

workspaces/controller/Makefile

@@ -48,7 +48,10 @@ 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/crd/bases
+	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." \
+		output:crd:artifacts:config=manifests/kustomize/base/crd \
+		output:webhook:artifacts:config=manifests/kustomize/base/webhook \
+		output:rbac:artifacts:config=manifests/kustomize/base/manager
 
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
@@ -118,12 +121,6 @@ docker-build-multi-arch:
 docker-build-push-multi-arch:
 	docker buildx build --platform ${ARCH} --tag ${IMG} --push .
 
-.PHONY: build-installer
-build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
-	mkdir -p dist
-	cd config/manager && $(KUSTOMIZE) edit set image workspaces-controller=${IMG}
-	$(KUSTOMIZE) build config/default > dist/install.yaml
-
 ##@ Deployment
 
 ifndef ignore-not-found
@@ -132,20 +129,20 @@ endif
 
 .PHONY: install
 install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
-	$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -
+	$(KUSTOMIZE) build manifests/kustomize/base/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.
-	$(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
+	$(KUSTOMIZE) build manifests/kustomize/base/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.
-	cd config/manager && $(KUSTOMIZE) edit set image workspaces-controller=${IMG}
-	$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -
+	cd manifests/kustomize/overlays/istio && $(KUSTOMIZE) edit set image workspaces-controller=${IMG}
+	$(KUBECTL) apply -k manifests/kustomize/overlays/istio
 
 .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.
-	$(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
+	$(KUBECTL) delete -k manifests/kustomize/overlays/istio --ignore-not-found=$(ignore-not-found)
 
 ##@ Dependencies
 

workspaces/controller/README.md

@@ -41,10 +41,10 @@ make deploy IMG=<some-registry>/workspaces-controller:tag
 privileges or be logged in as admin.
 
 **Create instances of your solution**
-You can apply the samples (examples) from the config/sample:
+You can apply the samples (examples) from the manifests/kustomize/samples:
 
 ```sh
-kubectl apply -k config/samples/
+kubectl apply -k manifests/kustomize/samples/
 ```
 
 >**NOTE**: Ensure that the samples has default values to test it out.
@@ -53,7 +53,7 @@ kubectl apply -k config/samples/
 **Delete the instances (CRs) from the cluster:**
 
 ```sh
-kubectl delete -k config/samples/
+kubectl delete -k manifests/kustomize/samples/
 ```
 
 **Delete the APIs(CRDs) from the cluster:**
@@ -67,26 +67,3 @@ make uninstall
 ```sh
 make undeploy
 ```
-
-## Project Distribution
-
-Following are the steps to build the installer and distribute this project to users.
-
-1. Build the installer for the image built and published in the registry:
-
-```sh
-make build-installer IMG=<some-registry>/workspaces-controller:tag
-```
-
-NOTE: The makefile target mentioned above generates an 'install.yaml'
-file in the dist directory. This file contains all the resources built
-with Kustomize, which are necessary to install this project without
-its dependencies.
-
-2. Using the installer
-
-Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
-
-```sh
-kubectl apply -f https://raw.githubusercontent.com/<org>/workspaces-controller/<tag or branch>/dist/install.yaml
-```