feat: Add new submodule for service networking #569
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Terraform service networking example | ||
| This example creates service networking with a global address. | ||
| <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | project\_id | Project ID | `string` | n/a | yes | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | peering | Service networking peering output | | ||
| | project\_id | Project ID | | ||
|
|
||
| <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /** | ||
| * Copyright 2024 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_network" "peering_network" { | ||
| name = "private-network" | ||
| auto_create_subnetworks = "false" | ||
| project = var.project_id | ||
| } | ||
|
|
||
| module "service_networking" { | ||
| source = "terraform-google-modules/network/google//modules/service-networking" | ||
| version = "~> 9.0" | ||
|
|
||
| project_id = var.project_id | ||
| network = { id : google_compute_network.peering_network.id } | ||
| global_addresses = [{ name : "global-address" }] | ||
| service = "servicenetworking.googleapis.com" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /** | ||
| * Copyright 2024 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. | ||
| */ | ||
|
|
||
| output "project_id" { | ||
| description = "Project ID" | ||
| value = var.project_id | ||
| } | ||
|
|
||
| output "peering" { | ||
| description = "Service networking peering output" | ||
| value = module.service_networking.peering | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| /** | ||
| * Copyright 2024 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. | ||
| */ | ||
|
|
||
| variable "project_id" { | ||
| description = "Project ID" | ||
| type = string | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Terraform Google service networking | ||
|
|
||
| This module creates global network address and a service networking | ||
| <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | create\_peered\_dns\_domain | Create peered dns domain | `bool` | `false` | no | | ||
| | create\_peering\_routes\_config | Create peering route config | `bool` | `false` | no | | ||
| | deletion\_policy | Deletion policy for service networking resource | `string` | `null` | no | | ||
| | dns\_suffix | Dns suffix | `string` | `null` | no | | ||
| | domain\_name | Domain name | `string` | `null` | no | | ||
| | export\_custom\_routes | Export custom routes | `bool` | `false` | no | | ||
| | global\_addresses | List of global addresses to be created | <pre>list(object({<br> name : string,<br> purpose : optional(string, "VPC_PEERING"),<br> type : optional(string, "INTERNAL"),<br> prefix_length : optional(number, 16)<br> }))</pre> | n/a | yes | | ||
| | import\_custom\_routes | Import custom routes to peering rout config | `bool` | `false` | no | | ||
| | network | Network details including name and id | <pre>object({<br> name = optional(string, null),<br> id = string<br> })</pre> | n/a | yes | | ||
| | project\_id | Project ID | `string` | n/a | yes | | ||
| | service | Service to create service networking connection | `string` | n/a | yes | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | address\_ids | Global address id | | ||
| | peering | Service networking connection peering | | ||
|
|
||
| <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /** | ||
| * Copyright 2024 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_global_address" "global_addresses" { | ||
| for_each = { for address in var.global_addresses : address.name => address } | ||
| project = var.project_id | ||
| name = each.value.name | ||
| purpose = each.value.purpose | ||
|
There was a problem hiding this comment. IIUC for this private service access usecase isn't it always There was a problem hiding this comment. I have used VPC_PEERING as default value. Should i remove the variable and use VPC_PEERING directly? There was a problem hiding this comment. @q2w In case of service networking it will always be vpc_peering. |
||
| address_type = each.value.type | ||
q2w marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| prefix_length = each.value.prefix_length | ||
| network = var.network.id | ||
| } | ||
|
|
||
| resource "google_service_networking_connection" "default" { | ||
| network = var.network.id | ||
| service = var.service | ||
| reserved_peering_ranges = [for name, _ in google_compute_global_address.global_addresses : name] | ||
q2w marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| deletion_policy = var.deletion_policy | ||
| } | ||
|
|
||
| resource "google_compute_network_peering_routes_config" "peering_routes" { | ||
| count = var.create_peering_routes_config ? 1 : 0 | ||
| project = var.project_id | ||
| peering = google_service_networking_connection.default.peering | ||
| network = var.network.name | ||
| import_custom_routes = var.import_custom_routes | ||
| export_custom_routes = var.export_custom_routes | ||
| } | ||
|
|
||
| resource "google_service_networking_peered_dns_domain" "default" { | ||
| count = var.create_peered_dns_domain ? 1 : 0 | ||
| project = var.project_id | ||
| name = var.domain_name | ||
| network = var.network.name | ||
| dns_suffix = var.dns_suffix | ||
| service = var.service | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| # Copyright 2024 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. | ||
|
|
||
| apiVersion: blueprints.cloud.google.com/v1alpha1 | ||
| kind: BlueprintMetadata | ||
| metadata: | ||
| name: terraform-google-network-service-networking | ||
| annotations: | ||
| config.kubernetes.io/local-config: "true" | ||
| spec: | ||
| info: | ||
| title: Terraform Google service networking | ||
| source: | ||
| repo: https://github.com/q2w/terraform-google-network.git | ||
q2w marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| sourceType: git | ||
| dir: /modules/service-networking | ||
| version: 9.1.0 | ||
| actuationTool: | ||
| flavor: Terraform | ||
| version: ">= 0.13.0" | ||
| description: {} | ||
| content: | ||
| examples: | ||
| - name: basic_auto_mode | ||
| location: examples/basic_auto_mode | ||
| - name: basic_custom_mode | ||
| location: examples/basic_custom_mode | ||
| - name: basic_firewall_rule | ||
| location: examples/basic_firewall_rule | ||
| - name: basic_secondary_ranges | ||
| location: examples/basic_secondary_ranges | ||
| - name: basic_shared_vpc | ||
| location: examples/basic_shared_vpc | ||
| - name: basic_vpc_peering | ||
| location: examples/basic_vpc_peering | ||
| - name: bidirectional-firewall-rules | ||
| location: examples/bidirectional-firewall-rules | ||
| - name: delete_default_gateway_routes | ||
| location: examples/delete_default_gateway_routes | ||
| - name: firewall_logging | ||
| location: examples/firewall_logging | ||
| - name: global-network-firewall-policy | ||
| location: examples/global-network-firewall-policy | ||
| - name: hierarchical-firewall-policy | ||
| location: examples/hierarchical-firewall-policy | ||
| - name: ilb_routing | ||
| location: examples/ilb_routing | ||
| - name: multi_vpc | ||
| location: examples/multi_vpc | ||
| - name: network_service_tiers | ||
| location: examples/network_service_tiers | ||
| - name: packet_mirroring | ||
| location: examples/packet_mirroring | ||
| - name: private_service_connect | ||
| location: examples/private_service_connect | ||
| - name: private_service_connect_google_apis | ||
| location: examples/private_service_connect_google_apis | ||
| - name: regional-network-firewall-policy | ||
| location: examples/regional-network-firewall-policy | ||
| - name: routes | ||
| location: examples/routes | ||
| - name: secondary_ranges | ||
| location: examples/secondary_ranges | ||
| - name: service-networking | ||
| location: examples/service-networking | ||
| - name: simple_ipv6_project | ||
| location: examples/simple_ipv6_project | ||
| - name: simple_project | ||
| location: examples/simple_project | ||
| - name: simple_project_with_regional_network | ||
| location: examples/simple_project_with_regional_network | ||
| - name: submodule_firewall | ||
| location: examples/submodule_firewall | ||
| - name: submodule_network_peering | ||
| location: examples/submodule_network_peering | ||
| - name: submodule_svpc_access | ||
| location: examples/submodule_svpc_access | ||
| - name: submodule_vpc_serverless_connector | ||
| location: examples/submodule_vpc_serverless_connector | ||
| interfaces: | ||
| variables: | ||
| - name: create_peered_dns_domain | ||
| description: Create peered dns domain | ||
| varType: bool | ||
| defaultValue: false | ||
| - name: create_peering_routes_config | ||
| description: Create peering route config | ||
| varType: bool | ||
| defaultValue: false | ||
| - name: deletion_policy | ||
| description: Deletion policy for service networking resource | ||
| varType: string | ||
| - name: dns_suffix | ||
| description: Dns suffix | ||
| varType: string | ||
| - name: domain_name | ||
| description: Domain name | ||
| varType: string | ||
| - name: export_custom_routes | ||
| description: Export custom routes | ||
| varType: bool | ||
| defaultValue: false | ||
| - name: global_addresses | ||
| description: List of global addresses to be created | ||
| varType: |- | ||
| list(object({ | ||
| name : string, | ||
| purpose : optional(string, "VPC_PEERING"), | ||
| type : optional(string, "INTERNAL"), | ||
| prefix_length : optional(number, 16) | ||
| })) | ||
| required: true | ||
| - name: import_custom_routes | ||
| description: Import custom routes to peering rout config | ||
| varType: bool | ||
| defaultValue: false | ||
| - name: network | ||
| description: Network details including name and id | ||
| varType: |- | ||
| object({ | ||
| name = optional(string, null), | ||
| id = string | ||
| }) | ||
| required: true | ||
| - name: project_id | ||
| description: Project ID | ||
| varType: string | ||
| required: true | ||
| - name: service | ||
| description: Service to create service networking connection | ||
| varType: string | ||
| required: true | ||
| outputs: | ||
| - name: address_ids | ||
| description: Global address id | ||
| - name: peering | ||
| description: Service networking connection peering | ||
| requirements: | ||
| roles: | ||
| - level: Project | ||
| roles: | ||
| - roles/compute.networkAdmin | ||
| - roles/compute.securityAdmin | ||
| - roles/iam.serviceAccountUser | ||
| - roles/vpcaccess.admin | ||
| - roles/serviceusage.serviceUsageAdmin | ||
| - roles/dns.admin | ||
| - roles/resourcemanager.tagAdmin | ||
| - roles/iam.serviceAccountAdmin | ||
| - roles/compute.orgFirewallPolicyAdmin | ||
| services: | ||
| - cloudresourcemanager.googleapis.com | ||
| - compute.googleapis.com | ||
| - serviceusage.googleapis.com | ||
| - vpcaccess.googleapis.com | ||
| - dns.googleapis.com | ||
| - networksecurity.googleapis.com | ||
| - iam.googleapis.com | ||
| - servicenetworking.googleapis.com | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we add some more context on the uses cases? IIUC this module would be used for private service access. Is there any other usecase cc @imrannayer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the module README and example README