AI 助理
备案控制台
文档
输入文档关键字查找
首页 Terraform 实践教程 RDS（云数据库） 通过 Terraform 管理数据库连接的网络配置

通过 Terraform 管理数据库连接的网络配置

更新时间：
我的收藏

本文介绍如何使用Terraform申请、修改和释放RDS PostgreSQL实例的外网地址，以及查询和切换交换机。

说明

本教程所含示例代码支持一键运行，您可以直接运行代码。一键运行

前提条件

  • 已创建RDS PostgreSQL实例，详情请参见创建RDS PostgreSQL实例。

  • 实例状态为运行中，您可以通过如下两种方式查看：

    • 参见查询实例详情查看参数status，如果取值为Running则表示实例状态为运行中。

    • 前往RDS管理控制台，切换到目标地域，找到指定实例后，查看实例状态。

  • 由于阿里云账号（主账号）具有资源的所有权限，一旦发生泄露将面临重大风险。建议您使用RAM用户，并为该RAM用户创建AccessKey，具体操作方式请参见创建RAM用户和创建AccessKey。

  • 通过RAM授权，RAM用户可以有效地管理其云资源访问权限，适应多用户协同工作的需求，并且能够按需为用户分配最小权限，避免权限过大导致的安全漏洞‌。具体操作方式请参见为RAM用户授权。

    {
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "vpc:DescribeVpcAttribute",
                "vpc:DescribeRouteTableList",
                "vpc:DescribeVSwitchAttributes",
                "vpc:DeleteVpc",
                "vpc:DeleteVSwitch",
                "vpc:CreateVpc",
                "vpc:CreateVSwitch"
            ],
            "Resource": "*"
        },
        {
            "Action": "rds:*",
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": "dbs:*",
            "Resource": "acs:rds:*:*:*",
            "Effect": "Allow"
        },
        {
            "Action": "hdm:*",
            "Resource": "acs:rds:*:*:*",
            "Effect": "Allow"
        },
        {
            "Action": "dms:LoginDatabase",
            "Resource": "acs:rds:*:*:*",
            "Effect": "Allow"
        },
        {
            "Effect": "Allow",
            "Action": "ram:CreateServiceLinkedRole",
            "Resource": "*",
            "Condition": {
                "StringEquals": {
                    "ram:ServiceName": [
                        "backupencryption.rds.aliyuncs.com"
                    ]
                }
            }
        },
        {
            "Effect": "Allow",
            "Action": "bss:ModifyAgreementRecord",
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "bss:DescribeOrderList",
                "bss:DescribeOrderDetail",
                "bss:PayOrder",
                "bss:CancelOrder"
            ],
            "Resource": "*"
        }
    ]
}

  • 准备Terraform运行环境，您可以选择以下任一方式来使用Terraform。

    • 在Terraform Explorer中使用Terraform：阿里云提供了Terraform的在线运行环境，您无需安装Terraform，登录后即可在线使用和体验Terraform。适用于零成本、快速、便捷地体验和调试Terraform的场景。

    • Cloud Shell：阿里云Cloud Shell中预装了Terraform的组件，并已配置好身份凭证，您可直接在Cloud Shell中运行Terraform的命令。适用于低成本、快速、便捷地访问和使用Terraform的场景。

    • 在本地安装和配置Terraform：适用于网络连接较差或需要自定义开发环境的场景。

使用的资源

说明

本教程示例包含的部分资源会产生一定费用，请在不需要时及时进行释放或退订。

申请外网地址

  1. 创建一个工作目录，并在该工作目录中创建名为main.tf的配置文件，然后将以下代码复制到main.tf中。

    • 创建前置资源。

      variable "region" {
  default = "cn-heyuan"
}

variable "zone_id" {
  default = "cn-heyuan-b"
}

variable "instance_type" {
  default = "pg.n2.2c.2m"
}

provider "alicloud" {
  region = var.region
}

# 创建VPC
resource "alicloud_vpc" "main" {
  vpc_name   = "alicloud"
  cidr_block = "172.16.0.0/16"
}

# 创建交换机
resource "alicloud_vswitch" "main" {
  vpc_id     = alicloud_vpc.main.id
  cidr_block = "172.16.192.0/20"
  zone_id    = var.zone_id
}

