add support for upgrade notification filters to gke cluster modules (#3316)
This commit is contained in:
Ludovico Magnocavallo
committed by
GitHub
GitHub
parent
01e5e6d3e8
commit
75906c4e9e
@@ -268,25 +268,25 @@ module "cluster-1" {
|
||||
|
||||
| name | description | type | required | default |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [location](variables.tf#L149) | Autopilot clusters are always regional. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L228) | Cluster name. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L260) | Cluster project ID. | <code>string</code> | ✓ | |
|
||||
| [vpc_config](variables.tf#L276) | 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> | ✓ | |
|
||||
| [location](variables.tf#L161) | Autopilot clusters are always regional. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L240) | Cluster name. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L272) | Cluster project ID. | <code>string</code> | ✓ | |
|
||||
| [vpc_config](variables.tf#L288) | 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) })) })) private_nodes = optional(bool, true) master_ipv4_cidr_block = optional(string) })">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({ encryption_key = optional(string) include_secrets = optional(bool, true) include_volume_data = optional(bool, true) labels = optional(map(string)) namespaces = optional(list(string)) region = string schedule = string retention_policy_days = optional(string) retention_policy_lock = optional(bool, false) retention_policy_delete_lock_days = optional(string) })), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [deletion_protection](variables.tf#L66) | 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#L73) | Cluster description. | <code>string</code> | | <code>null</code> |
|
||||
| [enable_addons](variables.tf#L79) | Addons enabled in the cluster (true means enabled). | <code title="object({ cloudrun = optional(bool, false) config_connector = optional(bool, false) istio = optional(object({ enable_tls = bool })) kalm = optional(bool, false) })">object({…})</code> | | <code>{}</code> |
|
||||
| [enable_features](variables.tf#L93) | Enable cluster-level features. Certain features allow configuration. | <code title="object({ beta_apis = optional(list(string)) binary_authorization = 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 })) gateway_api = optional(bool, false) groups_for_rbac = optional(string) 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 })) allow_net_admin = optional(bool, false) 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) tpu = optional(bool, false) upgrade_notifications = optional(object({ topic_id = optional(string) })) vertical_pod_autoscaling = optional(bool, false) enterprise_cluster = optional(bool) })">object({…})</code> | | <code>{}</code> |
|
||||
| [issue_client_certificate](variables.tf#L137) | Enable issuing client certificate. | <code>bool</code> | | <code>false</code> |
|
||||
| [labels](variables.tf#L143) | Cluster resource labels. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [logging_config](variables.tf#L154) | Logging configuration. | <code title="object({ 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#L165) | 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> |
|
||||
| [min_master_version](variables.tf#L188) | 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#L194) | Monitoring configuration. System metrics collection cannot be disabled. Control plane metrics are optional. Kube state metrics are optional. Google Cloud Managed Service for Prometheus is enabled by default. | <code title="object({ 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) })">object({…})</code> | | <code>{}</code> |
|
||||
| [node_config](variables.tf#L233) | Configuration for nodes and nodepools. | <code title="object({ boot_disk_kms_key = optional(string) service_account = optional(string) tags = optional(list(string)) workload_metadata_config_mode = optional(string) kubelet_readonly_port_enabled = optional(bool, true) })">object({…})</code> | | <code>{}</code> |
|
||||
| [node_locations](variables.tf#L253) | Zones in which the cluster's nodes are located. | <code>list(string)</code> | | <code>[]</code> |
|
||||
| [release_channel](variables.tf#L265) | Release channel for GKE upgrades. Clusters created in the Autopilot mode must use a release channel. Choose between \"RAPID\", \"REGULAR\", and \"STABLE\". | <code>string</code> | | <code>"REGULAR"</code> |
|
||||
| [enable_features](variables.tf#L93) | Enable cluster-level features. Certain features allow configuration. | <code title="object({ beta_apis = optional(list(string)) binary_authorization = 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 })) gateway_api = optional(bool, false) groups_for_rbac = optional(string) 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 })) allow_net_admin = optional(bool, false) 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) 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) enterprise_cluster = optional(bool) })">object({…})</code> | | <code>{}</code> |
|
||||
| [issue_client_certificate](variables.tf#L149) | Enable issuing client certificate. | <code>bool</code> | | <code>false</code> |
|
||||
| [labels](variables.tf#L155) | Cluster resource labels. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [logging_config](variables.tf#L166) | Logging configuration. | <code title="object({ 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#L177) | 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> |
|
||||
| [min_master_version](variables.tf#L200) | 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#L206) | Monitoring configuration. System metrics collection cannot be disabled. Control plane metrics are optional. Kube state metrics are optional. Google Cloud Managed Service for Prometheus is enabled by default. | <code title="object({ 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) })">object({…})</code> | | <code>{}</code> |
|
||||
| [node_config](variables.tf#L245) | Configuration for nodes and nodepools. | <code title="object({ boot_disk_kms_key = optional(string) service_account = optional(string) tags = optional(list(string)) workload_metadata_config_mode = optional(string) kubelet_readonly_port_enabled = optional(bool, true) })">object({…})</code> | | <code>{}</code> |
|
||||
| [node_locations](variables.tf#L265) | Zones in which the cluster's nodes are located. | <code>list(string)</code> | | <code>[]</code> |
|
||||
| [release_channel](variables.tf#L277) | Release channel for GKE upgrades. Clusters created in the Autopilot mode must use a release channel. Choose between \"RAPID\", \"REGULAR\", and \"STABLE\". | <code>string</code> | | <code>"REGULAR"</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
||||
@@ -265,7 +265,13 @@ resource "google_container_cluster" "cluster" {
|
||||
for_each = var.enable_features.upgrade_notifications != null ? [""] : []
|
||||
content {
|
||||
pubsub {
|
||||
enabled = true
|
||||
enabled = var.enable_features.upgrade_notifications.enabled
|
||||
dynamic "filter" {
|
||||
for_each = var.enable_features.upgrade_notifications.event_types != null ? [""] : []
|
||||
content {
|
||||
event_type = var.enable_features.upgrade_notifications.event_types
|
||||
}
|
||||
}
|
||||
topic = (
|
||||
try(var.enable_features.upgrade_notifications.topic_id, null) != null
|
||||
? var.enable_features.upgrade_notifications.topic_id
|
||||
|
||||
@@ -126,12 +126,24 @@ variable "enable_features" {
|
||||
service_external_ips = optional(bool, true)
|
||||
tpu = optional(bool, false)
|
||||
upgrade_notifications = optional(object({
|
||||
topic_id = optional(string)
|
||||
enabled = optional(bool, true)
|
||||
event_types = optional(list(string), [])
|
||||
topic_id = optional(string)
|
||||
}))
|
||||
vertical_pod_autoscaling = optional(bool, false)
|
||||
enterprise_cluster = optional(bool)
|
||||
})
|
||||
default = {}
|
||||
validation {
|
||||
condition = alltrue([
|
||||
for e in try(var.enable_features.upgrade_notifications.event_types, []) :
|
||||
contains([
|
||||
"UPGRADE_AVAILABLE_EVENT", "UPGRADE_EVENT",
|
||||
"SECURITY_BULLETIN_EVENT", "UPGRADE_INFO_EVENT"
|
||||
], e)
|
||||
])
|
||||
error_message = "Invalid upgrade notification event type."
|
||||
}
|
||||
}
|
||||
|
||||
variable "issue_client_certificate" {
|
||||
|
||||
@@ -13,6 +13,7 @@ This module offers a way to create and manage Google Kubernetes Engine (GKE) [St
|
||||
- [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)
|
||||
@@ -222,6 +223,30 @@ module "cluster-1" {
|
||||
# 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.
|
||||
@@ -416,7 +441,6 @@ module "cluster-1" {
|
||||
|
||||
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"
|
||||
@@ -486,10 +510,10 @@ module "cluster-1" {
|
||||
|
||||
| name | description | type | required | default |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [location](variables.tf#L269) | Cluster zone or region. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L384) | Cluster name. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L435) | Cluster project id. | <code>string</code> | ✓ | |
|
||||
| [vpc_config](variables.tf#L446) | 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> | ✓ | |
|
||||
| [location](variables.tf#L281) | Cluster zone or region. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L396) | Cluster name. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L447) | Cluster project id. | <code>string</code> | ✓ | |
|
||||
| [vpc_config](variables.tf#L458) | 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)) 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#L67) | 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> |
|
||||
@@ -497,18 +521,18 @@ module "cluster-1" {
|
||||
| [deletion_protection](variables.tf#L165) | 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#L172) | Cluster description. | <code>string</code> | | <code>null</code> |
|
||||
| [enable_addons](variables.tf#L178) | 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#L200) | 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({ 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#L256) | Enable issuing client certificate. | <code>bool</code> | | <code>false</code> |
|
||||
| [labels](variables.tf#L262) | Cluster resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [logging_config](variables.tf#L274) | 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#L295) | 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#L318) | Maximum number of pods per node in this cluster. | <code>number</code> | | <code>110</code> |
|
||||
| [min_master_version](variables.tf#L324) | 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#L330) | 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#L389) | 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) })">object({…})</code> | | <code>{}</code> |
|
||||
| [node_locations](variables.tf#L411) | Zones in which the cluster's nodes are located. | <code>list(string)</code> | | <code>[]</code> |
|
||||
| [node_pool_auto_config](variables.tf#L418) | 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#L440) | Release channel for GKE upgrades. | <code>string</code> | | <code>null</code> |
|
||||
| [enable_features](variables.tf#L200) | 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#L268) | Enable issuing client certificate. | <code>bool</code> | | <code>false</code> |
|
||||
| [labels](variables.tf#L274) | Cluster resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [logging_config](variables.tf#L286) | 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#L307) | 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#L330) | Maximum number of pods per node in this cluster. | <code>number</code> | | <code>110</code> |
|
||||
| [min_master_version](variables.tf#L336) | 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#L342) | 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#L401) | 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) })">object({…})</code> | | <code>{}</code> |
|
||||
| [node_locations](variables.tf#L423) | Zones in which the cluster's nodes are located. | <code>list(string)</code> | | <code>[]</code> |
|
||||
| [node_pool_auto_config](variables.tf#L430) | 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#L452) | Release channel for GKE upgrades. | <code>string</code> | | <code>null</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
||||
@@ -494,7 +494,13 @@ resource "google_container_cluster" "cluster" {
|
||||
for_each = var.enable_features.upgrade_notifications != null ? [""] : []
|
||||
content {
|
||||
pubsub {
|
||||
enabled = true
|
||||
enabled = var.enable_features.upgrade_notifications.enabled
|
||||
dynamic "filter" {
|
||||
for_each = var.enable_features.upgrade_notifications.event_types != null ? [""] : []
|
||||
content {
|
||||
event_type = var.enable_features.upgrade_notifications.event_types
|
||||
}
|
||||
}
|
||||
topic = (
|
||||
try(var.enable_features.upgrade_notifications.topic_id, null) != null
|
||||
? var.enable_features.upgrade_notifications.topic_id
|
||||
|
||||
@@ -238,7 +238,9 @@ variable "enable_features" {
|
||||
shielded_nodes = optional(bool, false)
|
||||
tpu = optional(bool, false)
|
||||
upgrade_notifications = optional(object({
|
||||
topic_id = optional(string)
|
||||
enabled = optional(bool, true)
|
||||
event_types = optional(list(string), [])
|
||||
topic_id = optional(string)
|
||||
}))
|
||||
vertical_pod_autoscaling = optional(bool, false)
|
||||
workload_identity = optional(bool, true)
|
||||
@@ -251,6 +253,16 @@ variable "enable_features" {
|
||||
)
|
||||
error_message = "FQDN network policy is only supported for clusters with Dataplane v2."
|
||||
}
|
||||
validation {
|
||||
condition = alltrue([
|
||||
for e in try(var.enable_features.upgrade_notifications.event_types, []) :
|
||||
contains([
|
||||
"UPGRADE_AVAILABLE_EVENT", "UPGRADE_EVENT",
|
||||
"SECURITY_BULLETIN_EVENT", "UPGRADE_INFO_EVENT"
|
||||
], e)
|
||||
])
|
||||
error_message = "Invalid upgrade notification event type."
|
||||
}
|
||||
}
|
||||
|
||||
variable "issue_client_certificate" {
|
||||
|
||||
181
tests/modules/gke_cluster_standard/examples/notifications.yaml
Normal file
181
tests/modules/gke_cluster_standard/examples/notifications.yaml
Normal file
@@ -0,0 +1,181 @@
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
values:
|
||||
module.cluster-1.google_container_cluster.cluster:
|
||||
addons_config:
|
||||
- cloudrun_config:
|
||||
- disabled: true
|
||||
load_balancer_type: null
|
||||
config_connector_config:
|
||||
- enabled: false
|
||||
dns_cache_config:
|
||||
- enabled: true
|
||||
gce_persistent_disk_csi_driver_config:
|
||||
- enabled: true
|
||||
gcp_filestore_csi_driver_config:
|
||||
- enabled: true
|
||||
gcs_fuse_csi_driver_config:
|
||||
- enabled: true
|
||||
gke_backup_agent_config:
|
||||
- enabled: false
|
||||
horizontal_pod_autoscaling:
|
||||
- disabled: false
|
||||
http_load_balancing:
|
||||
- disabled: false
|
||||
istio_config:
|
||||
- auth: null
|
||||
disabled: true
|
||||
kalm_config:
|
||||
- enabled: false
|
||||
network_policy_config:
|
||||
- disabled: true
|
||||
stateful_ha_config:
|
||||
- enabled: false
|
||||
allow_net_admin: null
|
||||
binary_authorization: []
|
||||
control_plane_endpoints_config:
|
||||
- dns_endpoint_config:
|
||||
- allow_external_traffic: true
|
||||
ip_endpoints_config:
|
||||
- enabled: false
|
||||
cost_management_config:
|
||||
- enabled: true
|
||||
datapath_provider: ADVANCED_DATAPATH
|
||||
default_max_pods_per_node: 110
|
||||
deletion_protection: true
|
||||
description: null
|
||||
disable_l4_lb_firewall_reconciliation: false
|
||||
dns_config: []
|
||||
effective_labels:
|
||||
goog-terraform-provisioned: 'true'
|
||||
enable_autopilot: null
|
||||
enable_cilium_clusterwide_network_policy: false
|
||||
enable_fqdn_network_policy: true
|
||||
enable_intranode_visibility: false
|
||||
enable_k8s_beta_apis: []
|
||||
enable_kubernetes_alpha: false
|
||||
enable_l4_ilb_subsetting: false
|
||||
enable_legacy_abac: false
|
||||
enable_multi_networking: false
|
||||
enable_shielded_nodes: false
|
||||
enable_tpu: false
|
||||
fleet: []
|
||||
in_transit_encryption_config: null
|
||||
initial_node_count: 1
|
||||
ip_allocation_policy:
|
||||
- additional_ip_ranges_config: []
|
||||
additional_pod_ranges_config: []
|
||||
stack_type: IPV4
|
||||
location: europe-west1-b
|
||||
logging_config:
|
||||
- enable_components:
|
||||
- SYSTEM_COMPONENTS
|
||||
maintenance_policy:
|
||||
- daily_maintenance_window:
|
||||
- start_time: 03:00
|
||||
maintenance_exclusion: []
|
||||
recurring_window: []
|
||||
master_auth:
|
||||
- client_certificate_config:
|
||||
- issue_client_certificate: false
|
||||
min_master_version: null
|
||||
monitoring_config:
|
||||
- enable_components:
|
||||
- SYSTEM_COMPONENTS
|
||||
managed_prometheus:
|
||||
- enabled: true
|
||||
name: cluster-1
|
||||
network: projects/xxx/global/networks/aaa
|
||||
network_performance_config: []
|
||||
network_policy: []
|
||||
node_config:
|
||||
- advanced_machine_features: []
|
||||
boot_disk_kms_key: null
|
||||
containerd_config: []
|
||||
enable_confidential_storage: null
|
||||
ephemeral_storage_config: []
|
||||
ephemeral_storage_local_ssd_config: []
|
||||
fast_socket: []
|
||||
flex_start: null
|
||||
gvnic: []
|
||||
host_maintenance_policy: []
|
||||
local_nvme_ssd_block_config: []
|
||||
local_ssd_encryption_mode: null
|
||||
max_run_duration: null
|
||||
node_group: null
|
||||
preemptible: false
|
||||
reservation_affinity: []
|
||||
resource_labels: null
|
||||
resource_manager_tags: null
|
||||
sandbox_config: []
|
||||
secondary_boot_disks: []
|
||||
sole_tenant_config: []
|
||||
spot: false
|
||||
storage_pools: null
|
||||
tags: null
|
||||
taint: []
|
||||
node_pool_defaults:
|
||||
- node_config_defaults:
|
||||
- containerd_config: []
|
||||
gcfs_config:
|
||||
- enabled: false
|
||||
insecure_kubelet_readonly_port_enabled: 'TRUE'
|
||||
notification_config:
|
||||
- pubsub:
|
||||
- enabled: true
|
||||
filter:
|
||||
- event_type:
|
||||
- SECURITY_BULLETIN_EVENT
|
||||
- UPGRADE_EVENT
|
||||
pod_security_policy_config: []
|
||||
private_cluster_config:
|
||||
- enable_private_endpoint: true
|
||||
enable_private_nodes: true
|
||||
private_endpoint_subnetwork: null
|
||||
project: myproject
|
||||
remove_default_node_pool: true
|
||||
resource_labels: null
|
||||
resource_usage_export_config: []
|
||||
secret_manager_config: []
|
||||
subnetwork: subnet_self_link
|
||||
terraform_labels:
|
||||
goog-terraform-provisioned: 'true'
|
||||
timeouts: null
|
||||
user_managed_keys_config: []
|
||||
workload_identity_config:
|
||||
- workload_pool: myproject.svc.id.goog
|
||||
module.cluster-1.google_pubsub_topic.notifications[0]:
|
||||
effective_labels:
|
||||
content: gke-notifications
|
||||
goog-terraform-provisioned: 'true'
|
||||
ingestion_data_source_settings: []
|
||||
kms_key_name: null
|
||||
labels:
|
||||
content: gke-notifications
|
||||
message_retention_duration: null
|
||||
message_transforms: []
|
||||
name: gke-pubsub-notifications
|
||||
project: myproject
|
||||
schema_settings: []
|
||||
terraform_labels:
|
||||
content: gke-notifications
|
||||
goog-terraform-provisioned: 'true'
|
||||
timeouts: null
|
||||
|
||||
counts:
|
||||
google_container_cluster: 1
|
||||
google_pubsub_topic: 1
|
||||
modules: 1
|
||||
resources: 2
|
||||
Reference in New Issue
Block a user