This is the documentation for gke module.
This module creates following resources -
- gke cluster with a default worker nodepool
- optionally you can create more worker nodepools
No modules.
Name |
Description |
Type |
Default |
Required |
cluster_name |
The name of the cluster, unique within the project and location. |
string |
n/a |
yes |
k8s_version |
kubernetes version |
string |
"1.27" |
no |
network |
The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. |
string |
n/a |
yes |
nodepools |
Nodepools for the Kubernetes cluster |
map(object({ name = string node_count = number node_labels = map(any) machine_type = string })) |
{ "worker": { "machine_type": "n1-standard-1", "name": "worker", "node_count": 1, "node_labels": { "worker-name": "worker" } } } |
no |
region |
The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well |
string |
n/a |
yes |
subnetwork |
The name or self_link of the Google Compute Engine subnetwork in which the cluster's instances are launched. |
string |
n/a |
yes |
Name |
Description |
client_certificate |
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster. |
client_key |
Base64 encoded private key used by clients to authenticate to the cluster endpoint. |
cluster_ca_certificate |
Base64 encoded public certificate that is the root certificate of the cluster. |
cluster_id |
an identifier for the resource with format projects/{{project}}/locations/{{zone}}/clusters/{{name}} |
cluster_master_version |
The current version of the master in the cluster. This may be different than the min_master_version set in the config if the master has been updated by GKE. |
endpoint |
The IP address of this cluster's Kubernetes master. |