Install on Google Kubernetes Engine

This guide describes how to deploy SuperPlane to Google Kubernetes Engine (GKE) using Terraform.

Prerequisites

• A GCP project with billing enabled
• Terraform >= 1.5.0
• gcloud CLI installed and authenticated
• kubectl installed

Step 1: Authenticate with GCP

gcloud auth application-default login
gcloud config set project YOUR_PROJECT_ID

Step 2: Create Static IP Address

Create a global static IP address for the ingress:

gcloud compute addresses create superplane-ip --global --ip-version=IPV4

Get the reserved IP address:

gcloud compute addresses describe superplane-ip --global --format='get(address)'

Step 3: Configure DNS

Create an A record in your DNS provider pointing to the static IP:

• Type: A
• Name: Your subdomain (e.g., superplane)
• Value: The static IP address from Step 2

Wait for DNS propagation and verify:

dig superplane.example.com +short

Step 4: Clone and Configure Terraform

git clone https://github.com/superplanehq/superplane-terraform
cd superplane-terraform/gke
cp terraform.tfvars.example terraform.tfvars

Edit terraform.tfvars:

project_id        = "my-gcp-project"
domain_name       = "superplane.example.com"
static_ip_name    = "superplane-ip"
letsencrypt_email = "admin@example.com"

Configuration Options

Variable	Description	Default
project_id	GCP project ID	(required)
domain_name	Domain name for SuperPlane	(required)
static_ip_name	Name of pre-created static IP	(required)
letsencrypt_email	Email for Let’s Encrypt	(required)
region	GCP region	us-central1
zone	GCP zone	us-central1-a
cluster_name	GKE cluster name	superplane
node_count	Number of GKE nodes	2
machine_type	GKE node machine type	e2-medium
superplane_image_tag	SuperPlane image tag	stable
installation.beaconEnabled	Enable anonymized beacon telemetry	true

Step 5: Deploy

terraform init
terraform apply

The deployment takes 15-20 minutes and creates:

• GKE cluster
• Cloud SQL PostgreSQL instance with VPC peering
• Kubernetes secrets
• cert-manager with Let’s Encrypt
• SuperPlane deployment

Step 6: Verify

Configure kubectl:

gcloud container clusters get-credentials superplane --zone=us-central1-a \
  --project=YOUR_PROJECT_ID

Check pods and ingress:

kubectl get pods -n superplane
kubectl get ingress -n superplane

Check SSL certificate status:

kubectl get certificate -n superplane

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

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 for the database and the cluster
terraform apply \
  -var="gke_deletion_protection=false" \
  -var="sql_deletion_protection=false"

# Then destroy all resources
terraform destroy \
  -var="gke_deletion_protection=false" \
  -var="sql_deletion_protection=false"

# Delete the static IP
gcloud compute addresses delete superplane-ip --global