feat: add organization labels to namespace and build/task pods

uselagoon · Nov 15, 2023 · 76b1e50 · 76b1e50
1 parent 22597d2
commit 76b1e50
Show file tree

Hide file tree

Showing 9 changed files with 116 additions and 4 deletions.
diff --git a/apis/lagoon/v1beta1/lagoonbuild_types.go b/apis/lagoon/v1beta1/lagoonbuild_types.go
@@ -140,6 +140,12 @@ type Project struct {
 	EnvironmentIdling     *int            `json:"environmentIdling,omitempty"`
 	ProjectIdling         *int            `json:"projectIdling,omitempty"`
 	StorageCalculator     *int            `json:"storageCalculator,omitempty"`
+	Organization          *Organization   `json:"organization,omitempty"`
+}
+
+type Organization struct {
+	ID   *uint  `json:"id,omitempty"`
+	Name string `json:"name,omitempty"`
 }
 
 // Variables contains the project and environment variables from lagoon.

diff --git a/apis/lagoon/v1beta1/lagoontask_types.go b/apis/lagoon/v1beta1/lagoontask_types.go
@@ -124,6 +124,7 @@ type LagoonTaskProject struct {
 	Name             string          `json:"name"`
 	NamespacePattern string          `json:"namespacePattern,omitempty"`
 	Variables        LagoonVariables `json:"variables,omitempty"`
+	Organization     *Organization   `json:"organization,omitempty"`
 }
 
 // LagoonTaskEnvironment defines the lagoon environment information.

diff --git a/apis/lagoon/v1beta1/zz_generated.deepcopy.go b/apis/lagoon/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/crd.lagoon.sh_lagoonbuilds.yaml b/config/crd/bases/crd.lagoon.sh_lagoonbuilds.yaml
@@ -94,6 +94,13 @@ spec:
                     type: string
                   namespacePattern:
                     type: string
+                  organization:
+                    properties:
+                      id:
+                        type: integer
+                      name:
+                        type: string
+                    type: object
                   productionEnvironment:
                     type: string
                   projectIdling:

diff --git a/config/crd/bases/crd.lagoon.sh_lagoontasks.yaml b/config/crd/bases/crd.lagoon.sh_lagoontasks.yaml
@@ -109,6 +109,13 @@ spec:
                     type: string
                   namespacePattern:
                     type: string
+                  organization:
+                    properties:
+                      id:
+                        type: integer
+                      name:
+                        type: string
+                    type: object
                   variables:
                     description: Variables contains the project and environment variables
                       from lagoon.

diff --git a/controller-test.sh b/controller-test.sh
@@ -17,6 +17,7 @@ CHECK_TIMEOUT=20
 NS=nginx-example-main
 LBUILD=7m5zypx
 LBUILD2=8m5zypx
+LBUILD3=9m5zypx
 
 HARBOR_VERSION=${HARBOR_VERSION:-1.6.4}
 
@@ -201,6 +202,31 @@ kubectl -n $CONTROLLER_NAMESPACE patch lagoonbuilds.crd.lagoon.sh lagoon-build-$
 sleep 10
 check_lagoon_build lagoon-build-${LBUILD}
 
+echo "==> Trigger a lagoon build using kubectl apply and check organization labels exist"
+kubectl -n $CONTROLLER_NAMESPACE apply -f test-resources/example-project2.yaml
+# patch the resource with the controller namespace
+kubectl -n $CONTROLLER_NAMESPACE patch lagoonbuilds.crd.lagoon.sh lagoon-build-${LBUILD2} --type=merge --patch '{"metadata":{"labels":{"lagoon.sh/controller":"'$CONTROLLER_NAMESPACE'"}}}'
+# patch the resource with a random label to bump the controller event filter
+kubectl -n $CONTROLLER_NAMESPACE patch lagoonbuilds.crd.lagoon.sh lagoon-build-${LBUILD2} --type=merge --patch '{"metadata":{"labels":{"bump":"bump"}}}'
+sleep 10
+check_lagoon_build lagoon-build-${LBUILD2}
+if ! $(kubectl get namespace -l 'organization.lagoon.sh/name=test-org' --no-headers 2> /dev/null | grep -q ${NS}); then 
+    echo "==> Build failed to set organization name label on namespace"
+    clean_task_test_resources
+    check_controller_log ${1}
+    tear_down
+    echo "============== FAILED ==============="
+    exit 1
+fi
+if ! $(kubectl get namespace -l 'organization.lagoon.sh/id=123' --no-headers 2> /dev/null | grep -q ${NS}); then 
+    echo "==> Build failed to set organization id label on namespace"
+    clean_task_test_resources
+    check_controller_log ${1}
+    tear_down
+    echo "============== FAILED ==============="
+    exit 1
+fi
+
 echo "==> Trigger a Task using kubectl apply to test dynamic secret mounting"
 
 kubectl -n $NS apply -f test-resources/dynamic-secret-in-task-project1-secret.yaml
@@ -235,7 +261,7 @@ echo '
     "routing_key":"ci-local-controller-kubernetes:builddeploy",
     "payload":"{
         \"metadata\": {
-            \"name\": \"lagoon-build-8m5zypx\"
+            \"name\": \"lagoon-build-9m5zypx\"
         },
         \"spec\": {
             \"build\": {
@@ -246,7 +272,7 @@ echo '
             \"project\": {
                 \"name\": \"nginx-example\",
                 \"environment\": \"main\",
