feat(TF>1.3)!: Min terraform version 1.3. Changed variables type object with optional parameters (#79)

Author: imrannayer

README.md

@@ -1,6 +1,16 @@
-# [terraform-google-cloud-router](https://registry.terraform.io/modules/terraform-google-modules/cloud-router/google)
+# [Cloud Router Terraform Module](https://registry.terraform.io/modules/terraform-google-modules/cloud-router/google)
 
-This module handles opinionated Google Cloud Platform routing.
+This module handles opinionated Google Cloud Platform [cloud router](https://cloud.google.com/network-connectivity/docs/router/concepts/overview). Optionally it can also create [cloud nat](https://cloud.google.com/nat/docs/overview)
+
+## Compatibility
+
+This module is meant for use with Terraform 1.3+ and tested using Terraform 1.3+. If you find incompatibilities using Terraform >=1.3, please open an issue.
+
+## Version
+
+Upgrade guides:
+
+- [5.X -> 6.0.](/docs/upgrading_to_v6.0.md)
 
 ## Usage
 
@@ -9,27 +19,33 @@ Basic usage of this module is as follows:
 ```hcl
 module "cloud_router" {
   source  = "terraform-google-modules/cloud-router/google"
-  version = "~> 5.1"
+  version = "~> 6.0"
 
   name    = "example-router"
-  project = "<PROJECT ID>"
   region  = "us-central1"
+
+  bgp = {
+    # The ASN (16550, 64512 - 65534, 4200000000 - 4294967294) can be any private ASN
+    # not already used as a peer ASN in the same region and network or 16550 for Partner Interconnect.
+    asn = "65001"
+  }
+
+  project = "<PROJECT ID>"
   network = "default"
 }
 ```
 
-Functional examples are included in the
-[examples](./examples/) directory.
+Functional examples are included in the [examples](./examples/) directory. By default logging will be enabled for `Cloud NAT` with `filter` set to `All`. You can disable cloud nat logging by setting parameters in `nats.log_config`
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| bgp | BGP information specific to this router. | `any` | `null` | no |
+| bgp | BGP information specific to this router. | <pre>object({<br>    asn               = string<br>    advertise_mode    = optional(string, "CUSTOM")<br>    advertised_groups = optional(list(string))<br>    advertised_ip_ranges = optional(list(object({<br>      range       = string<br>      description = optional(string)<br>    })), [])<br>    keepalive_interval = optional(number)<br>  })</pre> | `null` | no |
 | description | An optional description of this resource | `string` | `null` | no |
 | name | Name of the router | `string` | n/a | yes |
-| nats | NATs to deploy on this router. | `any` | `[]` | no |
+| nats | NATs to deploy on this router. | <pre>list(object({<br>    name                                = string<br>    nat_ip_allocate_option              = optional(string)<br>    source_subnetwork_ip_ranges_to_nat  = optional(string)<br>    nat_ips                             = optional(list(string), [])<br>    min_ports_per_vm                    = optional(number)<br>    max_ports_per_vm                    = optional(number)<br>    udp_idle_timeout_sec                = optional(number)<br>    icmp_idle_timeout_sec               = optional(number)<br>    tcp_established_idle_timeout_sec    = optional(number)<br>    tcp_transitory_idle_timeout_sec     = optional(number)<br>    tcp_time_wait_timeout_sec           = optional(number)<br>    enable_endpoint_independent_mapping = optional(bool)<br>    enable_dynamic_port_allocation      = optional(bool)<br><br>    log_config = optional(object({<br>      enable = optional(bool, true)<br>      filter = optional(string, "ALL")<br>    }), {})<br><br>    subnetworks = optional(list(object({<br>      name                     = string<br>      source_ip_ranges_to_nat  = string<br>      secondary_ip_range_names = optional(string)<br>    })), [])<br><br>  }))</pre> | `[]` | no |
 | network | A reference to the network to which this router belongs | `string` | n/a | yes |
 | project | The project ID to deploy to | `string` | n/a | yes |
 | region | Region where the router resides | `string` | n/a | yes |
@@ -38,10 +54,15 @@ Functional examples are included in the
 
 | Name | Description |
 |------|-------------|
-| router | The created router |
+| nat | Created NATs |
+| router | Created Router |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
+
+## nats
+
+
 ## Requirements
 
 These sections describe requirements for using this module.
@@ -50,8 +71,8 @@ These sections describe requirements for using this module.
 
 The following dependencies must be available:
 
-- [Terraform][terraform] v0.12 and above
-- [Terraform Provider for GCP][terraform-provider-gcp] plugin v2.0
+- [Terraform][terraform] v1.3 and above
+- [Terraform Provider for GCP][terraform-provider-gcp] plugin v4.51 and above
 
 ### Service Account
 

build/int.cloudbuild.yaml

@@ -19,23 +19,47 @@ steps:
   args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && module-swapper']
 - id: prepare
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && prepare_environment']
+  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && prepare_environment && sleep 120']
   env:
   - 'TF_VAR_org_id=$_ORG_ID'
   - 'TF_VAR_folder_id=$_FOLDER_ID'
   - 'TF_VAR_billing_account=$_BILLING_ACCOUNT'
-- id: create
+- id: init-all
+  waitFor:
+    - prepare
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do create']
-- id: converge
+  args: ['/bin/bash', '-c', 'cft test run all --stage init --verbose']
+- id: simple-example-apply
+  waitFor:
+    - init-all
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do converge']
-- id: verify
+  args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage apply --verbose']
+- id: simple-example-verify
+  waitFor:
+    - simple-example-apply
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do verify']
-- id: destroy
+  args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage verify --verbose']
+- id: simple-example-teardown
+  waitFor:
+    - simple-example-verify
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do destroy']
+  args: ['/bin/bash', '-c', 'cft test run TestSimpleExample --stage teardown --verbose']
+
+- id: nat-apply
+  waitFor:
+    - simple-example-teardown
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestNat --stage apply --verbose']
+- id: nat-verify
+  waitFor:
+    - nat-apply
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestNat --stage verify --verbose']
+- id: nat-teardown
+  waitFor:
+    - nat-verify
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestNat --stage teardown --verbose']
 tags:
 - 'ci'
 - 'integration'

docs/upgrading_to_v6.0.md

@@ -0,0 +1,5 @@
+# Upgrading to v6.0
+
+The v6.0 release contains backwards-incompatible changes.
+
+### [Terraform](https://www.terraform.io/downloads.html) >= 1.3.0 is required Since [optional attributes](https://developer.hashicorp.com/terraform/language/expressions/type-constraints#optional-object-type-attributes) is a version 1.3 feature, the configuration will fail if the pinned version is < 1.3.

examples/nat/README.md

@@ -8,12 +8,13 @@ inside of a project.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| project\_id | The project ID to host the Cloud Router in | `any` | n/a | yes |
+| project\_id | The GCP project ID | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
+| project\_id | Project ID of the router |
 | router\_name | The name of the created router |
 | router\_region | The region of the created router |
 

examples/nat/main.tf

@@ -14,13 +14,24 @@
  * limitations under the License.
  */
 
+module "vpc" {
+  source  = "terraform-google-modules/network/google"
+  version = "~> 7.0"
+
+  project_id   = var.project_id
+  network_name = "test-network"
+  routing_mode = "GLOBAL"
+  subnets      = []
+}
+
+
 # [START cloudnat_simple_create]
 module "cloud_router" {
   source  = "terraform-google-modules/cloud-router/google"
   version = "~> 5.0"
-  project = var.project_id # Replace this with your project ID in quotes
   name    = "my-cloud-router"
-  network = "default"
+  project = var.project_id
+  network = module.vpc.network_name
   region  = "us-central1"
 
   nats = [{

examples/nat/outputs.tf

@@ -23,3 +23,8 @@ output "router_region" {
   value       = module.cloud_router.router.region
   description = "The region of the created router"
 }
+
+output "project_id" {
+  value       = module.cloud_router.router.project
+  description = "Project ID of the router"
+}

examples/nat/variables.tf

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC
+ * Copyright 2020 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+
 variable "project_id" {
-  description = "The project ID to host the Cloud Router in"
+  type        = string
+  description = "The GCP project ID"
 }

examples/nat/versions.tf

@@ -21,5 +21,5 @@ terraform {
       version = "~> 4.0"
     }
   }
-  required_version = ">= 0.13"
+  required_version = ">= 1.3"
 }

examples/simple/variables.tf

@@ -7,13 +7,14 @@ This example configures a single simple Cloud Router inside of a project.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| network | A reference to the network to which this router belongs | `string` | n/a | yes |
-| project | The GCP project ID | `string` | n/a | yes |
+| project\_id | The GCP project ID | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
+| project\_id | Project ID of the router |
+| router | Project ID of the router |
 | router\_name | The name of the created router |
 | router\_region | The region of the created router |