google.cloud.gcp_sql_instance 模块 – 创建 GCP 实例

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 需求。

要在 playbook 中使用它，请指定：google.cloud.gcp_sql_instance。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

概要

  • 表示一个 Cloud SQL 实例。Cloud SQL 实例是在 Google 云中托管的 SQL 数据库。Instances 资源提供了常用配置和管理任务的方法。

需求

执行此模块的主机需要以下需求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必填

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

backend_type

字符串

* FIRST_GEN：第一代实例。仅限 MySQL。

* SECOND_GEN：第二代实例或 PostgreSQL 实例。

* EXTERNAL：Google 不管理的数据库服务器。

一些有效的选项包括：“FIRST_GEN”、“SECOND_GEN”、“EXTERNAL”

connection_name

字符串

连接字符串中使用的 Cloud SQL 实例的连接名称。

database_version

字符串

数据库引擎类型和版本。对于第一代实例，可以是 MYSQL_5_5 或 MYSQL_5_6。对于第二代实例，可以是 MYSQL_5_6 或 MYSQL_5_7。默认为 MYSQL_5_6。

PostgreSQL 实例：POSTGRES_9_6 实例创建后无法更改 databaseVersion 属性。

一些有效的选项包括：“MYSQL_5_5”、“MYSQL_5_6”、“MYSQL_5_7”、“POSTGRES_9_6”

disk_encryption_configuration

字典

磁盘加密设置。

kms_key_name

字符串

用于加密 Cloud SQL 实例的 KMS 密钥。

disk_encryption_status

字典

磁盘加密状态。

kms_key_version_name

字符串

用于加密 Cloud SQL 实例的 KMS 密钥版本。

env_type

字符串

指定您在此模块中运行的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

failover_replica

字典

故障转移副本的名称和状态。此属性仅适用于第二代实例。

name

字符串

故障转移副本的名称。如果在实例创建时指定，则会为实例创建故障转移副本。名称不包含项目 ID。此属性仅适用于第二代实例。

instance_type

字符串

实例类型。可以是以下之一。

* CLOUD_SQL_INSTANCE：不是从主实例复制的 Cloud SQL 实例。

* ON_PREMISES_INSTANCE：在客户场所运行的实例。

* READ_REPLICA_INSTANCE：配置为只读副本的 Cloud SQL 实例。

一些有效的选项包括：“CLOUD_SQL_INSTANCE”、“ON_PREMISES_INSTANCE”、“READ_REPLICA_INSTANCE”

ipv6_address

字符串

分配给实例的 IPv6 地址。此属性仅适用于第一代实例。

master_instance_name

字符串

将在复制设置中充当主实例的实例名称。

max_disk_size

整数

实例的最大磁盘大小（以字节为单位）。

name

字符串 / 必填

Cloud SQL 实例的名称。这不包含项目 ID。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串

地理区域。根据实例类型（第一代或第二代/PostgreSQL）默认为 us-central 或 us-central1。

replica_configuration

字典

特定于故障转移副本和只读副本的配置。

failover_target

布尔值

指定副本是否为故障转移目标。如果该字段设置为 true，则副本将被指定为故障转移副本。

如果主实例发生故障，副本实例将被提升为新的主实例。

只能将一个副本指定为故障转移目标，并且副本必须与主实例位于不同的区域。

选项

  • false

  • true

mysql_replica_configuration

字典

从本地 MySQL 主实例复制时的 MySQL 特定配置。复制配置信息（例如用户名、密码、证书和密钥）不会存储在实例元数据中。配置信息仅用于设置复制连接，并由 MySQL 存储在一个名为 master.info 的文件中，该文件位于数据目录中。

ca_certificate

字符串

受信任的 CA 的 x509 证书的 PEM 表示形式。

client_certificate

字符串

副本的 x509 证书的 PEM 表示形式。

client_key

字符串

副本私钥的 PEM 表示形式。相应的公钥编码在客户端的证书中。

connect_retry_interval

整数

连接重试之间等待的秒数。MySQL 的默认值为 60 秒。

dump_file_path

字符串

