google.cloud.gcp_container_cluster_info – Gather info for GCP Cluster

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_container_cluster_info.

Synopsis

  • Gather info for GCP Cluster

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.
location
string / required
The location where the cluster is deployed.

aliases: region, zone
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.

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 cluster
  gcp_container_cluster_info:
    location: us-central1-a
    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
 
addonsConfig
complex
success
Configurations for the various addons available to run in the cluster.
   
horizontalPodAutoscaling
complex
success
Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
     
disabled
boolean
success
Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
   
httpLoadBalancing
complex
success
Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
     
disabled
boolean
success
Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
   
networkPolicyConfig
complex
success
Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
     
disabled
boolean
success
Whether NetworkPolicy is enabled for this cluster.
 
binaryAuthorization
complex
success
Configuration for the BinaryAuthorization feature.
   
enabled
boolean
success
If enabled, all container images will be validated by Binary Authorization.
 
clusterIpv4Cidr
string
success
The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.
 
conditions
complex
success
Which conditions caused the current cluster state.
   
code
string
success
Machine-friendly representation of the condition.
   
message
string
success
Human-friendly representation of the condition.
 
createTime
string
success
The time the cluster was created, in RFC3339 text format.
 
currentMasterVersion
string
success
The current software version of the master endpoint.
 
currentNodeCount
integer
success
The number of nodes currently in the cluster.
 
currentNodeVersion
string
success
The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
 
databaseEncryption
complex
success
Configuration of etcd encryption.
   
keyName
string
success
Name of CloudKMS key to use for the encryption of secrets in etcd. Ex.
`projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key` .
   
state
string
success
Denotes the state of etcd encryption.
 
defaultMaxPodsConstraint
complex
success
The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster.
Only honored if cluster created with IP Alias support.
   
maxPodsPerNode
string
success
Constraint enforced on the max num of pods per node.
 
description
string
success
An optional description of this cluster.
 
enableKubernetesAlpha
boolean
success
Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.
 
enableTpu
boolean
success
(Optional) Whether to enable Cloud TPU resources in this cluster.
 
endpoint
string
success
The IP address of this cluster's master endpoint.
The endpoint can be accessed from the internet at https://username:password@endpoint/ See the masterAuth property of this resource for username and password information.
 
expireTime
string
success
The time the cluster will be automatically deleted in RFC3339 text format.
 
initialClusterVersion
string
success
The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
 
initialNodeCount
integer
success
The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "nodePool" object, since this configuration (along with the "nodeConfig") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a nodePool at the same time.
This field has been deprecated. Please use nodePool.initial_node_count instead.
 
ipAllocationPolicy
complex
success
Configuration for controlling how IPs are allocated in the cluster.
   
clusterIpv4CidrBlock
string
success
The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank.
This field is only applicable when useIpAliases is true.
Set to blank to have a range chosen with the default size.
Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.
   
clusterSecondaryRangeName
string
success
The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses.
This must be an existing secondary range associated with the cluster subnetwork .
   
createSubnetwork
boolean
success
Whether a new subnetwork will be created automatically for the cluster.
   
nodeIpv4CidrBlock
string
success
The IP address range of the instance IPs in this cluster.
This is applicable only if createSubnetwork is true.
Set to blank to have a range chosen with the default size.
Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.
   
servicesIpv4CidrBlock
string
success
The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.
This field is only applicable when useIpAliases is true.
Set to blank to have a range chosen with the default size.
Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.
   
servicesSecondaryRangeName
string
success
The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.
   
subnetworkName
string
success
A custom subnetwork name to be used if createSubnetwork is true.
If this field is empty, then an automatic name will be chosen for the new subnetwork.
   
tpuIpv4CidrBlock
string
success
The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size.
This field is only applicable when useIpAliases is true.
If unspecified, the range will use the default size.
Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.
   
useIpAliases
boolean
success
Whether alias IPs will be used for pod IPs in the cluster.
 
labelFingerprint
string
success
The fingerprint of the set of labels for this cluster.
 
legacyAbac
complex
success
Configuration for the legacy ABAC authorization mode.
   
enabled
boolean
success
Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
 
location
string
success
The location where the cluster is deployed.
 
locations
list / elements=string
success
The list of Google Compute Engine zones in which the cluster's nodes should be located.
 
loggingService
string
success
The logging service the cluster should use to write logs. Currently available options: logging.googleapis.com - the Google Cloud Logging service.
none - no logs will be exported from the cluster.
if left as an empty string,logging.googleapis.com will be used.
 
masterAuth
complex
success
The authentication information for accessing the master endpoint.
   
clientCertificate
string
success
Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
   
clientCertificateConfig
complex
success
Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
     
issueClientCertificate
boolean
success
Issue a client certificate.
   
clientKey
string
success
Base64-encoded private key used by clients to authenticate to the cluster endpoint.
   
clusterCaCertificate
string
success
Base64-encoded public certificate that is the root of trust for the cluster.
   
password
string
success
The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password with a minimum of 16 characters.
   
username
string
success
The username to use for HTTP basic authentication to the master endpoint.
 
