Install on Amazon EKS

This guide describes how to deploy SuperPlane to Amazon EKS using Terraform.

Prerequisites

• An AWS account with permissions to create EKS, RDS, and VPC resources
• Terraform >= 1.5.0
• AWS CLI installed
• kubectl installed

Step 1: Configure AWS CLI

Configure the AWS CLI with your credentials:

aws configure

You will be prompted to enter:

• AWS Access Key ID: Your access key
• AWS Secret Access Key: Your secret key
• Default region name: e.g., us-east-1
• Default output format: json (recommended)

Verify the configuration:

aws sts get-caller-identity

Step 2: Clone and Configure Terraform

If you already have the SuperPlane repo checked out, the Terraform configuration lives in superplane-terraform/eks. Otherwise, clone it:

git clone https://github.com/superplanehq/superplane-terraform

Then:

cd superplane-terraform/eks
cp terraform.tfvars.example terraform.tfvars

Edit terraform.tfvars:

domain_name       = "superplane.example.com"
letsencrypt_email = "admin@example.com"

Configuration Options

Variable	Description	Default
domain_name	Domain name for SuperPlane	(required)
letsencrypt_email	Email for Let’s Encrypt	(required)
region	AWS region	us-east-1
cluster_name	EKS cluster name	superplane
node_count	Number of EKS nodes	2
instance_type	EKS node instance type	t3.medium
db_instance_class	RDS instance class	db.t3.medium
superplane_image_tag	SuperPlane image tag	stable
installation.beaconEnabled	Enable anonymized beacon telemetry	true

Step 3: Deploy

terraform init
terraform apply

The deployment takes 15-20 minutes and creates:

• VPC with public and private subnets
• EKS cluster with node group
• RDS PostgreSQL instance
• Network Load Balancer
• cert-manager with Let’s Encrypt
• SuperPlane deployment

Step 4: Configure kubectl

aws eks update-kubeconfig --region us-east-1 --name superplane

Step 5: Configure DNS

Get the Load Balancer hostname:

kubectl get svc -n ingress-nginx ingress-nginx-controller \
  -o jsonpath='{.status.loadBalancer.ingress[0].hostname}'

Create a CNAME record in your DNS provider:

• Type: CNAME
• Name: Your subdomain (e.g., superplane)
• Value: The hostname from the command above

Wait for DNS propagation:

dig superplane.example.com +short

Step 6: Verify

Check pods and certificate status:

kubectl get pods -n superplane
kubectl get certificate -n superplane

Once the certificate shows Ready, access SuperPlane at https://your-domain.com.

Note: Certificate issuance may take 5-10 minutes after DNS propagation completes.

Updating SuperPlane

1. Check the GitHub releases for the latest version tag.
2. Update superplane_image_tag in terraform.tfvars with the new tag.
3. Apply the changes:

terraform apply

Uninstalling

# Disable deletion protection on the database
aws rds modify-db-instance \
  --db-instance-identifier superplane-db \
  --no-deletion-protection \
  --apply-immediately

# Wait for modification to complete
aws rds wait db-instance-available --db-instance-identifier superplane-db

# Destroy all resources
terraform destroy