Google Cloud Storage 中 SQL 转储文件的路径，从中创建副本实例。URI 采用 gs://bucketName/fileName 的形式。也支持压缩的 gzip 文件 (.gz)。转储应包含应从其开始复制的 binlog 坐标。这可以通过在使用 mysqldump 时将 –master-data 设置为 1 来实现。

master_heartbeat_period

整数

复制心跳之间的间隔（毫秒）。

密码

字符串

复制连接的密码。

ssl_cipher

字符串

用于SSL加密的允许密码列表。

用户名

字符串

复制连接的用户名。

verify_server_certificate

布尔值

是否检查主服务器在SSL握手期间发送的证书中的通用名称值。

选项

  • false

  • true

replica_names

列表 / 元素=字符串

实例的副本。

service_account_email_address

字符串

分配给实例的服务帐号电子邮件地址。此属性仅适用于第二代实例。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐号JSON文件的内容，可以是字典，也可以是表示它的JSON字符串。

service_account_email

字符串

如果选择machineaccount并且用户不希望使用默认电子邮件，则可以选择的服务帐号电子邮件地址。

service_account_file

路径

如果选择serviceaccount作为类型，则服务帐号JSON文件的路径。

settings

字典

用户设置。

availability_type

字符串

availabilityType 定义您的 postgres 实例是运行在区域内还是跨区域。

一些有效的选项包括：“ZONAL”、“REGIONAL”

backup_configuration

字典

实例的每日备份配置。

binary_log_enabled

布尔值

是否启用二进制日志。如果禁用备份配置，则也必须禁用二进制日志。仅限 MySQL。

选项

  • false

  • true

enabled

布尔值

为您的实例启用自动备份。

选项

  • false

  • true

start_time

字符串

以UTC（HH:MM）定义备份开始时间。

database_flags

列表 / 元素=字典

启动时传递给实例的数据库标志。

name

字符串

标志的名称。这些标志在实例启动时传递，因此包括 MySQL 的服务器选项和系统变量。标志应使用下划线而不是连字符指定。

value

字符串

标志的值。布尔值应设置为 on 表示真，设置为 off 表示假。如果标志不接受值，则必须省略此字段。

ip_configuration

字典

IP 管理设置。这允许启用或禁用实例 IP 并管理哪些外部网络可以连接到实例。第二代实例的 IPv4 地址不能禁用。

authorized_networks

列表 / 元素=字典

允许使用 IP 连接到实例的外部网络列表。采用 CIDR 表示法，也称为“斜线”表示法（例如 192.168.100.0/24）。

expiration_time

字符串

此访问控制条目以 RFC 3339 格式过期的时刻，例如 2012-11-15T16:19:00.094Z。

name

字符串

用于标识此条目的可选标签。

value

字符串

访问控制列表的白名单值。例如，要授予来自外部 IP（IPv4 或 IPv6）地址或子网的客户端的访问权限，请在此处使用该地址或子网。

ipv4_enabled

布尔值

实例是否应分配 IP 地址。

选项

  • false

  • true

private_network

字符串

Cloud SQL 实例可用于专用 IP 的 VPC 网络的资源链接（例如 /projects/myProject/global/networks/default）

require_ssl

布尔值

mysqld 是否应默认为通过 IP 连接的用户的“REQUIRE X509”。

选项

  • false

  • true

tier

字符串

此实例的分层结构或机器类型，例如 db-n1-standard-1。对于 MySQL 实例，此字段确定实例是第二代（推荐）还是第一代。

user_labels

字典

用户提供的标签，表示为字典，其中每个标签都是一个键值对。

state

字符串

给定对象是否应存在于 GCP 中

选项

  • "present" ← (默认)

  • "absent"

示例

- name: create a instance
  google.cloud.gcp_sql_instance:
    name: "{{resource_name}}-2"
    settings:
      ip_configuration:
        authorized_networks:
        - name: google dns server
          value: 8.8.8.8/32
      tier: db-n1-standard-1
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常用返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

backendType

字符串

* FIRST_GEN：第一代实例。仅限 MySQL。

* SECOND_GEN：第二代实例或 PostgreSQL 实例。

* EXTERNAL：Google 不管理的数据库服务器。

返回：成功

connectionName

