google.cloud.gcp_compute_instance_group_manager 模块 – 创建 GCP InstanceGroupManager

注意

此模块是 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

列表 / elements=字典

为与此 Instance Group Manager 互补的 Instance Groups 配置的命名端口。

name

字符串

此命名端口的名称。名称必须为 1-63 个字符长，并符合 RFC1035。

port

整数

端口号，其值可以在 1 到 65535 之间。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / elements=字符串

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

state

字符串

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

选择

  • "present" ←（默认）

  • "absent"

target_pools

列表 / elements=字典

将实例添加到 instanceGroup 字段的目标池资源。目标池会自动应用于托管实例组中的所有实例。

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

字典

正在管理的实例组。

返回: 成功

instanceTemplate

字典

为此托管实例组指定的实例模板。该组使用此模板在托管实例组中创建所有新实例。

返回: 成功

name

字符串

托管实例组的名称。名称必须为 1-63 个字符长，并符合 RFC1035。

返回: 成功

namedPorts

复杂类型

为与此 Instance Group Manager 互补的 Instance Groups 配置的命名端口。

返回: 成功

name

字符串

此命名端口的名称。名称必须为 1-63 个字符长，并符合 RFC1035。

返回: 成功

port

整数

端口号，其值可以在 1 到 65535 之间。

返回: 成功

region

字符串

此托管实例组所在的区域（对于区域资源）。

返回: 成功

targetPools

列表 / elements=字符串

将实例添加到 instanceGroup 字段的目标池资源。目标池会自动应用于托管实例组中的所有实例。

返回: 成功

targetSize

整数

此托管实例组的目标运行实例数。删除或放弃实例会减少此数字。调整组大小会更改此数字。

返回: 成功

zone

字符串

托管实例组所在的区域。

返回: 成功

作者

  • Google Inc. (@googlecloudplatform)