Skip to content

kubernetes.mdx

Latest commit

 

History

History
432 lines (331 loc) · 10.7 KB

kubernetes.mdx

File metadata and controls

432 lines (331 loc) · 10.7 KB
title Kubernetes
description You can self-host Trigger.dev in Kubernetes using our official Helm chart.

The following instructions will help you deploy Trigger.dev to Kubernetes using our official Helm chart. Make sure to read the self-hosting overview first.

As self-hosted deployments tend to have unique requirements and configurations, we don't provide specific advice for securing your deployment, scaling up, or improving reliability.

Should the burden ever get too much, we'd be happy to see you on Trigger.dev cloud where we deal with these concerns for you.

Warning: This guide alone is unlikely to result in a production-ready deployment. Security, scaling, and reliability concerns are not fully addressed here.

Requirements

Prerequisites

  • Kubernetes cluster 1.19+
  • Helm 3.8+
  • Kubectl with cluster access

Resources

The following are minimum requirements for running the entire stack on Kubernetes:

Cluster resources:

  • 6+ vCPU total
  • 12+ GB RAM total
  • Persistent volume support

Individual components:

  • Webapp: 1 vCPU, 2 GB RAM
  • Supervisor: 1 vCPU, 1 GB RAM
  • PostgreSQL: 1 vCPU, 2 GB RAM
  • Redis: 0.5 vCPU, 1 GB RAM
  • ClickHouse: 1 vCPU, 2 GB RAM
  • Object Storage: 0.5 vCPU, 1 GB RAM
  • Workers: Depending on concurrency and machine preset

These requirements scale based on your task concurrency and can be adjusted via the resources section in your values.yaml. For example:

webapp:
  resources:
    requests:
      cpu: 500m
      memory: 1Gi
    limits:
      cpu: 2000m
      memory: 4Gi

Installation

Quick start

  1. Install with default values (for testing only):
helm upgrade -n trigger --install trigger \
  oci://ghcr.io/triggerdotdev/charts/trigger \
  --version "~4.0.0-beta" \
  --create-namespace
  1. Access the webapp:
kubectl port-forward svc/trigger-webapp 3040:3030 -n trigger

  1. Open the dashboard: http://localhost:3040

  2. Login with the magic link:

# Check the webapp logs
kubectl logs -n trigger deployment/trigger-webapp | grep -A1 "magic link"
While v4 is in beta, always use `@v4-beta` instead of `@latest`. For example: `npx trigger.dev@v4-beta dev`

Configuration

Most values map directly to the environment variables documented in the webapp and supervisor environment variable overview.

Naming convention:

  • Environment variables use UPPER_SNAKE_CASE
  • Helm values use camelCase

Example mapping:

# Environment variable
APP_ORIGIN=https://trigger.example.com

# Becomes Helm value
config:
  appOrigin: "https://trigger.example.com"

Default values

The following commands will display the default values:

# Specific version
helm show values oci://ghcr.io/triggerdotdev/charts/trigger \
  --version "4.0.0-beta.5"

# Latest v4 beta
helm show values oci://ghcr.io/triggerdotdev/charts/trigger \
  --version "~4.0.0-beta"

Custom values

The default values are insecure and are only suitable for testing. You will need to configure your own secrets as a bare minimum.

Create a values-custom.yaml file to override the defaults. For example:

# Generate new secrets with `openssl rand -hex 16`
# WARNING: You should probably use an existingSecret instead
secrets:
  enabled: true
  sessionSecret: "your-32-char-hex-secret-1"
  magicLinkSecret: "your-32-char-hex-secret-2"
  # ...

# Recommended: existingSecret, must contain at least the following keys:
# - SESSION_SECRET
# - MAGIC_LINK_SECRET
# - ENCRYPTION_KEY
# - MANAGED_WORKER_SECRET
# - OBJECT_STORE_ACCESS_KEY_ID
# - OBJECT_STORE_SECRET_ACCESS_KEY
secrets:
  enabled: false
  existingSecret: "your-existing-secret"

# Application URLs
config:
  appOrigin: "https://trigger.example.com"
  loginOrigin: "https://trigger.example.com"
  apiOrigin: "https://trigger.example.com"

# Resource limits
webapp:
  resources:
    requests:
      cpu: 1000m
      memory: 2Gi
    limits:
      cpu: 2000m
      memory: 4Gi

supervisor:
  resources:
    requests:
      cpu: 200m
      memory: 512Mi
    limits:
      cpu: 1000m
      memory: 2Gi

Deploy with your custom values:

helm upgrade -n trigger --install trigger \
  oci://ghcr.io/triggerdotdev/charts/trigger \
  --version "~4.0.0-beta" \
  --create-namespace \
  -f values-custom.yaml

Extra env

You can set extra environment variables on all services. For example:

webapp:
  extraEnv:
    - name: EXTRA_ENV_VAR
      value: "extra-value"

Extra annotations

You can set extra annotations on all services. For example:

webapp:
  podAnnotations:
    "my-annotation": "my-value"

External services

You can disable the built-in services and use external services instead. For example:

postgres:
  enabled: false
  external: true
  externalConnection:
    host: "my-postgres.example.com"
    port: 5432
    database: "my-database"
    username: "my-username"
    password: "my-password"