# 创建RDS PostgreSQL实例
resource "alicloud_db_instance" "instance" {
  engine               = "PostgreSQL"
  engine_version       = "13.0"
  instance_type        = var.instance_type
  instance_storage     = "30"
  instance_charge_type = "Postpaid"
  vswitch_id           = alicloud_vswitch.main.id
}

    • 在main.tf文件中增加resource "alicloud_db_database" "db" {}配置项和resource "alicloud_db_connection" "extranet" {}，具体配置如下：

      ...
resource "alicloud_db_database" "db" {
  instance_id = alicloud_db_instance.instance.id
  name        = "tf_database_test"
}

resource "alicloud_db_connection" "extranet" {
  instance_id = alicloud_db_instance.instance.id
  port        = "5432"
}

  2. 执行以下命令，初始化Terraform运行环境。

    terraform init

    返回如下信息，表示Terraform初始化成功。

    Initializing the backend...

Initializing provider plugins...
- Checking for available provider plugins...
- Downloading plugin for provider "alicloud" (hashicorp/alicloud) 1.90.1...
...

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

  3. 创建执行计划，并预览变更。

    terraform plan

  4. 执行以下命令，创建资源。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示运行成功。

    alicloud_db_connection.extranet: Creating...
alicloud_db_connection.extranet: Still creating... [10s elapsed]
alicloud_db_connection.extranet: Creation complete after 11s [id=pgm-****:pgm-****]

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

  5. 验证结果。

    执行terraform show命令

    您可以使用以下命令查看RDS PostgreSQL实例外网地址。

    terraform show
    # alicloud_db_connection.extranet:
resource "alicloud_db_connection" "extranet" {
    connection_prefix = "pgm-****"
    connection_string = "pgm-****.pg.rds.aliyuncs.com"
    id                = "pgm-****:pgm-****"
    instance_id       = "pgm-****"
    ip_address        = "47.118.XX.XX"
    port              = "5432"
}

# alicloud_db_instance.instance:
resource "alicloud_db_instance" "instance" {
    client_ca_enabled          = 0
    client_crl_enabled         = 0
    connection_string          = "pgm-****.pg.rds.aliyuncs.com"
    connection_string_prefix   = "pgm-****"
    db_instance_storage_type   = "cloud_essd"
    db_time_zone               = "Asia/Shanghai"
    deletion_protection        = false
    engine                     = "PostgreSQL"
    engine_version             = "13.0"
    force_restart              = false
    ha_config                  = "Auto"
    id                         = "pgm-****"
    instance_charge_type       = "Postpaid"
    instance_name              = "terraformtest"
    instance_storage           = 50
    instance_type              = "pg.n2.2c.2m"
    maintain_time              = "05:00Z-06:00Z"
    monitoring_period          = 300
    period                     = 0
    port                       = "5432"
    private_ip_address         = "172.16.XX.XX"
    resource_group_id          = "rg-****"
    security_group_ids         = []
    security_ip_mode           = "normal"
    security_ips               = [
        "127.0.0.1",
    ]
    sql_collector_config_value = 30
    sql_collector_status       = "Disabled"
    storage_auto_scale         = "Enable"
    storage_threshold          = 30
    storage_upper_bound        = 100
    target_minor_version       = "rds_postgres_1300_20220830"
    tcp_connection_type        = "SHORT"
    vpc_id                     = "vpc-****"
    vswitch_id                 = "vsw-"
    zone_id                    = "cn-heyuan-j"

    pg_hba_conf {
        address     = "127.0.0.1"
        database    = "all"
        method      = "md5"
        priority_id = 1
        type        = "host"
        user        = "all"
    }
}

    登录RDS管理控制台

    登录RDS管理控制台查看RDS PostgreSQL实例的外网连接地址。外网地址

修改外网地址

以修改RDS PostgreSQL实例外网地址的前缀改为pgtest为例。

  1. 在上述main.tf文件的resource "alicloud_db_connection" "extranet" {}中增加connection_prefix配置项，具体配置如下：

    ...
resource "alicloud_db_connection" "extranet" {
...
  connection_prefix = "pgtest"
}

  2. 执行以下命令。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示运行成功。

    alicloud_db_connection.extranet: Destroying... [id=pgm-****:pgm-****]
