Skip to content

Latest commit

 

History

History

autogen

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
main.tf.tmpl
main.tf.tmpl
 
 
outputs.tf.tmpl
outputs.tf.tmpl
 
 
variables.tf.tmpl
variables.tf.tmpl
 
 
versions.tf.tmpl
versions.tf.tmpl
 
 

README.md

Global HTTP Load Balancer Terraform Module {%- if serverless %} for Serverless NEGs{% endif %}

{% if not serverless %} Modular Global HTTP Load Balancer for GCE using forwarding rules. {% endif %}

{% if root %}

  • If you would like to allow for backend groups to be managed outside Terraform, such as via GKE services, see the dynamic backends submodule.
  • If you would like to use load balancing with serverless backends (Cloud Run, Cloud Functions or App Engine), see the serverless_negs submodule and cloudrun example.

{% elif dynamic_backends %} This submodule allows for configuring dynamic backend outside Terraform. As such, any changes to the backends.groups variable after creation will be ignored. {% elif serverless %} This submodule allows you to create Cloud HTTP(S) Load Balancer with Serverless Network Endpoint Groups (NEGs) and place serverless services from Cloud Run, Cloud Functions and App Engine behind a Cloud Load Balancer. {% endif %}

{% if not serverless %} {# TCP LB and ILB don't work for Serverless NEGs yet. #}

Load Balancer Types

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 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.

Version

Current version is 9.0. Upgrade guides:

Usage

{% if not serverless %}
module "gce-lb-http" {
{% else %}
module "lb-http" {
{% endif %}
  source            = "GoogleCloudPlatform/lb-http/google{{ module_path }}"
  version           = "~> 9.0"

  project           = "my-project-id"
  {% if serverless %}
  name              = "my-lb"

  ssl                             = true
  managed_ssl_certificate_domains = ["your-domain.com"]
  https_redirect                  = true
  {% else %}
  name              = "group-http-lb"
  target_tags       = [module.mig1.target_tags, module.mig2.target_tags]
  {% endif %}
  backends = {
    default = {
      {% if not serverless %}{# not necessary for serverless as default port_name=http, protocol=HTTP #}
      port                            = var.service_port
      {% endif %}
      protocol                        = "HTTP"
      port_name                       = var.service_port_name
      {% if not serverless %}
      timeout_sec                     = 10
      {% endif %}
      enable_cdn                      = false

      {% if not serverless %}

      health_check = {
        request_path        = "/"
        port                = var.service_port
      }
      {% endif %}

      log_config = {
        enable = true
        sample_rate = 1.0
      }

      {% if serverless %}
      groups = [
        {
          # Your serverless service should have a NEG created that's referenced here.
          group = google_compute_region_network_endpoint_group.default.id
        }
      ]
      {% else %}
      groups = [
        {
          # Each node pool instance group should be added to the backend.
          group                        = var.backend
        },
      ]
      {% endif %}

      iap_config = {
        enable               = false
      }
    }
  }
}

{% if not serverless %}

Resources created

Figure 1. diagram of terraform resources

architecture diagram {% endif %}

Inputs

Name Description Type Default Required
address IPv4 address (actual IP address value) string "null" no
ipv6_address IPv6 address (actual IP address value) string "null" no
backends Map backend indices to list of backend maps. object n/a yes
cdn Set to true to enable cdn on backend. bool "false" no
certificate Content of the SSL certificate. Required if ssl is true and ssl_certificates is empty. string "null" no
certificate_map Certificate Map ID in format projects/{project}/locations/global/certificateMaps/{{name}}. Identifies a certificate map associated with the given target proxy string null no
create_address Create a new global IPv4 address bool "true" no
create_ipv6_address Create a new global IPv6 address bool "true" no
create_url_map Set to false if url_map variable is provided. bool "true" no
firewall_networks Names of the networks to create firewall rules in list(string) <list> no
firewall_projects Names of the projects to create firewall rules in list(string) <list> no
http_forward Set to false to disable HTTP port 80 forward bool "true" no
https_redirect Set to true to enable https redirect on the lb. bool "false" no
name Name for the forwarding rule and prefix for supporting resources string n/a yes
private_key Content of the private SSL key. Required if ssl is true and ssl_certificates is empty. string "null" no
project The project to deploy to, if not set the default provider project is used. string n/a yes
quic Set to true to enable QUIC support bool "false" no
security_policy The resource URL for the security policy to associate with the backend service string "null" no
ssl Set to true to enable SSL support, requires variable ssl_certificates - a list of self_link certs bool "false" no
ssl_certificates SSL cert self_link list. Required if ssl is true and no private_key and certificate is provided. list(string) <list> 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) <list> 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) <list> no
url_map The url_map resource to use. Default is to send all traffic to first backend. string "null" no
use_ssl_certificates If true, use the certificates provided by ssl_certificates, otherwise, create cert from private_key and certificate bool "false" no

Outputs

Name Description
backend_services The backend service resources.
external_ip The external IPv4 address assigned to the global fowarding rule.
external_ipv6_address The external IPv6 address assigned to the global fowarding rule.
http_proxy The HTTP proxy used by this module.
https_proxy The HTTPS proxyused by this module.