-
Notifications
You must be signed in to change notification settings - Fork 910
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Network Load Balancer module (#1418)
* wip * example tests passing
- Loading branch information
Showing
9 changed files
with
803 additions
and
2 deletions.
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,203 @@ | ||
| # Network Load Balancer Module | ||
|
|
||
| This module allows managing a GCE Network Load Balancer and integrates the forwarding rule, regional backend, and optional health check resources. It's designed to be a simple match for the [`compute-vm`](../compute-vm) module, which can be used to manage instance templates and instance groups. | ||
|
|
||
| ## Examples | ||
|
|
||
| - [Referencing existing MIGs](#referencing-existing-migs) | ||
| - [Externally manages instances](#externally-managed-instances) | ||
| - [End to end example](#end-to-end-example) | ||
|
|
||
| ### Referencing existing MIGs | ||
|
|
||
| This example shows how to reference existing Managed Infrastructure Groups (MIGs). | ||
|
|
||
| ```hcl | ||
| module "instance_template" { | ||
| source = "./fabric/modules/compute-vm" | ||
| project_id = var.project_id | ||
| create_template = true | ||
| name = "vm-test" | ||
| service_account_create = true | ||
| zone = "europe-west1-b" | ||
| network_interfaces = [ | ||
| { | ||
| network = var.vpc.self_link | ||
| subnetwork = var.subnet.self_link | ||
| } | ||
| ] | ||
| tags = [ | ||
| "http-server" | ||
| ] | ||
| } | ||
| module "mig" { | ||
| source = "./fabric/modules/compute-mig" | ||
| project_id = var.project_id | ||
| location = "europe-west1" | ||
| name = "mig-test" | ||
| target_size = 1 | ||
| instance_template = module.instance_template.template.self_link | ||
| } | ||
| module "nlb" { | ||
| source = "./fabric/modules/net-nlb" | ||
| project_id = var.project_id | ||
| region = "europe-west1" | ||
| name = "nlb-test" | ||
| vpc_config = { | ||
| network = var.vpc.self_link | ||
| subnetwork = var.subnet.self_link | ||
| } | ||
| backends = [{ | ||
| group = module.mig.group_manager.instance_group | ||
| }] | ||
| health_check_config = { | ||
| http = { | ||
| port = 80 | ||
| } | ||
| } | ||
| } | ||
| # tftest modules=3 resources=6 | ||
| ``` | ||
|
|
||
| ### Externally managed instances | ||
|
|
||
| This examples shows how to create an NLB by combining externally managed instances (in a custom module or even outside of the current root module) in an unmanaged group. When using internally managed groups, remember to run `terraform apply` each time group instances change. | ||
|
|
||
| ```hcl | ||
| module "nlb" { | ||
| source = "./fabric/modules/net-nlb" | ||
| project_id = var.project_id | ||
| region = "europe-west1" | ||
| name = "nlb-test" | ||
| vpc_config = { | ||
| network = var.vpc.self_link | ||
| subnetwork = var.subnet.self_link | ||
| } | ||
| group_configs = { | ||
| my-group = { | ||
| zone = "europe-west1-b" | ||
| instances = [ | ||
| "instance-1-self-link", | ||
| "instance-2-self-link" | ||
| ] | ||
| } | ||
| } | ||
| backends = [{ | ||
| group = module.nlb.groups.my-group.self_link | ||
| }] | ||
| health_check_config = { | ||
| http = { | ||
| port = 80 | ||
| } | ||
| } | ||
| } | ||
| # tftest modules=1 resources=4 | ||
| ``` | ||
|
|
||
| ### End to end example | ||
|
|
||
| This example spins up a simple HTTP server and combines four modules: | ||
|
|
||
| - [`nginx`](../cloud-config-container/nginx) from the `cloud-config-container` collection, to manage instance configuration | ||
| - [`compute-vm`](../compute-vm) to manage the instance template and unmanaged instance group | ||
| - this module to create a Network Load Balancer in front of the managed instance group | ||
|
|
||
| Note that the example uses the GCE default service account. You might want to create an ad-hoc service account by combining the [`iam-service-account`](../iam-service-account) module, or by having the GCE VM module create one for you. In both cases, remember to set at least logging write permissions for the service account, or the container on the instances won't be able to start. | ||
|
|
||
| ```hcl | ||
| module "cos-nginx" { | ||
| source = "./fabric/modules/cloud-config-container/nginx" | ||
| } | ||
| module "instance-group" { | ||
| source = "./fabric/modules/compute-vm" | ||
| for_each = toset(["b", "c"]) | ||
| project_id = var.project_id | ||
| zone = "europe-west1-${each.key}" | ||
| name = "nlb-test-${each.key}" | ||
| network_interfaces = [{ | ||
| network = var.vpc.self_link | ||
| subnetwork = var.subnet.self_link | ||
| nat = false | ||
| addresses = null | ||
| }] | ||
| boot_disk = { | ||
| initialize_params = { | ||
| image = "projects/cos-cloud/global/images/family/cos-stable" | ||
| type = "pd-ssd" | ||
| size = 10 | ||
| } | ||
| } | ||
| tags = ["http-server", "ssh"] | ||
| metadata = { | ||
| user-data = module.cos-nginx.cloud_config | ||
| } | ||
| group = { named_ports = {} } | ||
| } | ||
| module "nlb" { | ||
| source = "./fabric/modules/net-nlb" | ||
| project_id = var.project_id | ||
| region = "europe-west1" | ||
| name = "nlb-test" | ||
| vpc_config = { | ||
| network = var.vpc.self_link | ||
| subnetwork = var.subnet.self_link | ||
| } | ||
| ports = [80] | ||
| backends = [ | ||
| for z, mod in module.instance-group : { | ||
| group = mod.group.self_link | ||
| } | ||
| ] | ||
| health_check_config = { | ||
| http = { | ||
| port = 80 | ||
| } | ||
| } | ||
| } | ||
| # tftest modules=3 resources=7 | ||
| ``` | ||
| <!-- BEGIN TFDOC --> | ||
|
|
||
| ## Variables | ||
|
|
||
| | name | description | type | required | default | | ||
| |---|---|:---:|:---:|:---:| | ||
| | [name](variables.tf#L186) | Name used for all resources. | <code>string</code> | ✓ | | | ||
| | [project_id](variables.tf#L197) | Project id where resources will be created. | <code>string</code> | ✓ | | | ||
| | [region](variables.tf#L213) | GCP region. | <code>string</code> | ✓ | | | ||
| | [vpc_config](variables.tf#L218) | VPC-level configuration. | <code title="object({ network = string subnetwork = string })">object({…})</code> | ✓ | | | ||
| | [address](variables.tf#L17) | Optional IP address used for the forwarding rule. | <code>string</code> | | <code>null</code> | | ||
| | [backend_service_config](variables.tf#L23) | Backend service level configuration. | <code title="object({ connection_draining_timeout_sec = optional(number) connection_tracking = optional(object({ idle_timeout_sec = optional(number) persist_conn_on_unhealthy = optional(string) track_per_session = optional(bool) })) failover_config = optional(object({ disable_conn_drain = optional(bool) drop_traffic_if_unhealthy = optional(bool) ratio = optional(number) })) locality_lb_policy = optional(string) log_sample_rate = optional(number) port_name = optional(string) protocol = optional(string, "UNSPECIFIED") session_affinity = optional(string) timeout_sec = optional(number) })">object({…})</code> | | <code>{}</code> | | ||
| | [backends](variables.tf#L72) | Load balancer backends, balancing mode is one of 'CONNECTION' or 'UTILIZATION'. | <code title="list(object({ group = string description = optional(string, "Terraform managed.") failover = optional(bool, false) }))">list(object({…}))</code> | | <code>[]</code> | | ||
| | [description](variables.tf#L83) | Optional description used for resources. | <code>string</code> | | <code>"Terraform managed."</code> | | ||
| | [group_configs](variables.tf#L89) | Optional unmanaged groups to create. Can be referenced in backends via outputs. | <code title="map(object({ zone = string instances = optional(list(string), []) named_ports = optional(map(number), {}) }))">map(object({…}))</code> | | <code>{}</code> | | ||
| | [health_check](variables.tf#L100) | Name of existing health check to use, disables auto-created health check. | <code>string</code> | | <code>null</code> | | ||
| | [health_check_config](variables.tf#L106) | Optional auto-created health check configuration, use the output self-link to set it in the auto healing policy. Refer to examples for usage. | <code title="object({ check_interval_sec = optional(number) description = optional(string, "Terraform managed.") enable_logging = optional(bool, false) healthy_threshold = optional(number) timeout_sec = optional(number) unhealthy_threshold = optional(number) grpc = optional(object({ port = optional(number) port_name = optional(string) port_specification = optional(string) # USE_FIXED_PORT USE_NAMED_PORT USE_SERVING_PORT service_name = optional(string) })) http = optional(object({ host = optional(string) port = optional(number) port_name = optional(string) port_specification = optional(string) # USE_FIXED_PORT USE_NAMED_PORT USE_SERVING_PORT proxy_header = optional(string) request_path = optional(string) response = optional(string) })) http2 = optional(object({ host = optional(string) port = optional(number) port_name = optional(string) port_specification = optional(string) # USE_FIXED_PORT USE_NAMED_PORT USE_SERVING_PORT proxy_header = optional(string) request_path = optional(string) response = optional(string) })) https = optional(object({ host = optional(string) port = optional(number) port_name = optional(string) port_specification = optional(string) # USE_FIXED_PORT USE_NAMED_PORT USE_SERVING_PORT proxy_header = optional(string) request_path = optional(string) response = optional(string) })) tcp = optional(object({ port = optional(number) port_name = optional(string) port_specification = optional(string) # USE_FIXED_PORT USE_NAMED_PORT USE_SERVING_PORT proxy_header = optional(string) request = optional(string) response = optional(string) })) ssl = optional(object({ port = optional(number) port_name = optional(string) port_specification = optional(string) # USE_FIXED_PORT USE_NAMED_PORT USE_SERVING_PORT proxy_header = optional(string) request = optional(string) response = optional(string) })) })">object({…})</code> | | <code title="{ tcp = { port_specification = "USE_SERVING_PORT" } }">{…}</code> | | ||
| | [labels](variables.tf#L180) | Labels set on resources. | <code>map(string)</code> | | <code>{}</code> | | ||
| | [ports](variables.tf#L191) | Comma-separated ports, leave null to use all ports. | <code>list(string)</code> | | <code>null</code> | | ||
| | [protocol](variables.tf#L202) | IP protocol used, defaults to TCP. UDP or L3_DEFAULT can also be used. | <code>string</code> | | <code>"TCP"</code> | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | name | description | sensitive | | ||
| |---|---|:---:| | ||
| | [backend_service](outputs.tf#L17) | Backend resource. | | | ||
| | [backend_service_id](outputs.tf#L22) | Backend id. | | | ||
| | [backend_service_self_link](outputs.tf#L27) | Backend self link. | | | ||
| | [forwarding_rule](outputs.tf#L32) | Forwarding rule resource. | | | ||
| | [forwarding_rule_address](outputs.tf#L37) | Forwarding rule address. | | | ||
| | [forwarding_rule_self_link](outputs.tf#L42) | Forwarding rule self link. | | | ||
| | [group_self_links](outputs.tf#L47) | Optional unmanaged instance group self links. | | | ||
| | [groups](outputs.tf#L54) | Optional unmanaged instance group resources. | | | ||
| | [health_check](outputs.tf#L59) | Auto-created health-check resource. | | | ||
| | [health_check_self_id](outputs.tf#L64) | Auto-created health-check self id. | | | ||
| | [health_check_self_link](outputs.tf#L69) | Auto-created health-check self link. | | | ||
| | [id](outputs.tf#L74) | Fully qualified forwarding rule id. | | | ||
|
|
||
| <!-- END TFDOC --> |
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,33 @@ | ||
| /** | ||
| * Copyright 2022 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. | ||
| */ | ||
|
|
||
| # tfdoc:file:description Optional instance group resources. | ||
|
|
||
| resource "google_compute_instance_group" "unmanaged" { | ||
| for_each = var.group_configs | ||
| project = var.project_id | ||
| zone = each.value.zone | ||
| name = each.key | ||
| description = "Terraform-managed." | ||
| instances = each.value.instances | ||
| dynamic "named_port" { | ||
| for_each = each.value.named_ports | ||
| content { | ||
| name = named_port.key | ||
| port = named_port.value | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.