alicloud_db_connection.extranet: Destruction complete after 1s
alicloud_db_connection.extranet: Creating...
alicloud_db_connection.extranet: Still creating... [10s elapsed]
alicloud_db_connection.extranet: Creation complete after 15s [id=pgm-****:pgtest]

Apply complete! Resources: 1 added, 0 changed, 1 destroyed.

  3. 验证结果。

    执行terraform show命令

    您可以使用以下命令查看RDS PostgreSQL实例外网地址。

    terraform show
    # alicloud_db_connection.extranet:
resource "alicloud_db_connection" "extranet" {
    connection_prefix = "pgtest"
    connection_string = "pgtest.pg.rds.aliyuncs.com"
    id                = "pgm-****:pgtest"
    instance_id       = "pgm-****"
    ip_address        = "47.118.XX.XX"
    port              = "5432"
}

# alicloud_db_instance.instance:
resource "alicloud_db_instance" "instance" {
    client_ca_enabled          = 0
    client_crl_enabled         = 0
    connection_string          = "pgm-****.pg.rds.aliyuncs.com"
    connection_string_prefix   = "pgm-****"
    db_instance_storage_type   = "cloud_essd"
    db_time_zone               = "Asia/Shanghai"
    deletion_protection        = false
    engine                     = "PostgreSQL"
    engine_version             = "13.0"
    force_restart              = false
    ha_config                  = "Auto"
    id                         = "pgm-****"
    instance_charge_type       = "Postpaid"
    instance_name              = "terraformtest"
    instance_storage           = 50
    instance_type              = "pg.n2.2c.2m"
    maintain_time              = "05:00Z-06:00Z"
    monitoring_period          = 300
    period                     = 0
    port                       = "5432"
    private_ip_address         = "172.16.XX.XX"
    resource_group_id          = "rg-****"
    security_group_ids         = []
    security_ip_mode           = "normal"
    security_ips               = [
        "127.0.0.1",
    ]
    sql_collector_config_value = 30
    sql_collector_status       = "Disabled"
    storage_auto_scale         = "Enable"
    storage_threshold          = 30
    storage_upper_bound        = 100
    target_minor_version       = "rds_postgres_1300_20220830"
    tcp_connection_type        = "SHORT"
    vpc_id                     = "vpc-****"
    vswitch_id                 = "vsw-****"
    zone_id                    = "cn-heyuan-j"

    pg_hba_conf {
        address     = "127.0.0.1"
        database    = "all"
        method      = "md5"
        priority_id = 1
        type        = "host"
        user        = "all"
    }
}

    登录RDS管理控制台

    登录RDS管理控制台查看RDS PostgreSQL实例的外网连接地址。外网连接地址改后

释放外网地址

  1. 在上述main.tf文件中，删除resource "alicloud_db_connection" "extranet" {}配置项的内容，例如，删除如下信息：

    ...
resource "alicloud_db_connection" "extranet" {
  instance_id = alicloud_db_instance.instance.id
  port  = "5432"
  connection_prefix = "pgtest"
}

  2. 执行以下命令。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示运行成功。

    alicloud_db_connection.extranet: Destroying... [id=pgm-****:pgtest]
alicloud_db_connection.extranet: Destruction complete after 1s

Apply complete! Resources: 0 added, 0 changed, 1 destroyed.

  3. 验证结果。

    执行terraform show命令

    您可以使用以下命令查看RDS PostgreSQL实例外网地址

    terraform show
    # alicloud_db_account.account:
