Skip to main content

Helm Install

This guide walks through deploying Yardrail to a Kubernetes cluster using the Helm chart. By default, the worker uses the Docker executor — see Kubernetes Executor Setup to switch to Pod-based execution.

Add the Helm repository​

helm repo add yardrail https://charts.yardrail.com
helm repo update

Create the namespace​

kubectl create namespace yardrail

Prepare the values file​

Create a values.yaml with your environment's configuration. At minimum, you need Temporal, Postgres, and secrets configured:

values.yaml
config:
publicBaseUrl: "https://yardrail.example.com"
temporal:
address: "temporal-frontend.temporal:7233"
namespace: "default"
s3:
endpoint: "s3.amazonaws.com"
accessKey: "AKIA..."
bucket: "yardrail-avatars"
useSSL: true

secrets:
create: true
databaseUrl: "postgres://yardrail:password@postgres:5432/yardrail?sslmode=require"
jwtSecret: "" # output of: openssl rand -hex 32
secretsKey: "" # output of: openssl rand -base64 32
serviceToken: "" # output of: openssl rand -hex 32
encryptionKeys: "" # output of: echo "key1:$(openssl rand -base64 32)"
s3SecretKey: "" # your S3 secret access key
caution

Generate real values for each secret before deploying. Do not commit secrets to version control. For production, use an ExternalSecret provider instead of secrets.create: true.

Install the chart​

helm install yardrail yardrail/yardrail \
--namespace yardrail \
--values values.yaml

Check the deployment​

# Both deployments should be available
kubectl -n yardrail get deployments

Expected output:

NAME READY UP-TO-DATE AVAILABLE
yardrail-frontend 1/1 1 1
yardrail-worker 1/1 1 1

Check the worker logs to confirm it connected to Temporal:

kubectl -n yardrail logs deployment/yardrail-worker

You should see:

{"level":"INFO","msg":"yardrail-worker starting","temporal":"temporal-frontend.temporal:7233",...}

Upgrading​

helm repo update
helm upgrade yardrail yardrail/yardrail \
--namespace yardrail \
--values values.yaml

Next steps​