Add labels and annotations field to SubNamespace resource

api/v1/subnamespace_types.go

@@ -16,13 +16,28 @@ const (
 	SubNamespaceConflict = SubNamespaceStatus("conflict")
 )
 
+// SubNamespaceSpec defines the desired state of SubNamespace
+type SubNamespaceSpec struct {
+	// Labels is the labels for be propagated to the sub-namespace.
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+
+	// Annotations is the annotations for be propagated to the sub-namespace.
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
+}
+
 //+kubebuilder:object:root=true
 
 // SubNamespace is the Schema for the subnamespaces API
 type SubNamespace struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// Spec is the spec of SubNamespace.
+	// +optional
+	Spec SubNamespaceSpec `json:"spec,omitempty"`
+
 	// Status is the status of SubNamespace.
 	// +optional
 	Status SubNamespaceStatus `json:"status,omitempty"`

charts/accurate/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/accurate/crds/accurate.cybozu.com_subnamespaces.yaml

@@ -32,6 +32,21 @@ spec:
             type: string
           metadata:
             type: object
+          spec:
+            description: Spec is the spec of SubNamespace.
+            properties:
+              annotations:
+                additionalProperties:
+                  type: string
+                description: Annotations is the annotations for be propagated to the
+                  sub-namespace.
+                type: object
+              labels:
+                additionalProperties:
+                  type: string
+                description: Labels is the labels for be propagated to the sub-namespace.
+                type: object
+            type: object
           status:
             description: Status is the status of SubNamespace.
             enum:

cmd/accurate-controller/sub/run.go

