making namespace configurable for the operator

Signed-off-by: Mihai Sarbulescu <[email protected]>

Author: SubZer0MS

CONTRIBUTING.md

@@ -136,6 +136,7 @@ It runs on the default Mongodb port (27017) and authentication is not required t
 With your local Porter configuration file pointed to the in-cluster mongodb server, you can use Porter to query and interact with installations created by the operator.
 
 Expose the in-cluster mongodb server on the default mongo porter: 27017.
+* NOTE: Use your custom namespace if you have installed with the non-default one (porter-operator-system)
 ```
 kubectl port-forward --namespace porter-operator-system svc/mongodb 27017:27017 >/dev/null &
 ```

config/crd/bases/getporter.org_agentactions.yaml

@@ -803,7 +803,8 @@ spec:
                                         defined in spec.resourceClaims, that are used
                                         by this container. \n This is an alpha field
                                         and requires enabling the DynamicResourceAllocation
-                                        feature gate. \n This field is immutable."
+                                        feature gate. \n This field is immutable.
+                                        It can only be set for containers."
                                       items:
                                         description: ResourceClaim references one
                                           entry in PodSpec.ResourceClaims.

config/crd/bases/getporter.org_agentconfigs.yaml

@@ -101,9 +101,7 @@ spec:
               storageClassName:
                 description: StorageClassName is the name of the storage class that
                   Porter will request when running the Porter Agent. It is used to
-                  determine what the storage class will be for the volume requested.
-                  The storage class must support ReadWriteOnce and ReadOnlyMany access modes
-                  as well as allow for 'chmod' to be executed.
+                  determine what the storage class will be for the volume requested
                 type: string
               volumeSize:
                 description: VolumeSize is the size of the persistent volume that

controllers/agentaction_controller.go

