Skip to content

README-pgcopydb-gcp.md

Latest commit

 

History

History
61 lines (47 loc) · 1.99 KB

README-pgcopydb-gcp.md

File metadata and controls

61 lines (47 loc) · 1.99 KB
Raw

PlanetScale Migration — pgcopydb Migration Instance (GCP Terraform)

What This Does

This Terraform template creates a Compute Engine instance pre-configured with pgcopydb, the tool PlanetScale uses to migrate your PostgreSQL data. The instance runs Ubuntu 24.04 and pulls the latest PlanetScale migration helper scripts at boot.

What Gets Created

  • A Compute Engine instance with pgcopydb and PostgreSQL client tools installed
  • A persistent disk for migration working data
  • A firewall rule for SSH access via IAP tunnel
  • A startup script that installs all required tools
  • Migration helper scripts from github.com/planetscale/migration-scripts in /home/ubuntu/

How to Deploy

Prerequisites

  • Terraform installed (v1.0+)
  • A GCP project with a VPC and subnet
  • gcloud CLI authenticated

Steps

  1. Save both files (pgcopydb-migration-instance.tf and startup-script.sh) in the same directory

  2. Deploy (restricting SSH to your IP is recommended — get it from icanhazip.com):

    terraform init
terraform apply \
  -var="project_id=YOUR_PROJECT" \
  -var="vpc_name=YOUR_VPC" \
  -var="subnet_name=YOUR_SUBNET" \
  -var="your_public_ip=$(curl -s icanhazip.com)"

  3. Connect via IAP tunnel:

    gcloud compute ssh $(terraform output -raw instance_name) \
  --zone=$(terraform output -raw zone) \
  --project=YOUR_PROJECT \
  --tunnel-through-iap

    Or via the GCP Console (browser-based SSH — open the instance in Compute Engine and click SSH).

How to Tear Down

terraform destroy \
  -var="project_id=YOUR_PROJECT" \
  -var="vpc_name=YOUR_VPC" \
  -var="subnet_name=YOUR_SUBNET" \
  -var="your_public_ip=$(curl -s icanhazip.com)"

Questions?

Visit PlanetScale documentation for more information.