APEx Dispatch API Knative Helm Chart

This repository contains a Helm chart for deploying the FastAPI-based APEx Dispatch API on Knative Serving using serving.knative.dev/v1 Service resources.

Optionally, the chart can also expose the Knative service through Contour using a projectcontour.io/v1 HTTPProxy resource.

The chart is intended for development and testing deployments of the APEx Dispatch API in Knative-enabled Kubernetes environments.

Repository Layout

• charts/: Helm chart sources
• docs/: MkDocs documentation organized with the Diataxis structure
• .github/workflows/: CI workflows for docs and Helm chart packaging/publishing
• Taskfile.yaml: local developer commands

Chart Location

The Helm chart lives in charts/.

Local Commands

Render the chart locally:

task helm:render

Run the Helm unit tests:

task helm:test

Serve the documentation locally:

task docs:serve

Build the documentation:

task docs:build

Install

helm install apex-dispatch-api ./charts

OCI Distribution

The Helm chart is also published as an OCI artifact in GitHub Container Registry:

• Package page: ghcr.io OCI package
• OCI reference: oci://ghcr.io/esa-apex/helm/apex-dispatch-api

Pull the chart from GHCR:

helm pull oci://ghcr.io/esa-apex/helm/apex-dispatch-api --version 0.1.0

Install directly from the OCI registry:

helm install apex-dispatch-api oci://ghcr.io/esa-apex/helm/apex-dispatch-api --version 0.1.0

Important values

• serviceAccount.create: create a dedicated Kubernetes service account
• serviceAccount.existingName: existing Kubernetes service account used when create=false
• serviceAccount.name: service account name used when create=true
• image.repository, image.tag: container image to run
• knative.minScale, knative.maxScale: Knative autoscaling bounds
• contour.enabled: enable/disable the Contour HTTPProxy resource
• contour.virtualhost.fqdn: public hostname used by HTTPProxy
• contour.virtualhost.tls.enabled: enable/disable TLS termination on HTTPProxy
• contour.virtualhost.tls.secretName: TLS secret used by HTTPProxy when TLS is enabled
• secrets.create: create the app secret from Helm values or reference an existing one
• externalSecret.enabled: manage app secrets through External Secrets Operator
• migration.enabled: run alembic upgrade head as a Helm hook Job
• probes.enabled: enable /health probes if your runtime dependencies are ready at startup

See docs/reference/index.md for the detailed values and runtime contract.

Required secret keys

If secrets.create=false, the secret referenced by secrets.name should already exist and contain:

• KEYCLOAK_CLIENT_ID
• KEYCLOAK_CLIENT_SECRET
• BACKENDS
• DATABASE_URL

Documentation

The project documentation is built with MkDocs and includes:

• tutorials
• how-to guides
• explanation pages
• reference material

The documentation entry point is docs/index.md.

CI

The repository includes GitHub Actions workflows for:

• building and deploying documentation with a GitHub Pages approach
• packaging the Helm chart
• publishing the Helm chart to ghcr.io as an OCI artifact

On main, the Helm OCI workflow publishes a latest tag alias. On vX.Y.Z tags, it publishes the chart with version X.Y.Z.

License

This project is licensed under the Apache License 2.0. See LICENSE.