https://github.com/googlecloudplatform/terraform-google-regional-lb-http
Creates a regional HTTP load balancer using forwarding rules
https://github.com/googlecloudplatform/terraform-google-regional-lb-http
cft-terraform
Last synced: about 2 months ago
JSON representation
Creates a regional HTTP load balancer using forwarding rules
- Host: GitHub
- URL: https://github.com/googlecloudplatform/terraform-google-regional-lb-http
- Owner: GoogleCloudPlatform
- License: apache-2.0
- Created: 2024-11-08T18:46:02.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-25T13:30:59.000Z (3 months ago)
- Last Synced: 2025-04-12T05:05:37.836Z (about 2 months ago)
- Topics: cft-terraform
- Language: HCL
- Homepage: https://registry.terraform.io/modules/GoogleCloudPlatform/regional-lb-http/google
- Size: 187 KB
- Stars: 4
- Watchers: 12
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Regional HTTP Load Balancer Terraform Module
Modular Regional HTTP Load Balancer for GCE using forwarding rules.
- If you would like to allow for backend groups to be managed outside
Terraform, such as via GKE services, see the [backends](./modules/backends)
submodule.
- If you would like to use regional load balancing with serverless backends
(Cloud Run, Cloud Functions or App Engine), see the
[frontend](./modules/frontend) submodule.
## Load Balancer Types
- [TCP load balancer](https://github.com/terraform-google-modules/terraform-google-lb)
- [HTTP/S global load balancer](https://github.com/terraform-google-modules/terraform-google-lb-http)
- **HTTP/S reginal load balancer**
- [Internal load balancer](https://github.com/terraform-google-modules/terraform-google-lb-internal)
## 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. If
you haven't [upgraded](https://www.terraform.io/upgrade-guides/0-13.html) and
need a Terraform 0.12.x-compatible version of this module, the last released
version intended for Terraform 0.12.x is
[v4.5.0](https://registry.terraform.io/modules/GoogleCloudPlatform/lb-http/google/4.5.0).
## Contributing
Refer to the [contribution guidelines](./CONTRIBUTING.md) for information on
contributing to this module.
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| address | Existing IPv4 address to use (the actual IP address value) | `string` | `null` | no |
| affinity\_cookie\_ttl\_sec | Lifetime of cookies in seconds if session\_affinity is GENERATED\_COOKIE. | `number` | `null` | no |
| certificate | Content of the SSL certificate. Requires `ssl` to be set to `true` and `create_ssl_certificate` set to `true` | `string` | `null` | no |
| connection\_draining\_timeout\_sec | Time for which instance will be drained (not accept new connections, but still work to finish started). | `number` | `null` | no |
| create\_address | Create a new global IPv4 address | `bool` | `true` | no |
| create\_ssl\_certificate | If `true`, Create certificate using `private_key/certificate` | `bool` | `false` | no |
| create\_url\_map | Set to `false` if url\_map variable is provided. | `bool` | `true` | no |
| description | Description of the backend service. | `string` | `null` | no |
| enable\_cdn | Enable Cloud CDN for this BackendService. | `bool` | `false` | no |
| firewall\_networks | Names of the networks to create firewall rules in | `list(string)` |
[
"default"
]
| no |
| firewall\_projects | Names of the projects to create firewall rules in | `list(string)` | [
"default"
]
| no |
| groups | The list of backend instance group which serves the traffic. | list(object({
group = string
description = optional(string)
balancing_mode = optional(string)
capacity_scaler = optional(number)
max_connections = optional(number)
max_connections_per_instance = optional(number)
max_connections_per_endpoint = optional(number)
max_rate = optional(number)
max_rate_per_instance = optional(number)
max_rate_per_endpoint = optional(number)
max_utilization = optional(number)
})) | `[]` | no |
| health\_check | Input for creating HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend. | object({
host = optional(string, null)
request_path = optional(string, null)
request = optional(string, null)
response = optional(string, null)
port = optional(number, null)
port_name = optional(string, null)
proxy_header = optional(string, null)
port_specification = optional(string, null)
protocol = optional(string, null)
check_interval_sec = optional(number, 10)
timeout_sec = optional(number, 10)
healthy_threshold = optional(number, 2)
unhealthy_threshold = optional(number, 2)
logging = optional(bool, true)
}) | `null` | no |
| http\_forward | Set to `false` to disable HTTP port 80 forward | `bool` | `true` | no |
| http\_keep\_alive\_timeout\_sec | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). | `number` | `null` | no |
| http\_port | The port for the HTTP load balancer | `number` | `80` | no |
| https\_port | The port for the HTTPS load balancer | `number` | `443` | no |
| https\_redirect | Set to `true` to enable https redirect on the lb. | `bool` | `false` | no |
| labels | The labels to attach to resources created by this module | `map(string)` | `{}` | no |
| load\_balancing\_scheme | Load balancing scheme type (EXTERNAL for classic external load balancer, EXTERNAL\_MANAGED for Envoy-based load balancer, and INTERNAL\_SELF\_MANAGED for traffic director) | `string` | `"EXTERNAL_MANAGED"` | no |
| locality\_lb\_policy | The load balancing algorithm used within the scope of the locality. | `string` | `null` | no |
| managed\_ssl\_certificate\_domains | Create Google-managed SSL certificates for specified domains. Requires `ssl` to be set to `true` | `list(string)` | `[]` | no |
| name | Name for the backend service. | `string` | n/a | yes |
| network | Network for INTERNAL\_SELF\_MANAGED load balancing scheme | `string` | `"default"` | no |
| port\_name | Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. | `string` | `"http"` | no |
| private\_key | Content of the private SSL key. Requires `ssl` to be set to `true` and `create_ssl_certificate` set to `true` | `string` | `null` | no |
| project\_id | The project to deploy to, if not set the default provider project is used. | `string` | n/a | yes |
| protocol | The protocol this BackendService uses to communicate with backends. | `string` | `"HTTP"` | no |
| random\_certificate\_suffix | Bool to enable/disable random certificate name generation. Set and keep this to true if you need to change the SSL cert. | `bool` | `false` | no |
| region | The region where the load balancer backend service will be created | `string` | n/a | yes |
| security\_policy | Security policy in string. | `string` | `null` | no |
| server\_tls\_policy | The resource URL for the server TLS policy to associate with the https proxy service | `string` | `null` | no |
| serverless\_neg\_backends | The list of serverless backend which serves the traffic. | list(object({
region = string
type = string // cloud-run, cloud-function, and app-engine
service_name = string
service_version = optional(string)
capacity_scaler = optional(number, 1.0)
})) | `[]` | no |
| session\_affinity | Type of session affinity to use. Possible values are: NONE, CLIENT\_IP, CLIENT\_IP\_PORT\_PROTO, CLIENT\_IP\_PROTO, GENERATED\_COOKIE, HEADER\_FIELD, HTTP\_COOKIE, STRONG\_COOKIE\_AFFINITY. | `string` | `null` | no |
| ssl | Set to `true` to enable SSL support. If `true` then at least one of these are required: 1) `ssl_certificates` OR 2) `create_ssl_certificate` set to `true` and `private_key/certificate` OR 3) `managed_ssl_certificate_domains`, OR 4) `certificate_map` | `bool` | `false` | no |
| ssl\_certificates | SSL cert self\_link list. Requires `ssl` to be set to `true` | `list(string)` | `[]` | no |
| ssl\_policy | Selfink to SSL Policy | `string` | `null` | no |
| target\_service\_accounts | List of target service accounts for health check firewall rule. Exactly one of target\_tags or target\_service\_accounts should be specified. | `list(string)` | `[]` | no |
| target\_tags | List of target tags for health check firewall rule. Exactly one of target\_tags or target\_service\_accounts should be specified. | `list(string)` | `[]` | no |
| timeout\_sec | This has different meaning for different type of load balancing. Please refer https://cloud.google.com/load-balancing/docs/backend-service#timeout-setting | `number` | `null` | no |
| url\_map\_input | List of host, path and backend service for creating url\_map | list(object({
host = string
path = string
backend_service = string
})) | `[]` | no |
| url\_map\_resource\_uri | The url\_map resource to use. Default is to send all traffic to first backend. | `string` | `null` | no |
## Outputs
| Name | Description |
|------|-------------|
| backend\_services | The region backend service resources. |
| external\_ip | The external IPv4 assigned to the fowarding rule. |
| http\_proxy | The HTTP proxy used by this module. |
| https\_proxy | The HTTPS proxy used by this module. |
| url\_map | The default URL map used by this module. |