resource "alicloud_db_account" "account" {
    account_name     = "tf_account_test"
    account_password = (sensitive value)
    account_type     = "Normal"
    db_instance_id   = "pgm-****"
    id               = "pgm-****:tf_account_test"
    instance_id      = "pgm-****）"
    name             = "tf_account_test"
    status           = "Available"
    type             = "Normal"
}
# alicloud_db_instance.instance:
resource "alicloud_db_instance" "instance" {
    client_ca_enabled          = 0
    client_crl_enabled         = 0
    connection_string          = "pgm-****.pg.rds.aliyuncs.com"
    connection_string_prefix   = "pgm-****"
    db_instance_storage_type   = "cloud_essd"
    db_time_zone               = "Asia/Shanghai"
    deletion_protection        = false
    engine                     = "PostgreSQL"
    engine_version             = "13.0"
    force_restart              = false
    ha_config                  = "Auto"
    id                         = "pgm-****"
    instance_charge_type       = "Postpaid"
    instance_name              = "terraformtest"
    instance_storage           = 50
    instance_type              = "pg.n2.2c.2m"
    maintain_time              = "05:00Z-06:00Z"
    monitoring_period          = 300
    period                     = 0
    port                       = "5432"
    private_ip_address         = "172.16.XX.XX"
    resource_group_id          = "rg-****"
    security_group_ids         = []
    security_ip_mode           = "normal"
    security_ips               = [
        "127.0.0.1",
    ]
    sql_collector_config_value = 30
    sql_collector_status       = "Disabled"
    storage_auto_scale         = "Enable"
    storage_threshold          = 30
    storage_upper_bound        = 100
    target_minor_version       = "rds_postgres_1300_20220730"
    tcp_connection_type        = "SHORT"
    vpc_id                     = "vpc-****"
    vswitch_id                 = "vsw-****"
    zone_id                    = "cn-heyuan-j"
}

    登录RDS管理控制台

    登录RDS管理控制台查看RDS PostgreSQL实例的外网连接地址已释放。已释放外网地址

查询交换机详情

  1. 在上述main.tf文件中增加data "alicloud_vswitches" "instance" {}配置项，具体配置如下：

    ...
data "alicloud_vswitches" "instance" {
  vpc_id            = alicloud_vpc.main.id
}

  2. 执行以下命令。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示运行成功。

    data.alicloud_vswitches.instance: Reading...
alicloud_db_instance.instance: Refreshing state... [id=pgm-****]
data.alicloud_vswitches.instance: Read complete after 1s [id=44344****]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are
needed.

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

  3. 验证结果。

    执行terraform show命令

    您可以使用以下命令查看结果.

    terraform show
    # data.alicloud_vswitches.instance:
data "alicloud_vswitches" "instance" {
    id        = "246547****"
    ids       = [
        "vsw-****",
        "vsw-****",
    ]
    names     = [
        "test",
        "",
    ]
    vpc_id    = "vpc-****"
    vswitches = [
        {
            available_ip_address_count = 252
            cidr_block                 = "10.1.0.0/24"
            creation_time              = "2022-09-13T01:57:56Z"
            description                = ""
            id                         = "vsw-****"
            is_default                 = false
            name                       = "test"
            resource_group_id          = "rg-****"
            route_table_id             = "vtb-****"
            status                     = "Available"
            tags                       = {}
            vpc_id                     = "vpc-****"
            vswitch_id                 = "vsw-****"
            vswitch_name               = "test"
            zone_id                    = "cn-heyuan-b"
        },
        {
            available_ip_address_count = 237
            cidr_block                 = "10.2.0.0/24"
            creation_time              = "2022-09-07T06:18:47Z"
            description                = ""
            id                         = "vsw-****"
            is_default                 = false
            name                       = ""
            resource_group_id          = "rg-****"
            route_table_id             = "vtb-****"
            status                     = "Available"
            tags                       = {}
            vpc_id                     = "vpc-****"
            vswitch_id                 = "vsw-****"
            vswitch_name               = ""
            zone_id                    = "cn-heyuan-b"
        },
    ]
}

切换交换机

若您因业务需要，希望变更RDS PostgreSQL实例交换机时，请参考以下示例。

重要

  • 切换交换机的操作会删除原有RDS PostgreSQL实例，创建新的RDS PostgreSQL实例，实例内数据将不会继承，请谨慎操作。

  • RDS PostgreSQL实例不支持切换VPC，切换后的交换机必须属于当前实例的VPC。

  1. 对上述main.tf文件中的resource "alicloud_db_instance" "instance" {}配置项中的vswitch_id进行修改配置如下：

    ...
resource "alicloud_db_instance" "instance" {
...
  vswitch_id       = "vsw-****"
}

  2. 执行以下命令。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示运行成功。

    alicloud_db_instance.instance: Destroying... [id=pgm-****]
