CockroachDB

cpln gvc get GVC_NAME -o json

cpln gvc add-location GVC_NAME --location aws-us-east-2

# ─── Locations ────────────────────────────────────────────────────────────────
# This chart deploys into the GVC you install into — it does NOT create one.
# Every location listed here MUST already exist in that GVC, or the CockroachDB
# nodes refuse to initialise with a named error (see Prerequisites in the README).
# Extra locations in the GVC are fine: nothing CockroachDB-related runs in them.
#
# Surviving the loss of a whole location needs at least THREE locations. One
# location with three replicas survives a node loss, not a region loss.
locations:
  - name: aws-us-east-1
    replicas: 3

image: cockroachdb/cockroach:v25.4.0

# Confirm every location in your GVC supports multi-zone before enabling this --
# a location that does not will wedge with no error. See the README.
multiZone: false

resources:
  cpu: 2
  memory: 4Gi

database:
  name: mydb
  user: myuser

volumeset:
  capacity: 10 # Initial capacity in GiB (minimum is 10)
  autoscaling:
    enabled: false # Set to true to enable autoscaling
    maxCapacity: 100 # Maximum capacity in GiB when autoscaling is enabled
    minFreePercentage: 10 # Minimum free percentage to trigger scaling when autoscaling is enabled
    scalingFactor: 1.2 # Scaling factor to determine how much to scale up when autoscaling is triggered

internal_access:
  type: same-gvc # options: same-gvc, same-org, workload-list; used for CockroachDB when pgbouncer is disabled
  workloads:  # Note: can only be used if type is workload-list
    #- //gvc/GVC_NAME/workload/WORKLOAD_NAME

pgbouncer:
  enabled: true
  image: edoburu/pgbouncer:v1.25.1-p0
  poolMode: transaction  # options: session, transaction, statement
  defaultPoolSize: 25    # number of real CockroachDB connections PgBouncer maintains per pod
  maxClientConn: 250     # maximum number of client connections PgBouncer accepts per pod
  maxDbConnections: 100  # hard cap on total CockroachDB connections regardless of how many PgBouncer pods are running
  minReplicas: 2         # per location
  maxReplicas: 4         # per location
  serverCheckDelay: 30      # seconds between idle server connection health checks (default 30)
  serverConnectTimeout: 2   # seconds before giving up on a new server connection (default 15)
  serverLoginRetry: 0       # seconds before retrying a failed server login; 0 = no caching of failures (default 15)
  clientLoginTimeout: 10    # seconds before rejecting a client waiting for login (default 60)
  queryWaitTimeout: 10      # seconds before rejecting a logged-in client waiting for a server connection (default 120)
  internal_access:
    type: same-gvc # options: same-gvc, same-org, workload-list; controls who can connect to PgBouncer
    workloads:  # Note: can only be used if type is workload-list
      #- //gvc/GVC_NAME/workload/WORKLOAD_NAME
  resources:
    maxCpu: 200m
    minCpu: 100m
    maxMemory: 1Gi
    minMemory: 128Mi

backup:
  enabled: false
  image: ghcr.io/controlplane-com/backup-images/cockroach-backup:1.1
  schedule: "0 2 * * *"
  activeDeadlineSeconds: 14400   # hard kill after 4 hours if backup hangs
  location: aws-us-east-1        # MUST be one of `locations` above; put it near your bucket
  resources:
    cpu: 500m
    memory: 512Mi
  provider: aws  # options: aws, gcp
  aws:
    bucket: my-backup-bucket
    region: us-east-1
    cloudAccountName: my-backup-cloudaccount
    policyName: my-backup-policy
    prefix: cockroach/backups
  gcp:
    bucket: my-backup-bucket
    cloudAccountName: my-backup-cloudaccount
    prefix: cockroach/backups

database:
  name: mydb
  user: myuser

internal_access:
  type: workload-list
  workloads:
    - //gvc/GVC_NAME/workload/WORKLOAD_NAME

RELEASE_NAME-cockroach-pgbouncer.GVC_NAME.cpln.local:5432

cockroach sql --insecure \
  --host=RELEASE_NAME-cockroach-pgbouncer.GVC_NAME.cpln.local:5432 --database=mydb

cpln port-forward RELEASE_NAME-cockroach 8080:8080 --gvc GVC_NAME

SHOW SURVIVAL GOAL FROM DATABASE mydb;
SHOW REGIONS FROM CLUSTER;

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:PutObject",
                "s3:DeleteObject",
                "s3:ListBucket",
                "s3:GetObjectVersion",
                "s3:DeleteObjectVersion",
                "s3:GetBucketLocation",
                "s3:AbortMultipartUpload",
                "s3:ListBucketMultipartUploads",
                "s3:ListMultipartUploadParts"
            ],
            "Resource": [
                "arn:aws:s3:::YOUR_BUCKET_NAME",
                "arn:aws:s3:::YOUR_BUCKET_NAME/*"
            ]
        }
    ]
}

cockroach sql --insecure --host="RELEASE_NAME-cockroach.GVC_NAME.cpln.local:26257" \
  --execute="RESTORE DATABASE mydb FROM LATEST IN 's3://BUCKET_NAME/PREFIX?AUTH=implicit&AWS_REGION=BUCKET_REGION' WITH new_db_name = 'mydb_restored';"

cockroach sql --insecure --host="RELEASE_NAME-cockroach.GVC_NAME.cpln.local:26257" \
  --execute="DROP DATABASE mydb CASCADE; DROP USER myuser;"

cockroach sql --insecure --host="RELEASE_NAME-cockroach.GVC_NAME.cpln.local:26257" \
  --execute="RESTORE FROM LATEST IN 's3://BUCKET_NAME/PREFIX?AUTH=implicit&AWS_REGION=BUCKET_REGION';"