database-lab-engine/engine/configs/rds-refresh.example.yaml at ec74bc61bbca01f1d29d1bfabe485c197d4d1271 · postgres-ai/database-lab-engine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# Example configuration for rds-refresh component
#
# This component automates DBLab full refresh using temporary RDS/Aurora clones.
# Copy this file and customize for your environment.
#
# For Lambda deployment, see deploy/rds-refresh/template.yaml
# For CLI usage: rds-refresh -config rds-refresh.yaml

# Source database configuration
source:
  # Type of source database:
  # - "rds" for RDS DB instance
  # - "aurora-cluster" for Aurora cluster
  type: rds

  # RDS DB instance identifier or Aurora cluster identifier
  identifier: production-db

  # Optional: Specific snapshot identifier to use
  # If empty, the latest automated snapshot will be used
  # snapshotIdentifier: rds:production-db-2024-01-15-02-00

# Temporary clone configuration
clone:
  # Instance class for the clone (can be smaller than production)
  instanceClass: db.t3.medium

  # DB subnet group (must be in a VPC accessible from DBLab Engine)
  subnetGroup: default-vpc-subnet

  # VPC security groups for the clone
  # Must allow inbound connections from DBLab Engine on PostgreSQL port
  securityGroups:
    - sg-12345678
    - sg-87654321

  # Whether the clone should be publicly accessible
  # Set to false if DBLab is in the same VPC
  publiclyAccessible: false

  # Enable IAM database authentication (recommended)
  enableIAMAuth: true

  # Optional: DB parameter group name
  # parameterGroup: custom-postgres-params

  # Optional: DB option group name (RDS only)
  # optionGroup: custom-options

  # Optional: Cluster parameter group (Aurora only)
  # clusterParameterGroup: aurora-postgres-params

  # Optional: Engine version override
  # engineVersion: "15.4"

  # Optional: Custom port (default: 5432)
  # port: 5432

  # Optional: Storage type (gp2, gp3, io1, io2)
  # storageType: gp3

  # Deletion protection (should be false for temporary clones)
  deletionProtection: false

  # Additional tags for the clone
  tags:
    Environment: dblab-refresh
    Team: platform
    CostCenter: engineering

# DBLab Engine configuration
dblab:
  # DBLab Engine API endpoint
  apiEndpoint: https://dblab.example.com:2345

  # Verification token for DBLab API
  # Use environment variable expansion for security
  token: ${DBLAB_TOKEN}

  # Skip TLS certificate verification (not recommended for production)
  insecure: false

  # How often to poll DBLab status during refresh
  pollInterval: 30s

  # Maximum time to wait for refresh to complete
  timeout: 4h

# AWS configuration
aws:
  # AWS region where RDS/Aurora resources are located
  region: us-east-1

  # Optional: Custom AWS endpoint (for testing with LocalStack)
  # endpoint: http://localhost:4566