f1762a5465
* Add resource_manager_tags to gke-nodepool, gke-standard-cluster's node_config and gke-autopilot
553 lines
32 KiB
Markdown
553 lines
32 KiB
Markdown
# GKE Standard cluster module
|
|
|
|
This module offers a way to create and manage Google Kubernetes Engine (GKE) [Standard clusters](https://cloud.google.com/kubernetes-engine/docs/concepts/choose-cluster-mode#why-standard). With its sensible default settings based on best practices and authors' experience as Google Cloud practitioners, the module accommodates for many common use cases out-of-the-box, without having to rely on verbose configuration.
|
|
|
|
> [!IMPORTANT]
|
|
> This module should be used together with the [`gke-nodepool`](../gke-nodepool/) module because the default node pool is deleted upon cluster creation by default.
|
|
|
|
<!-- BEGIN TOC -->
|
|
- [Cluster access configurations](#cluster-access-configurations)
|
|
- [Private cluster with DNS endpoint enabled](#private-cluster-with-dns-endpoint-enabled)
|
|
- [Public cluster](#public-cluster)
|
|
- [Allowing access from Google Cloud services](#allowing-access-from-google-cloud-services)
|
|
- [Regional cluster](#regional-cluster)
|
|
- [Enable Dataplane V2](#enable-dataplane-v2)
|
|
- [Managing GKE logs](#managing-gke-logs)
|
|
- [Upgrade notifications](#upgrade-notifications)
|
|
- [Monitoring configuration](#monitoring-configuration)
|
|
- [Disable GKE logs or metrics collection](#disable-gke-logs-or-metrics-collection)
|
|
- [Cloud DNS](#cloud-dns)
|
|
- [Backup for GKE](#backup-for-gke)
|
|
- [Automatic creation of new secondary ranges](#automatic-creation-of-new-secondary-ranges)
|
|
- [Node auto-provisioning with GPUs and TPUs](#node-auto-provisioning-with-gpus-and-tpus)
|
|
- [Disable PSC endpoint creation](#disable-psc-endpoint-creation)
|
|
- [Variables](#variables)
|
|
- [Outputs](#outputs)
|
|
<!-- END TOC -->
|
|
|
|
## Cluster access configurations
|
|
|
|
The `access_config` variable can be used to configure access to the control plane, and nodes public access. The following examples illustrate different possible configurations.
|
|
|
|
### Private cluster with DNS endpoint enabled
|
|
|
|
The default module configuration creates a cluster with private nodes, no public endpoint, and access via the DNS endpoint enabled. The default variable configuration is shown in comments.
|
|
|
|
Master authorized ranges can be set via the `access_config.ip_access.authorized_ranges` attribute.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
# access_config can be omitted if master authorized ranges are not needed
|
|
access_config = {
|
|
# dns_access = true
|
|
ip_access = {
|
|
authorized_ranges = {
|
|
internal-vms = "10.0.0.0/8"
|
|
}
|
|
}
|
|
# private_nodes = true
|
|
}
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {
|
|
pods = "pods"
|
|
services = "services"
|
|
}
|
|
}
|
|
max_pods_per_node = 32
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=access-private.yaml
|
|
```
|
|
|
|
### Public cluster
|
|
|
|
To configure a public cluster, turn off `access_config.ip_access.disable_public_endpoint`. Nodes can be left as private or made public if needed, like in the example below. DNS endpoint is turned off here as it's probably redundant for a public cluster.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
access_config = {
|
|
dns_access = false
|
|
ip_access = {
|
|
authorized_ranges = {
|
|
"corporate proxy" = "8.8.8.8/32"
|
|
}
|
|
gcp_public_cidrs_access_enabled = false
|
|
disable_public_endpoint = false
|
|
}
|
|
private_nodes = false
|
|
}
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {
|
|
pods = "pods"
|
|
services = "services"
|
|
}
|
|
}
|
|
max_pods_per_node = 32
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=access-public.yaml
|
|
```
|
|
|
|
### Allowing access from Google Cloud services
|
|
|
|
To allow access to your cluster from Google Cloud services (like Cloud Shell, Cloud Build, etc.) without needing to manually specify all Google Cloud IP ranges, you can use the `gcp_public_cidrs_access_enabled` parameter:
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
access_config = {
|
|
dns_access = false
|
|
ip_access = {
|
|
authorized_ranges = {
|
|
internal-vms = "10.0.0.0/8"
|
|
}
|
|
gcp_public_cidrs_access_enabled = true
|
|
disable_public_endpoint = false
|
|
}
|
|
private_nodes = false
|
|
}
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {
|
|
pods = "pods"
|
|
services = "services"
|
|
}
|
|
}
|
|
max_pods_per_node = 32
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=access-google.yaml
|
|
```
|
|
|
|
## Regional cluster
|
|
|
|
Regional clusters are created by setting `location` to a GCP region and then configuring `node_locations`, as shown in the example below.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1"
|
|
node_locations = ["europe-west1-b"]
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {
|
|
pods = "pods"
|
|
services = "services"
|
|
}
|
|
}
|
|
max_pods_per_node = 32
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=regional.yaml
|
|
```
|
|
|
|
## Enable Dataplane V2
|
|
|
|
This example shows how to [create a zonal GKE Cluster with Dataplane V2 enabled](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2).
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-dataplane-v2"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {} # use default names "pods" and "services"
|
|
}
|
|
enable_features = {
|
|
dataplane_v2 = true
|
|
fqdn_network_policy = true
|
|
secret_manager_config = true
|
|
workload_identity = true
|
|
}
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1
|
|
```
|
|
|
|
## Managing GKE logs
|
|
|
|
This example shows you how to [control which logs are sent from your GKE cluster to Cloud Logging](https://cloud.google.com/stackdriver/docs/solutions/gke/installing).
|
|
|
|
When you create a new GKE cluster, [Cloud Operations for GKE](https://cloud.google.com/stackdriver/docs/solutions/gke) integration with Cloud Logging is enabled by default and [System logs](https://cloud.google.com/stackdriver/docs/solutions/gke/managing-logs#what_logs) are collected. You can enable collection of several other [types of logs](https://cloud.google.com/stackdriver/docs/solutions/gke/managing-logs#what_logs). The following example enables collection of *all* optional logs.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {}
|
|
}
|
|
logging_config = {
|
|
enable_workloads_logs = true
|
|
enable_api_server_logs = true
|
|
enable_scheduler_logs = true
|
|
enable_controller_manager_logs = true
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=logging-config-enable-all.yaml
|
|
```
|
|
|
|
## Upgrade notifications
|
|
|
|
Upgrade notifications are configured via the `enable_features.upgrade_notifications`. An existing PubSub topic can be defined via its `topic` attribute, or a new one can be created if the attribute is not set. The `event_types` attribute can be used to control which event types are sent.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {}
|
|
}
|
|
enable_features = {
|
|
upgrade_notifications = {
|
|
event_types = ["SECURITY_BULLETIN_EVENT", "UPGRADE_EVENT"]
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2 inventory=notifications.yaml
|
|
```
|
|
|
|
## Monitoring configuration
|
|
|
|
This example shows how to [configure collection of Kubernetes control plane metrics](https://cloud.google.com/stackdriver/docs/solutions/gke/managing-metrics#enable-control-plane-metrics). These metrics are optional and are not collected by default.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {} # use default names "pods" and "services"
|
|
}
|
|
monitoring_config = {
|
|
enable_api_server_metrics = true
|
|
enable_controller_manager_metrics = true
|
|
enable_scheduler_metrics = true
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=monitoring-config-control-plane.yaml
|
|
```
|
|
|
|
The next example shows how to [configure collection of kube state metrics](https://cloud.google.com/stackdriver/docs/solutions/gke/managing-metrics#enable-ksm). These metrics are optional and are not collected by default.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {} # use default names "pods" and "services"
|
|
}
|
|
monitoring_config = {
|
|
enable_cadvisor_metrics = true
|
|
enable_daemonset_metrics = true
|
|
enable_deployment_metrics = true
|
|
enable_hpa_metrics = true
|
|
enable_pod_metrics = true
|
|
enable_statefulset_metrics = true
|
|
enable_storage_metrics = true
|
|
# Kube state metrics collection requires Google Cloud Managed Service for Prometheus,
|
|
# which is enabled by default.
|
|
# enable_managed_prometheus = true
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=monitoring-config-kube-state.yaml
|
|
```
|
|
|
|
The *control plane metrics* and *kube state metrics* collection can be configured in a single `monitoring_config` block.
|
|
|
|
## Disable GKE logs or metrics collection
|
|
|
|
> [!WARNING]
|
|
> If you've disabled Cloud Logging or Cloud Monitoring, GKE customer support
|
|
> is offered on a best-effort basis and might require additional effort
|
|
> from your engineering team.
|
|
|
|
This example shows how to fully disable logs collection on a zonal GKE Standard cluster. This is not recommended.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {}
|
|
}
|
|
logging_config = {
|
|
enable_system_logs = false
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=logging-config-disable-all.yaml
|
|
```
|
|
|
|
The next example shows how to fully disable metrics collection on a zonal GKE Standard cluster. This is not recommended.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {}
|
|
}
|
|
monitoring_config = {
|
|
enable_system_metrics = false
|
|
enable_managed_prometheus = false
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=monitoring-config-disable-all.yaml
|
|
```
|
|
|
|
## Cloud DNS
|
|
|
|
This example shows how to [use Cloud DNS as a Kubernetes DNS provider](https://cloud.google.com/kubernetes-engine/docs/how-to/cloud-dns) for GKE Standard clusters.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = var.project_id
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {}
|
|
}
|
|
enable_features = {
|
|
dns = {
|
|
provider = "CLOUD_DNS"
|
|
scope = "CLUSTER_SCOPE"
|
|
domain = "gke.local"
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=dns.yaml
|
|
```
|
|
|
|
## Backup for GKE
|
|
|
|
> [!NOTE]
|
|
> Although Backup for GKE can be enabled as an add-on when configuring your GKE clusters, it is a separate service from GKE.
|
|
|
|
[Backup for GKE](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/concepts/backup-for-gke) is a service for backing up and restoring workloads in GKE clusters. It has two components:
|
|
|
|
- A [Google Cloud API](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest) that serves as the control plane for the service.
|
|
- A GKE add-on (the [Backup for GKE agent](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/concepts/backup-for-gke#agent_overview)) that must be enabled in each cluster for which you wish to perform backup and restore operations.
|
|
|
|
This example shows how to [enable Backup for GKE on a new zonal GKE Standard cluster](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/how-to/install#enable_on_a_new_cluster_optional) and [plan a set of backups](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/how-to/backup-plan).
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = var.project_id
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {}
|
|
}
|
|
backup_configs = {
|
|
enable_backup_agent = true
|
|
backup_plans = {
|
|
"backup-1" = {
|
|
region = "europe-west2"
|
|
schedule = "0 9 * * 1"
|
|
applications = {
|
|
namespace-1 = ["app-1", "app-2"]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2 inventory=backup.yaml
|
|
```
|
|
|
|
## Automatic creation of new secondary ranges
|
|
|
|
You can use `var.vpc_config.secondary_range_blocks` to let GKE create new secondary ranges for the cluster. The example below reserves an available /14 block for pods and a /20 for services.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = var.project_id
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_blocks = {
|
|
pods = ""
|
|
services = "/20" # can be an empty string as well
|
|
}
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1
|
|
```
|
|
|
|
## Node auto-provisioning with GPUs and TPUs
|
|
|
|
You can use `var.cluster_autoscaling` block to configure node auto-provisioning for the GKE cluster. The example below configures limits for CPU, memory, GPUs and TPUs.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-standard"
|
|
project_id = var.project_id
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_blocks = {
|
|
pods = ""
|
|
services = "/20"
|
|
}
|
|
}
|
|
cluster_autoscaling = {
|
|
cpu_limits = {
|
|
max = 48
|
|
}
|
|
mem_limits = {
|
|
max = 182
|
|
}
|
|
# Can be GPUs or TPUs
|
|
accelerator_resources = [
|
|
{
|
|
resource_type = "nvidia-l4"
|
|
max = 2
|
|
},
|
|
{
|
|
resource_type = "tpu-v5-lite-podslice"
|
|
max = 2
|
|
}
|
|
]
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1
|
|
```
|
|
|
|
### Disable PSC endpoint creation
|
|
|
|
To disable IP access to the GKE control plane and prevent PSC endpoint creation, set `var.access_config.ip_access` to `null` or omit the variable.
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./fabric/modules/gke-cluster-autopilot"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1"
|
|
access_config = {
|
|
dns_access = true
|
|
}
|
|
vpc_config = {
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_names = {
|
|
pods = "pods"
|
|
services = "services"
|
|
}
|
|
}
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1 inventory=no-ip-access.yaml
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [location](variables.tf#L282) | Cluster zone or region. | <code>string</code> | ✓ | |
|
|
| [name](variables.tf#L397) | Cluster name. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L449) | Cluster project id. | <code>string</code> | ✓ | |
|
|
| [vpc_config](variables.tf#L460) | VPC-level configuration. | <code title="object({ disable_default_snat = optional(bool) network = string subnetwork = string secondary_range_blocks = optional(object({ pods = string services = string })) secondary_range_names = optional(object({ pods = optional(string) services = optional(string) })) additional_ranges = optional(list(string)) stack_type = optional(string) })">object({…})</code> | ✓ | |
|
|
| [access_config](variables.tf#L17) | Control plane endpoint and nodes access configurations. | <code title="object({ dns_access = optional(bool, true) ip_access = optional(object({ authorized_ranges = optional(map(string)) disable_public_endpoint = optional(bool) gcp_public_cidrs_access_enabled = optional(bool) private_endpoint_authorized_ranges_enforcement = optional(bool) private_endpoint_config = optional(object({ endpoint_subnetwork = optional(string) global_access = optional(bool, true) })) })) master_ipv4_cidr_block = optional(string) private_nodes = optional(bool, true) })">object({…})</code> | | <code>{}</code> |
|
|
| [backup_configs](variables.tf#L45) | Configuration for Backup for GKE. | <code title="object({ enable_backup_agent = optional(bool, false) backup_plans = optional(map(object({ region = string applications = optional(map(list(string))) encryption_key = optional(string) include_secrets = optional(bool, true) include_volume_data = optional(bool, true) labels = optional(map(string)) namespaces = optional(list(string)) permissive_mode = optional(bool) schedule = optional(string) retention_policy_days = optional(number) retention_policy_lock = optional(bool, false) retention_policy_delete_lock_days = optional(number) })), {}) })">object({…})</code> | | <code>{}</code> |
|
|
| [cluster_autoscaling](variables.tf#L68) | Enable and configure limits for Node Auto-Provisioning with Cluster Autoscaler. | <code title="object({ enabled = optional(bool, true) autoscaling_profile = optional(string, "BALANCED") auto_provisioning_defaults = optional(object({ boot_disk_kms_key = optional(string) disk_size = optional(number) disk_type = optional(string, "pd-standard") image_type = optional(string) oauth_scopes = optional(list(string)) service_account = optional(string) management = optional(object({ auto_repair = optional(bool, true) auto_upgrade = optional(bool, true) })) shielded_instance_config = optional(object({ integrity_monitoring = optional(bool, true) secure_boot = optional(bool, false) })) upgrade_settings = optional(object({ blue_green = optional(object({ node_pool_soak_duration = optional(string) standard_rollout_policy = optional(object({ batch_percentage = optional(number) batch_node_count = optional(number) batch_soak_duration = optional(string) })) })) surge = optional(object({ max = optional(number) unavailable = optional(number) })) })) })) auto_provisioning_locations = optional(list(string)) cpu_limits = optional(object({ min = optional(number, 0) max = number })) mem_limits = optional(object({ min = optional(number, 0) max = number })) accelerator_resources = optional(list(object({ resource_type = string min = optional(number, 0) max = number }))) })">object({…})</code> | | <code>null</code> |
|
|
| [default_nodepool](variables.tf#L148) | Enable default nodepool. | <code title="object({ remove_pool = optional(bool, true) initial_node_count = optional(number, 1) })">object({…})</code> | | <code>{}</code> |
|
|
| [deletion_protection](variables.tf#L166) | Whether or not to allow Terraform to destroy the cluster. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. | <code>bool</code> | | <code>true</code> |
|
|
| [description](variables.tf#L173) | Cluster description. | <code>string</code> | | <code>null</code> |
|
|
| [enable_addons](variables.tf#L179) | Addons enabled in the cluster (true means enabled). | <code title="object({ cloudrun = optional(bool, false) config_connector = optional(bool, false) dns_cache = optional(bool, true) gce_persistent_disk_csi_driver = optional(bool, true) gcp_filestore_csi_driver = optional(bool, true) gcs_fuse_csi_driver = optional(bool, true) horizontal_pod_autoscaling = optional(bool, true) http_load_balancing = optional(bool, true) istio = optional(object({ enable_tls = bool })) kalm = optional(bool, false) network_policy = optional(bool, false) stateful_ha = optional(bool, false) })">object({…})</code> | | <code>{}</code> |
|
|
| [enable_features](variables.tf#L201) | Enable cluster-level features. Certain features allow configuration. | <code title="object({ beta_apis = optional(list(string)) binary_authorization = optional(bool, false) cilium_clusterwide_network_policy = optional(bool, false) cost_management = optional(bool, true) dns = optional(object({ additive_vpc_scope_dns_domain = optional(string) provider = optional(string) scope = optional(string) domain = optional(string) })) multi_networking = optional(bool, false) database_encryption = optional(object({ state = string key_name = string })) dataplane_v2 = optional(bool, true) fqdn_network_policy = optional(bool, true) gateway_api = optional(bool, false) groups_for_rbac = optional(string) image_streaming = optional(bool, false) intranode_visibility = optional(bool, false) l4_ilb_subsetting = optional(bool, false) mesh_certificates = optional(bool) pod_security_policy = optional(bool, false) secret_manager_config = optional(bool) security_posture_config = optional(object({ mode = string vulnerability_mode = string })) resource_usage_export = optional(object({ dataset = string enable_network_egress_metering = optional(bool) enable_resource_consumption_metering = optional(bool) })) service_external_ips = optional(bool, true) shielded_nodes = optional(bool, false) tpu = optional(bool, false) upgrade_notifications = optional(object({ enabled = optional(bool, true) event_types = optional(list(string), []) topic_id = optional(string) })) vertical_pod_autoscaling = optional(bool, false) workload_identity = optional(bool, true) enterprise_cluster = optional(bool) })">object({…})</code> | | <code>{}</code> |
|
|
| [issue_client_certificate](variables.tf#L269) | Enable issuing client certificate. | <code>bool</code> | | <code>false</code> |
|
|
| [labels](variables.tf#L275) | Cluster resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [logging_config](variables.tf#L287) | Logging configuration. | <code title="object({ enable_system_logs = optional(bool, true) enable_workloads_logs = optional(bool, false) enable_api_server_logs = optional(bool, false) enable_scheduler_logs = optional(bool, false) enable_controller_manager_logs = optional(bool, false) })">object({…})</code> | | <code>{}</code> |
|
|
| [maintenance_config](variables.tf#L308) | Maintenance window configuration. | <code title="object({ daily_window_start_time = optional(string) recurring_window = optional(object({ start_time = string end_time = string recurrence = string })) maintenance_exclusions = optional(list(object({ name = string start_time = string end_time = string scope = optional(string) }))) })">object({…})</code> | | <code title="{ daily_window_start_time = "03:00" recurring_window = null maintenance_exclusion = [] }">{…}</code> |
|
|
| [max_pods_per_node](variables.tf#L331) | Maximum number of pods per node in this cluster. | <code>number</code> | | <code>110</code> |
|
|
| [min_master_version](variables.tf#L337) | Minimum version of the master, defaults to the version of the most recent official release. | <code>string</code> | | <code>null</code> |
|
|
| [monitoring_config](variables.tf#L343) | Monitoring configuration. Google Cloud Managed Service for Prometheus is enabled by default. | <code title="object({ enable_system_metrics = optional(bool, true) enable_api_server_metrics = optional(bool, false) enable_controller_manager_metrics = optional(bool, false) enable_scheduler_metrics = optional(bool, false) enable_daemonset_metrics = optional(bool, false) enable_deployment_metrics = optional(bool, false) enable_hpa_metrics = optional(bool, false) enable_pod_metrics = optional(bool, false) enable_statefulset_metrics = optional(bool, false) enable_storage_metrics = optional(bool, false) enable_cadvisor_metrics = optional(bool, false) enable_managed_prometheus = optional(bool, true) advanced_datapath_observability = optional(object({ enable_metrics = bool enable_relay = bool })) })">object({…})</code> | | <code>{}</code> |
|
|
| [node_config](variables.tf#L402) | Node-level configuration. | <code title="object({ boot_disk_kms_key = optional(string) k8s_labels = optional(map(string)) labels = optional(map(string)) service_account = optional(string) tags = optional(list(string)) workload_metadata_config_mode = optional(string) kubelet_readonly_port_enabled = optional(bool, true) resource_manager_tags = optional(map(string), {}) })">object({…})</code> | | <code>{}</code> |
|
|
| [node_locations](variables.tf#L425) | Zones in which the cluster's nodes are located. | <code>list(string)</code> | | <code>[]</code> |
|
|
| [node_pool_auto_config](variables.tf#L432) | Node pool configs that apply to auto-provisioned node pools in autopilot clusters and node auto-provisioning-enabled clusters. | <code title="object({ cgroup_mode = optional(string) kubelet_readonly_port_enabled = optional(bool, true) network_tags = optional(list(string), []) resource_manager_tags = optional(map(string), {}) })">object({…})</code> | | <code>{}</code> |
|
|
| [release_channel](variables.tf#L454) | Release channel for GKE upgrades. | <code>string</code> | | <code>null</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [ca_certificate](outputs.tf#L17) | Public certificate of the cluster (base64-encoded). | ✓ |
|
|
| [cluster](outputs.tf#L25) | Cluster resource. | ✓ |
|
|
| [dns_endpoint](outputs.tf#L31) | Control plane DNS endpoint. | |
|
|
| [endpoint](outputs.tf#L39) | Cluster endpoint. | |
|
|
| [id](outputs.tf#L44) | FUlly qualified cluster id. | |
|
|
| [location](outputs.tf#L49) | Cluster location. | |
|
|
| [master_version](outputs.tf#L54) | Master version. | |
|
|
| [name](outputs.tf#L59) | Cluster name. | |
|
|
| [notifications](outputs.tf#L64) | GKE PubSub notifications topic. | |
|
|
| [self_link](outputs.tf#L69) | Cluster self link. | ✓ |
|
|
| [workload_identity_pool](outputs.tf#L75) | Workload identity pool. | |
|
|
<!-- END TFDOC -->
|