mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
766 lines
29 KiB
Python
766 lines
29 KiB
Python
|
#!/usr/bin/python
|
||
|
# -*- coding: utf-8 -*-
|
||
|
#
|
||
|
# Copyright (C) 2017 Google
|
||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
# ----------------------------------------------------------------------------
|
||
|
#
|
||
|
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
|
||
|
#
|
||
|
# ----------------------------------------------------------------------------
|
||
|
#
|
||
|
# This file is automatically generated by Magic Modules and manual
|
||
|
# changes will be clobbered when the file is regenerated.
|
||
|
#
|
||
|
# Please read more about how to change this file at
|
||
|
# https://www.github.com/GoogleCloudPlatform/magic-modules
|
||
|
#
|
||
|
# ----------------------------------------------------------------------------
|
||
|
|
||
|
from __future__ import absolute_import, division, print_function
|
||
|
|
||
|
__metaclass__ = type
|
||
|
|
||
|
################################################################################
|
||
|
# Documentation
|
||
|
################################################################################
|
||
|
|
||
|
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}
|
||
|
|
||
|
DOCUMENTATION = '''
|
||
|
---
|
||
|
module: gcp_container_cluster_info
|
||
|
description:
|
||
|
- Gather info for GCP Cluster
|
||
|
short_description: Gather info for GCP Cluster
|
||
|
author: Google Inc. (@googlecloudplatform)
|
||
|
requirements:
|
||
|
- python >= 2.6
|
||
|
- requests >= 2.18.4
|
||
|
- google-auth >= 1.3.0
|
||
|
options:
|
||
|
location:
|
||
|
description:
|
||
|
- The location where the cluster is deployed.
|
||
|
required: true
|
||
|
type: str
|
||
|
aliases:
|
||
|
- region
|
||
|
- zone
|
||
|
project:
|
||
|
description:
|
||
|
- The Google Cloud Platform project to use.
|
||
|
type: str
|
||
|
auth_kind:
|
||
|
description:
|
||
|
- The type of credential used.
|
||
|
type: str
|
||
|
required: true
|
||
|
choices:
|
||
|
- application
|
||
|
- machineaccount
|
||
|
- serviceaccount
|
||
|
service_account_contents:
|
||
|
description:
|
||
|
- The contents of a Service Account JSON file, either in a dictionary or as a
|
||
|
JSON string that represents it.
|
||
|
type: jsonarg
|
||
|
service_account_file:
|
||
|
description:
|
||
|
- The path of a Service Account JSON file if serviceaccount is selected as type.
|
||
|
type: path
|
||
|
service_account_email:
|
||
|
description:
|
||
|
- An optional service account email address if machineaccount is selected and
|
||
|
the user does not wish to use the default email.
|
||
|
type: str
|
||
|
scopes:
|
||
|
description:
|
||
|
- Array of scopes to be used
|
||
|
type: list
|
||
|
env_type:
|
||
|
description:
|
||
|
- 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.
|
||
|
type: str
|
||
|
notes:
|
||
|
- for authentication, you can set service_account_file using the C(gcp_service_account_file)
|
||
|
env variable.
|
||
|
- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS)
|
||
|
env variable.
|
||
|
- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
|
||
|
env variable.
|
||
|
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
|
||
|
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
|
||
|
- Environment variables values will only be used if the playbook values are not set.
|
||
|
- The I(service_account_email) and I(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 = '''
|
||
|
resources:
|
||
|
description: List of resources
|
||
|
returned: always
|
||
|
type: complex
|
||
|
contains:
|
||
|
name:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
description:
|
||
|
description:
|
||
|
- An optional description of this cluster.
|
||
|
returned: success
|
||
|
type: str
|
||
|
initialNodeCount:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: int
|
||
|
nodeConfig:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
machineType:
|
||
|
description:
|
||
|
- The name of a Google Compute Engine machine type (e.g.
|
||
|
- n1-standard-1). If unspecified, the default machine type is n1-standard-1.
|
||
|
returned: success
|
||
|
type: str
|
||
|
diskSizeGb:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: int
|
||
|
oauthScopes:
|
||
|
description:
|
||
|
- 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: U(https://www.googleapis.com/auth/compute) is required
|
||
|
for mounting persistent storage on your nodes.'
|
||
|
- U(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.
|
||
|
returned: success
|
||
|
type: list
|
||
|
serviceAccount:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
metadata:
|
||
|
description:
|
||
|
- 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" }.'
|
||
|
returned: success
|
||
|
type: dict
|
||
|
imageType:
|
||
|
description:
|
||
|
- The image type to use for this node. Note that for a given image type,
|
||
|
the latest version of it will be used.
|
||
|
returned: success
|
||
|
type: str
|
||
|
labels:
|
||
|
description:
|
||
|
- '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: U(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" }.'
|
||
|
returned: success
|
||
|
type: dict
|
||
|
localSsdCount:
|
||
|
description:
|
||
|
- 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: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits)
|
||
|
for more information.'
|
||
|
returned: success
|
||
|
type: int
|
||
|
tags:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: list
|
||
|
preemptible:
|
||
|
description:
|
||
|
- 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible)
|
||
|
for more information about preemptible VM instances.'
|
||
|
returned: success
|
||
|
type: bool
|
||
|
accelerators:
|
||
|
description:
|
||
|
- A list of hardware accelerators to be attached to each node. See U(https://cloud.google.com/compute/docs/gpus)
|
||
|
for more information about support for GPUs.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
acceleratorCount:
|
||
|
description:
|
||
|
- The number of accelerator cards exposed to an instance.
|
||
|
returned: success
|
||
|
type: str
|
||
|
acceleratorType:
|
||
|
description:
|
||
|
- The accelerator type resource name.
|
||
|
returned: success
|
||
|
type: str
|
||
|
diskType:
|
||
|
description:
|
||
|
- Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
|
||
|
If unspecified, the default disk type is 'pd-standard' .
|
||
|
returned: success
|
||
|
type: str
|
||
|
minCpuPlatform:
|
||
|
description:
|
||
|
- Minimum CPU platform to be used by this instance. The instance may be
|
||
|
scheduled on the specified or newer CPU platform.
|
||
|
returned: success
|
||
|
type: str
|
||
|
taints:
|
||
|
description:
|
||
|
- List of kubernetes taints to be applied to each node.
|
||
|
- 'For more information, including usage and the valid values, see: U(https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)
|
||
|
.'
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
key:
|
||
|
description:
|
||
|
- Key for taint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
value:
|
||
|
description:
|
||
|
- Value for taint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
effect:
|
||
|
description:
|
||
|
- Effect for taint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
masterAuth:
|
||
|
description:
|
||
|
- The authentication information for accessing the master endpoint.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
username:
|
||
|
description:
|
||
|
- The username to use for HTTP basic authentication to the master endpoint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
password:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
clientCertificateConfig:
|
||
|
description:
|
||
|
- Configuration for client certificate authentication on the cluster. For
|
||
|
clusters before v1.12, if no configuration is specified, a client certificate
|
||
|
is issued.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
issueClientCertificate:
|
||
|
description:
|
||
|
- Issue a client certificate.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
clusterCaCertificate:
|
||
|
description:
|
||
|
- Base64-encoded public certificate that is the root of trust for the cluster.
|
||
|
returned: success
|
||
|
type: str
|
||
|
clientCertificate:
|
||
|
description:
|
||
|
- Base64-encoded public certificate used by clients to authenticate to the
|
||
|
cluster endpoint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
clientKey:
|
||
|
description:
|
||
|
- Base64-encoded private key used by clients to authenticate to the cluster
|
||
|
endpoint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
loggingService:
|
||
|
description:
|
||
|
- '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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
monitoringService:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
network:
|
||
|
description:
|
||
|
- The name of the Google Compute Engine network to which the cluster is connected.
|
||
|
If left unspecified, the default network will be used.
|
||
|
returned: success
|
||
|
type: str
|
||
|
privateClusterConfig:
|
||
|
description:
|
||
|
- Configuration for a private cluster.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
enablePrivateNodes:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
enablePrivateEndpoint:
|
||
|
description:
|
||
|
- Whether the master's internal IP address is used as the cluster endpoint.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
masterIpv4CidrBlock:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
privateEndpoint:
|
||
|
description:
|
||
|
- The internal IP address of this cluster's master endpoint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
publicEndpoint:
|
||
|
description:
|
||
|
- The external IP address of this cluster's master endpoint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
clusterIpv4Cidr:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
addonsConfig:
|
||
|
description:
|
||
|
- Configurations for the various addons available to run in the cluster.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
httpLoadBalancing:
|
||
|
description:
|
||
|
- Configuration for the HTTP (L7) load balancing controller addon, which
|
||
|
makes it easy to set up HTTP load balancers for services in a cluster.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
disabled:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
horizontalPodAutoscaling:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
disabled:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
networkPolicyConfig:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
disabled:
|
||
|
description:
|
||
|
- Whether NetworkPolicy is enabled for this cluster.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
subnetwork:
|
||
|
description:
|
||
|
- The name of the Google Compute Engine subnetwork to which the cluster is connected.
|
||
|
returned: success
|
||
|
type: str
|
||
|
locations:
|
||
|
description:
|
||
|
- The list of Google Compute Engine zones in which the cluster's nodes should
|
||
|
be located.
|
||
|
returned: success
|
||
|
type: list
|
||
|
resourceLabels:
|
||
|
description:
|
||
|
- The resource labels for the cluster to use to annotate any related Google
|
||
|
Compute Engine resources.
|
||
|
returned: success
|
||
|
type: dict
|
||
|
labelFingerprint:
|
||
|
description:
|
||
|
- The fingerprint of the set of labels for this cluster.
|
||
|
returned: success
|
||
|
type: str
|
||
|
legacyAbac:
|
||
|
description:
|
||
|
- Configuration for the legacy ABAC authorization mode.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
enabled:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
networkPolicy:
|
||
|
description:
|
||
|
- Configuration options for the NetworkPolicy feature.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
provider:
|
||
|
description:
|
||
|
- The selected network policy provider.
|
||
|
returned: success
|
||
|
type: str
|
||
|
enabled:
|
||
|
description:
|
||
|
- Whether network policy is enabled on the cluster.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
defaultMaxPodsConstraint:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
maxPodsPerNode:
|
||
|
description:
|
||
|
- Constraint enforced on the max num of pods per node.
|
||
|
returned: success
|
||
|
type: str
|
||
|
ipAllocationPolicy:
|
||
|
description:
|
||
|
- Configuration for controlling how IPs are allocated in the cluster.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
useIpAliases:
|
||
|
description:
|
||
|
- Whether alias IPs will be used for pod IPs in the cluster.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
createSubnetwork:
|
||
|
description:
|
||
|
- Whether a new subnetwork will be created automatically for the cluster.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
subnetworkName:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
clusterSecondaryRangeName:
|
||
|
description:
|
||
|
- 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
|
||
|
.
|
||
|
returned: success
|
||
|
type: str
|
||
|
servicesSecondaryRangeName:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
clusterIpv4CidrBlock:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
nodeIpv4CidrBlock:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
servicesIpv4CidrBlock:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
tpuIpv4CidrBlock:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
endpoint:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
initialClusterVersion:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
currentMasterVersion:
|
||
|
description:
|
||
|
- The current software version of the master endpoint.
|
||
|
returned: success
|
||
|
type: str
|
||
|
currentNodeVersion:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
createTime:
|
||
|
description:
|
||
|
- The time the cluster was created, in RFC3339 text format.
|
||
|
returned: success
|
||
|
type: str
|
||
|
status:
|
||
|
description:
|
||
|
- The current status of this cluster.
|
||
|
returned: success
|
||
|
type: str
|
||
|
statusMessage:
|
||
|
description:
|
||
|
- Additional information about the current status of this cluster, if available.
|
||
|
returned: success
|
||
|
type: str
|
||
|
nodeIpv4CidrSize:
|
||
|
description:
|
||
|
- The size of the address space on each node for hosting containers.
|
||
|
- This is provisioned from within the container_ipv4_cidr range.
|
||
|
returned: success
|
||
|
type: int
|
||
|
servicesIpv4Cidr:
|
||
|
description:
|
||
|
- 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.
|
||
|
returned: success
|
||
|
type: str
|
||
|
currentNodeCount:
|
||
|
description:
|
||
|
- The number of nodes currently in the cluster.
|
||
|
returned: success
|
||
|
type: int
|
||
|
expireTime:
|
||
|
description:
|
||
|
- The time the cluster will be automatically deleted in RFC3339 text format.
|
||
|
returned: success
|
||
|
type: str
|
||
|
enableTpu:
|
||
|
description:
|
||
|
- Enable the ability to use Cloud TPUs in this cluster.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
tpuIpv4CidrBlock:
|
||
|
description:
|
||
|
- The IP address range of the Cloud TPUs in this cluster, in CIDR notation.
|
||
|
returned: success
|
||
|
type: str
|
||
|
conditions:
|
||
|
description:
|
||
|
- Which conditions caused the current cluster state.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
code:
|
||
|
description:
|
||
|
- Machine-friendly representation of the condition.
|
||
|
returned: success
|
||
|
type: str
|
||
|
message:
|
||
|
description:
|
||
|
- Human-friendly representation of the condition.
|
||
|
returned: success
|
||
|
type: str
|
||
|
masterAuthorizedNetworksConfig:
|
||
|
description:
|
||
|
- Configuration for controlling how IPs are allocated in the cluster.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
enabled:
|
||
|
description:
|
||
|
- Whether or not master authorized networks is enabled.
|
||
|
returned: success
|
||
|
type: bool
|
||
|
cidrBlocks:
|
||
|
description:
|
||
|
- Define up to 50 external networks that could access Kubernetes master
|
||
|
through HTTPS.
|
||
|
returned: success
|
||
|
type: complex
|
||
|
contains:
|
||
|
displayName:
|
||
|
description:
|
||
|
- Optional field used to identify cidr blocks.
|
||
|
returned: success
|
||
|
type: str
|
||
|
cidrBlock:
|
||
|
description:
|
||
|
- Block specified in CIDR notation.
|
||
|
returned: success
|
||
|
type: str
|
||
|
location:
|
||
|
description:
|
||
|
- The location where the cluster is deployed.
|
||
|
returned: success
|
||
|
type: str
|
||
|
'''
|
||
|
|
||
|
################################################################################
|
||
|
# Imports
|
||
|
################################################################################
|
||
|
from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
|
||
|
import json
|
||
|
|
||
|
################################################################################
|
||
|
# Main
|
||
|
################################################################################
|
||
|
|
||
|
|
||
|
def main():
|
||
|
module = GcpModule(argument_spec=dict(location=dict(required=True, type='str', aliases=['region', 'zone'])))
|
||
|
|
||
|
if not module.params['scopes']:
|
||
|
module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform']
|
||
|
|
||
|
return_value = {'resources': fetch_list(module, collection(module))}
|
||
|
module.exit_json(**return_value)
|
||
|
|
||
|
|
||
|
def collection(module):
|
||
|
return "https://container.googleapis.com/v1/projects/{project}/locations/{location}/clusters".format(**module.params)
|
||
|
|
||
|
|
||
|
def fetch_list(module, link):
|
||
|
auth = GcpSession(module, 'container')
|
||
|
return auth.list(link, return_if_object, array_name='clusters')
|
||
|
|
||
|
|
||
|
def return_if_object(module, response):
|
||
|
# If not found, return nothing.
|
||
|
if response.status_code == 404:
|
||
|
return None
|
||
|
|
||
|
# If no content, return nothing.
|
||
|
if response.status_code == 204:
|
||
|
return None
|
||
|
|
||
|
try:
|
||
|
module.raise_for_status(response)
|
||
|
result = response.json()
|
||
|
except getattr(json.decoder, 'JSONDecodeError', ValueError) as inst:
|
||
|
module.fail_json(msg="Invalid JSON response with error: %s" % inst)
|
||
|
|
||
|
if navigate_hash(result, ['error', 'errors']):
|
||
|
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
|
||
|
|
||
|
return result
|
||
|
|
||
|
|
||
|
if __name__ == "__main__":
|
||
|
main()
|