Prerequisites
Everything you need before deploying Yardrail to Kubernetes with Helm.
Requirements
| Requirement | Details |
|---|---|
| Kubernetes cluster | v1.27 or later. Any managed (EKS, GKE, AKS) or self-hosted distribution. |
| Helm | v3.12 or later. |
| kubectl | Configured with cluster-admin access for the target cluster. |
| PostgreSQL v18+ | A running instance reachable from the cluster. Not bundled by the chart. |
| Temporal Server | A running deployment reachable from the cluster. Not bundled by the chart. |
| S3-compatible storage | AWS S3 or MinIO for workflow artifacts and avatar uploads. |
Secrets to generate
Yardrail requires several secrets. Generate them before creating your Helm values:
# JWT signing secret (session tokens)
openssl rand -hex 32
# Credential encryption key (AES-256-GCM, secrets at rest)
openssl rand -base64 32
# Temporal payload encryption key (format: id:base64key)
echo "key1:$(openssl rand -base64 32)"
# Interlink service token (worker ↔ frontend auth)
openssl rand -hex 32
For production, use an ExternalSecret provider (e.g. AWS Secrets Manager, Vault) instead of storing secrets directly in Helm values.
S3 CSI driver
The Kubernetes executor needs a CSI driver that can mount S3 buckets as inline volumes on Pods. Your choice depends on your S3 provider:
| S3 provider | Recommended CSI driver | Driver name |
|---|---|---|
| AWS S3 | Mountpoint for Amazon S3 CSI | s3.csi.aws.amazon.com |
| MinIO / self-hosted S3 | csi-s3 or equivalent | varies |
The Kubernetes executor setup guide includes a full walkthrough for installing the Mountpoint for S3 CSI driver on EKS with a MinIO alternative path.
Workflow artifacts bucket
Create a dedicated S3 bucket for workflow staging and output data (default name:
yardrail-workflows). This is separate from the frontend's avatar upload bucket.
# AWS S3
aws s3 mb s3://yardrail-workflows
# MinIO
mc mb myminio/yardrail-workflows