-                \"uiLink\": \"https:\/\/dashboard.amazeeio.cloud\/projects\/project\/project-environment\/deployments\/lagoon-build-8m5zypx\",
+                \"uiLink\": \"https:\/\/dashboard.amazeeio.cloud\/projects\/project\/project-environment\/deployments\/lagoon-build-9m5zypx\",
                 \"routerPattern\": \"main-nginx-example\",
                 \"environmentType\": \"production\",
                 \"productionEnvironment\": \"main\",
@@ -274,7 +300,7 @@ echo '
 curl -s -u guest:guest -H "Accept: application/json" -H "Content-Type:application/json" -X POST -d @payload.json http://172.17.0.1:15672/api/exchanges/%2f/lagoon-tasks/publish
 echo ""
 sleep 10
-check_lagoon_build lagoon-build-${LBUILD2}
+check_lagoon_build lagoon-build-${LBUILD3}
 
 echo "==> Check pod cleanup worked"
 CHECK_COUNTER=1

diff --git a/controllers/v1beta1/build_helpers.go b/controllers/v1beta1/build_helpers.go
@@ -106,6 +106,14 @@ func (r *LagoonBuildReconciler) getOrCreateNamespace(ctx context.Context, namesp
 		"lagoon.sh/environmentType": lagoonBuild.Spec.Project.EnvironmentType,
 		"lagoon.sh/controller":      r.ControllerNamespace,
 	}
+	if lagoonBuild.Spec.Project.Organization != nil {
+		if lagoonBuild.Spec.Project.Organization.ID != nil {
+			nsLabels["organization.lagoon.sh/id"] = fmt.Sprintf("%d", *lagoonBuild.Spec.Project.Organization.ID)
+		}
+		if lagoonBuild.Spec.Project.Organization.Name != "" {
+			nsLabels["organization.lagoon.sh/name"] = lagoonBuild.Spec.Project.Organization.Name
+		}
+	}
 	if lagoonBuild.Spec.Project.ID != nil {
 		nsLabels["lagoon.sh/projectId"] = fmt.Sprintf("%d", *lagoonBuild.Spec.Project.ID)
 	}
@@ -820,6 +828,14 @@ func (r *LagoonBuildReconciler) processBuild(ctx context.Context, opLog logr.Log
 			},
 		},
 	}
+	if lagoonBuild.Spec.Project.Organization != nil {
+		if lagoonBuild.Spec.Project.Organization.ID != nil {
+			newPod.ObjectMeta.Labels["organization.lagoon.sh/id"] = fmt.Sprintf("%d", *lagoonBuild.Spec.Project.Organization.ID)
+		}
+		if lagoonBuild.Spec.Project.Organization.Name != "" {
+			newPod.ObjectMeta.Labels["organization.lagoon.sh/name"] = lagoonBuild.Spec.Project.Organization.Name
+		}
+	}
 
 	// set the pod security context, if defined to a non-default value
 	if r.BuildPodRunAsUser != 0 || r.BuildPodRunAsGroup != 0 ||

diff --git a/controllers/v1beta1/task_controller.go b/controllers/v1beta1/task_controller.go
@@ -271,6 +271,14 @@ func (r *LagoonTaskReconciler) getTaskPodDeployment(ctx context.Context, lagoonT
 						},
 						Spec: dep.Spec.Template.Spec,
 					}
+					if lagoonTask.Spec.Project.Organization != nil {
+						if lagoonTask.Spec.Project.Organization.ID != nil {
+							taskPod.ObjectMeta.Labels["organization.lagoon.sh/id"] = fmt.Sprintf("%d", *lagoonTask.Spec.Project.Organization.ID)
+						}
+						if lagoonTask.Spec.Project.Organization.Name != "" {
+							taskPod.ObjectMeta.Labels["organization.lagoon.sh/name"] = lagoonTask.Spec.Project.Organization.Name
+						}
+					}
 					return taskPod, nil
 				}
 			}
@@ -564,6 +572,14 @@ func (r *LagoonTaskReconciler) createAdvancedTask(ctx context.Context, lagoonTas
 				},
 			},
 		}
+		if lagoonTask.Spec.Project.Organization != nil {
+			if lagoonTask.Spec.Project.Organization.ID != nil {
+				newPod.ObjectMeta.Labels["organization.lagoon.sh/id"] = fmt.Sprintf("%d", *lagoonTask.Spec.Project.Organization.ID)
+			}
+			if lagoonTask.Spec.Project.Organization.Name != "" {
+				newPod.ObjectMeta.Labels["organization.lagoon.sh/name"] = lagoonTask.Spec.Project.Organization.Name
+			}
+		}
 		if lagoonTask.Spec.AdvancedTask.DeployerToken {
 			// start this with the serviceaccount so that it gets the token mounted into it
 			newPod.Spec.ServiceAccountName = "lagoon-deployer"

diff --git a/test-resources/example-project2.yaml b/test-resources/example-project2.yaml
@@ -1,14 +1,17 @@
 kind: LagoonBuild
 apiVersion: crd.lagoon.sh/v1beta1
 metadata:
-    name: lagoon-build-9m5zypx
+    name: lagoon-build-8m5zypx
 spec:
     build:
         ci: 'true' #to make sure that readwritemany is changed to readwriteonce
         type: branch
     gitReference: origin/main
     project:
         name: nginx-example
+        organization:
+            id: 123
+            name: test-org
         environment: main
         uiLink: https://dashboard.amazeeio.cloud/projects/project/project-environment/deployments/lagoon-build-7m5zypx
         routerPattern: 'main-nginx-example'