CONSOLE-5163: Add labels field to Ingress componentRoutes

config/v1/tests/ingresses.config.openshift.io/AAA_ungated.yaml

@@ -23,6 +23,129 @@ tests:
         kind: Ingress
         spec:
           domain: apps.example.com
+    - name: Should be able to create an Ingress with componentRoutes containing labels
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                ingress: shard-console
+      expected: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                ingress: shard-console
+    - name: Should be able to create an Ingress with multiple componentRoutes with labels
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console-2
+              namespace: openshift-console
+              hostname: console.internal.corp.example.com
+              labels:
+                ingress: shard-console2
+            - name: console-3
+              namespace: openshift-console
+              hostname: console.private.corp.example.com
+              labels:
+                ingress: shard-console3
+      expected: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console-2
+              namespace: openshift-console
+              hostname: console.internal.corp.example.com
+              labels:
+                ingress: shard-console2
+            - name: console-3
+              namespace: openshift-console
+              hostname: console.private.corp.example.com
+              labels:
+                ingress: shard-console3
+    - name: Should be able to create componentRoutes with empty labels map
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels: {}
+      expected: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+    - name: Should reject componentRoutes with invalid label key
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                "!!!bad": value
+      expectedError: "label keys must be valid Kubernetes label keys"
+    - name: Should reject componentRoutes with invalid label value
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                ingress: "invalid value with spaces!"
+      expectedError: "label values must be valid Kubernetes label values"
+    - name: Should reject componentRoutes with more than 8 labels
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                label1: value1
+                label2: value2
+                label3: value3
+                label4: value4
+                label5: value5
+                label6: value6
+                label7: value7
+                label8: value8
+                label9: value9
+      expectedError: "Too many properties"
   onUpdate:
     - name: Should not be able to change domain once set
       initial: |
@@ -54,3 +177,35 @@ tests:
         spec:
           domain: apps.example.com
           appsDomain: custom.example.com
+    - name: Should be able to add labels to componentRoutes on update
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+      updated: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                ingress: shard-console
+      expected: |
+        apiVersion: config.openshift.io/v1
+        kind: Ingress
+        spec:
+          domain: apps.example.com
+          componentRoutes:
+            - name: console
+              namespace: openshift-console
+              hostname: console.example.com
+              labels:
+                ingress: shard-console

config/v1/types_ingress.go

@@ -245,6 +245,20 @@ type ComponentRouteSpec struct {
 	// the Secret specification for a serving certificate will not be needed.
 	// +optional
 	ServingCertKeyPairSecret SecretNameReference `json:"servingCertKeyPairSecret"`
+
+	// labels defines additional labels to be applied to the route created
+	// for the component. These labels are used by the IngressController to
+	// determine which routes it should manage.
+	// Label keys and values must conform to Kubernetes label conventions:
+	// keys must be 1-63 characters (with optional prefix up to 253 characters),
+	// and values must be 0-63 characters, consisting of alphanumeric characters,
+	// '-', '_', or '.', and must start and end with an alphanumeric character.
+	// +optional
+	// +mapType=granular
+	// +kubebuilder:validation:MaxProperties=8
+	// +kubebuilder:validation:XValidation:rule="self.all(key, key.matches('^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*[/])?([A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?)$'))",message="label keys must be valid Kubernetes label keys"
+	// +kubebuilder:validation:XValidation:rule="self.all(key, self[key].matches('^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$'))",message="label values must be valid Kubernetes label values (at most 63 characters, alphanumeric, '-', '_', or '.', must start and end with alphanumeric)"
+	Labels map[string]string `json:"labels,omitempty"`
 }
 
 // ComponentRouteStatus contains information allowing configuration of a route's hostname and serving certificate.

config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_ingresses.crd.yaml

@@ -75,6 +75,27 @@ spec:
                         the route.
                       pattern: ^([a-zA-Z0-9\p{S}\p{L}]((-?[a-zA-Z0-9\p{S}\p{L}]{0,62})?)|([a-zA-Z0-9\p{S}\p{L}](([a-zA-Z0-9-\p{S}\p{L}]{0,61}[a-zA-Z0-9\p{S}\p{L}])?)(\.)){1,}([a-zA-Z\p{L}]){2,63})$|^(([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})[\.]){0,}([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})$
                       type: string
