W3cubDocs

/Ansible 2.11

google.cloud.gcp_compute_node_group_info – Gather info for GCP NodeGroup

Note

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

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

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

Synopsis

  • Gather info for GCP NodeGroup

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
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
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.
filters
list / elements=string
A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters.
Each additional filter in the list will act be added as an AND condition (filter1 and filter2) .
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.
zone
string / required
Zone where this node group is located .

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_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: get info on a node group
  gcp_compute_node_group_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

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

Key Returned Description
resources
complex
always
List of resources

autoscalingPolicy
complex
success
If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups.

maxNodes
integer
success
Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.

minNodes
integer
success
Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.

mode
string
success
The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler.
- ON: Enables scaling in and scaling out.
- ONLY_SCALE_OUT: Enables only scaling out.
You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers.

creationTimestamp
string
success
Creation timestamp in RFC3339 text format.

description
string
success
An optional textual description of the resource.

maintenancePolicy
string
success
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT.

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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_node_group_info_module.html