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 |
| 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 | A reference to Network resource. | ||
project | The Google Cloud Platform project to use. | ||
region | A reference to Region resource. | ||
scopes required | 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 required |
| Whether the given object should exist in GCP | |
subnetwork | A reference to Subnetwork resource. | ||
zone required | A reference to Zone resource. |
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 }}" scopes: - https://www.googleapis.com/auth/compute state: present register: network - name: create a instance group gcp_compute_instance_group: name: testObject named_ports: - name: ansible port: 1234 network: "{{ network }}" zone: 'us-central1-a' project: testProject auth_kind: service_account service_account_file: /tmp/auth.pem scopes: - https://www.googleapis.com/auth/compute state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
creation_timestamp str | success | Creation timestamp in RFC3339 text format. | |
description str | success | An optional description of this resource. Provide this property when you create the resource. | |
id int | success | A unique identifier for this instance group. | |
name str | 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 str | success | The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. | |
port int | success | The port number, which can be a value between 1 and 65535. | |
network dict | success | A reference to Network resource. | |
region str | success | A reference to Region resource. | |
subnetwork dict | success | A reference to Subnetwork resource. | |
zone str | success | A reference to Zone resource. |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/gcp_compute_instance_group_module.html