ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-18 17:01:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

adding ansible types in documentation (#303)

Browse source 
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2019-07-16 14:19:07 -07:00 • committed by Alex Stephen
parent 72e4cc7214
commit 43536a1e38
81 changed files with 844 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

48
plugins/modules/gcp_container_cluster.py
View file

@ -53,10 +53,12 @@ options:
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.
required: false
type: str
description:
description:
- An optional description of this cluster.
required: false
type: str
initial_node_count:
description:
- The number of nodes to create in this cluster. You must ensure that your Compute
@ -67,6 +69,7 @@ options:
name. Do not use this and a nodePool at the same time.
- This field has been deprecated. Please use nodePool.initial_node_count instead.
required: false
type: int
node_config:
description:
- Parameters used in creating the cluster's nodes.
@ -77,17 +80,20 @@ options:
the node configuration of the first node pool. If unspecified, the defaults
are used.
required: false
type: dict
suboptions:
machine_type:
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.
required: false
type: str
disk_size_gb:
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.
required: false
type: int
oauth_scopes:
description:
- The set of Google API scopes to be made available on all of the node VMs
@ -100,11 +106,13 @@ options:
- If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring
are enabled, in which case their required scopes will be added.
required: false
type: list
service_account:
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.
required: false
type: str
metadata:
description:
- The metadata key/value pairs assigned to instances in the cluster.
@ -120,11 +128,13 @@ options:
- 'An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
required: false
type: dict
image_type:
description:
- The image type to use for this node. Note that for a given image type, the
latest version of it will be used.
required: false
type: str
labels:
description:
- 'The map of Kubernetes labels (key/value pairs) to be applied to each node.
@ -136,6 +146,7 @@ options:
An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
required: false
type: dict
local_ssd_count:
description:
- The number of local SSD disks to be attached to the node.
@ -143,6 +154,7 @@ options:
available on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits)
for more information.'
required: false
type: int
tags:
description:
- The list of instance tags applied to all nodes. Tags are used to identify
@ -150,6 +162,7 @@ options:
client during cluster or node pool creation. Each tag within the list must
comply with RFC1035.
required: false
type: list
preemptible:
description:
- 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible)
@ -161,27 +174,32 @@ options:
- 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.
required: false
type: list
version_added: 2.9
suboptions:
accelerator_count:
description:
- The number of accelerator cards exposed to an instance.
required: false
type: str
accelerator_type:
description:
- The accelerator type resource name.
required: false
type: str
disk_type:
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' .
required: false
type: str
version_added: 2.9
min_cpu_platform:
description:
- Minimum CPU platform to be used by this instance. The instance may be scheduled
on the specified or newer CPU platform.
required: false
type: str
version_added: 2.9
taints:
description:
@ -189,43 +207,51 @@ options:
- 'For more information, including usage and the valid values, see: U(https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)
.'
required: false
type: list
version_added: 2.9
suboptions:
key:
description:
- Key for taint.
required: false
type: str
value:
description:
- Value for taint.
required: false
type: str
effect:
description:
- Effect for taint.
- 'Some valid choices include: "EFFECT_UNSPECIFIED", "NO_SCHEDULE", "PREFER_NO_SCHEDULE",
"NO_EXECUTE"'
required: false
type: str
master_auth:
description:
- The authentication information for accessing the master endpoint.
required: false
type: dict
suboptions:
username:
description:
- The username to use for HTTP basic authentication to the master endpoint.
required: false
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.
required: false
type: str
client_certificate_config:
description:
- Configuration for client certificate authentication on the cluster. For
clusters before v1.12, if no configuration is specified, a client certificate
is issued.
required: false
type: dict
version_added: 2.9
suboptions:
issue_client_certificate:
@ -241,6 +267,7 @@ options:
- if left as an empty string,logging.googleapis.com will be used.
- 'Some valid choices include: "logging.googleapis.com", "none"'
required: false
type: str
monitoring_service:
description:
- The monitoring service the cluster should use to write metrics.
@ -250,15 +277,18 @@ options:
- if left as an empty string, monitoring.googleapis.com will be used.
- 'Some valid choices include: "monitoring.googleapis.com", "none"'
required: false
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.
required: false
type: str
private_cluster_config:
description:
- Configuration for a private cluster.
required: false
type: dict
version_added: 2.8
suboptions:
enable_private_nodes:
@ -280,22 +310,26 @@ options:
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.
required: false
type: str
cluster_ipv4_cidr:
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.
required: false
type: str
addons_config:
description:
- Configurations for the various addons available to run in the cluster.
required: false
type: dict
suboptions:
http_load_balancing:
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.
required: false
type: dict
suboptions:
disabled:
description:
@ -310,6 +344,7 @@ options:
or decreases the number of replica pods a replication controller has based
on the resource usage of the existing pods.
required: false
type: dict
suboptions:
disabled:
description:
@ -324,6 +359,7 @@ options:
or not on the Master, it does not track whether network policy is enabled
for the nodes.
required: false
type: dict
version_added: 2.9
suboptions:
disabled:
@ -335,11 +371,13 @@ options:
description:
- The name of the Google Compute Engine subnetwork to which the cluster is connected.
required: false
type: str
locations:
description:
- The list of Google Compute Engine zones in which the cluster's nodes should
be located.
required: false
type: list
aliases:
- nodeLocations
version_added: 2.9
@ -348,11 +386,13 @@ options:
- The resource labels for the cluster to use to annotate any related Google Compute
Engine resources.
required: false
type: dict
version_added: 2.9
legacy_abac:
description:
- Configuration for the legacy ABAC authorization mode.
required: false
type: dict
version_added: 2.9
suboptions:
enabled:
@ -367,6 +407,7 @@ options:
description:
- Configuration options for the NetworkPolicy feature.
required: false
type: dict
version_added: 2.9
suboptions:
provider:
@ -374,6 +415,7 @@ options:
- The selected network policy provider.
- 'Some valid choices include: "PROVIDER_UNSPECIFIED", "CALICO"'
required: false
type: str
enabled:
description:
- Whether network policy is enabled on the cluster.
@ -385,12 +427,14 @@ options:
on a node in the node pool of this cluster.
- Only honored if cluster created with IP Alias support.
required: false
type: dict
version_added: 2.9
suboptions:
max_pods_per_node:
description:
- Constraint enforced on the max num of pods per node.
required: false
type: str
enable_tpu:
description:
- Enable the ability to use Cloud TPUs in this cluster.
@ -401,11 +445,13 @@ options:
description:
- The IP address range of the Cloud TPUs in this cluster, in CIDR notation.
required: false
type: str
version_added: 2.9
location:
description:
- The location where the cluster is deployed.
required: true
type: str
aliases:
- zone
version_added: 2.8
@ -416,12 +462,14 @@ options:
- Any existing file at this path will be completely overwritten.
- This requires the PyYaml library.
required: false
type: str
version_added: 2.9
kubectl_context:
description:
- The name of the context for the kubectl config file. Will default to the cluster
name.
required: false
type: str
version_added: 2.9
extends_documentation_fragment: gcp
'''