Skip to main content

Helm Chart Deployment

GoRoute AI Gateway ships an official Kubernetes Helm chart (goroute, chart version 0.3.0, app version 1.8.0) under deployments/helm/goroute/ and as a packaged .tgz archive on the GitHub Releases page.

For raw manifests without Helm, see Kubernetes & Kustomize Deployment.


1. Chart Overview & Optional Dependencies​

Chart.yaml defines apiVersion: v2 (type: application) with two optional Bitnami subchart dependencies:

DependencyVersion ConstraintCondition KeyDefault
postgresql16.x.x (https://charts.bitnami.com/bitnami)postgresql.enabledfalse
redis20.x.x (https://charts.bitnami.com/bitnami)redis.enabledfalse

In production, keep postgresql.enabled: false and redis.enabled: false when pointing to managed PostgreSQL 16+ and Redis 7 / Cluster / Sentinel services. For single-cluster evaluations, enable both subcharts via --set postgresql.enabled=true --set redis.enabled=true after updating dependencies.


2. Quick Install & Upgrade​

Install from Local Chart or Release Archive​

# Option A: Install directly from a release .tgz archive
helm upgrade --install goroute ./goroute-0.3.0.tgz \
--namespace goroute-prod --create-namespace \
--set secrets.existingSecret="goroute-prod-secrets" \
--set migration.enabled=true

# Option B: Install from the cloned repository
helm dependency update deployments/helm/goroute
helm upgrade --install goroute deployments/helm/goroute \
--namespace goroute-prod --create-namespace \
-f prod-values.yaml

[!WARNING] Default values in values.yaml include placeholder secrets (changeme-master-admin-key, sample postgresDSN, and sample masterEncryptionKey). Always set secrets.existingSecret (recommended) or override every secrets.* value via an external secret manager before deploying to production.


3. Production Security, Scaling & Networking Templates​

TemplateKind / APIDefault Behavior
templates/deployment.yamlapps/v1 DeploymentNon-root podSecurityContext (runAsNonRoot: true, UID/GID/fsGroup 65532), readOnlyRootFilesystem: true, allowPrivilegeEscalation: false, capabilities.drop: ["ALL"], writable /tmp emptyDir, /healthz & /readyz probes, terminationGracePeriodSeconds: 30.
templates/service.yamlv1 ServiceClusterIP on port 8080 (http). Exposes grpc port on both Service and Deployment when service.grpcPort > 0.
templates/hpa.yamlautoscaling/v2 HorizontalPodAutoscalerEnabled by default (minReplicas: 2, maxReplicas: 10, CPU 75%, Memory 80%). When enabled, static replicaCount is omitted from Deployment.
templates/pdb.yamlpolicy/v1 PodDisruptionBudgetEnabled by default (minAvailable: 1; also supports maxUnavailable when minAvailable is removed).
templates/networkpolicy.yamlnetworking.k8s.io/v1 NetworkPolicyEnabled by default; restricts ingress to service.port (and service.grpcPort when > 0, optionally scoped via networkPolicy.ingressFrom) and egress to DNS (53 UDP/TCP), PostgreSQL (5432), Redis (6379), and HTTPS (443).
templates/ingress.yamlnetworking.k8s.io/v1 IngressDisabled by default (ingress.enabled: false); supports className, annotations, hosts, and tls.
templates/migration-job.yamlbatch/v1 JobDisabled by default (migration.enabled: false). Runs as a pre-install,pre-upgrade Helm hook (hook-weight: "-5") executing /app/ai-gateway -config /app/configs/config.yaml -migrate-only.
templates/secret.yamlv1 SecretCreated only when secrets.create: true and secrets.existingSecret is empty. Injects GATEWAY_POSTGRES_DSN, GATEWAY_MASTER_ADMIN_KEY, GATEWAY_MASTER_ENCRYPTION_KEY, and optional GATEWAY_JWT_SECRET / GATEWAY_REDIS_PASSWORD.

4. values.yaml Reference​

KeyDefaultDescription
replicaCount2Static pod count (used only when autoscaling.enabled: false).
image.repositoryghcr.io/goroute-ai/ai-gateway-goContainer image repository.
image.tag""Overrides Chart.AppVersion (1.8.0) when non-empty.
image.pullPolicyIfNotPresentKubernetes image pull policy.
service.typeClusterIPKubernetes Service type.
service.port8080HTTP data plane, /admin/v1, /ui/, and /metrics port.
service.grpcPort0Optional A2A gRPC port (0 disables gRPC Service/container port).
ingress.enabledfalseEnables the Ingress manifest.
envGATEWAY_PORT: "8080", GATEWAY_ENV: "production", GATEWAY_STORAGE_MODE: "postgres", GATEWAY_REDIS_ADDR: "redis:6379"Non-secret environment variables injected into the gateway and migration job pods.
secrets.createtrueCreates the Kubernetes Secret when secrets.existingSecret is empty.
secrets.existingSecret""Name of a pre-existing Secret containing GATEWAY_POSTGRES_DSN, GATEWAY_MASTER_ADMIN_KEY, GATEWAY_MASTER_ENCRYPTION_KEY, etc.
resourcesrequests: 100m / 128Mi, limits: 1000m / 512MiGateway pod CPU and memory requests/limits.
livenessProbeGET /healthz (:8080, initialDelaySeconds: 5, periodSeconds: 10)Container liveness probe configuration.
readinessProbeGET /readyz (:8080, initialDelaySeconds: 3, periodSeconds: 5)Container readiness probe checking PostgreSQL and Redis connectivity.
autoscaling.enabledtrueEnables HPA (minReplicas: 2, maxReplicas: 10, CPU 75%, Mem 80%).
podDisruptionBudget.enabledtrueEnables PDB (minAvailable: 1).
networkPolicy.enabledtrueEnables Pod NetworkPolicy with egressPorts: {postgres: 5432, redis: 6379, https: 443}.
migration.enabledfalseEnables the pre-install,pre-upgrade -migrate-only Job (backoffLimit: 3, activeDeadlineSeconds: 300).