Merge pull request #1 from umairidris/impl

Initial implementation

Author: morgante

README.md

@@ -1,10 +1,6 @@
 # terraform-google-cloud-router
 
-This module was generated from [terraform-google-module-template](https://github.com/terraform-google-modules/terraform-google-module-template/), which by default generates a module that simply creates a GCS bucket. As the module develops, this README should be updated.
-
-The resources/services/activations/deletions that this module will create/trigger are:
-
-- Create a GCS bucket with the provided name
+This module handles opinionated Google Cloud Platform routing.
 
 ## Usage
 
@@ -15,8 +11,10 @@ module "cloud_router" {
   source  = "terraform-google-modules/cloud-router/google"
   version = "~> 0.1"
 
-  project_id  = "<PROJECT ID>"
-  bucket_name = "gcs-test-bucket"
+  name = "example-router"
+  project  = "<PROJECT ID>"
+  region = "us-central1"
+  network = "default"
 }
 ```
 
@@ -28,14 +26,18 @@ Functional examples are included in the
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| bucket\_name | The name of the bucket to create | string | n/a | yes |
-| project\_id | The project ID to deploy to | string | n/a | yes |
+| bgp | BGP information specific to this router. | any | `"null"` | no |
+| name | Name of the router | string | n/a | yes |
+| nats | NATs to deploy on this router. | any | `<list>` | 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 |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| bucket\_name |  |
+| router | The created router |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
@@ -55,7 +57,7 @@ The following dependencies must be available:
 A service account with the following roles must be used to provision
 the resources of this module:
 
-- Storage Admin: `roles/storage.admin`
+- Network Admin: `roles/compute.networkAdmin`
 
 The [Project Factory module][project-factory-module] and the
 [IAM module][iam-module] may be used in combination to provision a
@@ -66,7 +68,7 @@ service account with the necessary roles applied.
 A project with the following APIs enabled must be used to host the
 resources of this module:
 
-- Google Cloud Storage JSON API: `storage-api.googleapis.com`
+- Google Cloud Compute Engine API: `compute.googleapis.com`
 
 The [Project Factory module][project-factory-module] can be used to
 provision a project with the necessary APIs enabled.
@@ -76,7 +78,6 @@ provision a project with the necessary APIs enabled.
 Refer to the [contribution guidelines](./CONTRIBUTING.md) for
 information on contributing to this module.
 
-[iam-module]: https://registry.terraform.io/modules/terraform-google-modules/iam/google
 [project-factory-module]: https://registry.terraform.io/modules/terraform-google-modules/project-factory/google
 [terraform-provider-gcp]: https://www.terraform.io/docs/providers/google/index.html
 [terraform]: https://www.terraform.io/downloads.html

examples/interconnect_attachment/main.tf

@@ -0,0 +1,54 @@
+/**
+ * Copyright 2018 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.
+ */
+
+provider "google" {
+  version = "~> 3.0"
+}
+
+module "cloud_router" {
+  source = "../../"
+
+  name = "example-router"
+  project  = "example-project"
+  network = "default"
+  region = "us-central1"
+
+  bgp = {
+    asn = 65000
+    advertised_groups = ["ALL_SUBNETS"]
+  }
+}
+
+module "interconnect_attachment" {
+  source  = "../../modules/interconnect_attachment"
+  name = "example-attachment"
+  project = "example-project"
+  region = "us-central1"
+  router = module.cloud_router.router.name
+
+  interconnect = "https://googleapis.com/interconnects/example-interconnect"
+
+  interface = {
+    name = "example-interface"
+  }
+
+  peer = {
+    name = "example-peer"
+    peer_ip_address = "169.254.1.2"
+    peer_asn = 65001
+    advertised_groups = ["ALL_SUBNETS"]
+  }
+}

examples/simple_example/versions.tf renamed to examples/interconnect_attachment/versions.tf

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2018 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.
+ */
+
+provider "google" {
+  version = "~> 3.0"
+}
+
+module "cloud_router" {
+  source = "../../"
+
+  name = "example-router"
+  project  = "example-project"
+  network = "default"
+  region = "us-central1"
+
+  nats = [{
+    name = "example-nat"
+  }]
+}

examples/nat/main.tf

@@ -14,12 +14,6 @@
  * limitations under the License.
  */
 
-variable "project_id" {
-  description = "The ID of the project in which to provision resources."
-  type        = string
-}
-
-variable "bucket_name" {
-  description = "The name of the bucket to create."
-  type        = string
+terraform {
+  required_version = ">= 0.12"
 }

examples/simple_example/variables.tf renamed to examples/nat/versions.tf

@@ -15,12 +15,14 @@
  */
 
 provider "google" {
-  version = "~> 2.0"
+  version = "~> 3.0"
 }
 
 module "cloud_router" {
-  source = "../.."
+  source = "../../"
 
-  project_id  = var.project_id
-  bucket_name = var.bucket_name
+  name = "example-router"
+  project  = "example-project"
+  network = "default"
+  region = "us-central1"
 }

examples/simple_example/main.tf renamed to examples/simple/main.tf

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2018 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.
+ */
+
+terraform {
+  required_version = ">= 0.12"
+}

examples/simple/versions.tf

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 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,7 +14,30 @@
  * limitations under the License.
  */
 
-resource "google_storage_bucket" "main" {
-  project = var.project_id
-  name    = var.bucket_name
+resource "google_compute_router" "router" {
+  name    = var.name
+  network = var.network
+  region  = var.region
+  project = var.project
+  dynamic "bgp" {
+    for_each = var.bgp != null ? [var.bgp] : []
+    content {
+      asn = var.bgp.asn
+
+      # advertise_mode is intentionally set to CUSTOM to not allow "DEFAULT".
+      # This forces the config to explicitly state what subnets and ip ranges
+      # to advertise. To advertise the same range as DEFAULT, set
+      # `advertise_groups = ["ALL_SUBNETS"]`.
+      advertise_mode    = "CUSTOM"
+      advertised_groups = lookup(var.bgp, "advertised_groups", null)
+
+      dynamic "advertised_ip_ranges" {
+        for_each = lookup(var.bgp, "advertised_ip_ranges", [])
+        content {
+          range       = advertised_ip_ranges.value.range
+          description = lookup(advertised_ip_ranges.value, "description", null)
+        }
+      }
+    }
+  }
 }

examples/simple_example/README.md

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ * 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.
+ */
+
+resource "google_compute_interconnect_attachment" "attachment" {
+  name          = var.name
+  router        = var.router
+  project       = var.project
+  region        = var.region
+  interconnect  = var.interconnect
+  admin_enabled = var.admin_enabled
+  type          = var.type
+  description   = var.description
+  bandwidth     = var.bandwidth
+  vlan_tag8021q = var.vlan_tag8021q
+}
+
+module "interface" {
+  source                  = "../interface"
+  name                    = var.interface.name
+  project                 = var.project
+  router                  = var.router
+  region                  = var.region
+  ip_range                = google_compute_interconnect_attachment.attachment.cloud_router_ip_address
+  interconnect_attachment = google_compute_interconnect_attachment.attachment.self_link
+  peers = [{
+    name                      = var.peer.name
+    peer_ip_address           = var.peer.peer_ip_address
+    peer_asn                  = var.peer.peer_asn
+    advertised_route_priority = lookup(var.peer, "advertised_route_priority", null)
+    advertised_groups         = var.peer.advertised_groups
+  }]
+}