124 lines
12 KiB
Markdown
124 lines
12 KiB
Markdown
# GKE cluster module
|
|
|
|
This module allows simplified creation and management of GKE clusters and should be used together with the GKE nodepool module, as the default nodepool is turned off here and cannot be re-enabled. Some sensible defaults are set initially, in order to allow less verbose usage for most use cases.
|
|
|
|
## Example
|
|
|
|
### GKE Cluster
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./modules/gke-cluster"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_pods = "pods"
|
|
secondary_range_services = "services"
|
|
default_max_pods_per_node = 32
|
|
master_authorized_ranges = {
|
|
internal-vms = "10.0.0.0/8"
|
|
}
|
|
private_cluster_config = {
|
|
enable_private_nodes = true
|
|
enable_private_endpoint = true
|
|
master_ipv4_cidr_block = "192.168.0.0/28"
|
|
master_global_access = false
|
|
}
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1
|
|
```
|
|
|
|
### GKE Cluster with Dataplane V2 enabled
|
|
|
|
```hcl
|
|
module "cluster-1" {
|
|
source = "./modules/gke-cluster"
|
|
project_id = "myproject"
|
|
name = "cluster-1"
|
|
location = "europe-west1-b"
|
|
network = var.vpc.self_link
|
|
subnetwork = var.subnet.self_link
|
|
secondary_range_pods = "pods"
|
|
secondary_range_services = "services"
|
|
default_max_pods_per_node = 32
|
|
enable_dataplane_v2 = true
|
|
master_authorized_ranges = {
|
|
internal-vms = "10.0.0.0/8"
|
|
}
|
|
private_cluster_config = {
|
|
enable_private_nodes = true
|
|
enable_private_endpoint = true
|
|
master_ipv4_cidr_block = "192.168.0.0/28"
|
|
master_global_access = false
|
|
}
|
|
labels = {
|
|
environment = "dev"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=1
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [location](variables.tf#L163) | Cluster zone or region. | <code>string</code> | ✓ | |
|
|
| [name](variables.tf#L230) | Cluster name. | <code>string</code> | ✓ | |
|
|
| [network](variables.tf#L235) | Name or self link of the VPC used for the cluster. Use the self link for Shared VPC. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L279) | Cluster project id. | <code>string</code> | ✓ | |
|
|
| [secondary_range_pods](variables.tf#L302) | Subnet secondary range name used for pods. | <code>string</code> | ✓ | |
|
|
| [secondary_range_services](variables.tf#L307) | Subnet secondary range name used for services. | <code>string</code> | ✓ | |
|
|
| [subnetwork](variables.tf#L312) | VPC subnetwork name or self link. | <code>string</code> | ✓ | |
|
|
| [addons](variables.tf#L17) | Addons enabled in the cluster (true means enabled). | <code title="object({ cloudrun_config = bool dns_cache_config = bool horizontal_pod_autoscaling = bool http_load_balancing = bool istio_config = object({ enabled = bool tls = bool }) network_policy_config = bool gce_persistent_disk_csi_driver_config = bool gcp_filestore_csi_driver_config = bool config_connector_config = bool kalm_config = bool })">object({…})</code> | | <code title="{ cloudrun_config = false dns_cache_config = false horizontal_pod_autoscaling = true http_load_balancing = true istio_config = { enabled = false tls = false } network_policy_config = false gce_persistent_disk_csi_driver_config = false gcp_filestore_csi_driver_config = false config_connector_config = false kalm_config = false }">{…}</code> |
|
|
| [authenticator_security_group](variables.tf#L51) | RBAC security group for Google Groups for GKE, format is gke-security-groups@yourdomain.com. | <code>string</code> | | <code>null</code> |
|
|
| [cluster_autoscaling](variables.tf#L57) | Enable and configure limits for Node Auto-Provisioning with Cluster Autoscaler. | <code title="object({ enabled = bool cpu_min = number cpu_max = number memory_min = number memory_max = number })">object({…})</code> | | <code title="{ enabled = false cpu_min = 0 cpu_max = 0 memory_min = 0 memory_max = 0 }">{…}</code> |
|
|
| [database_encryption](variables.tf#L75) | Enable and configure GKE application-layer secrets encryption. | <code title="object({ enabled = bool state = string key_name = string })">object({…})</code> | | <code title="{ enabled = false state = "DECRYPTED" key_name = null }">{…}</code> |
|
|
| [default_max_pods_per_node](variables.tf#L89) | Maximum number of pods per node in this cluster. | <code>number</code> | | <code>110</code> |
|
|
| [description](variables.tf#L95) | Cluster description. | <code>string</code> | | <code>null</code> |
|
|
| [dns_config](variables.tf#L101) | Configuration for Using Cloud DNS for GKE. | <code title="object({ cluster_dns = string cluster_dns_scope = string cluster_dns_domain = string })">object({…})</code> | | <code title="{ cluster_dns = "PROVIDER_UNSPECIFIED" cluster_dns_scope = "DNS_SCOPE_UNSPECIFIED" cluster_dns_domain = "" }">{…}</code> |
|
|
| [enable_autopilot](variables.tf#L115) | Create cluster in autopilot mode. With autopilot there's no need to create node-pools and some features are not supported (e.g. setting default_max_pods_per_node). | <code>bool</code> | | <code>false</code> |
|
|
| [enable_binary_authorization](variables.tf#L121) | Enable Google Binary Authorization. | <code>bool</code> | | <code>null</code> |
|
|
| [enable_dataplane_v2](variables.tf#L127) | Enable Dataplane V2 on the cluster, will disable network_policy addons config. | <code>bool</code> | | <code>false</code> |
|
|
| [enable_intranode_visibility](variables.tf#L133) | Enable intra-node visibility to make same node pod to pod traffic visible. | <code>bool</code> | | <code>null</code> |
|
|
| [enable_l4_ilb_subsetting](variables.tf#L139) | Enable L4ILB Subsetting. | <code>bool</code> | | <code>null</code> |
|
|
| [enable_shielded_nodes](variables.tf#L145) | Enable Shielded Nodes features on all nodes in this cluster. | <code>bool</code> | | <code>null</code> |
|
|
| [enable_tpu](variables.tf#L151) | Enable Cloud TPU resources in this cluster. | <code>bool</code> | | <code>null</code> |
|
|
| [labels](variables.tf#L157) | Cluster resource labels. | <code>map(string)</code> | | <code>null</code> |
|
|
| [logging_config](variables.tf#L168) | Logging configuration (enabled components). | <code>list(string)</code> | | <code>null</code> |
|
|
| [logging_service](variables.tf#L174) | Logging service (disable with an empty string). | <code>string</code> | | <code>"logging.googleapis.com/kubernetes"</code> |
|
|
| [maintenance_config](variables.tf#L180) | Maintenance window configuration. | <code title="object({ daily_maintenance_window = object({ start_time = string }) recurring_window = object({ start_time = string end_time = string recurrence = string }) maintenance_exclusion = list(object({ exclusion_name = string start_time = string end_time = string })) })">object({…})</code> | | <code title="{ daily_maintenance_window = { start_time = "03:00" } recurring_window = null maintenance_exclusion = [] }">{…}</code> |
|
|
| [master_authorized_ranges](variables.tf#L206) | External Ip address ranges that can access the Kubernetes cluster master through HTTPS. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [min_master_version](variables.tf#L212) | 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#L218) | Monitoring configuration (enabled components). | <code>list(string)</code> | | <code>null</code> |
|
|
| [monitoring_service](variables.tf#L224) | Monitoring service (disable with an empty string). | <code>string</code> | | <code>"monitoring.googleapis.com/kubernetes"</code> |
|
|
| [node_locations](variables.tf#L240) | Zones in which the cluster's nodes are located. | <code>list(string)</code> | | <code>[]</code> |
|
|
| [notification_config](variables.tf#L246) | GKE Cluster upgrade notifications via PubSub. | <code>bool</code> | | <code>false</code> |
|
|
| [peering_config](variables.tf#L252) | Configure peering with the master VPC for private clusters. | <code title="object({ export_routes = bool import_routes = bool project_id = string })">object({…})</code> | | <code>null</code> |
|
|
| [pod_security_policy](variables.tf#L262) | Enable the PodSecurityPolicy feature. | <code>bool</code> | | <code>null</code> |
|
|
| [private_cluster_config](variables.tf#L268) | Enable and configure private cluster, private nodes must be true if used. | <code title="object({ enable_private_nodes = bool enable_private_endpoint = bool master_ipv4_cidr_block = string master_global_access = bool })">object({…})</code> | | <code>null</code> |
|
|
| [release_channel](variables.tf#L284) | Release channel for GKE upgrades. | <code>string</code> | | <code>null</code> |
|
|
| [resource_usage_export_config](variables.tf#L290) | Configure the ResourceUsageExportConfig feature. | <code title="object({ enabled = bool dataset = string })">object({…})</code> | | <code title="{ enabled = null dataset = null }">{…}</code> |
|
|
| [vertical_pod_autoscaling](variables.tf#L317) | Enable the Vertical Pod Autoscaling feature. | <code>bool</code> | | <code>null</code> |
|
|
| [workload_identity](variables.tf#L323) | Enable the Workload Identity feature. | <code>bool</code> | | <code>true</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [ca_certificate](outputs.tf#L17) | Public certificate of the cluster (base64-encoded). | ✓ |
|
|
| [cluster](outputs.tf#L23) | Cluster resource. | ✓ |
|
|
| [endpoint](outputs.tf#L29) | Cluster endpoint. | |
|
|
| [id](outputs.tf#L34) | Cluster ID. | ✓ |
|
|
| [location](outputs.tf#L40) | Cluster location. | |
|
|
| [master_version](outputs.tf#L45) | Master version. | |
|
|
| [name](outputs.tf#L50) | Cluster name. | |
|
|
| [notifications](outputs.tf#L55) | GKE PubSub notifications topic. | |
|
|
| [self_link](outputs.tf#L60) | Cluster self link. | ✓ |
|
|
|
|
<!-- END TFDOC --> |