support path based routing

olamilekan000 · olamilekan000 · commit 4b06a69ca880 · 2026-04-02T22:06:10.000+01:00
diff --git a/README.md.gotmpl b/README.md.gotmpl
@@ -39,7 +39,6 @@ helm install convoy convoy/convoy --values values.yaml
 ```bash
 helm install convoy .
 ```
-
 {{ template "chart.valuesSection" . }}
 
 {{- if not .SkipVersionFooter }}
diff --git a/charts/agent/templates/_helpers.tpl b/charts/agent/templates/_helpers.tpl
@@ -11,8 +11,8 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 If release name contains chart name it will be used as a full name.
 */}}
 {{- define "convoy-agent.fullname" -}}
-{{- if .Values.fullnameOverride }}
-{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- if or .Values.fullNameOverride .Values.fullnameOverride }}
+{{- coalesce .Values.fullNameOverride .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
 {{- $name := default .Chart.Name .Values.nameOverride }}
 {{- if contains $name .Release.Name }}
diff --git a/charts/agent/templates/deployment.yaml b/charts/agent/templates/deployment.yaml
@@ -91,11 +91,13 @@ spec:
             - name: HTTP_PROXY
               value: {{ .Values.env.proxy | quote }}
             - name: CONVOY_LOGGER_LEVEL
-              value: {{ .Values.env.log_level | quote }}
+              value: {{ coalesce .Values.env.log_level .Values.global.convoy.log_level "error" | quote }}
             - name: CONVOY_ENV
               value: {{ .Values.env.environment | quote }}
             - name: CONVOY_SIGNUP_ENABLED
               value: {{ .Values.env.sign_up_enabled | quote }}
+            - name: CONVOY_ROOT_PATH
+              value: {{ .Values.env.root_path | quote }}
             {{- if or .Values.global.convoy.cacert_secret_name .Values.global.convoy.cacert_content }}
             - name: CONVOY_DISPATCHER_CACERT_PATH
               value: "/etc/convoy/ca.crt"
diff --git a/charts/agent/templates/ingress.yaml b/charts/agent/templates/ingress.yaml
@@ -0,0 +1,47 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "convoy-agent.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else -}}
+apiVersion: apiextensions.k8s.io/v1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "convoy-agent.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- with .Values.ingress.ingressClassName }}
+  ingressClassName: {{ . | quote }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .http.paths }}
+          - path: {{ .path }}
+            pathType: {{ .pathType }}
+            backend:
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+          {{- end }}
+    {{- end }}
+{{- end }}
diff --git a/charts/agent/templates/rollout.yaml b/charts/agent/templates/rollout.yaml
@@ -93,11 +93,13 @@ spec:
             - name: HTTP_PROXY
               value: {{ .Values.env.proxy | quote }}
             - name: CONVOY_LOGGER_LEVEL
-              value: {{ .Values.env.log_level | quote }}
+              value: {{ coalesce .Values.env.log_level .Values.global.convoy.log_level "error" | quote }}
             - name: CONVOY_ENV
               value: {{ .Values.env.environment | quote }}
             - name: CONVOY_SIGNUP_ENABLED
               value: {{ .Values.env.sign_up_enabled | quote }}
+            - name: CONVOY_ROOT_PATH
+              value: {{ .Values.env.root_path | quote }}
             {{- if or .Values.global.convoy.cacert_secret_name .Values.global.convoy.cacert_content }}
             - name: CONVOY_DISPATCHER_CACERT_PATH
               value: "/etc/convoy/ca.crt"
diff --git a/charts/agent/values.yaml b/charts/agent/values.yaml
@@ -72,6 +72,8 @@ env:
   proxy: ""
   sign_up_enabled: false
   log_level: "error"
+  # -- Base path when exposed behind a path-prefix (e.g. Ingress path /agent). Sets CONVOY_ROOT_PATH. Use "" when each service has its own hostname.
+  root_path: ""
   auth:
     file:
       basic: []
@@ -167,6 +169,18 @@ rollout:
   enabled: false
   strategy: {}
 
+ingress:
+  enabled: false
+  annotations: {}
+  ingressClassName: ""
+  tls: []
+  hosts:
+    - host: agent.example.com
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+
 autoscaling:
   enabled: true
   minReplicas: 2
diff --git a/charts/server/templates/_helpers.tpl b/charts/server/templates/_helpers.tpl
@@ -11,8 +11,8 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 If release name contains chart name it will be used as a full name.
 */}}
 {{- define "convoy-server.fullname" -}}
