feat(http-add-on): add InterceptorRoute CRD and update RBAC permissions (#839)

Signed-off-by: Atharva Pakade <pakade310@gmail.com>

Author: AtharvaPakade

.github/workflows/ci-http-add-on.yml

@@ -143,6 +143,13 @@ jobs:
       - name: Get all CRDs
         run: kubectl get crds
 
+      - name: Get InterceptorRoute CRD
+        run: kubectl get crds/interceptorroutes.http.keda.sh
+
+      - name: Describe InterceptorRoute CRD
+        run: kubectl describe crds/interceptorroutes.http.keda.sh
+
+      # TODO: Drop `HTTPScaledObject` specific steps after crd is DEPRECATED
       - name: Get HTTPScaledObject CRD
         run: kubectl get crds/httpscaledobjects.http.keda.sh
 

http-add-on/README.md

@@ -85,7 +85,7 @@ their default values.
 | Parameter | Type | Default | Description |
 |-----------|------|---------|-------------|
 | `additionalLabels` | object | `{}` | Additional labels to be applied to installed resources. Note that not all resources will receive these labels. |
-| `crds.install` | bool | `true` | Whether to install the `HTTPScaledObject` [`CustomResourceDefinition`](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) |
+| `crds.install` | bool | `true` | Whether to install the `HTTPScaledObject` and `InterceptorRoute` [`CustomResourceDefinitions`](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) |
 | `images.interceptor` | string | `"ghcr.io/kedacore/http-add-on-interceptor"` | Image name for the interceptor image component |
 | `images.operator` | string | `"ghcr.io/kedacore/http-add-on-operator"` | Image name for the operator image component |
 | `images.scaler` | string | `"ghcr.io/kedacore/http-add-on-scaler"` | Image name for the scaler image component |

http-add-on/templates/crd.yaml

@@ -306,4 +306,290 @@ spec:
     storage: true
     subresources:
       status: {}
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.19.0
+  name: interceptorroutes.http.keda.sh
+spec:
+  group: http.keda.sh
+  names:
+    kind: InterceptorRoute
+    listKind: InterceptorRouteList
+    plural: interceptorroutes
+    singular: interceptorroute
+  scope: Namespaced
+  versions:
+  - additionalPrinterColumns:
+    - jsonPath: .spec.target.service
+      name: TargetService
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="Ready")].status
+      name: Ready
+      type: string
+    - jsonPath: .metadata.creationTimestamp
+      name: Age
+      type: date
+    name: v1beta1
+    schema:
+      openAPIV3Schema:
+        description: InterceptorRoute configures request routing and autoscaling for
+          a target service.
+        properties:
+          apiVersion:
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+            type: string
+          kind:
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: InterceptorRouteSpec defines the desired state of InterceptorRoute.
+            properties:
+              coldStart:
+                description: Cold start behavior when scaling from zero.
+                properties:
+                  fallback:
+                    description: |-
+                      Fallback service to route to when the target is scaling from zero
+                      and the wait timeout expires.
+                    properties:
+                      port:
+                        description: Port number on the Service. Mutually exclusive
+                          with portName.
+                        format: int32
+                        maximum: 65535
+                        minimum: 1
+                        type: integer
+                      portName:
+                        description: Named port on the Service. Mutually exclusive
+                          with port.
+                        minLength: 1
+                        type: string
+                      service:
+                        description: Name of the Kubernetes Service.
+                        minLength: 1
+                        type: string
+                    required:
+                    - service
+                    type: object
+                    x-kubernetes-validations:
+                    - message: exactly one of 'port' or 'portName' must be set
+                      rule: has(self.port) != has(self.portName)
+                required:
+                - fallback
+                type: object
+                x-kubernetes-validations:
+                - message: '''fallback'' must be set'
+                  rule: has(self.fallback)
+              rules:
+                description: Routing rules that define how requests are matched to
+                  this target.
+                items:
+                  description: RoutingRule defines a set of matching criteria for
+                    routing requests.
+                  properties:
+                    headers:
+                      description: |-
+                        All listed headers must match the request (AND semantics).
+                        If a header's Value is omitted, the header must be present but any
+                        value is accepted.
+                      items:
+                        description: HeaderMatch defines a header matching rule.
+                        properties:
+                          name:
+                            description: Name of the HTTP header.
+                            minLength: 1
+                            type: string
+                          value:
+                            description: Value to match against (exact match). If
+                              omitted, matches any value for given header name.
+                            type: string
+                        required:
+                        - name
+                        type: object
+                      type: array
+                      x-kubernetes-list-map-keys:
+                      - name
+                      x-kubernetes-list-type: map
+                    hosts:
+                      description: |-
+                        Match any of these hostnames. Wildcard patterns (e.g. "*.example.com")
+                        are supported. A single "*" acts as a catch-all. Exact matches take
+                        priority over wildcards; more specific wildcards (e.g. "*.bar.example.com")
+                        take priority over less specific ones.
+                      items:
+                        type: string
+                      type: array
+                      x-kubernetes-list-type: set
+                    paths:
+                      description: |-
+                        Match any of these path prefixes. When multiple paths match,
+                        the longest prefix wins.
+                      items:
+                        description: PathMatch defines a path matching rule.
+                        properties:
+                          value:
+                            description: Path prefix to match against. The longest
+                              matching prefix wins.
+                            minLength: 1
+                            type: string
+                        required:
+                        - value
+                        type: object
+                      type: array
+                      x-kubernetes-list-type: atomic
+                  type: object
+                type: array
+                x-kubernetes-list-type: atomic
+              scalingMetric:
+                description: Metric configuration for autoscaling.
+                properties:
+                  concurrency:
+                    description: Scale based on concurrent request count.
+                    properties:
+                      targetValue:
+                        default: 100
+                        description: Target concurrent request count per replica.
+                        format: int32
+                        minimum: 1
+                        type: integer
+                    type: object
+                  requestRate:
+                    description: Scale based on request rate.
+                    properties:
+                      granularity:
+                        default: 1s
+                        description: Bucket size for rate calculation within the window.
+                        type: string
+                      targetValue:
+                        default: 100
+                        description: Target request rate per replica.
+                        format: int32
+                        minimum: 1
+                        type: integer
+                      window:
+                        default: 1m
+                        description: Sliding time window over which the request rate
+                          is calculated.
+                        type: string
+                    type: object
+                type: object
+                x-kubernetes-validations:
+                - message: at least one of 'concurrency' or 'requestRate' must be
+                    set
+                  rule: has(self.concurrency) || has(self.requestRate)
+              target:
+                description: Backend service to route traffic to.
+                properties:
+                  port:
+                    description: Port number on the Service. Mutually exclusive with
+                      portName.
+                    format: int32
+                    maximum: 65535
+                    minimum: 1
+                    type: integer
+                  portName:
+                    description: Named port on the Service. Mutually exclusive with
+                      port.
+                    minLength: 1
+                    type: string
+                  service:
+                    description: Name of the Kubernetes Service.
+                    minLength: 1
+                    type: string
+                required:
+                - service
+                type: object
+                x-kubernetes-validations:
+                - message: exactly one of 'port' or 'portName' must be set
+                  rule: has(self.port) != has(self.portName)
+            required:
+            - scalingMetric
+            - target
+            type: object
+          status:
+            description: InterceptorRouteStatus defines the observed state of InterceptorRoute.
+            properties:
+              conditions:
+                description: Conditions of the InterceptorRoute.
+                items:
+                  description: Condition contains details for one aspect of the current
+                    state of this API Resource.
+                  properties:
+                    lastTransitionTime:
+                      description: |-
+                        lastTransitionTime is the last time the condition transitioned from one status to another.
+                        This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
+                      format: date-time
+                      type: string
+                    message:
+                      description: |-
+                        message is a human readable message indicating details about the transition.
+                        This may be an empty string.
+                      maxLength: 32768
+                      type: string
+                    observedGeneration:
+                      description: |-
+                        observedGeneration represents the .metadata.generation that the condition was set based upon.
+                        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+                        with respect to the current state of the instance.
+                      format: int64
+                      minimum: 0
+                      type: integer
+                    reason:
+                      description: |-
+                        reason contains a programmatic identifier indicating the reason for the condition's last transition.
+                        Producers of specific condition types may define expected values and meanings for this field,
+                        and whether the values are considered a guaranteed API.
+                        The value should be a CamelCase string.
+                        This field may not be empty.
+                      maxLength: 1024
+                      minLength: 1
+                      pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+                      type: string
+                    status:
+                      description: status of the condition, one of True, False, Unknown.
+                      enum:
+                      - "True"
+                      - "False"
+                      - Unknown
+                      type: string
+                    type:
+                      description: type of condition in CamelCase or in foo.example.com/CamelCase.
+                      maxLength: 316
+                      pattern: ^([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_.]*)?[A-Za-z0-9])$
+                      type: string
+                  required:
+                  - lastTransitionTime
+                  - message
+                  - reason
+                  - status
+                  - type
+                  type: object
+                type: array
+                x-kubernetes-list-map-keys:
+                - type
+                x-kubernetes-list-type: map
+            type: object
+        required:
+        - metadata
+        - spec
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}
 {{ end }}

http-add-on/templates/interceptor/rbac.yml

@@ -27,6 +27,7 @@ rules:
   - http.keda.sh
   resources:
   - httpscaledobjects
+  - interceptorroutes
   verbs:
   - get
   - list

http-add-on/templates/operator/rbac.yml

@@ -46,6 +46,7 @@ rules:
   - http.keda.sh
   resources:
   - httpscaledobjects
+  - interceptorroutes
   verbs:
   - create
   - delete
@@ -58,12 +59,14 @@ rules:
   - http.keda.sh
   resources:
   - httpscaledobjects/finalizers
+  - interceptorroutes/finalizers
   verbs:
   - update
 - apiGroups:
   - http.keda.sh
   resources:
   - httpscaledobjects/status
+  - interceptorroutes/status
   verbs:
   - get
   - patch

http-add-on/templates/rbac-aggregateclusterroles.yaml

@@ -14,6 +14,7 @@ rules:
   - http.keda.sh
   resources:
   - httpscaledobjects
+  - interceptorroutes
   verbs:
   - create
   - delete
@@ -38,6 +39,7 @@ rules:
   - http.keda.sh
   resources:
   - httpscaledobjects
+  - interceptorroutes
   verbs:
   - get
   - list

http-add-on/templates/scaler/rbac.yml

@@ -19,6 +19,7 @@ rules:
   - http.keda.sh
   resources:
   - httpscaledobjects
+  - interceptorroutes
   verbs:
   - get
   - list

http-add-on/values.yaml

@@ -2,7 +2,7 @@
 additionalLabels: {}
 
 crds:
-  # -- Whether to install the `HTTPScaledObject` [`CustomResourceDefinition`](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
+  # -- Whether to install the `HTTPScaledObject` and `InterceptorRoute` [`CustomResourceDefinitions`](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
   install: true
 
 logging: