google.cloud.gcp_compute_instance_group 模块 – 创建 GCP 实例组

注意

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

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

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

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

注意

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

概要 

表示实例组资源。实例组是自管理的，可以包含相同或不同的实例。实例组不使用实例模板。与托管实例组不同，您必须手动创建和添加实例到实例组。

要求 

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description 字符串	此资源的可选描述。创建资源时提供此属性。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
instances 列表 / 元素=字典	与该实例组关联的实例列表。所有实例必须在添加到实例组之前创建。此列表中不存在的所有实例都将从实例组中删除，并且不会被删除。只返回实例的完整标识符。
name 字符串	实例组的名称。名称必须为 1-63 个字符长，并符合 RFC1035。
named_ports 列表 / 元素=字典	为端口号分配名称。例如：{name: “http”, port: 80}。这允许系统通过分配的名称而不是端口号来引用端口。命名端口也可以包含多个端口。例如：[{name: “http”, port: 80},{name: “http”, port: 8080}] 命名端口适用于此实例组中的所有实例。
name 字符串	此命名端口的名称。名称必须为 1-63 个字符长，并符合 RFC1035。
port 整数	端口号，可以是 1 到 65535 之间的数值。
network 字典	实例组中所有实例所属的网络。此字段表示 GCP 中网络资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典；或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_network 任务中，然后将此 network 字段设置为“{{ name-of-resource }}”
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串	实例组所在的区域（对于区域资源）。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`
subnetwork 字典	实例组中所有实例所属的子网。此字段表示 GCP 中子网络资源的链接。它可以通过两种方式指定。首先，您可以使用一个字典，其中键为“selfLink”，值为您的资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_subnetwork 任务中，然后将此子网络字段设置为“{{ name-of-resource }}”
区域字符串 / 必需	实例组所在的区域的引用。

示例 

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

- name: create a instance group
  google.cloud.gcp_compute_instance_group:
    name: test_object
    named_ports:
    - name: ansible
      port: 1234
    network: "{{ network }}"
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

常见的返回值已在此处文档中说明，以下是此模块特有的字段

键	描述
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。返回：成功
description 字符串	此资源的可选描述。创建资源时提供此属性。返回：成功
id 整数	此实例组的唯一标识符。返回：成功
instances 列表 / 元素=字符串	与该实例组关联的实例列表。所有实例必须在添加到实例组之前创建。此列表中不存在的所有实例都将从实例组中删除，并且不会被删除。只返回实例的完整标识符。返回：成功
name 字符串	实例组的名称。名称必须为 1-63 个字符长，并符合 RFC1035。返回：成功
namedPorts 复杂	为端口号分配名称。例如：{name: “http”, port: 80}。这允许系统通过分配的名称而不是端口号来引用端口。命名端口也可以包含多个端口。例如：[{name: “http”, port: 80},{name: “http”, port: 8080}] 命名端口适用于此实例组中的所有实例。返回：成功
name 字符串	此命名端口的名称。名称必须为 1-63 个字符长，并符合 RFC1035。返回：成功
port 整数	端口号，可以是 1 到 65535 之间的数值。返回：成功
network 字典	实例组中所有实例所属的网络。返回：成功
region 字符串	实例组所在的区域（对于区域资源）。返回：成功
subnetwork 字典	实例组中所有实例所属的子网。返回：成功
区域字符串	实例组所在的区域的引用。返回：成功

作者

Google Inc. (@googlecloudplatform)