feat: Fix healthchecks inconsistency. (#56)

BREAKING CHANGE: Health check variables and resources were reorganized in this backwards-incompatible release. See the [upgrade guide](./docs/upgrading_to_mig_v2.0.md) for details.

Author: omazin

CHANGELOG.md

@@ -9,6 +9,11 @@ All notable changes to this project will be documented in this file. See [standa
 
 * derive project id for instance from instance template ([#63](https://github.com/terraform-google-modules/terraform-google-vm/issues/63)) ([3e2c8cd](https://github.com/terraform-google-modules/terraform-google-vm/commit/3e2c8cdeb2d0e6f1fe53bc2d0a9369c9dc59f013))
 
+### Changed
+
+- Replace health check related variables with a single object type parameter called `health_check` on the `mig` and
+  `mig_with_percent` submodules. [#56]
+
 ## [1.4.0] - 2020-01-08
 
 ### Added
@@ -92,4 +97,5 @@ All notable changes to this project will be documented in this file. See [standa
 [#43]: https://github.com/terraform-google-modules/terraform-google-vm/pull/43
 [#44]: https://github.com/terraform-google-modules/terraform-google-vm/pull/44
 [#52]: https://github.com/terraform-google-modules/terraform-google-vm/pull/52
+[#56]: https://github.com/terraform-google-modules/terraform-google-vm/pull/56
 [#57]: https://github.com/terraform-google-modules/terraform-google-vm/pull/57

Makefile

@@ -81,16 +81,16 @@ docker_generate_docs:
 		/bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs'
 
 # Generate files from autogen
-.PHONY: docker_generate
-docker_generate:
+.PHONY: docker_generate_modules
+docker_generate_modules:
 	docker run --rm -it \
-                -v "$(CURDIR)":/workspace \
-                $(REGISTRY_URL)/${DOCKER_IMAGE_DEVELOPER_TOOLS}:${DOCKER_TAG_VERSION_DEVELOPER_TOOLS} \
-                /bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate'
+		-v "$(CURDIR)":/workspace \
+		$(REGISTRY_URL)/${DOCKER_IMAGE_DEVELOPER_TOOLS}:${DOCKER_TAG_VERSION_DEVELOPER_TOOLS} \
+		/bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_modules'
 
 # Alias for backwards compatibility
 .PHONY: generate_docs
 generate_docs: docker_generate_docs
 
-.PHONY: generate
-generate: docker_generate
+.PHONY: generate_modules
+generate_modules: docker_generate_modules

autogen/README.md

@@ -14,6 +14,12 @@ This module allows you to set the percentage ratio of second version of instance
 
 See the [simple example](../../examples/{{ module_name }}/simple) for a usage example.
 
+## Upgrading
+
+The current version is 2.X. The following guides are available to assist with upgrades:
+
+- [1.X -> 2.0](../../docs/upgrading_to_mig_v2.0.md)
+
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

autogen/main.tf.tmpl

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,8 @@
 
 locals {
   healthchecks = concat(
-    google_compute_health_check.http_healthcheck.*.self_link,
-    google_compute_health_check.tcp_healthcheck.*.self_link,
+    google_compute_health_check.http.*.self_link,
+    google_compute_health_check.tcp.*.self_link,
   )
   distribution_policy_zones_base = {
     default = data.google_compute_zones.available.names
@@ -73,9 +73,12 @@ resource "google_compute_region_instance_group_manager" "{{ module_name }}" {
   target_pools = var.target_pools
   target_size  = var.autoscaling_enabled ? var.min_replicas : var.target_size
 
-  auto_healing_policies {
-    health_check      = length(local.healthchecks) > 0 ? local.healthchecks[0] : ""
-    initial_delay_sec = length(local.healthchecks) > 0 ? var.hc_initial_delay_sec : 0
+  dynamic "auto_healing_policies" {
+    for_each = local.healthchecks
+    content {
+      health_check      = auto_healing_policies.value
+      initial_delay_sec = var.health_check["initial_delay_sec"]
+    }
   }
 
   distribution_policy_zones = local.distribution_policy_zones
@@ -139,35 +142,39 @@ resource "google_compute_region_autoscaler" "autoscaler" {
   {% endif %}
 }
 
-resource "google_compute_health_check" "http_healthcheck" {
-  provider = google
-  count    = var.http_healthcheck_enable ? 1 : 0
-  name     = "${var.hostname}-http-healthcheck"
-  project  = var.project_id
+resource "google_compute_health_check" "http" {
+  count   = var.health_check["type"] == "http" ? 1 : 0
+  project = var.project_id
+  name    = "${var.hostname}-http-healthcheck"
 
-  check_interval_sec  = var.hc_interval_sec
-  timeout_sec         = var.hc_timeout_sec
-  healthy_threshold   = var.hc_healthy_threshold
-  unhealthy_threshold = var.hc_unhealthy_threshold
+  check_interval_sec  = var.health_check["check_interval_sec"]
+  healthy_threshold   = var.health_check["healthy_threshold"]
+  timeout_sec         = var.health_check["timeout_sec"]
+  unhealthy_threshold = var.health_check["unhealthy_threshold"]
 
   http_health_check {
-    request_path = var.hc_path
-    port         = var.hc_port
+    port         = var.health_check["port"]
+    request_path = var.health_check["request_path"]
+    host         = var.health_check["host"]
+    response     = var.health_check["response"]
+    proxy_header = var.health_check["proxy_header"]
   }
 }
 
-resource "google_compute_health_check" "tcp_healthcheck" {
-  provider = google
-  count    = var.tcp_healthcheck_enable ? 1 : 0
-  project  = var.project_id
-  name     = "${var.hostname}-tcp-healthcheck"
+resource "google_compute_health_check" "tcp" {
+  count   = var.health_check["type"] == "tcp" ? 1 : 0
+  project = var.project_id
+  name    = "${var.hostname}-tcp-healthcheck"
 
-  check_interval_sec  = var.hc_interval_sec
-  timeout_sec         = var.hc_timeout_sec
-  healthy_threshold   = var.hc_healthy_threshold
-  unhealthy_threshold = var.hc_unhealthy_threshold
+  timeout_sec         = var.health_check["timeout_sec"]
+  check_interval_sec  = var.health_check["check_interval_sec"]
+  healthy_threshold   = var.health_check["healthy_threshold"]
+  unhealthy_threshold = var.health_check["unhealthy_threshold"]
 
   tcp_health_check {
-    port = var.hc_port
+    port         = var.health_check["port"]
+    request      = var.health_check["request"]
+    response     = var.health_check["response"]
+    proxy_header = var.health_check["proxy_header"]
   }
 }

autogen/outputs.tf.tmpl

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

autogen/variables.tf.tmpl

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -89,49 +89,36 @@ variable "update_policy" {
 # Healthcheck
 ##############
 
-variable "http_healthcheck_enable" {
-  description = "Enable HTTP healthcheck"
-  default     = "false"
-}
-
-variable "tcp_healthcheck_enable" {
-  description = "Enable TCP healthcheck"
-  default     = "false"
-}
-
-variable "hc_initial_delay_sec" {
-  description = "Health check, intial delay in seconds."
-  default     = 30
-}
-
-variable "hc_interval_sec" {
-  description = "Health check interval in seconds."
-  default     = 30
-}
-
-variable "hc_timeout_sec" {
-  description = "Health check timeout in seconds."
-  default     = 10
-}
-
-variable "hc_healthy_threshold" {
-  description = "Health check healthy threshold."
-  default     = 1
-}
-
-variable "hc_unhealthy_threshold" {
-  description = "Health check unhealthy threshold."
-  default     = 5
-}
-
-variable "hc_path" {
-  description = "Health check http path to check."
-  default     = "/"
-}
-
-variable "hc_port" {
-  description = "Health check port."
-  default     = ""
+variable "health_check" {
+  description = "Health check to determine whether instances are responsive and able to do work"
+  type = object({
+    type                = string
+    initial_delay_sec   = number
+    check_interval_sec  = number
+    healthy_threshold   = number
+    timeout_sec         = number
+    unhealthy_threshold = number
+    response            = string
+    proxy_header        = string
+    port                = number
+    request             = string
+    request_path        = string
+    host                = string
+  })
+  default = {
+    type                = ""
+    initial_delay_sec   = 30
+    check_interval_sec  = 30
+    healthy_threshold   = 1
+    timeout_sec         = 10
+    unhealthy_threshold = 5
+    response            = ""
+    proxy_header        = "NONE"
+    port                = 80
+    request             = ""
+    request_path        = "/"
+    host                = ""
+  }
 }
 
 #############

autogen/versions.tf

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

docs/upgrading_to_mig_v2.0.md

@@ -0,0 +1,53 @@
+# Upgrading to MIG v2.0 (from v1.X)
+
+The v2.0 release of MIG is a backwards incompatible release. The health check related variables `http_healthcheck_enable`, `tcp_healthcheck_enable`, `hc_initial_delay_sec`, `hc_interval_sec`, `hc_timeout_sec`, `hc_healthy_threshold`, `hc_unhealthy_threshold`, `hc_path` and `hc_port` were replaced with the new object type parameter called `health_check`.
+
+## Migration Instructions
+
+### Health Check Arguments Changes
+
+Version 1.X of MIG used the optional health check variables:
+
+```hcl
+
+module "vm_mig" {
+  source                  = "terraform-google-modules/vm/google//modules/mig"
+  version                 = "1.3.0"
+  ...
+  /* health checks */
+  http_healthcheck_enable = true
+  tcp_healthcheck_enable  = false
+  hc_initial_delay_sec    = 30
+  hc_interval_sec         = 30
+  hc_timeout_sec          = 10
+  hc_healthy_threshold    = 1
+  hc_unhealthy_threshold  = 5
+  hc_path                 = "/"
+  hc_port                 = 80
+}
+```
+
+Version 2.X of MIG uses the new object parameter named `health_check`:
+
+```hcl
+module "mig" {
+  source                  = "terraform-google-modules/vm/google//modules/mig"
+  version                 = "1.3.0"
+  ...
+  health_check = {
+    type                = "http"
+    initial_delay_sec   = 30
+    check_interval_sec  = 30
+    healthy_threshold   = 1
+    timeout_sec         = 10
+    unhealthy_threshold = 5
+    response            = ""
+    proxy_header        = "NONE"
+    port                = 80
+    request             = ""
+    request_path        = "/"
+    host                = ""
+  }
+}
+```
+

examples/mig/full/main.tf

@@ -72,16 +72,8 @@ module "mig" {
   update_policy             = var.update_policy
   named_ports               = var.named_ports
 
-  /* health checks */
-  http_healthcheck_enable = var.http_healthcheck_enable
-  tcp_healthcheck_enable  = var.tcp_healthcheck_enable
-  hc_initial_delay_sec    = var.hc_initial_delay_sec
-  hc_interval_sec         = var.hc_interval_sec
-  hc_timeout_sec          = var.hc_timeout_sec
-  hc_healthy_threshold    = var.hc_healthy_threshold
-  hc_unhealthy_threshold  = var.hc_unhealthy_threshold
-  hc_path                 = var.hc_path
-  hc_port                 = var.hc_port
+  /* health check */
+  health_check = var.health_check
 
   /* autoscaler */
   autoscaling_enabled = var.autoscaling_enabled