google.cloud.gcp_compute_region_instance_group_manager module – Creates a GCP RegionInstanceGroupManager

Note

This module is part of the google.cloud collection (version 1.4.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_compute_region_instance_group_manager.

Synopsis

  • Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances.

  • A managed instance group can have up to 1000 VM instances per group.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter

Comments

access_token

string

An OAuth2 access token if credential type is accesstoken.

auth_kind

string / required

The type of credential used.

Choices:

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

auto_healing_policies

list / elements=dictionary

The autohealing policy for this managed instance group .

health_check

string

The URL for the health check that signals autohealing.

initial_delay_sec

integer

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances .

base_instance_name

string / required

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name.

The base instance name must comply with RFC1035.

description

string

An optional description of this resource. Provide this property when you create the resource.

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

instance_template

dictionary / required

The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

This field represents a link to a InstanceTemplate resource in GCP. It can be specified in two ways. First, you can place a dictionary with key ‘selfLink’ and value of your resource’s selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_instance_template task and then set this instance_template field to “{{ name-of-resource }}”

name

string / required

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

named_ports

list / elements=dictionary

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

name

string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port

integer

The port number, which can be a value between 1 and 65535.

project

string

The Google Cloud Platform project to use.

region

string / required

The region the managed instance group resides.

scopes

list / elements=string

Array of scopes to be used

service_account_contents

jsonarg

The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.

state

string

Whether the given object should exist in GCP

Choices:

  • "present" ← (default)

  • "absent"

target_pools

list / elements=dictionary

TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

target_size

integer

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

Examples

- 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-central1
    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 region instance group manager
  google.cloud.gcp_compute_region_instance_group_manager:
    name: test_object
    base_instance_name: test1-child
    region: us-central1
    instance_template: "{{ instancetemplate }}"
    target_size: 3
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

autoHealingPolicies

complex

The autohealing policy for this managed instance group .

Returned: success

healthCheck

string

The URL for the health check that signals autohealing.

Returned: success

initialDelaySec

integer

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances .

Returned: success

baseInstanceName

string

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name.

The base instance name must comply with RFC1035.

Returned: success

creationTimestamp

string

The creation timestamp for this managed instance group in RFC3339 text format.

Returned: success

currentActions

complex

The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

Returned: success

abandoning

integer

The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.

Returned: success

creating

integer

The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.

If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

Returned: success

creatingWithoutRetries

integer

The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group’s targetSize value accordingly.

Returned: success

deleting

integer

The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

Returned: success

none

integer

The number of instances in the managed instance group that are running and have no scheduled actions.

Returned: success

recreating

integer

The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated.

Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.

Returned: success

refreshing

integer

The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.

Returned: success

restarting

integer

The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

Returned: success

description

string

An optional description of this resource. Provide this property when you create the resource.

Returned: success

id

integer

A unique identifier for this resource.

Returned: success

instanceGroup

dictionary

The instance group being managed.

Returned: success

instanceTemplate

dictionary

The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

Returned: success

name

string

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

Returned: success

namedPorts

complex

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

Returned: success

name

string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

Returned: success

port

integer

The port number, which can be a value between 1 and 65535.

Returned: success

region

string

The region the managed instance group resides.

Returned: success

targetPools

list / elements=string

TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

Returned: success

targetSize

integer

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)