alicloud_db_instance.instance: Still destroying... [id=pgm-****, 10s elapsed]
alicloud_db_instance.instance: Still destroying... [id=pgm-****, 20s elapsed]
alicloud_db_instance.instance: Still destroying... [id=pgm-****, 30s elapsed]
alicloud_db_instance.instance: Destruction complete after 31s
alicloud_db_instance.instance: Creating...
alicloud_db_instance.instance: Still creating... [10s elapsed]
alicloud_db_instance.instance: Still creating... [20s elapsed]
...
alicloud_db_instance.instance: Still creating... [10m58s elapsed]
alicloud_db_instance.instance: Creation complete after 11m1s [id=pgm-****]

Apply complete! Resources: 1 added, 0 changed, 1 destroyed.

  3. 验证结果。

    执行terraform show命令

    您可以使用以下命令查看RDS PostgreSQL实例交换机信息。

    terraform show
    # alicloud_db_instance.instance:
resource "alicloud_db_instance" "instance" {
    client_ca_enabled          = 0
    client_crl_enabled         = 0
    connection_string          = "pgm-****.pg.rds.aliyuncs.com"
    connection_string_prefix   = "pgm-****"
    db_instance_storage_type   = "cloud_essd"
    db_time_zone               = "Asia/Shanghai"
    deletion_protection        = false
    engine                     = "PostgreSQL"
    engine_version             = "13.0"
    force_restart              = false
    ha_config                  = "Auto"
    id                         = "pgm-****"
    instance_charge_type       = "Postpaid"
    instance_name              = "terraformtest"
    instance_storage           = 50
    instance_type              = "pg.n2.2c.2m"
    maintain_time              = "05:00Z-06:00Z"
    monitoring_period          = 300
    period                     = 0
    port                       = "5432"
    private_ip_address         = "192.168.XX.XX"
    resource_group_id          = "rg-****"
    security_group_ids         = []
    security_ip_mode           = "normal"
    security_ips               = [
        "127.0.0.1",
    ]
    sql_collector_config_value = 30
    sql_collector_status       = "Disabled"
    storage_auto_scale         = "Enable"
    storage_threshold          = 30
    storage_upper_bound        = 100
    target_minor_version       = "rds_postgres_1300_20220830"
    tcp_connection_type        = "SHORT"
    vpc_id                     = "vpc-****"
    vswitch_id                 = "vsw-****"
    zone_id                    = "cn-heyuan-j"

    pg_hba_conf {
        address     = "127.0.0.1"
        database    = "all"
        method      = "md5"
        priority_id = 1
        type        = "host"
        user        = "all"
    }
}

    登录RDS管理控制台

    登录RDS管理控制台查看RDS PostgreSQL实例的交换机信息。交换机新

清理资源

当您不再需要上述通过Terraform创建或管理的资源时，请运行以下命令以释放资源。关于terraform destroy的更多信息，请参见Terraform常用命令。

terraform destroy

完整示例

说明

当前示例代码支持一键运行，您可以直接运行代码。一键运行

示例代码

variable "region" {
  default = "cn-heyuan"
}

variable "zone_id" {
  default = "cn-heyuan-b"
}

variable "instance_type" {
  default = "pg.n2.2c.2m"
}

provider "alicloud" {
  region = var.region
}

# 创建VPC
resource "alicloud_vpc" "main" {
  vpc_name   = "alicloud"
  cidr_block = "172.16.0.0/16"
}

# 创建交换机
resource "alicloud_vswitch" "main" {
  vpc_id     = alicloud_vpc.main.id
  cidr_block = "172.16.192.0/20"
  zone_id    = var.zone_id
}

# 创建RDS PostgreSQL实例
resource "alicloud_db_instance" "instance" {
  engine               = "PostgreSQL"
  engine_version       = "13.0"
  instance_type        = var.instance_type
  instance_storage     = "30"
  instance_charge_type = "Postpaid"
  vswitch_id           = alicloud_vswitch.main.id
}

# 创建数据库
resource "alicloud_db_database" "db" {
  instance_id = alicloud_db_instance.instance.id
  name        = "tf_database_test"
}

#申请外网地址
resource "alicloud_db_connection" "extranet" {
  instance_id       = alicloud_db_instance.instance.id
  port              = "5432"
  # 修改外网地址
  connection_prefix = "pgtest"
}

如果您想体验更多完整示例，请前往更多完整示例中对应产品的文件夹查看。

上一篇：通过 Terraform 管理 RDS PostgreSQL 只读实例下一篇：通过 Terraform 修改pg_hba.conf文件配置