Merge pull request #239 from yashvardhan-kukreja/yashvardhan/namespac…

…e-labels-and-annotations-support [MTSRE-691] | feat: Addon API supporting .spec.namespaces.labels and .spec.namespaces.annotations
openshift · Sep 15, 2022 · 39bc82b · 39bc82b
2 parents edd14dd + 12a2af7
commit 39bc82b
Show file tree

Hide file tree

Showing 8 changed files with 88 additions and 13 deletions.
diff --git a/apis/addons/v1alpha1/addons_types.go b/apis/addons/v1alpha1/addons_types.go
@@ -231,6 +231,14 @@ type AddonNamespace struct {
 	// Name of the KubernetesNamespace.
 	// +kubebuilder:validation:MinLength=1
 	Name string `json:"name"`
+
+	// Labels to be added to the namespace
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+
+	// Annotations to be added to the namespace
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
 const (

diff --git a/apis/addons/v1alpha1/zz_generated.deepcopy.go b/apis/addons/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/deploy/addons.managed.openshift.io_addons.yaml b/config/deploy/addons.managed.openshift.io_addons.yaml
@@ -266,6 +266,16 @@ spec:
                   existing Namespaces being adopted.
                 items:
                   properties:
+                    annotations:
+                      additionalProperties:
+                        type: string
+                      description: Annotations to be added to the namespace
+                      type: object
+                    labels:
+                      additionalProperties:
+                        type: string
+                      description: Labels to be added to the namespace
+                      type: object
                     name:
                       description: Name of the KubernetesNamespace.
                       minLength: 1

diff --git a/config/openshift/manifests/addons.crd.yaml b/config/openshift/manifests/addons.crd.yaml
@@ -264,6 +264,16 @@ spec:
                   existing Namespaces being adopted.
                 items:
                   properties:
+                    annotations:
+                      additionalProperties:
+                        type: string
+                      description: Annotations to be added to the namespace
+                      type: object
+                    labels:
+                      additionalProperties:
+                        type: string
+                      description: Labels to be added to the namespace
+                      type: object
                     name:
                       description: Name of the KubernetesNamespace.
                       minLength: 1

diff --git a/docs/api-reference/_index.md b/docs/api-reference/_index.md
@@ -229,6 +229,8 @@ AddonInstallSpec defines the desired Addon installation type.
 | Field | Description | Scheme | Required |
 | ----- | ----------- | ------ | -------- |
 | name | Name of the KubernetesNamespace. | string | true |
+| labels | Labels to be added to the namespace | map[string]string | false |
+| annotations | Annotations to be added to the namespace | map[string]string | false |
 
 [Back to Group]()
 

diff --git a/internal/controllers/addon/namespace_options.go b/internal/controllers/addon/namespace_options.go
@@ -0,0 +1,17 @@
+package addon
+
+import corev1 "k8s.io/api/core/v1"
+
+type NamespaceOpts func(*corev1.Namespace)
+
+func WithNamespaceLabels(labels map[string]string) NamespaceOpts {
+	return func(n *corev1.Namespace) {
+		n.ObjectMeta.Labels = labels
+	}
+}
+
+func WithNamespaceAnnotations(annotations map[string]string) NamespaceOpts {
+	return func(n *corev1.Namespace) {
+		n.ObjectMeta.Annotations = annotations
+	}
+}
diff --git a/internal/controllers/addon/namespace_reconciler.go b/internal/controllers/addon/namespace_reconciler.go
@@ -117,7 +117,7 @@ func (r *namespaceReconciler) ensureWantedNamespaces(
 	var unreadyNamespaces []string
 
 	for _, namespace := range addon.Spec.Namespaces {
-		ensuredNamespace, err := r.ensureNamespace(ctx, addon, namespace.Name)
+		ensuredNamespace, err := r.ensureNamespace(ctx, addon, namespace.Name, WithNamespaceLabels(namespace.Labels), WithNamespaceAnnotations(namespace.Annotations))
 		if err != nil {
 			return err
 		}
@@ -135,18 +135,16 @@ func (r *namespaceReconciler) ensureWantedNamespaces(
 }
 
 // Ensure a single Namespace for the given Addon resource
-func (r *namespaceReconciler) ensureNamespace(ctx context.Context, addon *addonsv1alpha1.Addon, name string) (*corev1.Namespace, error) {
-	return r.ensureNamespaceWithLabels(ctx, addon, name, map[string]string{})
-}
-
-// Ensure a single Namespace with a set of labels for the given Addon resource
-func (r *namespaceReconciler) ensureNamespaceWithLabels(ctx context.Context, addon *addonsv1alpha1.Addon, name string, labels map[string]string) (*corev1.Namespace, error) {
+func (r *namespaceReconciler) ensureNamespace(ctx context.Context, addon *addonsv1alpha1.Addon, name string, namespaceOpts ...NamespaceOpts) (*corev1.Namespace, error) {
 	namespace := &corev1.Namespace{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:   name,
-			Labels: labels,
+			Name: name,
 		},
 	}
+	for _, opt := range namespaceOpts {
+		opt := opt
+		opt(namespace)
+	}
 	controllers.AddCommonLabels(namespace, addon)
 	err := controllerutil.SetControllerReference(addon, namespace, r.scheme)
 	if err != nil {
@@ -174,5 +172,9 @@ func reconcileNamespace(ctx context.Context, c client.Client, namespace *corev1.
 	newLabels := labels.Merge(currentLabels, labels.Set(namespace.Labels))
 	currentNamespace.Labels = newLabels
 
+	currentAnnotations := labels.Set(currentNamespace.Annotations)
+	newAnnotations := labels.Merge(currentAnnotations, labels.Set(namespace.Annotations))
+	currentNamespace.Annotations = newAnnotations
+
 	return currentNamespace, c.Update(ctx, currentNamespace)
 }
diff --git a/internal/controllers/addon/namespace_reconciler_test.go b/internal/controllers/addon/namespace_reconciler_test.go
@@ -186,18 +186,23 @@ func TestEnsureNamespace_Create(t *testing.T) {
 	}
 
 	ctx := context.Background()
-	ensuredNamespace, err := r.ensureNamespace(ctx, addon, addon.Spec.Namespaces[0].Name)
+	namespace := addon.Spec.Namespaces[0]
+	ensuredNamespace, err := r.ensureNamespace(ctx, addon, namespace.Name)
 	c.AssertExpectations(t)
 	require.NoError(t, err)
 	require.NotNil(t, ensuredNamespace)
 }
 
-func TestEnsureNamespace_CreateWithLabels(t *testing.T) {
+func TestEnsureNamespace_CreateWithLabelsAndAnnotations(t *testing.T) {
 	addon := testutil.NewTestAddonWithSingleNamespace()
 	labels := map[string]string{
 		"foo": "bar",
 		"baz": "qux",
 	}
+	annotations := map[string]string{
+		"cache":  "invalidation",
+		"naming": "variables",
+	}
 
 	c := testutil.NewClient()
 	c.On("Get", testutil.IsContext, testutil.IsObjectKey, testutil.IsCoreV1NamespacePtr).Return(testutil.NewTestErrNotFound())
@@ -207,6 +212,10 @@ func TestEnsureNamespace_CreateWithLabels(t *testing.T) {
 			for key, value := range labels {
 				assert.Equal(t, value, ns.Labels[key])
 			}
+			for key, value := range annotations {
+				assert.Equal(t, value, ns.Annotations[key])
+			}
+
 		}).
 		Return(nil)
 
@@ -217,7 +226,8 @@ func TestEnsureNamespace_CreateWithLabels(t *testing.T) {
 
 	ctx := context.Background()
 
-	ensuredNamespace, err := r.ensureNamespaceWithLabels(ctx, addon, addon.Spec.Namespaces[0].Name, labels)
+	namespace := addon.Spec.Namespaces[0]
+	ensuredNamespace, err := r.ensureNamespace(ctx, addon, namespace.Name, WithNamespaceLabels(labels), WithNamespaceAnnotations(annotations))
 	c.AssertExpectations(t)
 	require.NoError(t, err)
 	require.NotNil(t, ensuredNamespace)