+                    labels:
+                      additionalProperties:
+                        type: string
+                      description: |-
+                        labels defines additional labels to be applied to the route created
+                        for the component. These labels are used by the IngressController to
+                        determine which routes it should manage.
+                        Label keys and values must conform to Kubernetes label conventions:
+                        keys must be 1-63 characters (with optional prefix up to 253 characters),
+                        and values must be 0-63 characters, consisting of alphanumeric characters,
+                        '-', '_', or '.', and must start and end with an alphanumeric character.
+                      maxProperties: 8
+                      type: object
+                      x-kubernetes-map-type: granular
+                      x-kubernetes-validations:
+                      - message: label keys must be valid Kubernetes label keys
+                        rule: self.all(key, key.matches('^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*[/])?([A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?)$'))
+                      - message: label values must be valid Kubernetes label values
+                          (at most 63 characters, alphanumeric, '-', '_', or '.',
+                          must start and end with alphanumeric)
+                        rule: self.all(key, self[key].matches('^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$'))
                     name:
                       description: |-
                         name is the logical name of the route to customize.

config/v1/zz_generated.featuregated-crd-manifests/ingresses.config.openshift.io/AAA_ungated.yaml

@@ -76,6 +76,27 @@ spec:
                         the route.
                       pattern: ^([a-zA-Z0-9\p{S}\p{L}]((-?[a-zA-Z0-9\p{S}\p{L}]{0,62})?)|([a-zA-Z0-9\p{S}\p{L}](([a-zA-Z0-9-\p{S}\p{L}]{0,61}[a-zA-Z0-9\p{S}\p{L}])?)(\.)){1,}([a-zA-Z\p{L}]){2,63})$|^(([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})[\.]){0,}([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})$
                       type: string
+                    labels:
+                      additionalProperties:
+                        type: string
+                      description: |-
+                        labels defines additional labels to be applied to the route created
+                        for the component. These labels are used by the IngressController to
+                        determine which routes it should manage.
+                        Label keys and values must conform to Kubernetes label conventions:
+                        keys must be 1-63 characters (with optional prefix up to 253 characters),
+                        and values must be 0-63 characters, consisting of alphanumeric characters,
+                        '-', '_', or '.', and must start and end with an alphanumeric character.
+                      maxProperties: 8
+                      type: object
+                      x-kubernetes-map-type: granular
+                      x-kubernetes-validations:
+                      - message: label keys must be valid Kubernetes label keys
+                        rule: self.all(key, key.matches('^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*[/])?([A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?)$'))
+                      - message: label values must be valid Kubernetes label values
+                          (at most 63 characters, alphanumeric, '-', '_', or '.',
+                          must start and end with alphanumeric)
+                        rule: self.all(key, self[key].matches('^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$'))
                     name:
                       description: |-
                         name is the logical name of the route to customize.

payload-manifests/crds/0000_10_config-operator_01_ingresses.crd.yaml

@@ -75,6 +75,27 @@ spec:
                         the route.
                       pattern: ^([a-zA-Z0-9\p{S}\p{L}]((-?[a-zA-Z0-9\p{S}\p{L}]{0,62})?)|([a-zA-Z0-9\p{S}\p{L}](([a-zA-Z0-9-\p{S}\p{L}]{0,61}[a-zA-Z0-9\p{S}\p{L}])?)(\.)){1,}([a-zA-Z\p{L}]){2,63})$|^(([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})[\.]){0,}([a-z0-9][-a-z0-9]{0,61}[a-z0-9]|[a-z0-9]{1,63})$
                       type: string
+                    labels:
+                      additionalProperties:
+                        type: string
+                      description: |-
+                        labels defines additional labels to be applied to the route created
+                        for the component. These labels are used by the IngressController to
+                        determine which routes it should manage.
+                        Label keys and values must conform to Kubernetes label conventions:
+                        keys must be 1-63 characters (with optional prefix up to 253 characters),
+                        and values must be 0-63 characters, consisting of alphanumeric characters,
+                        '-', '_', or '.', and must start and end with an alphanumeric character.
+                      maxProperties: 8
+                      type: object
+                      x-kubernetes-map-type: granular
+                      x-kubernetes-validations:
+                      - message: label keys must be valid Kubernetes label keys
+                        rule: self.all(key, key.matches('^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*[/])?([A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?)$'))
+                      - message: label values must be valid Kubernetes label values
+                          (at most 63 characters, alphanumeric, '-', '_', or '.',
+                          must start and end with alphanumeric)
+                        rule: self.all(key, self[key].matches('^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$'))
                     name:
                       description: |-
                         name is the logical name of the route to customize.