masterAuthorizedNetworksConfig
complex
success
Configuration for controlling how IPs are allocated in the cluster.
   
cidrBlocks
complex
success
Define up to 50 external networks that could access Kubernetes master through HTTPS.
     
cidrBlock
string
success
Block specified in CIDR notation.
     
displayName
string
success
Optional field used to identify cidr blocks.
   
enabled
boolean
success
Whether or not master authorized networks is enabled.
 
monitoringService
string
success
The monitoring service the cluster should use to write metrics.
Currently available options: monitoring.googleapis.com - the Google Cloud Monitoring service.
none - no metrics will be exported from the cluster.
if left as an empty string, monitoring.googleapis.com will be used.
 
name
string
success
The name of this cluster. The name must be unique within this project and location, and can be up to 40 characters. Must be Lowercase letters, numbers, and hyphens only. Must start with a letter. Must end with a number or a letter.
 
network
string
success
The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.
 
networkConfig
complex
success
Network configurations .
   
defaultSnatStatus
boolean
success
Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled.
   
enableIntraNodeVisibility
boolean
success
Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
   
network
string
success
The relative name of the Google Compute Engine network to which the cluster is connected.
Example: projects/my-project/global/networks/my-network .
   
subnetwork
string
success
The relative name of the Google Compute Engine subnetwork to which the cluster is connected.
Example: projects/my-project/regions/us-central1/subnetworks/my-subnet .
 
networkPolicy
complex
success
Configuration options for the NetworkPolicy feature.
   
enabled
boolean
success
Whether network policy is enabled on the cluster.
   
provider
string
success
The selected network policy provider.
 
nodeConfig
complex
success
Parameters used in creating the cluster's nodes.
For requests, this field should only be used in lieu of a "nodePool" object, since this configuration (along with the "initialNodeCount") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a nodePool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
   
accelerators
complex
success
A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
     
acceleratorCount
string
success
The number of accelerator cards exposed to an instance.
     
acceleratorType
string
success
The accelerator type resource name.
   
diskSizeGb
integer
success
Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
   
diskType
string
success
Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' .
   
imageType
string
success
The image type to use for this node. Note that for a given image type, the latest version of it will be used.
   
labels
dictionary
success
The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: http://kubernetes.io/v1.1/docs/user-guide/labels.html An object containing a list of "key": value pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
   
localSsdCount
integer
success
The number of local SSD disks to be attached to the node.
The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information.
   
machineType
string
success
The name of a Google Compute Engine machine type (e.g.
n1-standard-1). If unspecified, the default machine type is n1-standard-1.
   
metadata
dictionary
success
The metadata key/value pairs assigned to instances in the cluster.
Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB.
The total size of all keys and values must be less than 512 KB.
An object containing a list of "key": value pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
   
minCpuPlatform
string
success
Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform.
   
oauthScopes
list / elements=string
success
The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
The following scopes are recommended, but not required, and by default are not included: https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes.
https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry).
If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
   
preemptible
boolean
success
Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
   
serviceAccount
string
success
The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
   
shieldedInstanceConfig
complex
success
Shielded Instance options.
     
enableIntegrityMonitoring
boolean
success
Defines whether the instance has integrity monitoring enabled.
Enables monitoring and attestation of the boot integrity of the instance.
The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
     
enableSecureBoot
boolean
success
Defines whether the instance has Secure Boot enabled.
Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
   
tags
list / elements=string
success
The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
   
taints
complex
success
List of kubernetes taints to be applied to each node.
For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ .
     
effect
string
success
Effect for taint.
     
key
string
success
Key for taint.
     
value
string
success
Value for taint.
 
nodeIpv4CidrSize
integer
success
The size of the address space on each node for hosting containers.
This is provisioned from within the container_ipv4_cidr range.
 
nodePools
complex
success
Node pools belonging to this cluster.
   
name
string
success
Name of the node pool.
 
privateClusterConfig
complex
success
Configuration for a private cluster.
   
enablePrivateEndpoint
boolean
success
Whether the master's internal IP address is used as the cluster endpoint.
   
enablePrivateNodes
boolean
success
Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
   
masterIpv4CidrBlock
string
success
The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.
   
privateEndpoint
string
success
The internal IP address of this cluster's master endpoint.
   
publicEndpoint
string
success
The external IP address of this cluster's master endpoint.
 
releaseChannel
complex
success
ReleaseChannel indicates which release channel a cluster is subscribed to.
Release channels are arranged in order of risk and frequency of updates.
   
channel
string
success
Which release channel the cluster is subscribed to.
 
resourceLabels
dictionary
success
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
 
servicesIpv4Cidr
string
success
The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
 
shieldedNodes
complex
success
Shielded Nodes configuration.
   
enabled
boolean
success
Whether Shielded Nodes features are enabled on all nodes in this cluster.
 
status
string
success
The current status of this cluster.
 
statusMessage
string
success
Additional information about the current status of this cluster, if available.
 
subnetwork
string
success
The name of the Google Compute Engine subnetwork to which the cluster is connected.
 
tpuIpv4CidrBlock
string
success
The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).


Authors

  • Google Inc. (@googlecloudplatform)