字符串

连接字符串中使用的 Cloud SQL 实例的连接名称。

返回：成功

databaseVersion

字符串

数据库引擎类型和版本。对于第一代实例，可以是 MYSQL_5_5 或 MYSQL_5_6。对于第二代实例，可以是 MYSQL_5_6 或 MYSQL_5_7。默认为 MYSQL_5_6。

PostgreSQL 实例：POSTGRES_9_6 实例创建后无法更改 databaseVersion 属性。

返回：成功

diskEncryptionConfiguration

复杂

磁盘加密设置。

返回：成功

kmsKeyName

字符串

用于加密 Cloud SQL 实例的 KMS 密钥。

返回：成功

diskEncryptionStatus

复杂

磁盘加密状态。

返回：成功

kmsKeyVersionName

字符串

用于加密 Cloud SQL 实例的 KMS 密钥版本。

返回：成功

failoverReplica

复杂

故障转移副本的名称和状态。此属性仅适用于第二代实例。

返回：成功

可用

布尔值

故障转移副本的可用性状态。false 状态表示故障转移副本不同步。只有在状态为 true 时，主服务器才能故障转移到故障转移副本。

返回：成功

name

字符串

故障转移副本的名称。如果在实例创建时指定，则会为实例创建故障转移副本。名称不包含项目 ID。此属性仅适用于第二代实例。

返回：成功

实例当前从中提供服务的 Compute Engine 区域。如果实例已故障转移到其辅助区域，则此值可能与创建实例时指定的区域不同。

字符串

gceZone

返回：成功

instanceType

字符串

实例类型。可以是以下之一。

* CLOUD_SQL_INSTANCE：不是从主实例复制的 Cloud SQL 实例。

* ON_PREMISES_INSTANCE：在客户场所运行的实例。

* READ_REPLICA_INSTANCE：配置为只读副本的 Cloud SQL 实例。

返回：成功

ipAddresses

复杂

分配给实例的 IP 地址。

返回：成功

ipAddress

字符串

分配的 IP 地址。

返回：成功

timeToRetire

字符串

此 IP 预计退役的到期时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。此字段仅在计划退役 IP 时可用。

返回：成功

type

字符串

此 IP 地址的类型。PRIMARY 地址是可以接受传入连接的地址。如果支持，OUTGOING 地址是实例发起的连接的源地址。

返回：成功

ipv6Address

字符串

分配给实例的 IPv6 地址。此属性仅适用于第一代实例。

返回：成功

masterInstanceName

字符串

将在复制设置中充当主实例的实例名称。

返回：成功

maxDiskSize

整数

实例的最大磁盘大小（以字节为单位）。

返回：成功

name

字符串

Cloud SQL 实例的名称。这不包含项目 ID。

返回：成功

region

字符串

地理区域。根据实例类型（第一代或第二代/PostgreSQL）默认为 us-central 或 us-central1。

返回：成功

replicaConfiguration

复杂

特定于故障转移副本和只读副本的配置。

返回：成功

failoverTarget

布尔值

指定副本是否为故障转移目标。如果该字段设置为 true，则副本将被指定为故障转移副本。

如果主实例发生故障，副本实例将被提升为新的主实例。

只能将一个副本指定为故障转移目标，并且副本必须与主实例位于不同的区域。

返回：成功

mysqlReplicaConfiguration

复杂

从本地 MySQL 主实例复制时的 MySQL 特定配置。复制配置信息（例如用户名、密码、证书和密钥）不会存储在实例元数据中。配置信息仅用于设置复制连接，并由 MySQL 存储在一个名为 master.info 的文件中，该文件位于数据目录中。

返回：成功

caCertificate

字符串

受信任的 CA 的 x509 证书的 PEM 表示形式。

返回：成功

clientCertificate

字符串

副本的 x509 证书的 PEM 表示形式。

返回：成功

clientKey

字符串

副本私钥的 PEM 表示形式。相应的公钥编码在客户端的证书中。

返回：成功

connectRetryInterval

整数

连接重试之间等待的秒数。MySQL 的默认值为 60 秒。

返回：成功

dumpFilePath

字符串

