FAQ | This is a LIVE service | Changelog

Commit 2facca0a authored by Dave Hart's avatar Dave Hart 🍕
Browse files

fix: correct types of `map` variables 

Remove the type `map` from the `map` variables (module inputs) as it is
incorrect. Most of the variables should accept elements with different
types, and therefore should not be of type `map`. Instead, define the types
in detail which also provides more precise type-checking.

Clarify defaults for TLS checking and authentication proxy options in the
README.
parent 852873dd

README.md

+5 −2
Original line number Diff line number Diff line
@@ -86,9 +86,11 @@ module "monitoring" { 
    json_matcher = "EXACT_MATCH"

  }



  # Optional. Parameters to customise TLS certificate checks.

  # Optional. Parameters to customise TLS certificate checks. Ignored when an

  # authentication proxy is used (TLS checks are disabled automatically).

  tls_check = {

    # Enable alerting. Default: true

    # Enable alerting. Default: true without authentication proxy,

    # otherwise false

    alert_enabled = true



    # Minimum age of certificate. Default is 30 days.
@@ -105,6 +107,7 @@ module "monitoring" { 
    enabled                = true



    # The project that contains the cloud run service to proxy to.

    # Default: the value of the "project" variable

    cloud_run_project      = google_cloud_run_service.webapp.project



    # The region that contains the cloud run service to proxy to.

locals.tf

+3 −19
Original line number Diff line number Diff line
@@ -13,14 +13,7 @@ locals { 


  # Merge authentication_proxy variable with default values.

  authentication_proxy = merge({

    enabled                     = false

    cloud_run_project = local.project

    cloud_run_region            = ""

    cloud_run_service_name      = ""

    timeout                     = 30

    egress_connector            = ""

    egress_connector_settings   = null

    source_bucket_force_destroy = null

  }, var.authentication_proxy)



  # Merge uptime_check variable with default values.
@@ -28,13 +21,7 @@ locals { 
  # for the host and path of the authentication proxy

  uptime_check = merge(

    {

      id                        = ""

      alert_enabled             = true

      host = var.host

      path                      = "/"

      timeout                   = 30

      period                    = 300

      success_threshold_percent = 75

    },

    var.uptime_check,

    merge([
@@ -61,10 +48,7 @@ locals { 
      alert_enabled = false

      minimum_age   = 0

    } :

    merge({

      alert_enabled = true

      minimum_age   = 30

    }, var.tls_check)

    var.tls_check

  )



  # Use the default provider project if not provided in var.project.

variables.tf

+37 −4
Original line number Diff line number Diff line
@@ -62,25 +62,58 @@ variable "local_files_dir" { 
}



variable "uptime_check" {

  type        = map(any)

  type = object({

    id                        = optional(string, "")

    alert_enabled             = optional(bool, true)

    path                      = optional(string, "/")

    timeout                   = optional(number, 30)

    period                    = optional(number, 300)

    success_threshold_percent = optional(number, 75)

  })

  default     = {}

  description = "Optional. Configuration for uptime checks. See README."

}



variable "content_matchers" {

  type        = map(string)

  type = object({

    content      = optional(string)

    matcher      = optional(string)

    json_path    = optional(string)

    json_matcher = optional(string)

  })

  default     = {}

  description = "Optional. Configuration for content matching. See README."

}



variable "tls_check" {

  type        = map(any)

  type = object({

    alert_enabled = optional(bool, true)

    minimum_age   = optional(number, 30)

  })

  default     = {}

  description = "Optional. Configuration for TLS checks. See README."

}



variable "authentication_proxy" {

  type        = map(any)

  type = object({

    enabled = optional(bool, false)



    # Default is set in `locals.tf` as the default is calculated when

    # generating the plan

    cloud_run_project = optional(string)



    # The following two elements must be assigned non-empty string values

    # when the authentication proxy is enabled.

    cloud_run_region       = optional(string, "")

    cloud_run_service_name = optional(string, "")



    timeout          = optional(number, 30)

    egress_connector = optional(string, "")

    # Default null value of `egress_connector_settings` corresponds to

    # `PRIVATE_RANGES_ONLY`.

    egress_connector_settings   = optional(string)

    source_bucket_force_destroy = optional(bool)

  })

  default     = {}

  description = "Optional. Configuration for an authentication proxy. See README."

}