feat(helm): add Gateway API HTTPRoute support to the burrito-server (#927)

* feat(helm): add Gateway API HTTPRoute support to the burrito-server

* feat(helm): add Gateway API HTTPRoute for the burrito-controllers metrics endpoint

* fix(helm): reference named service port in HTTPRoute backendRef to match ingress

Author: somaz94

deploy/charts/burrito/README.md

@@ -52,6 +52,12 @@ A Helm chart for handling a complete burrito deployment
 | controllers.deployment.podAnnotations | object | `{"kubectl.kubernetes.io/default-container":"burrito"}` | Annotations to be added to the pods generated by the Burrito controller deployment |
 | controllers.deployment.readinessProbe | object | `{"httpGet":{"path":"/readyz","port":8081},"initialDelaySeconds":5,"periodSeconds":20}` | Controller readiness probe configuration |
 | controllers.metadata | object | `{"labels":{"app.kubernetes.io/component":"controllers","app.kubernetes.io/name":"burrito-controllers"}}` | Metadata configuration for the Burrito controller |
+| controllers.metricsHttproute.apiVersion | string | `"gateway.networking.k8s.io/v1"` | Gateway API version to use for the Burrito controller metrics HTTPRoute |
+| controllers.metricsHttproute.enabled | bool | `false` | Enable/Disable Gateway API HTTPRoute creation for the Burrito controller metrics endpoint (requires the Gateway API CRDs and controllers.service enabled) |
+| controllers.metricsHttproute.hostnames | list | `[]` | Hostnames the HTTPRoute matches. Defaults to the controller metrics ingress host when left empty |
+| controllers.metricsHttproute.metadata | object | `{"annotations":{},"labels":{}}` | Metadata configuration for the Burrito controller metrics HTTPRoute |
+| controllers.metricsHttproute.parentRefs | list | `[]` | Gateways the HTTPRoute attaches to (required when metricsHttproute is enabled). Each entry follows the Gateway API parentRef schema (name, optionally namespace/sectionName) |
+| controllers.metricsHttproute.rules | list | `[]` | HTTPRoute rules. Defaults to a single rule routing "/" (PathPrefix) to the burrito-controllers service when left empty |
 | controllers.service.enabled | bool | `false` | Enable/Disable service creation for the Burrito controller |
 | datastore.deployment.args | list | `["datastore","start"]` | Arguments to pass to the Burrito datastore container |
 | datastore.deployment.command | list | `["burrito"]` | Command to run in the Burrito datastore container |
@@ -116,6 +122,12 @@ A Helm chart for handling a complete burrito deployment
 | server.deployment.podAnnotations | object | `{"kubectl.kubernetes.io/default-container":"burrito"}` | Annotations to be added to the pods generated by the Burrito server deployment |
 | server.deployment.ports | list | `[{"containerPort":8080,"name":"http"}]` | Server exposed port |
 | server.deployment.readinessProbe | object | `{"httpGet":{"path":"/healthz","port":8080},"initialDelaySeconds":5,"periodSeconds":20}` | Server readiness probe configuration |
+| server.httproute.apiVersion | string | `"gateway.networking.k8s.io/v1"` | Gateway API version to use for the Burrito server HTTPRoute |
+| server.httproute.enabled | bool | `false` | Enable/Disable Gateway API HTTPRoute creation for the Burrito server (requires the Gateway API CRDs and server.service enabled) |
+| server.httproute.hostnames | list | `[]` | Hostnames the HTTPRoute matches. Defaults to the server ingress host when left empty |
+| server.httproute.metadata | object | `{"annotations":{},"labels":{}}` | Metadata configuration for the Burrito server HTTPRoute |
+| server.httproute.parentRefs | list | `[]` | Gateways the HTTPRoute attaches to (required when httproute is enabled). Each entry follows the Gateway API parentRef schema (name, optionally namespace/sectionName) |
+| server.httproute.rules | list | `[]` | HTTPRoute rules. Defaults to a single rule routing "/" (PathPrefix) to the burrito-server service when left empty |
 | server.ingress | object | `{"annotations":{},"enabled":false,"host":"burrito.example.com","ingressClassName":"nginx","tls":[]}` | Ingress configuration for the Burrito server |
 | server.ingress.annotations | object | `{}` | Annotations to be added to the Burrito server ingress |
 | server.ingress.enabled | bool | `false` | Enable/Disable ingress creation for the Burrito server |

deploy/charts/burrito/templates/controllers.yaml

@@ -190,6 +190,45 @@ spec:
   tls:
     {{- toYaml .metricsIngress.tls | nindent 4 }}
 {{- end }}
+{{- if .metricsHttproute.enabled }}
+{{- if not .metricsHttproute.parentRefs }}
+{{- fail "controllers.metricsHttproute.enabled is set but controllers.metricsHttproute.parentRefs is empty: at least one parentRef (Gateway) is required" }}
+{{- end }}
+---
+apiVersion: {{ .metricsHttproute.apiVersion | default "gateway.networking.k8s.io/v1" }}
+kind: HTTPRoute
+metadata:
+  name: burrito-controllers-metrics
+  {{- with mergeOverwrite (deepCopy .metadata) .metricsHttproute.metadata }}
+  labels:
+    {{- toYaml .labels | nindent 4}}
+  annotations:
+    {{- toYaml .annotations | nindent 4}}
+  {{- end }}
+spec:
+  parentRefs:
+    {{- toYaml .metricsHttproute.parentRefs | nindent 4 }}
+  {{- with .metricsHttproute.hostnames | default (list .metricsIngress.host) }}
+  hostnames:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  rules:
+    {{- with .metricsHttproute.rules }}
+    {{- toYaml . | nindent 4 }}
+    {{- else }}
+    - matches:
+        - path:
+            type: PathPrefix
+            value: /
+      backendRefs:
+        - name: burrito-controllers
+          {{- range .service.ports }}
+          {{- if eq .name "metrics" }}
+          port: {{ .port }}
+          {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}
 ---
 apiVersion: v1
 kind: ServiceAccount

deploy/charts/burrito/templates/server.yaml

@@ -167,6 +167,45 @@ spec:
   tls:
     {{- toYaml .ingress.tls | nindent 4 }}
 {{- end }}
+{{- if .httproute.enabled }}
+{{- if not .httproute.parentRefs }}
+{{- fail "server.httproute.enabled is set but server.httproute.parentRefs is empty: at least one parentRef (Gateway) is required" }}
+{{- end }}
+---
+apiVersion: {{ .httproute.apiVersion | default "gateway.networking.k8s.io/v1" }}
+kind: HTTPRoute
+metadata:
+  name: burrito-server
+  {{- with mergeOverwrite (deepCopy .metadata) .httproute.metadata }}
+  labels:
+    {{- toYaml .labels | nindent 4}}
+  annotations:
+    {{- toYaml .annotations | nindent 4}}
+  {{- end }}
+spec:
+  parentRefs:
+    {{- toYaml .httproute.parentRefs | nindent 4 }}
+  {{- with .httproute.hostnames | default (list .ingress.host) }}
+  hostnames:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  rules:
+    {{- with .httproute.rules }}
+    {{- toYaml . | nindent 4 }}
+    {{- else }}
+    - matches:
+        - path:
+            type: PathPrefix
+            value: /
+      backendRefs:
+        - name: burrito-server
+          {{- range .service.ports }}
+          {{- if eq .name "http" }}
+          port: {{ .port }}
+          {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}
 ---
 apiVersion: v1
 kind: ServiceAccount

deploy/charts/burrito/values.yaml

@@ -409,6 +409,24 @@ controllers:
     host: burrito-controllers.example.com
     # -- TLS configuration for the Burrito controller metrics ingress
     tls: []
+  metricsHttproute:
+    # -- Enable/Disable Gateway API HTTPRoute creation for the Burrito controller metrics endpoint (requires the Gateway API CRDs and controllers.service enabled)
+    enabled: false
+    # -- Metadata configuration for the Burrito controller metrics HTTPRoute
+    metadata:
+      labels: {}
+      annotations: {}
+    # -- Gateway API version to use for the Burrito controller metrics HTTPRoute
+    apiVersion: gateway.networking.k8s.io/v1
+    # -- Gateways the HTTPRoute attaches to (required when metricsHttproute is enabled). Each entry follows the Gateway API parentRef schema (name, optionally namespace/sectionName)
+    parentRefs: []
+    # - name: my-gateway
+    #   namespace: gateway-system
+    #   sectionName: https
+    # -- Hostnames the HTTPRoute matches. Defaults to the controller metrics ingress host when left empty
+    hostnames: []
+    # -- HTTPRoute rules. Defaults to a single rule routing "/" (PathPrefix) to the burrito-controllers service when left empty
+    rules: []
 
 server:
   # -- Metadata configuration for the Burrito server
@@ -498,6 +516,24 @@ server:
     host: burrito.example.com
     # -- TLS configuration for the Burrito server ingress
     tls: []
+  httproute:
+    # -- Enable/Disable Gateway API HTTPRoute creation for the Burrito server (requires the Gateway API CRDs and server.service enabled)
+    enabled: false
+    # -- Metadata configuration for the Burrito server HTTPRoute
+    metadata:
+      labels: {}
+      annotations: {}
+    # -- Gateway API version to use for the Burrito server HTTPRoute
+    apiVersion: gateway.networking.k8s.io/v1
+    # -- Gateways the HTTPRoute attaches to (required when httproute is enabled). Each entry follows the Gateway API parentRef schema (name, optionally namespace/sectionName)
+    parentRefs: []
+    # - name: my-gateway
+    #   namespace: gateway-system
+    #   sectionName: https
+    # -- Hostnames the HTTPRoute matches. Defaults to the server ingress host when left empty
+    hostnames: []
+    # -- HTTPRoute rules. Defaults to a single rule routing "/" (PathPrefix) to the burrito-server service when left empty
+    rules: []
 
 datastore:
   # -- Metadata configuration for the Burrito datastore