@@ -483,6 +483,8 @@ func (r *AgentActionReconciler) createAgentJob(ctx context.Context, log logr.Log
 func (r *AgentActionReconciler) resolveAgentConfig(ctx context.Context, log logr.Logger, action *porterv1.AgentAction) (porterv1.AgentConfigSpecAdapter, error) {
 	log.V(Log5Trace).Info("Resolving porter agent configuration")
 
+	operatorNamespace := operatorNamespaceDefault
+
 	logConfig := func(level string, config *porterv1.AgentConfig) {
 		if config == nil || config.Name == "" {
 			return
@@ -493,6 +495,8 @@ func (r *AgentActionReconciler) resolveAgentConfig(ctx context.Context, log logr
 			"namespace", config.Namespace,
 			"name", config.Name,
 			"plugin", config.Spec.PluginConfigFile)
+
+		operatorNamespace = config.Namespace
 	}
 
 	// Read agent configuration defined at the system level
@@ -550,6 +554,8 @@ func (r *AgentActionReconciler) resolveAgentConfig(ctx context.Context, log logr
 func (r *AgentActionReconciler) resolvePorterConfig(ctx context.Context, log logr.Logger, action *porterv1.AgentAction) (porterv1.PorterConfigSpec, error) {
 	log.V(Log5Trace).Info("Resolving porter configuration file")
 
+	operatorNamespace := operatorNamespaceDefault
+
 	logConfig := func(level string, config *porterv1.PorterConfig) {
 		if config == nil || config.Name == "" {
 			return
@@ -558,6 +564,8 @@ func (r *AgentActionReconciler) resolvePorterConfig(ctx context.Context, log log
 			"level", level,
 			"namespace", config.Namespace,
 			"name", config.Name)
+
+		operatorNamespace = config.Namespace
 	}
 
 	// Provide a safe default config in case nothing is defined anywhere
@@ -568,7 +576,7 @@ func (r *AgentActionReconciler) resolvePorterConfig(ctx context.Context, log log
 			{PluginConfig: porterv1.PluginConfig{
 				Name:         "in-cluster-mongodb",
 				PluginSubKey: "mongodb",
-				Config:       runtime.RawExtension{Raw: []byte(`{"url":"mongodb://mongodb.porter-operator-system.svc.cluster.local"}`)},
+				Config:       runtime.RawExtension{Raw: []byte(`{"url":"mongodb://mongodb.` + operatorNamespace + `.svc.cluster.local"}`)},
 			}},
 		},
 	}

controllers/agentaction_controller_test.go

@@ -928,7 +928,7 @@ func TestAgentActionReconciler_NoPluginsSpecified(t *testing.T) {
 
 func TestAgentActionReconciler_resolveAgentConfig(t *testing.T) {
 	systemCfg := porterv1.AgentConfig{
-		ObjectMeta: metav1.ObjectMeta{Name: "default", Namespace: operatorNamespace},
+		ObjectMeta: metav1.ObjectMeta{Name: "default", Namespace: operatorNamespaceDefault},
 		Status: porterv1.AgentConfigStatus{
 			Ready: true,
 		},

controllers/installation_controller.go

@@ -18,7 +18,7 @@ import (
 )
 
 const (
-	operatorNamespace = "porter-operator-system"
+	operatorNamespaceDefault = "porter-operator-system"
 )
 
 // InstallationReconciler calls porter to execute changes made to an Installation CRD

docs/content/install.md

@@ -95,6 +95,7 @@ porter credentials generate porterops -r ghcr.io/getporter/porter-operator:v0.8.
 ```
 
 Install the operator into the porter-operator-system namespace:
+* NOTE: Use your custom namespace if you want to install to a different one by adding **--param operatorNamespace=your-namespace-name**
 ```
 porter install porterops -c porterops -r ghcr.io/getporter/porter-operator:v0.8.0
 ```

docs/content/quickstart/_index.md

@@ -40,7 +40,7 @@ The bundle includes a custom action that prepares a namespace for you:
 porter invoke porterops --action configureNamespace --param namespace=quickstart -c porterops
 ```
 
-The Porter Operator is now installed on your cluster in the porter-operator-system namespace, along with a Mongodb server.
+The Porter Operator is now installed on your cluster in the porter-operator-system (or your custom namespace) namespace, along with a Mongodb server.
 This database is not secured with a username/password, so do not use this default installation configuration with production secrets!
 The cluster has a namespace, quickstart, where we will create resources and Porter will create jobs to run Porter.
 
@@ -50,6 +50,7 @@ Let's update your local porter CLI to read the data from the operator's datastor
 This isn't necessary for the operator to work, but will allow us to see what's happening and understand how the operator works.
 
 Run the following command to expose the operator's mongodb server to your localhost:
+* NOTE: Use your custom namespace if you have installed with the non-default one (porter-operator-system)
 ```
 kubectl port-forward --namespace porter-operator-system svc/mongodb 27020:27017 >/dev/null &
 ```

installer/helpers.sh

@@ -1,6 +1,23 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+OPNAMESPACE="porter-operator-system"
+
+setCustomNamespaceForOperator() {
+  if [ -z "$1" ]; then
+    echo "No namespace specified, using default $OPNAMESPACE"
+  else
+    OPNAMESPACE=$1
+    echo "Using custom namespace $OPNAMESPACE"
+  fi
+
+  # Replace the namespace in the operator.yaml
+  echo "Setting namespace to $OPNAMESPACE"
+  cd manifests
+  kustomize edit set namespace $OPNAMESPACE
+  kustomize build -o operator.yaml
+}
+
 setControllerImage() {
   # Replace the manager image with the image packaged with the bundle
   echo "Setting manager image to $1"
@@ -46,11 +63,15 @@ configureNamespace() {
 }
 
 waitForDeployment() {
+  if [ ! -z "$1" ]; then
+    OPNAMESPACE=$1
+  fi
+
   set +e # allow this next command to fail
-  kubectl rollout status deploy/porter-operator-controller-manager --namespace porter-operator-system --timeout 30s
+  kubectl rollout status deploy/porter-operator-controller-manager --namespace $OPNAMESPACE --timeout 30s
   if [[ $? != 0 ]]; then
     echo "Deployment failed, retrieving logs to troubleshoot"
-    kubectl logs deploy/porter-operator-controller-manager --namespace porter-operator-system -c manager
+    kubectl logs deploy/porter-operator-controller-manager --namespace $OPNAMESPACE -c manager
   fi
 }
 

installer/vanilla.porter.yaml

@@ -68,6 +68,13 @@ parameters:
     default: "13.6.2"
     applyTo:
       - install
+  - name: operatorNamespace
+    description: Namespace to install the operator into
+    type: string
+    default: "porter-operator-system"
+    applyTo:
+      - install
+      - upgrade
   - name: mongodbVals
     description: Helm values file to use when installing the mongodb chart
     type: file
@@ -88,6 +95,12 @@ mixins:
   - kubernetes
 
 install:
+  - exec:
+      description: "Set custom namespace for operator if present"
+      command: ./helpers.sh
+      arguments:
+        - setCustomNamespaceForOperator
+        - ${bundle.parameters.operatorNamespace}
   - exec:
       description: "Set manager image reference"
       command: ./helpers.sh
@@ -101,7 +114,7 @@ install:
       wait: true
   - helm3:
       description: "Install a mongo database for Porter"
-      namespace: porter-operator-system
+      namespace: ${bundle.parameters.operatorNamespace}
       name: mongodb
       chart: bitnami/mongodb
       version: ${bundle.parameters.mongodbChartVersion}
@@ -115,8 +128,15 @@ install:
       command: ./helpers.sh
       arguments:
         - waitForDeployment
+        - ${bundle.parameters.operatorNamespace}
 
 upgrade:
+  - exec:
+      description: "Set custom namespace for operator if present"
+      command: ./helpers.sh
+      arguments:
+        - setCustomNamespaceForOperator
+        - ${bundle.parameters.operatorNamespace}
   - exec:
       description: "Set manager image reference"
       command: ./helpers.sh