Add label and annotation support for ResourceClaims (#111)

Author: jkupferer

helm/crds/resourceproviders.yaml

@@ -236,6 +236,18 @@ spec:
                             fields to specific numeric ranges.
                           type: object
                           x-kubernetes-preserve-unknown-fields: true
+              resourceClaimAnnotations:
+                description: >-
+                  Annotations to apply to ResourceClaim.
+                type: object
+                additionalProperties:
+                  type: string
+              resourceClaimLabels:
+                description: >-
+                  Labels to apply to ResourceClaim.
+                type: object
+                additionalProperties:
+                  type: string
               resourceName:
                 description: >-
                   Name to apply to resource list entry when resources list is generated.

helm/templates/crds/resourceproviders.yaml

@@ -237,6 +237,18 @@ spec:
                             fields to specific numeric ranges.
                           type: object
                           x-kubernetes-preserve-unknown-fields: true
+              resourceClaimAnnotations:
+                description: >-
+                  Annotations to apply to ResourceClaim.
+                type: object
+                additionalProperties:
+                  type: string
+              resourceClaimLabels:
+                description: >-
+                  Labels to apply to ResourceClaim.
+                type: object
+                additionalProperties:
+                  type: string
               resourceName:
                 description: >-
                   Name to apply to resource list entry when resources list is generated.

operator/resourceclaim.py

@@ -725,6 +725,18 @@ async def manage(self, logger) -> None:
                     else:
                         raise
 
+                metadata_patch = {}
+                for key, value in resource_provider.resource_claim_annotations.items():
+                    if self.annotations.get(key) != value:
+                        metadata_patch.setdefault('annotations', {})[key] = value
+                for key, value in resource_provider.resource_claim_labels.items():
+                    if self.labels.get(key) != value:
+                        metadata_patch.setdefault('labels', {})[key] = value
+                if metadata_patch:
+                    await self.merge_patch({
+                        "metadata": metadata_patch,
+                    })
+
                 if resource_provider.approval_required:
                     if not 'approval' in self.status:
                         await self.merge_patch_status({

operator/resourceprovider.py

@@ -269,6 +269,14 @@ def parameter_defaults(self) -> Mapping:
             if parameter.default_value != None
         }
 
+    @property
+    def resource_claim_annotations(self) -> Mapping:
+        return self.spec.get('resourceClaimAnnotations', {})
+
+    @property
+    def resource_claim_labels(self) -> Mapping:
+        return self.spec.get('resourceClaimLabels', {})
+
     @property
     def resource_name(self):
         return self.spec.get('resourceName', self.name)

test/roles/poolboy_test_simple/tasks/test-parameters-01.yaml

@@ -44,6 +44,10 @@
               type: integer
               default: 0
               minimum: 0
+        resourceClaimAnnotations:
+          test-annotation: test-annotation-value
+        resourceClaimLabels:
+          test-label: test-label-value
         template:
           definition:
             spec:
@@ -100,6 +104,8 @@
   assert:
     that:
     - __state.status.resources[0].state.metadata.name == resource_claim_test_parameters_01_a_resource_name
+    - __state.metadata.annotations['test-annotation'] == 'test-annotation-value'
+    - __state.metadata.labels['test-label'] == 'test-label-value'
 
 - name: Verify creation of ResourceClaimTest test-parameters-01-a
   kubernetes.core.k8s_info: