google.cloud.gcp_compute_instance_group_manager 模块 – 创建 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_manager。

注意

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

概要 

使用您在请求中指定的信息创建托管实例组。创建组后，它会安排一个操作，使用指定的实例模板在组中创建实例。即使组中的实例尚未创建，此操作在创建组时也会标记为已完成。您必须单独验证各个实例的状态。
每个托管实例组最多可以包含 1000 个虚拟机实例。

要求 

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

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
base_instance_name 字符串 / 必需	此组中实例要使用的基本实例名称。该值必须为 1-58 个字符。通过将连字符和随机的四个字符字符串附加到基本实例名称来命名实例。基本实例名称必须符合 RFC1035。
description 字符串	此资源的可选描述。创建资源时提供此属性。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
instance_template 字典 / 必需	为此托管实例组指定的实例模板。该组使用此模板在托管实例组中创建所有新实例。此字段表示 GCP 中 InstanceTemplate 资源的链接。可以通过两种方式指定它。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_instance_template 任务，然后将此 instance_template 字段设置为“{{ name-of-resource }}”
name 字符串 / 必需	托管实例组的名称。名称必须为 1-63 个字符长，并符合 RFC1035。
named_ports 列表 / 元素=字典	为此实例组管理器补充的实例组配置的命名端口。
name 字符串	此命名端口的名称。名称必须为 1-63 个字符长，并符合 RFC1035。
port 整数	端口号，可以是 1 到 65535 之间的数值。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`
target_pools 列表 / 元素=字典	将 instanceGroup 字段中的实例添加到其中的 TargetPool 资源。目标池会自动应用于托管实例组中的所有实例。
target_size 整数	此托管实例组正在运行的实例的目标数量。删除或放弃实例会减少此数量。调整组大小会更改此数量。
zone 字符串 / 必需	托管实例组所在的区域。

示例 

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

- name: create a address
  google.cloud.gcp_compute_address:
    name: address-instancetemplate
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a instance template
  google.cloud.gcp_compute_instance_template:
    name: "{{ resource_name }}"
    properties:
      disks:
      - auto_delete: 'true'
        boot: 'true'
        initialize_params:
          source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
      machine_type: n1-standard-1
      network_interfaces:
      - network: "{{ network }}"
        access_configs:
        - name: test-config
          type: ONE_TO_ONE_NAT
          nat_ip: "{{ address }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancetemplate

- name: create a instance group manager
  google.cloud.gcp_compute_instance_group_manager:
    name: test_object
    base_instance_name: test1-child
    instance_template: "{{ instancetemplate }}"
    target_size: 3
    zone: us-west1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

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

键	描述
baseInstanceName 字符串	此组中实例要使用的基本实例名称。该值必须为 1-58 个字符。通过将连字符和随机的四个字符字符串附加到基本实例名称来命名实例。基本实例名称必须符合 RFC1035。返回：成功
creationTimestamp 字符串	此托管实例组的创建时间戳，以 RFC3339 文本格式表示。返回：成功
currentActions 复杂	实例操作列表以及此托管实例组中为每个操作计划的实例数量。返回：成功
abandoning 整数	计划放弃的托管实例组中实例的总数。放弃实例会将其从托管实例组中删除，而不会将其删除。返回：成功
creating 整数	托管实例组中计划创建或当前正在创建的实例数。如果该组未能创建任何这些实例，它会尝试再次创建，直到成功创建实例为止。如果您已禁用创建重试，则不会填充此字段；而是会填充 `creatingWithoutRetries` 字段。返回：成功
creatingWithoutRetries 整数	托管实例组将尝试创建的实例数量。该组仅尝试创建每个实例一次。如果该组未能创建任何这些实例，它将相应地减少组的 `targetSize` 值。返回：成功
deleting 整数	托管实例组中已计划删除或正在删除的实例数量。返回：成功
none 整数	托管实例组中正在运行且没有任何计划操作的实例数量。返回：成功
recreating 整数	托管实例组中已计划重新创建或正在重新创建的实例数量。重新创建实例会删除现有的根永久性磁盘，并根据实例模板中定义的镜像创建一个新磁盘。返回：成功
refreshing 整数	托管实例组中正在使用不需要重启或重新创建操作的属性重新配置的实例数量。例如，为实例设置或删除目标池。返回：成功
restarting 整数	托管实例组中已计划重启或正在重启的实例数量。返回：成功
description 字符串	此资源的可选描述。创建资源时提供此属性。返回：成功
id 整数	此资源的唯一标识符。返回：成功
instanceGroup dictionary	正在管理的实例组。返回：成功
instanceTemplate dictionary	为此托管实例组指定的实例模板。该组使用此模板在托管实例组中创建所有新实例。返回：成功
name 字符串	托管实例组的名称。名称必须为 1-63 个字符长，并符合 RFC1035。返回：成功
namedPorts 复杂	为此实例组管理器补充的实例组配置的命名端口。返回：成功
name 字符串	此命名端口的名称。名称必须为 1-63 个字符长，并符合 RFC1035。返回：成功
port 整数	端口号，可以是 1 到 65535 之间的数值。返回：成功
region 字符串	此托管实例组所在的区域（对于区域资源）。返回：成功
targetPools 列表 / 元素=字符串	将 instanceGroup 字段中的实例添加到其中的 TargetPool 资源。目标池会自动应用于托管实例组中的所有实例。返回：成功
targetSize 整数	此托管实例组正在运行的实例的目标数量。删除或放弃实例会减少此数量。调整组大小会更改此数量。返回：成功
zone 字符串	托管实例组所在的区域。返回：成功

作者

Google Inc. (@googlecloudplatform)