Merge pull request #168 from sassoftware/staging

4.4.0 - April 20, 2023

Author: jarpat

.pre-commit-config_template.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-  repo: meta
+   hooks:
+   - id: check-hooks-apply
+-  repo: local
+   hooks:
+   - id: hadolint-docker-file-entrypoint
+     name: hadolint
+     entry: docker.io/hadolint/hadolint /bin/hadolint
+     language: docker_image
+     types: [dockerfile]
+   - id: shellcheck-docker-file-entrypoint
+     name: shellcheck
+     entry: docker.io/koalaman/shellcheck
+     language: docker_image
+     types: [shell]
+   - id: tflint-locally-installed
+     name: tflint
+     entry: tflint
+     language: system
+     types: [terraform]
+-  repo: https://github.com/pre-commit/pre-commit-hooks
+   rev: v4.4.0
+   hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-added-large-files
+    - id: check-yaml

docs/CONFIG-VARS.md

@@ -107,7 +107,7 @@ The application of a Kubernetes version in GCP has some limitations when assigni
 | cluster_autoscaling_max_cpu_cores | MAX number of cores in the cluster | number | 500 | |
 | cluster_autoscaling_max_memory_gb | MAX number of gb of memory in the cluster | number | 10000 | |
 | create_static_kubeconfig | Allows the user to create a provider / service account based kube config file | bool | true | A value of `false` will default to using the cloud providers mechanism for generating the kubeconfig file. A value of `true` will create a static kubeconfig which utilizes a `Service Account` and `Cluster Role Binding` to provide credentials. |
-| regional | Create a regional GKE control plane | bool | true | If false a zonal GKE control plane is created |
+| regional | Create a regional GKE control plane | bool | true | If false a zonal GKE control plane is created. **WARNING: changing this after cluster creation is destructive** |
 | create_jump_vm | Create bastion host | bool | true | |
 | create_jump_public_ip | Add public ip to jump VM | bool | true | |
 | jump_vm_admin | OS Admin User for the Jump VM | string | "jumpuser" | |

locals.tf

@@ -55,6 +55,7 @@ locals {
       vm_type            = settings.vm_type
       node_taints        = settings.accelerator_count > 0 ? concat(settings.node_taints, ["nvidia.com/gpu=present:NoSchedule"]) : settings.node_taints
       initial_node_count = max(local.initial_node_count, settings.min_nodes)
+      node_locations     = var.nodepools_locations	!= "" && var.nodepools_locations != null ? var.nodepools_locations : local.zone
     }
   }
 
@@ -70,6 +71,7 @@ locals {
       "accelerator_count"  = 0
       "accelerator_type"   = ""
       "initial_node_count" = var.default_nodepool_min_nodes
+      "node_locations"     = var.default_nodepool_locations	!= "" && var.default_nodepool_locations != null ? var.default_nodepool_locations : local.zone
     }
   })
 

main.tf

@@ -141,7 +141,7 @@ module "gke" {
     for nodepool, settings in local.node_pools : {
       name               = nodepool
       machine_type       = settings.vm_type
-      node_locations     = local.zone # This must be a zone not a region. So var.location may not always work. ;)
+      node_locations     = settings.node_locations
       min_count          = settings.min_nodes
       max_count          = settings.max_nodes
       node_count         = (settings.min_nodes == settings.max_nodes) ? settings.min_nodes : null

outputs.tf

@@ -17,7 +17,7 @@ output "kube_config" {
   sensitive = true
 }
 
-#postgres
+# postgres
 output "postgres_servers" {
   value     = length(module.postgresql) != 0 ? local.postgres_outputs : null
   sensitive = true
@@ -90,7 +90,7 @@ output "nfs_admin_username" {
   value = var.storage_type == "standard" ? module.nfs_server.0.admin_username : null
 }
 
-# Container regsitry
+# Container registry
 output "cr_endpoint" {
   value = var.enable_registry_access ? "https://gcr.io/${var.project}" : null
 }

variables.tf

@@ -196,6 +196,13 @@ variable "default_nodepool_labels" {
   default = {}
 }
 
+# Multi-zonal cluster support - Experimental - may change, use at your own risk
+variable "default_nodepool_locations" {
+  description = "GCP zone(s) where the default nodepool will allocate nodes in. Comma separated list."
+  type    = string
+  default = ""
+}
+
 variable "node_pools" {
   description = "Node pool definitions"
   type = map(object({
@@ -266,6 +273,22 @@ variable "node_pools" {
   }
 }
 
+# Multi-zonal cluster support - Experimental - may change, use at your own risk
+# TODO - NOTE
+#   This was made external to the node_pools map variable since a requirement of terraform v1.0.0 (the minimum version
+#   we require, see versions.tf) is that for variables with nested fields, all attributes are required otherwise
+#   execution fails.
+#   In Terraform v1.3+ you can mark nested attributes as optional.
+#   Since this is an experimental change, at the moment I do no want to impose new requirements on existing users.
+#   Potentially we upgrade Terraform modules and versions and we bump our minimum required terraform version to be >1.3
+#   then at that time I can deprecate this variable and instead allow the user to configure node_locations per node pool.
+#   Refer to https://github.com/hashicorp/terraform/issues/29407#issuecomment-1150491619
+variable "nodepools_locations" {
+  description = "GCP zone(s) where the additional node pools will allocate nodes in. Comma separated list."
+  type    = string
+  default = ""
+}
+
 variable "enable_cluster_autoscaling" {
   description = "Setting this value will enable cluster_autoscaling"
   type        = bool