-{{- if .Values.fullnameOverride }}
-{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- if or .Values.fullNameOverride .Values.fullnameOverride }}
+{{- coalesce .Values.fullNameOverride .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
 {{- $name := default .Chart.Name .Values.nameOverride }}
 {{- if contains $name .Release.Name }}
diff --git a/charts/server/templates/deployment.yaml b/charts/server/templates/deployment.yaml
@@ -98,7 +98,7 @@ spec:
             - name: CONVOY_ROOT_PATH
               value: {{ .Values.env.root_path | quote }}              
             - name: CONVOY_LOGGER_LEVEL
-              value: {{ .Values.env.log_level | quote }}
+              value: {{ coalesce .Values.env.log_level .Values.global.convoy.log_level "error" | quote }}
             - name: CONVOY_SIGNUP_ENABLED
               value: {{ .Values.env.sign_up_enabled | quote }}
             - name: CONVOY_MAX_RESPONSE_SIZE
diff --git a/charts/server/templates/ingress.yaml b/charts/server/templates/ingress.yaml
@@ -16,7 +16,9 @@ metadata:
     {{- toYaml . | nindent 4 }}
   {{- end }}
 spec:
-  ingressClassName: {{ .Values.ingress.ingressClassName }}
+  {{- with .Values.ingress.ingressClassName }}
+  ingressClassName: {{ . | quote }}
+  {{- end }}
   {{- if .Values.ingress.tls }}
   tls:
     {{- range .Values.ingress.tls }}
@@ -42,4 +44,4 @@ spec:
                   number: {{ $svcPort }}
           {{- end }}
     {{- end }}
-  {{- end }}
+{{- end }}
diff --git a/charts/server/templates/rollout.yaml b/charts/server/templates/rollout.yaml
@@ -100,7 +100,7 @@ spec:
             - name: CONVOY_ROOT_PATH
               value: {{ .Values.env.root_path | quote }}              
             - name: CONVOY_LOGGER_LEVEL
-              value: {{ .Values.env.log_level | quote }}
+              value: {{ coalesce .Values.env.log_level .Values.global.convoy.log_level "error" | quote }}
             - name: CONVOY_SIGNUP_ENABLED
               value: {{ .Values.env.sign_up_enabled | quote }}
             - name: CONVOY_MAX_RESPONSE_SIZE
diff --git a/templates/_helpers.tpl b/templates/_helpers.tpl
@@ -0,0 +1,6 @@
+{{- define "convoy.labels" -}}
+helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+app.kubernetes.io/name: {{ .Chart.Name }}
+{{- end }}
diff --git a/templates/unified-ingress.yaml b/templates/unified-ingress.yaml
@@ -0,0 +1,93 @@
+{{- if .Values.unifiedIngress.enabled }}
+{{- if not (and .Values.server.enabled .Values.agent.enabled) }}
+{{- fail "unifiedIngress.enabled requires both server.enabled and agent.enabled" }}
+{{- end }}
+{{- if .Values.server.ingress.enabled }}
+{{- fail "Set server.ingress.enabled to false when using unifiedIngress (one Ingress routes to both services)" }}
+{{- end }}
+{{- if .Values.agent.ingress.enabled }}
+{{- fail "Set agent.ingress.enabled to false when using unifiedIngress (one Ingress routes to both services)" }}
+{{- end }}
+{{- if .Values.server.gateway.enabled }}
+{{- fail "Set server.gateway.enabled to false when using unifiedIngress" }}
+{{- end }}
+{{- $serverSvc := coalesce .Values.unifiedIngress.serverServiceName .Values.server.fullNameOverride }}
+{{- $agentSvc := coalesce .Values.unifiedIngress.agentServiceName .Values.agent.fullNameOverride }}
+{{- if not $serverSvc }}
+{{- fail "unifiedIngress: set unifiedIngress.serverServiceName or server.fullNameOverride so the server Service name is known" }}
+{{- end }}
+{{- if not $agentSvc }}
+{{- fail "unifiedIngress: set unifiedIngress.agentServiceName or agent.fullNameOverride so the agent Service name is known" }}
+{{- end }}
+{{- $serverPort := .Values.unifiedIngress.server.servicePort | default .Values.server.service.port }}
+{{- $agentPort := .Values.unifiedIngress.agent.servicePort | default .Values.agent.service.port }}
+{{- $mode := .Values.unifiedIngress.mode | default "prefix" }}
+{{- if and (ne $mode "prefix") (ne $mode "split") }}
+{{- fail "unifiedIngress.mode must be prefix or split" }}
+{{- end }}
+{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion }}
+apiVersion: networking.k8s.io/v1
+{{- else }}
+apiVersion: apiextensions.k8s.io/v1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ .Release.Name }}-unified
+  labels:
+    {{- include "convoy.labels" . | nindent 4 }}
+  {{- with .Values.unifiedIngress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- with .Values.unifiedIngress.ingressClassName }}
+  ingressClassName: {{ . | quote }}
+  {{- end }}
+  {{- if .Values.unifiedIngress.tls }}
+  tls:
+    {{- range .Values.unifiedIngress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    - host: {{ .Values.unifiedIngress.host | quote }}
+      http:
+        paths:
+{{- if eq $mode "split" }}
+{{- range .Values.unifiedIngress.split.agentPaths }}
+          - path: {{ .path }}
+            pathType: {{ .pathType }}
+            backend:
+              service:
+                name: {{ $agentSvc }}
+                port:
+                  number: {{ $agentPort }}
+{{- end }}
+          - path: {{ .Values.unifiedIngress.split.serverPath.path }}
+            pathType: {{ .Values.unifiedIngress.split.serverPath.pathType }}
+            backend:
+              service:
+                name: {{ $serverSvc }}
+                port:
+                  number: {{ $serverPort }}
+{{- else }}
+          - path: {{ .Values.unifiedIngress.server.path }}
+            pathType: {{ .Values.unifiedIngress.server.pathType }}
+            backend:
+              service:
+                name: {{ $serverSvc }}
+                port:
+                  number: {{ $serverPort }}
+          - path: {{ .Values.unifiedIngress.agent.path }}
+            pathType: {{ .Values.unifiedIngress.agent.pathType }}
+            backend:
+              service:
+                name: {{ $agentSvc }}
+                port:
+                  number: {{ $agentPort }}
+{{- end }}
+{{- end }}
diff --git a/values.yaml b/values.yaml