Worker token

When using the default bootstrap configuration, worker creation and authentication is handled automatically. The webapp generates a worker token and makes it available to the supervisor via a shared volume.

Bootstrap (default)

webapp:
  bootstrap:
    enabled: true
    workerGroupName: "bootstrap"

Manual

If you need to set up workers separately or use a custom token:

  1. Get the worker token from the webapp logs:
kubectl logs deployment/trigger-webapp -n trigger | grep -A15 "Worker Token"
  1. Create a secret with the token:
kubectl create secret generic worker-token \
  --from-literal=token=tr_wgt_your_token_here \
  -n trigger
  1. Configure the supervisor to use the secret:
supervisor:
  bootstrap:
    enabled: false
    workerToken:
      secret:
        name: "worker-token"
        key: "token"

Registry setup

See the Docker registry setup for conceptual information. The configuration is specified in your values.yaml:

# Use external registry (recommended)
registry:
  external: true
  # Part of deployment image ref, for example: your-registry.example.com/your-company/proj_123:20250625.1.prod
  repositoryNamespace: "your-company"
  externalConnection:
    host: "your-registry.example.com"
    port: 5000
    auth:
      enabled: true
      username: "your-username"
      password: "your-password"
The internal registry (`registry.external: false`) is experimental and requires proper TLS setup and additional cluster configuration. Use an external registry for production.

Object storage

See the Docker object storage setup for conceptual information. The defaults will use built-in MinIO, but you can use an external S3-compatible storage. The configuration is specified in your values.yaml:

# Use external S3-compatible storage
minio:
  enabled: false
  external: true
  externalConnection:
    url: "https://s3.amazonaws.com"
    # or: "https://your-minio.com:9000"

# Configure credentials
secrets:
  objectStore:
    accessKeyId: "admin"
    secretAccessKey: "very-safe-password"

Authentication

Authentication options are identical to the Docker-based installation. The configuration is specified in your values.yaml:

GitHub OAuth:

webapp:
  extraEnv:
    - name: AUTH_GITHUB_CLIENT_ID
      value: "your-github-client-id"
    - name: AUTH_GITHUB_CLIENT_SECRET
      value: "your-github-client-secret"

Email authentication (Resend):

webapp:
  extraEnv:
    - name: EMAIL_TRANSPORT
      value: "resend"
    - name: FROM_EMAIL
      value: "noreply@yourdomain.com"
    - name: REPLY_TO_EMAIL
      value: "support@yourdomain.com"
    - name: RESEND_API_KEY
      value: "your-resend-api-key"

Restricting access:

webapp:
  extraEnv:
    - name: WHITELISTED_EMAILS
      value: "user1@company\\.com|user2@company\\.com"

Version locking

You can lock versions in two ways:

Helm chart version (recommended):

# Pin to a specific version for production
helm upgrade -n trigger --install trigger \
  oci://ghcr.io/triggerdotdev/charts/trigger \
  --version "4.0.0-beta.5"

# The app version will be different from the chart version
# This is the version of the Trigger.dev webapp and supervisor
# ..and should always match your Trigger.dev CLI version
helm show chart \
  oci://ghcr.io/triggerdotdev/charts/trigger \
  --version "4.0.0-beta.5" | grep appVersion

Specific image tags:

webapp:
  image:
    tag: "v4.0.0-v4-beta.21"

supervisor:
  image:
    tag: "v4.0.0-v4-beta.21"

The chart version's appVersion field determines the default image tags. Newer image tags may be incompatible with older chart versions and vice versa.

Troubleshooting

Check logs:

# Webapp logs
kubectl logs deployment/trigger-webapp -n trigger -f 

# Supervisor logs
kubectl logs deployment/trigger-supervisor -n trigger -f 

# All pods
kubectl logs -l app.kubernetes.io/instance=trigger -n trigger -f

Check pod status:

kubectl get pods -n trigger
kubectl describe pod <pod-name> -n trigger

Start from scratch:

# Delete the release
helm uninstall trigger -n trigger

# Delete persistent volumes (optional)
# WARNING: This will delete all your data!
kubectl delete pvc -l app.kubernetes.io/instance=trigger -n trigger

# Delete the namespace (optional)
kubectl delete namespace trigger

Common issues:

  • Magic links not working: Check webapp logs for email delivery errors
  • Deploy fails: Verify registry access and authentication
  • Pods stuck pending: Describe the pod and check the events
  • Worker token issues: Check webapp and supervisor logs for errors

See the Docker troubleshooting section for more information.

CLI usage

See the Docker CLI usage section, the commands are identical regardless of deployment method.

While v4 is in beta, always use `@v4-beta` instead of `@latest`. For example: `npx trigger.dev@v4-beta dev`

CI / GitHub Actions

When running the CLI in a CI environment, your login profiles won't be available. Instead, you can use the TRIGGER_API_URL and TRIGGER_ACCESS_TOKEN environment variables to point at your self-hosted instance and authenticate.

For more detailed instructions, see the GitHub Actions guide.

Telemetry

By default, the Trigger.dev webapp sends telemetry data to our servers. This data is used to improve the product and is not shared with third parties. To disable telemetry, set in your values.yaml:

telemetry:
  enabled: false