google.cloud.gcp_compute_instance_group module – Creates a GCP InstanceGroup
Note
This module is part of the google.cloud collection (version 1.1.3).
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_instance_group.
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 |
Comments |
|---|---|
The type of credential used. Choices:
|
|
An optional description of this resource. Provide this property when you create the resource. |
|
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. |
|
The list of instances associated with this InstanceGroup. All instances must be created before being added to an InstanceGroup. All instances not in this list will be removed from the InstanceGroup and will not be deleted. Only the full identifier of the instance will be returned. |
|
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. |
|
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. |
|
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. |
|
The port number, which can be a value between 1 and 65535. |
|
The network to which all instances in the instance group belong. This field represents a link to a Network 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_network task and then set this network field to “{{ name-of-resource }}” |
|
The Google Cloud Platform project to use. |
|
The region where the instance group is located (for regional resources). |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Whether the given object should exist in GCP Choices:
|
|
The subnetwork to which all instances in the instance group belong. This field represents a link to a Subnetwork 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_subnetwork task and then set this subnetwork field to “{{ name-of-resource }}” |
|
A reference to the zone where the instance group resides. |
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Creation timestamp in RFC3339 text format. Returned: success |
|
An optional description of this resource. Provide this property when you create the resource. Returned: success |
|
A unique identifier for this instance group. Returned: success |
|
The list of instances associated with this InstanceGroup. All instances must be created before being added to an InstanceGroup. All instances not in this list will be removed from the InstanceGroup and will not be deleted. Only the full identifier of the instance will be returned. Returned: success |
|
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. Returned: 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. Returned: success |
|
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. Returned: success |
|
The port number, which can be a value between 1 and 65535. Returned: success |
|
The network to which all instances in the instance group belong. Returned: success |
|
The region where the instance group is located (for regional resources). Returned: success |
|
The subnetwork to which all instances in the instance group belong. Returned: success |
|
A reference to the zone where the instance group resides. Returned: success |