google.cloud.gcp_compute_node_group – Creates a GCP NodeGroup

Note

This plugin is part of the google.cloud collection (version 1.0.1).

To install it use: ansible-galaxy collection install google.cloud.

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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Represents a NodeGroup resource to manage a group of sole-tenant nodes.

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 string / required	application machineaccount serviceaccount	The type of credential used.
description string		An optional textual description of 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.
name string		Name of the resource.
node_template dictionary / required		The URL of the node template to which this node group belongs. This field represents a link to a NodeTemplate 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_node_template task and then set this node_template field to "Template:Name-of-resource"
project string		The Google Cloud Platform project to use.
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.
size integer / required		The total number of nodes in the node group.
state string	present ← absent	Whether the given object should exist in GCP
zone string / required		Zone where this node group is located .

Notes

Note

API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups
Sole-Tenant Nodes: https://cloud.google.com/compute/docs/nodes/
for authentication, you can set service_account_file using the gcp_service_account_file env variable.
for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS 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 node template
  google.cloud.gcp_compute_node_template:
    name: "{{ resource_name }}"
    region: us-central1
    node_type: n1-node-96-624
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: node_template

- name: create a node group
  google.cloud.gcp_compute_node_group:
    name: test_object
    zone: us-central1-a
    description: example group for ansible
    size: 1
    node_template: "{{ node_template }}"
    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	Returned	Description
creationTimestamp string	success	Creation timestamp in RFC3339 text format.
description string	success	An optional textual description of the resource.
name string	success	Name of the resource.
nodeTemplate dictionary	success	The URL of the node template to which this node group belongs.
size integer	success	The total number of nodes in the node group.
zone string	success	Zone where this node group is located .

Authors

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_node_group_module.html