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

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_redis_instance。

注意

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

概要

• 一个 Google Cloud Redis 实例。

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
alternative_location_id 字符串	仅适用于 STANDARD_HA 层，该层通过在两个区域中配置实例来保护实例免受区域故障的影响。 如果提供，它必须与 [locationId] 中提供的区域不同。
auth_enabled 布尔值	可选。指示是否为实例启用 OSS Redis AUTH。如果设置为“true”，则在实例上启用 AUTH。 默认值为“false”，表示 AUTH 已禁用。 选项 false ← (默认) true
auth_kind 字符串 / 必需	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
authorized_network 字符串	实例连接到的 Google Compute Engine 网络的完整名称。如果未指定，则将使用默认网络。
connect_mode 字符串	Redis 实例的连接模式。 一些有效的选项包括：“DIRECT_PEERING”、“PRIVATE_SERVICE_ACCESS” 默认： "DIRECT_PEERING"
display_name 字符串	实例的任意和可选用户提供名称。
env_type 字符串	指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
labels 字典	表示用户提供元数据的资源标签。
location_id 字符串	将配置实例的区域。如果未提供，服务将为实例选择一个区域。对于 STANDARD_HA 层，实例将在两个区域中创建，以防止区域故障。如果还提供了 [alternativeLocationId]，则它必须与 [locationId] 不同。
memory_size_gb 整数 / 必需	以 GiB 为单位的 Redis 内存大小。
name 字符串 / 必需	实例的 ID 或实例的完全限定标识符。
project 字符串	要使用的 Google Cloud Platform 项目。
redis_configs 字典	Redis 配置参数，根据 https://redis.ac.cn/topics/config。 请查看 Memorystore 文档以了解支持的参数列表： https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs。
redis_version 字符串	Redis 软件的版本。如果未提供，将使用最新支持的版本。请查看顶部链接的 API 文档以了解最新的有效值。
region 字符串 / 必需	实例的 Redis 区域名称。
reserved_ip_range 字符串	为该实例保留的内部地址的 CIDR 范围。如果未提供，服务将选择一个未使用的 /29 块，例如 10.0.0.0/29 或 192.168.0.0/29。范围必须是唯一的，并且与授权网络中现有的子网不重叠。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中 选项 "present" ← (默认) "absent"
tier 字符串	实例的服务层级。必须是以下值之一：- BASIC：独立实例 - STANDARD_HA：高可用主/从实例。 一些有效的选项包括：“BASIC”、“STANDARD_HA” 默认： "BASIC"
transit_encryption_mode 字符串	Redis 实例的 TLS 模式，如果未提供，则实例的 TLS 被禁用。 SERVER_AUTHENTICATION：启用客户端到服务器流量加密，并进行服务器身份验证。 一些有效的选项包括：“SERVER_AUTHENTICATION”、“DISABLED” 默认： "DISABLED"

备注

注意

• API 参考：https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances

• 官方文档：https://cloud.google.com/memorystore/docs/redis/

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

• 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

• 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

• 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

• 只有在未设置 playbook 值时，才会使用环境变量值。

• service_account_email 和 service_account_file 选项是互斥的。

示例

- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instance
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a instance
  google.cloud.gcp_redis_instance:
    name: instance37
    tier: STANDARD_HA
    memory_size_gb: 1
    region: us-central1
    location_id: us-central1-a
    redis_version: REDIS_3_2
    display_name: Ansible Test Instance
    reserved_ip_range: 192.168.0.0/29
    labels:
      my_key: my_val
      other_key: other_val
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键	描述
alternativeLocationId 字符串	仅适用于 STANDARD_HA 层，该层通过在两个区域中配置实例来保护实例免受区域故障的影响。 如果提供，它必须与 [locationId] 中提供的区域不同。 返回：成功
authEnabled 布尔值	可选。指示是否为实例启用 OSS Redis AUTH。如果设置为“true”，则在实例上启用 AUTH。 默认值为“false”，表示 AUTH 已禁用。 返回：成功
authorizedNetwork 字符串	实例连接到的 Google Compute Engine 网络的完整名称。如果未指定，则将使用默认网络。 返回：成功
connectMode 字符串	Redis 实例的连接模式。 返回：成功
createTime 字符串	实例创建的时间，采用 RFC3339 UTC “Zulu” 格式，精确到纳秒。 返回：成功
currentLocationId 字符串	Redis 端点所在的当前区域。 对于基本层级实例，这将始终与用户在创建时提供的 [locationId] 相同。对于标准层级实例，这可以是 [locationId] 或 [alternativeLocationId]，并且在故障转移事件后可能会更改。 返回：成功
displayName 字符串	实例的任意和可选用户提供名称。 返回：成功
host 字符串	客户端用于连接到服务的公开 Redis 端点的主机名或 IP 地址。 返回：成功
labels 字典	表示用户提供元数据的资源标签。 返回：成功
locationId 字符串	将配置实例的区域。如果未提供，服务将为实例选择一个区域。对于 STANDARD_HA 层，实例将在两个区域中创建，以防止区域故障。如果还提供了 [alternativeLocationId]，则它必须与 [locationId] 不同。 返回：成功
memorySizeGb 整数	以 GiB 为单位的 Redis 内存大小。 返回：成功
name 字符串	实例的 ID 或实例的完全限定标识符。 返回：成功
persistenceIamIdentity 字符串	输出仅。导入/导出操作用于将数据传输到/从 Cloud Storage 的 Cloud IAM 身份。格式为“serviceAccount:”。 对于给定的实例，该值可能会随着时间的推移而发生变化，因此应该在每次导入/导出操作之前进行检查。 返回：成功
port 整数	公开 Redis 端点的端口号。 返回：成功
redisConfigs 字典	Redis 配置参数，根据 https://redis.ac.cn/topics/config。 请查看 Memorystore 文档以了解支持的参数列表： https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs。 返回：成功
redisVersion 字符串	Redis 软件的版本。如果未提供，将使用最新支持的版本。请查看顶部链接的 API 文档以了解最新的有效值。 返回：成功
region 字符串	实例的 Redis 区域名称。 返回：成功
reservedIpRange 字符串	为该实例保留的内部地址的 CIDR 范围。如果未提供，服务将选择一个未使用的 /29 块，例如 10.0.0.0/29 或 192.168.0.0/29。范围必须是唯一的，并且与授权网络中现有的子网不重叠。 返回：成功
serverCaCerts 复杂	实例的服务器 CA 证书列表。 返回：成功
cert 字符串	从证书中提取的序列号。 返回：成功
createTime 字符串	证书创建的时间。 返回：成功
expireTime 字符串	证书过期的时间。 返回：成功
serialNumber 字符串	从证书中提取的序列号。 返回：成功
sha1Fingerprint 字符串	证书的 Sha1 指纹。 返回：成功
tier 字符串	实例的服务层级。必须是以下值之一：- BASIC：独立实例 - STANDARD_HA：高可用主/从实例。 返回：成功
transitEncryptionMode 字符串	Redis 实例的 TLS 模式，如果未提供，则实例的 TLS 被禁用。 SERVER_AUTHENTICATION：启用客户端到服务器流量加密，并进行服务器身份验证。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

资源链接

• 问题追踪器
• 主页
• 代码仓库