@@ -98,7 +98,9 @@ func subMain(ns, addr string, port int) error {
 
 	// SubNamespace reconciler & webhook
 	if err = (&controllers.SubNamespaceReconciler{
-		Client: mgr.GetClient(),
+		Client:         mgr.GetClient(),
+		LabelKeys:      cfg.LabelKeys,
+		AnnotationKeys: cfg.AnnotationKeys,
 	}).SetupWithManager(mgr); err != nil {
 		return fmt.Errorf("unable to create SubNamespace controller: %w", err)
 	}

config/crd/bases/accurate.cybozu.com_subnamespaces.yaml

@@ -33,6 +33,21 @@ spec:
             type: string
           metadata:
             type: object
+          spec:
+            description: Spec is the spec of SubNamespace.
+            properties:
+              annotations:
+                additionalProperties:
+                  type: string
+                description: Annotations is the annotations for be propagated to the
+                  sub-namespace.
+                type: object
+              labels:
+                additionalProperties:
+                  type: string
+                description: Labels is the labels for be propagated to the sub-namespace.
+                type: object
+            type: object
           status:
             description: Status is the status of SubNamespace.
             enum:

controllers/namespace_controller.go

@@ -98,25 +98,11 @@ func (r *NamespaceReconciler) propagateMeta(ctx context.Context, ns, parent *cor
 }
 
 func (r *NamespaceReconciler) matchLabelKey(key string) bool {
-	for _, l := range r.LabelKeys {
-		// The glob pattern has been verified to be in the valid format when reading the config file.
-		if ok, _ := path.Match(l, key); ok {
-			return true
-		}
-	}
-
-	return false
+	return matchKey(key, r.LabelKeys)
 }
 
 func (r *NamespaceReconciler) matchAnnotationKey(key string) bool {
-	for _, a := range r.AnnotationKeys {
-		// The glob pattern has been verified to be in the valid format when reading the config file.
-		if ok, _ := path.Match(a, key); ok {
-			return true
-		}
-	}
-
-	return false
+	return matchKey(key, r.AnnotationKeys)
 }
 
 func (r *NamespaceReconciler) propagateResource(ctx context.Context, res *unstructured.Unstructured, parent, ns string) error {
@@ -345,3 +331,14 @@ func (r *NamespaceReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		For(&corev1.Namespace{}).
 		Complete(r)
 }
+
+func matchKey(key string, list []string) bool {
+	for _, l := range list {
+		// The glob pattern has been verified to be in the valid format when reading the config file.
+		if ok, _ := path.Match(l, key); ok {
+			return true
+		}
+	}
+
+	return false
+}

controllers/subnamespace_controller.go

@@ -23,6 +23,8 @@ import (
 // SubNamespaceReconciler reconciles a SubNamespace object
 type SubNamespaceReconciler struct {
 	client.Client
+	LabelKeys      []string
+	AnnotationKeys []string
 }
 
 //+kubebuilder:rbac:groups=accurate.cybozu.com,resources=subnamespaces,verbs=get;list;watch;create;update;patch;delete
@@ -113,6 +115,22 @@ func (r *SubNamespaceReconciler) reconcileNS(ctx context.Context, sn *accuratev1
 
 	if ns.Labels[constants.LabelParent] == sn.Namespace {
 		sn.Status = accuratev1.SubNamespaceOK
+		for k, v := range sn.Spec.Labels {
+			if ok := r.matchLabelKey(k); ok {
+				ns.Labels[k] = v
+			}
+		}
+		if ns.Annotations == nil {
+			ns.Annotations = make(map[string]string)
+		}
+		for k, v := range sn.Spec.Annotations {
+			if ok := r.matchAnnotationKey(k); ok {
+				ns.Annotations[k] = v
+			}
+		}
+		if err := r.Update(ctx, ns); err != nil {
+			return err
+		}
 	} else {
 		logger.Info("a conflicting namespace already exists")
 		sn.Status = accuratev1.SubNamespaceConflict
@@ -121,6 +139,14 @@ func (r *SubNamespaceReconciler) reconcileNS(ctx context.Context, sn *accuratev1
 	return r.Update(ctx, sn)
 }
 
+func (r *SubNamespaceReconciler) matchLabelKey(key string) bool {
+	return matchKey(key, r.LabelKeys)
+}
+
+func (r *SubNamespaceReconciler) matchAnnotationKey(key string) bool {
+	return matchKey(key, r.AnnotationKeys)
+}
+
 // SetupWithManager sets up the controller with the Manager.
 func (r *SubNamespaceReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	nsHandler := func(o client.Object, q workqueue.RateLimitingInterface) {

controllers/subnamespace_controller_test.go

@@ -29,7 +29,9 @@ var _ = Describe("SubNamespace controller", func() {
 		Expect(err).ToNot(HaveOccurred())
 
 		snr := &SubNamespaceReconciler{
-			Client: mgr.GetClient(),
+			Client:         mgr.GetClient(),
+			LabelKeys:      []string{"exists"},
+			AnnotationKeys: []string{"exists"},
 		}
 		err = snr.SetupWithManager(mgr)
 		Expect(err).ToNot(HaveOccurred())
@@ -60,6 +62,14 @@ var _ = Describe("SubNamespace controller", func() {
 		sn.Namespace = "test1"
 		sn.Name = "test1-sub1"
 		sn.Finalizers = []string{constants.Finalizer}
+		sn.Spec.Labels = map[string]string{
+			"exists":     "true",
+			"not-exists": "true",
+		}
+		sn.Spec.Annotations = map[string]string{
+			"exists":     "true",
+			"not-exists": "true",
+		}
 		err = k8sClient.Create(ctx, sn)
 		Expect(err).NotTo(HaveOccurred())
 
@@ -72,6 +82,11 @@ var _ = Describe("SubNamespace controller", func() {
 		Expect(sub1.Labels).To(HaveKeyWithValue(constants.LabelCreatedBy, "accurate"))
 		Expect(sub1.Labels).To(HaveKeyWithValue(constants.LabelParent, "test1"))
 
+		Expect(sub1.Labels).To(HaveKeyWithValue("exists", "true"))
+		Expect(sub1.Annotations).To(HaveKeyWithValue("exists", "true"))
+		Expect(sub1.Labels).NotTo(HaveKeyWithValue("not-exists", "true"))
+		Expect(sub1.Annotations).NotTo(HaveKeyWithValue("not-exists", "true"))
+
 		Eventually(func() accuratev1.SubNamespaceStatus {
 			sn = &accuratev1.SubNamespace{}
 			err = k8sClient.Get(ctx, client.ObjectKey{Namespace: "test1", Name: "test1-sub1"}, sn)

docs/crd_subnamespace.md

@@ -6,6 +6,7 @@
 ### Sub Resources
 
 * [SubNamespaceList](#subnamespacelist)
+* [SubNamespaceSpec](#subnamespacespec)
 
 #### SubNamespace
 
@@ -14,6 +15,7 @@ SubNamespace is the Schema for the subnamespaces API
 | Field | Description | Scheme | Required |
 | ----- | ----------- | ------ | -------- |
 | metadata |  | metav1.ObjectMeta | false |
+| spec | Spec is the spec of SubNamespace. | [SubNamespaceSpec](#subnamespacespec) | false |
 | status | Status is the status of SubNamespace. | SubNamespaceStatus | false |
 
 [Back to Custom Resources](#custom-resources)
@@ -28,3 +30,14 @@ SubNamespaceList contains a list of SubNamespace
 | items |  | [][SubNamespace](#subnamespace) | true |
 
 [Back to Custom Resources](#custom-resources)
+
+#### SubNamespaceSpec
+
+SubNamespaceSpec defines the desired state of SubNamespace
+
+| Field | Description | Scheme | Required |
+| ----- | ----------- | ------ | -------- |
+| labels | Labels is the labels for be propagated to the sub-namespace. | map[string]string | false |
+| annotations | Annotations is the annotations for be propagated to the sub-namespace. | map[string]string | false |
+
+[Back to Custom Resources](#custom-resources)