Google Cloud Storage 中 SQL 转储文件的路径，从中创建副本实例。URI 采用 gs://bucketName/fileName 的形式。也支持压缩的 gzip 文件 (.gz)。转储应包含应从其开始复制的 binlog 坐标。这可以通过在使用 mysqldump 时将 –master-data 设置为 1 来实现。

返回：成功

masterHeartbeatPeriod

整数

复制心跳之间的间隔（毫秒）。

返回：成功

密码

字符串

复制连接的密码。

返回：成功

sslCipher

字符串

用于SSL加密的允许密码列表。

返回：成功

用户名

字符串

复制连接的用户名。

返回：成功

verifyServerCertificate

布尔值

是否检查主服务器在SSL握手期间发送的证书中的通用名称值。

返回：成功

replicaNames

列表 / 元素=字符串

实例的副本。

返回：成功

serviceAccountEmailAddress

字符串

分配给实例的服务帐号电子邮件地址。此属性仅适用于第二代实例。

返回：成功

serverCaCert

复杂

SSL 配置。

返回：成功

cert

字符串

X.509 证书的 PEM 表示。

返回：成功

certSerialNumber

字符串

从证书中提取的序列号。

返回：成功

commonName

字符串

用户提供的名称。限制为 [a-zA-Z.-_ ]+。

返回：成功

createTime

字符串

证书创建的时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。

返回：成功

expirationTime

字符串

证书过期的时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。

返回：成功

sha1Fingerprint

字符串

证书的 SHA-1 指纹。

返回：成功

settings

复杂

用户设置。

返回：成功

availabilityType

字符串

availabilityType 定义您的 postgres 实例是运行在区域内还是跨区域。

返回：成功

backupConfiguration

复杂

实例的每日备份配置。

返回：成功

binaryLogEnabled

布尔值

是否启用二进制日志。如果禁用备份配置，则也必须禁用二进制日志。仅限 MySQL。

返回：成功

enabled

布尔值

为您的实例启用自动备份。

返回：成功

startTime

字符串

以UTC（HH:MM）定义备份开始时间。

返回：成功

databaseFlags

复杂

启动时传递给实例的数据库标志。

返回：成功

name

字符串

标志的名称。这些标志在实例启动时传递，因此包括 MySQL 的服务器选项和系统变量。标志应使用下划线而不是连字符指定。

返回：成功

value

字符串

标志的值。布尔值应设置为 on 表示真，设置为 off 表示假。如果标志不接受值，则必须省略此字段。

返回：成功

ipConfiguration

复杂

IP 管理设置。这允许启用或禁用实例 IP 并管理哪些外部网络可以连接到实例。第二代实例的 IPv4 地址不能禁用。

返回：成功

authorizedNetworks

复杂

允许使用 IP 连接到实例的外部网络列表。采用 CIDR 表示法，也称为“斜线”表示法（例如 192.168.100.0/24）。

返回：成功

expirationTime

字符串

此访问控制条目以 RFC 3339 格式过期的时刻，例如 2012-11-15T16:19:00.094Z。

返回：成功

name

字符串

用于标识此条目的可选标签。

返回：成功

value

字符串

访问控制列表的白名单值。例如，要授予来自外部 IP（IPv4 或 IPv6）地址或子网的客户端的访问权限，请在此处使用该地址或子网。

返回：成功

ipv4Enabled

布尔值

实例是否应分配 IP 地址。

返回：成功

requireSsl

布尔值

mysqld 是否应默认为通过 IP 连接的用户的“REQUIRE X509”。

返回：成功

settingsVersion

整数

实例设置的版本。这是更新方法的必填字段，用于确保正确处理并发更新。

在更新期间，请使用此实例的最新 settingsVersion 值，不要尝试更新此值。

返回：成功

tier

字符串

此实例的分层结构或机器类型，例如 db-n1-standard-1。对于 MySQL 实例，此字段确定实例是第二代（推荐）还是第一代。

返回：成功

userLabels

字典

用户提供的标签，表示为字典，其中每个标签都是一个键值对。

返回：成功

state

字符串

数据库实例的当前服务状态。

返回：成功

作者

  • 谷歌公司（@googlecloudplatform）