如何通过Terraform在Cloud SQL Postgres创建Replication Slot以配置Datastream连接

方法一：使用PostgreSQL Terraform Provider（推荐） #

通过官方PostgreSQL Provider可直接管理Postgres的复制相关对象，无需手动执行SQL。前提是Terraform运行环境能访问你的Cloud SQL实例（可通过私有IP、Cloud SQL Auth Proxy或公网IP加白名单实现）。

1. 配置PostgreSQL Provider #

添加Provider并配置连接参数：

provider "postgresql" {
  host            = google_sql_database_instance.your_instance.private_ip_address # 替换为实例IP，用Auth Proxy时填127.0.0.1
  port            = 5432
  username        = var.db_username
  password        = var.db_password
  database        = "postgres"
  sslmode         = "require" # Cloud SQL强制SSL连接
  connect_timeout = 15
}

2. 为用户添加REPLICATION权限 #

用postgresql_exec执行SQL修改用户属性：

resource "postgresql_exec" "grant_replication_role" {
  sql = "ALTER USER ${var.db_username} WITH REPLICATION;"
}

3. 创建PUBLICATION #

使用postgresql_publication资源一键创建：

resource "postgresql_publication" "datastream_publication" {
  name       = var.publication_name
  all_tables = true # 对应SQL中的FOR ALL TABLES
  depends_on = [postgresql_exec.grant_replication_role]
}

4. 创建逻辑复制槽 #

通过postgresql_replication_slot资源创建pgoutput类型的复制槽：

resource "postgresql_replication_slot" "datastream_slot" {
  name   = var.replication_slot_name
  plugin = "pgoutput"
  depends_on = [postgresql_publication.datastream_publication]
}

方法二：使用null_resource + local-exec执行SQL命令 #

如果不想引入额外Provider，可直接调用psql客户端执行目标SQL，配合Cloud SQL Auth Proxy实现安全连接。

1. 启动Cloud SQL Auth Proxy（可选） #

若Terraform环境无法直接访问Cloud SQL，先启动代理：

resource "null_resource" "start_sql_proxy" {
  provisioner "local-exec" {
    command = "nohup cloud-sql-proxy ${google_sql_database_instance.your_instance.connection_name} &"
  }

  triggers = {
    instance_conn = google_sql_database_instance.your_instance.connection_name
  }
}

2. 执行复制配置SQL #

通过null_resource的local-exec执行完整SQL序列：

resource "null_resource" "setup_replication" {
  depends_on = [null_resource.start_sql_proxy]

  provisioner "local-exec" {
    command = <<EOT
psql "host=127.0.0.1 port=5432 user=${var.db_username} password=${var.db_password} dbname=postgres sslmode=require" <<SQL
ALTER USER ${var.db_username} WITH REPLICATION;
CREATE PUBLICATION ${var.publication_name} FOR ALL TABLES;
SELECT PG_CREATE_LOGICAL_REPLICATION_SLOT('${var.replication_slot_name}', 'pgoutput');
SQL
EOT
  }
}

关键注意事项 #

• 确保psql客户端和Cloud SQL Auth Proxy已安装在Terraform运行环境中
• 敏感信息（如密码）请用Terraform变量或密钥管理工具存储，禁止硬编码
• 依赖关系必须通过depends_on明确，保证执行顺序：权限配置 → 发布创建 → 复制槽创建
• 若使用公网IP连接，需提前将Terraform运行环境的IP加入Cloud SQL的授权网络列表

内容的提问来源于stack exchange，提问作者Cory Randolph