Skip to main content

Prerequisites

Everything you need before deploying Yardrail to Kubernetes with Helm.

Requirements​

RequirementDetails
Kubernetes clusterv1.27 or later. Any managed (EKS, GKE, AKS) or self-hosted distribution.
Helmv3.12 or later.
kubectlConfigured with cluster-admin access for the target cluster.
PostgreSQL v18+A running instance reachable from the cluster. Not bundled by the chart.
Temporal ServerA running deployment reachable from the cluster. Not bundled by the chart.
S3-compatible storageAWS 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 providerRecommended CSI driverDriver name
AWS S3Mountpoint for Amazon S3 CSIs3.csi.aws.amazon.com
MinIO / self-hosted S3csi-s3 or equivalentvaries

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

Next steps​

Install with Helm →