gcp_compute_instance_group – Creates a GCP InstanceGroup

New in version 2.6.

Synopsis

  • Represents an Instance Group resource. Instance groups are self-managed and can contain identical or different instances. Instance groups do not use an instance template. Unlike managed instance groups, you must create and add instances to an instance group manually.

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 Choices/Defaults Comments
auth_kind
- / required
    Choices:
  • machineaccount
  • serviceaccount
  • application
The type of credential used.
description
-
An optional description of this resource. Provide this property when you create the resource.
name
-
The name of the instance group.
The name must be 1-63 characters long, and comply with RFC1035.
named_ports
-
Assigns a name to a port number.
For example: {name: "http", port: 80}.
This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports.
For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
name
-
The name for this named port.
The name must be 1-63 characters long, and comply with RFC1035.
port
-
The port number, which can be a value between 1 and 65535.
network
-
The network to which all instances in the instance group belong.
project
-
Default:
null
The Google Cloud Platform project to use.
region
-
The region where the instance group is located (for regional resources).
scopes
-
Array of scopes to be used.
service_account_email
-
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
-
The path of a Service Account JSON file if serviceaccount is selected as type.
state
-
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
subnetwork
-
The subnetwork to which all instances in the instance group belong.
zone
- / required
A reference to the zone where the instance group resides.

Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a network
  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
  gcp_compute_instance_group:
      name: "test_object"
      named_ports:
      - name: ansible
        port: 1234
      network: "{{ network }}"
      zone: us-central1-a
      project: "test_project"
      auth_kind: "service_account"
      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 Returned Description
creation_timestamp
string
 success
Creation timestamp in RFC3339 text format.
description
string
 success
An optional description of this resource. Provide this property when you create the resource.
id
integer
 success
A unique identifier for this instance group.
name
string
 success
The name of the instance group.
The name must be 1-63 characters long, and comply with RFC1035.
named_ports
complex
 success
Assigns a name to a port number.
For example: {name: "http", port: 80}.
This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports.
For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
  name
string
 success
The name for this named port.
The name must be 1-63 characters long, and comply with RFC1035.
  port
integer
 success
The port number, which can be a value between 1 and 65535.
network
dictionary
 success
The network to which all instances in the instance group belong.
region
string
 success
The region where the instance group is located (for regional resources).
subnetwork
dictionary
 success
The subnetwork to which all instances in the instance group belong.
zone
string
 success
A reference to the zone where the instance group resides.


Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.