Set up a managed instance group backend

Cloud CDN leverages Google Cloud global external HTTP(S) load balancers to provide routing, health checking, and Anycast IP support. Global external HTTP(S) load balancers can have multiple backend instance types, and you can choose which backends (or origins) to enable Cloud CDN for.

This setup guide shows you how to create an external HTTP(S) load balancer with a Compute Engine managed instance group backend with Cloud CDN enabled.

If this example doesn't match your use case, see one of the following pages:

For general concepts, see the External HTTP(S) load balancer overview.

If you are an existing user of the global external HTTP(S) load balancer (classic), make sure that you review Plan your migration to the global external HTTP(S) load balancer when you plan a new deployment with the global external HTTP(S) load balancer.

Load balancer topologies

For an HTTPS load balancer, you create the configuration shown in the following diagram.

HTTPS load balancer with a managed instance group (MIG) backend.
Figure 1. HTTPS load balancer with a managed instance group (MIG) backend (click to enlarge)

For an HTTP load balancer, you create the configuration shown in the following diagram.

HTTP load balancer with a managed instance group (MIG) backend.
Figure 2. HTTP load balancer with a managed instance group (MIG) backend (click to enlarge)

The sequence of events in the diagrams are as follows:

  1. A client sends a content request to the external IPv4 address defined in the forwarding rule.

  2. The load balancer checks whether the request can be served from cache. If so, the load balancer serves the requested content out of cache. If not, processing continues.

  3. For an HTTPS load balancer, the forwarding rule directs the request to the target HTTPS proxy.

    For an HTTP load balancer, the forwarding rule directs the request to the target HTTP proxy.

  4. The target proxy uses the rule in the URL map to determine that the single backend service receives all requests.

  5. The load balancer determines that the backend service has only one instance group and directs the request to a virtual machine (VM) instance in that group.

  6. The VM serves the content requested by the user.

External HTTP(S) load balancer with a managed instance group (MIG) backend and Cloud CDN enabled.
External HTTP(S) load balancer with a managed instance group (MIG) backend and Cloud CDN enabled (click to enlarge)

Before you begin

Complete the following steps before you create the load balancer.

Set up an SSL certificate resource

For an HTTPS load balancer, create an SSL certificate resource as described in the following:

We recommend using a Google-managed certificate.

This example assumes that you already have an SSL certificate resource named www-ssl-cert.

Set up permissions

To complete the steps in this guide, you must have permission to create Compute Engine instances, firewall rules, and reserved IP addresses in a project. You must have either a project owner or editor role, or you must have the following Compute Engine IAM roles.

Task Required role
Create instances Instance Admin
Add and remove firewall rules Security Admin
Create load balancer components Network Admin
Create a project (optional) Project Creator

For more information, see the following guides:

Create a managed instance group

To set up a load balancer with a Compute Engine backend, your VMs need to be in an instance group. This guide describes how to create a managed instance group with Linux VMs that have Apache running, and then set up load balancing. A managed instance group creates each of its managed instances based on the instance templates that you specify.

The managed instance group provides VMs running the backend servers of an external HTTP(S) load balancer. For demonstration purposes, backends serve their own hostnames.

Before you create a managed instance group, create an instance template.

Console

  1. In the Google Cloud console, go to the Instance templates page.

    Go to Instance templates

  2. Click Create instance template.

  3. For Name, enter lb-backend-template.

  4. Ensure that the Boot disk is set to a Debian image, such as Debian GNU/Linux 10 (buster). These instructions use commands that are only available on Debian, such as apt-get.

  5. Do not configure the Firewall option.

    Because the external HTTP(S) load balancer is a proxy, you don't need to select Allow HTTPS traffic or Allow HTTP traffic under Firewall. In Configuring a firewall rule, you create the only necessary firewall rule for this load balancer.

  6. Click Advanced options.

  7. Click Networking and configure the following field:

    1. For Network tags, enter allow-health-check.

  8. Click Management. Enter the following script into the Startup script field.

    #! /bin/bash
apt-get update
apt-get install apache2 -y
a2ensite default-ssl
a2enmod ssl
vm_hostname="$(curl -H "Metadata-Flavor:Google" \
http://metadata.google.internal/computeMetadata/v1/instance/name)"
echo "Page served from: $vm_hostname" | \
tee /var/www/html/index.html
systemctl restart apache2

  9. Click Create.

gcloud

  1. Create the template.

    gcloud compute instance-templates create TEMPLATE_NAME \
   --region=us-east1 \
   --network=default \
   --subnet=default \
   --tags=allow-health-check \
   --image-family=debian-10 \
   --image-project=debian-cloud \
   --metadata=startup-script='#! /bin/bash
     apt-get update
     apt-get install apache2 -y
     a2ensite default-ssl
     a2enmod ssl
     vm_hostname="$(curl -H "Metadata-Flavor:Google" \
   http://metadata.google.internal/computeMetadata/v1/instance/name)"
   echo "Page served from: $vm_hostname" | \
   tee /var/www/html/index.html
   systemctl restart apache2'

Terraform

To create the instance template, use the google_compute_instance_template resource.

lb/external_http_lb_mig_backend/main.tf 
resource "google_compute_instance_template" "default" {
  name = "lb-backend-template"
  disk {
    auto_delete  = true
    boot         = true
    device_name  = "persistent-disk-0"
    mode         = "READ_WRITE"
    source_image = "projects/debian-cloud/global/images/family/debian-11"
    type         = "PERSISTENT"
  }
  labels = {
    managed-by-cnrm = "true"
  }
  machine_type = "n1-standard-1"
  metadata = {
    startup-script = "#! /bin/bash\n     sudo apt-get update\n     sudo apt-get install apache2 -y\n     sudo a2ensite default-ssl\n     sudo a2enmod ssl\n     vm_hostname=\"$(curl -H \"Metadata-Flavor:Google\" \\\n   http://169.254.169.254/computeMetadata/v1/instance/name)\"\n   sudo echo \"Page served from: $vm_hostname\" | \\\n   tee /var/www/html/index.html\n   sudo systemctl restart apache2"
  }
  network_interface {
    access_config {
      network_tier = "PREMIUM"
    }
    network    = "global/networks/default"
    subnetwork = "regions/us-east1/subnetworks/default"
  }
  region = "us-east1"
  scheduling {
    automatic_restart   = true
    on_host_maintenance = "MIGRATE"
    provisioning_model  = "STANDARD"
  }
  service_account {
    email  = "default"
    scopes = ["https://www.googleapis.com/auth/devstorage.read_only", "https://www.googleapis.com/auth/logging.write", "https://www.googleapis.com/auth/monitoring.write", "https://www.googleapis.com/auth/pubsub", "https://www.googleapis.com/auth/service.management.readonly", "https://www.googleapis.com/auth/servicecontrol", "https://www.googleapis.com/auth/trace.append"]
  }
  tags = ["allow-health-check"]
}

Create the managed instance group and select the instance template.

Console

  1. In the Google Cloud console, go to the Instance groups page.

    Go to the Instance groups page

  2. Click Create instance group.
  3. On the left, choose New managed instance group (stateless).
  4. For Name, enter lb-backend-example.
  5. Under Location, select Single zone.
  6. For Region, select your preferred region. This example uses us-east1.
  7. For Zone, select us-east1-b.
  8. Under Instance template, select the instance template lb-backend-template.

  9. For Autoscaling mode, select On: add and remove instances to the group.

    Set Minimum number of instances to 2, and set Maximum number of instances to 2 or more.

  10. To create the new instance group, click Create.

gcloud

  1. Create the managed instance group based on the template.

    gcloud compute instance-groups managed create lb-backend-example \
--template=TEMPLATE_NAME --size=2 --zone=us-east1-b

Terraform

To create the managed instance group, use the google_compute_instance_group_manager resource.

lb/external_http_lb_mig_backend/main.tf 
resource "google_compute_instance_group_manager" "default" {
  name = "lb-backend-example"
  zone = "us-east1-b"
  named_port {
    name = "http"
    port = 80
  }
  version {
    instance_template = google_compute_instance_template.default.id
    name              = "primary"
  }
  base_instance_name = "vm"
  target_size        = 2
}

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

Add a named port to the instance group

For your instance group, define an HTTP service and map a port name to the relevant port. The load balancing service forwards traffic to the named port. For more information, see Named ports.

Console

  1. In the Google Cloud console, go to the Instance groups page.

    Go to the Instance groups page

  2. Click the name of your instance group (in this example lb-backend-example).
  3. On the instance group's Overview page, click Edit .
  4. Under Port mapping, click Add port.
    1. For the port name, enter http. For the port number, enter 80.
  5. Click Save.

gcloud

Use the gcloud compute instance-groups set-named-ports command.

gcloud compute instance-groups set-named-ports lb-backend-example \
    --named-ports http:80 \
    --zone us-east1-b

Terraform

The named_port attribute is included in the managed instance group sample.

Configure a firewall rule

In this example, you create the fw-allow-health-check firewall rule. This is an ingress rule that allows traffic from the Google Cloud health checking systems (130.211.0.0/22 and 35.191.0.0/16). This example uses the target tag allow-health-check to identify the VMs.

Console

  1. In the Google Cloud console, go to the Firewall page.

    Go to the Firewall page

  2. Click Create firewall rule to create the firewall rule.
  3. For Name, enter fw-allow-health-check.
  4. Under Network, select Default.
  5. Under Targets, select Specified target tags.
  6. Populate the Target tags field with allow-health-check.
  7. Set Source filter to IPv4 ranges.
  8. Set Source IPv4 ranges to 130.211.0.0/22 and 35.191.0.0/16.
  9. Under Protocols and ports, select Specified protocols and ports.
  10. Select the TCP checkbox, and then type 80 for the port numbers.
  11. Click Create.

gcloud 

gcloud compute firewall-rules create fw-allow-health-check \
    --network=default \
    --action=allow \
    --direction=ingress \
    --source-ranges=130.211.0.0/22,35.191.0.0/16 \
    --target-tags=allow-health-check \
    --rules=tcp:80

Terraform

To create the firewall rule, use the google_compute_firewall resource.

lb/external_http_lb_mig_backend/main.tf 
resource "google_compute_firewall" "default" {
  name          = "fw-allow-health-check"
  direction     = "INGRESS"
  network       = "global/networks/default"
  priority      = 1000
  source_ranges = ["130.211.0.0/22", "35.191.0.0/16"]
  target_tags   = ["allow-health-check"]
  allow {
    ports    = ["80"]
    protocol = "tcp"
  }
}

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

Reserve an external IP address

Now that your instances are up and running, set up a global static external IP address that your customers use to reach your load balancer.

Console

  1. In the Google Cloud console, go to the External IP addresses page.

    Go to the External IP addresses page

  2. To reserve an IPv4 address, click Reserve static address.
  3. For Name, enter lb-ipv4-1.
  4. Set Network Service Tier to Premium.
  5. Set IP version to IPv4.
  6. Set Type to Global.
  7. Click Reserve.

gcloud 

gcloud compute addresses create lb-ipv4-1 \
    --ip-version=IPV4 \
    --network-tier=PREMIUM \
    --global

Note the IPv4 address that was reserved:

gcloud compute addresses describe lb-ipv4-1 \
    --format="get(address)" \
    --global

Terraform

To reserve the IP address, use the google_compute_global_address resource.

lb/external_http_lb_mig_backend/main.tf 
resource "google_compute_global_address" "default" {
  name       = "lb-ipv4-1"
  ip_version = "IPV4"
}

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

Set up the load balancer

In this example, you are using HTTPS (frontend) between the client and the load balancer. For HTTPS, you need one or more SSL certificate resources to configure the proxy. We recommend using a Google-managed certificate.

Even if you're using HTTPS on the frontend, you can use HTTP on the backend. Google automatically encrypts traffic between Google Front Ends (GFEs) and your backends that reside within Google Cloud VPC networks.

Console

Start the configuration

  1. In the Google Cloud console, go to the Load balancing page.
    Go to Load balancing
  2. Under HTTP(S) load balancing, click Start configuration.
  3. Under Internet facing or internal only, select From Internet to my VMs.
  4. Under Global or regional, select Global HTTP(S) Load Balancer (classic).
  5. Click Continue.
  6. For the load balancer Name, enter something like web-map-https or web-map-http.
Frontend configuration
  1. Click Frontend configuration.
  2. Set Protocol to HTTPS.
  3. Set IP address to lb-ipv4-1, which you created earlier.
  4. Ensure that Port is set to 443 to allow HTTPS traffic.
  5. Click Certificate, and select your primary SSL certificate.
  6. Optional: Create an SSL policy:
    1. In the SSL policy list, select Create a policy.
    2. Set the name of the SSL policy to my-ssl-policy.
    3. For Minimum TLS Version, select TLS 1.0.
    4. For Profile, select Modern. The Enabled features and Disabled features are displayed.
    5. Click Save.
      6. If you have not created any SSL policies, a default GCP SSL policy is applied.
    6. Optional: Select the Enable HTTP to HTTPS Redirect checkbox to enable redirects from port 80 to port 443.

      Enabling this checkbox creates an additional partial HTTP load balancer that uses the same IP address as your HTTPS load balancer and redirects incoming HTTP requests to your load balancer's HTTPS frontend.

      This checkbox can only be selected when the HTTPS protocol is selected and a reserved IP address is used.

  7. Click Done.
Backend configuration
  1. Click Backend configuration.
  2. Under Create or select backend services & backend buckets, select Backend services > Create a backend service.
  3. Add a name for your backend service, such as web-backend-service.
  4. Under Protocol, select HTTP.
  5. For the Named Port, enter http.
  6. In Backends > New backend > Instance group, select your instance group, lb-backend-example.
  7. For the Port numbers, enter 80.
  8. Retain the other default settings.
  9. Under Health check, select Create a health check, and then add a name for your health check, such as http-basic-check.
  10. Set the protocol to HTTP, and then click Save.

  11. Optional: Configure a default backend security policy. The default security policy throttles traffic over a user-configured threshold. For more information about default security policies, see the Rate limiting overview.

    1. To opt out of the Google Cloud Armor default security policy, select None in the backend security policy list menu.
    2. In the Security section, select Default security policy.
    3. In the Policy name field, accept the automatically generated name or enter a name for your security policy.
    4. In the Request count field, accept the default request count or enter an integer between 1 and 10,000.
    5. In the Interval field, select an interval.
    6. In the Enforce on key field, choose one of the following values: All, IP address, or X-Forwarded-For IP address. For more information about these options, see Identifying clients for rate limiting.
  12. Select Enable Cloud CDN.
  13. Optional: Modify the cache mode and TTL settings.
  14. Retain the other default settings.
  15. Click Create.
Host and path rules

For Host and path rules, retain the default settings.

Review and finalize
  1. Click Review and finalize.
  2. Review your load balancer configuration settings.
  3. Optional: Click Equivalent code to view the REST API request that will be used to create the load balancer.
  4. Click Create.

Wait for the load balancer to be created.

If you created an HTTPS load balancer and selected the Enable HTTP to HTTPS Redirect checkbox, you will also see an HTTP load balancer created with a -redirect suffix.

  1. Click the name of the load balancer.
  2. On the Load balancer details screen, note the IP:Port for your load balancer.

gcloud

  1. Create a health check. 
      gcloud compute health-checks create http http-basic-check \
      --port 80
  2. Create a backend service. 
      gcloud compute backend-services create web-backend-service \
      --load-balancing-scheme=EXTERNAL \
      --protocol=HTTP \
      --port-name=http \
      --health-checks=http-basic-check \
      --global
  3. Add your instance group as the backend to the backend service. 
      gcloud compute backend-services add-backend web-backend-service \
      --instance-group=lb-backend-example \
      --instance-group-zone=us-east1-b \
      --global
  4. For HTTP, create a URL map to route the incoming requests to the default backend service. 
      gcloud compute url-maps create web-map-http \
      --default-service web-backend-service
  5. For HTTPS, create a URL map to route the incoming requests to the default backend service. 
      gcloud compute url-maps create web-map-https \
      --default-service web-backend-service

Setting up an HTTPS frontend

Skip this section for HTTP load balancers.
  1. For HTTPS, if you haven't already done so, create the global SSL certificate resource, as shown in:

  2. For HTTPS, create a target HTTPS proxy to route requests to your URL map. The proxy is the portion of the load balancer that holds the SSL certificate for an HTTPS load balancer, so you also load your certificate in this step.

      gcloud compute target-https-proxies create https-lb-proxy \
      --url-map=web-map-https \
      --ssl-certificates=www-ssl-cert
  3. For HTTPS, create a global forwarding rule to route incoming requests to the proxy. 
      gcloud compute forwarding-rules create https-content-rule \
      --load-balancing-scheme=EXTERNAL \
      --network-tier=PREMIUM \
      --address=lb-ipv4-1 \
      --global \
      --target-https-proxy=https-lb-proxy \
      --ports=443
  4. Optional: For HTTPS, create a global SSL policy and attach it to the HTTPS proxy.
    To create a global SSL policy: 
      gcloud compute ssl-policies create my-ssl-policy \
      --profile MODERN \
      --min-tls-version 1.0
    To attach the SSL policy to the global target HTTPS proxy: 
      gcloud compute target-https-proxies update https-lb-proxy \
      --ssl-policy my-ssl-policy

Setting up an HTTP frontend

Skip this section for HTTPS load balancers.

  1. For HTTP, create a target HTTP proxy to route requests to your URL map. 
      gcloud compute target-http-proxies create http-lb-proxy \
      --url-map=web-map-http
  2. For HTTP, create a global forwarding rule to route incoming requests to the proxy. 
      gcloud compute forwarding-rules create http-content-rule \
      --load-balancing-scheme=EXTERNAL \
      --address=lb-ipv4-1 \
      --global \
      --target-http-proxy=http-lb-proxy \
      --ports=80

Terraform

  1. To create the health check, use the google_compute_health_check resource.

    lb/external_http_lb_mig_backend/main.tf 
    resource "google_compute_health_check" "default" {
  name               = "http-basic-check"
  check_interval_sec = 5
  healthy_threshold  = 2
  http_health_check {
    port               = 80
    port_specification = "USE_FIXED_PORT"
    proxy_header       = "NONE"
    request_path       = "/"
  }
  timeout_sec         = 5
  unhealthy_threshold = 2
}

  2. To create the backend service, use the google_compute_backend_service resource.

    This example uses load_balancing_scheme="EXTERNAL_MANAGED", which sets up a global external HTTP(S) load balancer with advanced traffic management capability. To create a global external HTTP(S) load balancer (classic), make sure you change the load_balancing_scheme to EXTERNAL before running the script.

    lb/external_http_lb_mig_backend/main.tf 
    resource "google_compute_backend_service" "default" {
  name                            = "web-backend-service"
  connection_draining_timeout_sec = 0
  health_checks                   = [google_compute_health_check.default.id]
  load_balancing_scheme           = "EXTERNAL_MANAGED"
  port_name                       = "http"
  protocol                        = "HTTP"
  session_affinity                = "NONE"
  timeout_sec                     = 30
  backend {
    group           = google_compute_instance_group_manager.default.instance_group
    balancing_mode  = "UTILIZATION"
    capacity_scaler = 1.0
  }
}

  3. To create the URL map, use the google_compute_url_map resource.

    lb/external_http_lb_mig_backend/main.tf 
    resource "google_compute_url_map" "default" {
  name            = "web-map-http"
  default_service = google_compute_backend_service.default.id
}

  4. To create the target HTTP proxy, use the google_compute_target_http_proxy resource.

    lb/external_http_lb_mig_backend/main.tf 
    resource "google_compute_target_http_proxy" "default" {
  name    = "http-lb-proxy"
  url_map = google_compute_url_map.default.id
}

  5. To create the forwarding rule, use the google_compute_global_forwarding_rule resource.

    This example uses load_balancing_scheme="EXTERNAL_MANAGED", which sets up a global external HTTP(S) load balancer with advanced traffic management capability. To create a global external HTTP(S) load balancer (classic), make sure you change the load_balancing_scheme to EXTERNAL before running the script.

    lb/external_http_lb_mig_backend/main.tf 
    resource "google_compute_global_forwarding_rule" "default" {
  name                  = "http-content-rule"
  ip_protocol           = "TCP"
  load_balancing_scheme = "EXTERNAL_MANAGED"
  port_range            = "80-80"
  target                = google_compute_target_http_proxy.default.id
  ip_address            = google_compute_global_address.default.id
}

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

Enable Cloud CDN

If you didn't already enable Cloud CDN when you created your backend service, you can do this now by updating the backend service.

gcloud compute backend-services update web-backend-service \
    --enable-cdn \
    --cache-mode=CACHE_MODE

Set the cache mode by replacing CACHE_MODE with one of the following:

  • CACHE_All_STATIC: Automatically caches static content.

  • USE_ORIGIN_HEADERS (default): Requires the origin to set valid caching headers to cache content.

  • FORCE_CACHE_ALL: Caches all content, ignoring any private, no-store, or no-cache directives in Cache-Control response headers.

Connect your domain to your load balancer

After the load balancer is created, note the IP address that is associated with the load balancer—for example, 30.90.80.100. To point your domain to your load balancer, create an A record by using your domain registration service. If you added multiple domains to your SSL certificate, you must add an A record for each one, all pointing to the load balancer's IP address. For example, to create A records for www.example.com and example.com, use the following:

NAME                  TYPE     DATA
www                   A        30.90.80.100
@                     A        30.90.80.100

If you are using Google Domains, for more information, see Google Domains Help.

Test traffic sent to your instances

Now that the load balancing service is running, you can send traffic to the forwarding rule and watch the traffic be dispersed to different instances.

Console

  1. In the Google Cloud console, go to the Load balancing page.

    Go to the Load balancing page

  2. Click the load balancer that you just created.
  3. In the Backend section, confirm that the VMs are healthy. The Healthy column should be populated, indicating that both VMs are healthy (2/2). If you see otherwise, first try reloading the page. It can take a few moments for the Google Cloud console to indicate that the VMs are healthy. If the backends do not appear healthy after a few minutes, review the firewall configuration and the network tag assigned to your backend VMs.
  4. For HTTPS, if you are using a Google-managed certificate, confirm that your certificate resource's status is ACTIVE. For more information, see Google-managed SSL certificate resource status.
  5. After the Google Cloud console shows that the backend instances are healthy, you can test your load balancer using a web browser by going to https://IP_ADDRESS (or http://IP_ADDRESS). Replace IP_ADDRESS with the load balancer's IP address.
  6. If you used a self-signed certificate for testing HTTPS, your browser displays a warning. You must explicitly instruct your browser to accept a self-signed certificate.
  7. Your browser should render a page with content showing the name of the instance that served the page, along with its zone (for example, Page served from: lb-backend-example-xxxx). If your browser doesn't render this page, review the configuration settings in this guide.

gcloud 

gcloud compute addresses describe lb-ipv4-1 \
   --format="get(address)" \
   --global

After a few minutes have passed, you can test the setup by running the following curl command.

curl http://IP_ADDRESS

-OR-

curl https://HOSTNAME

Disable Cloud CDN

Console

Disable Cloud CDN for a single backend service

  1. In the Google Cloud console, go to the Cloud CDN page.

    Go to the Cloud CDN page

  2. On the right side of the origin row, click Menu and then select Edit.
  3. Clear the checkboxes of any backend services that you want to stop from using Cloud CDN.
  4. Click Update.

Remove Cloud CDN for all backend services for an origin

  1. In the Google Cloud console, go to the Cloud CDN page.

    Go to the Cloud CDN page

  2. On the right side of the origin row, click Menu and then select Remove.
  3. To confirm, click Remove.

gcloud 

gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --no-enable-cdn

Disabling Cloud CDN does not invalidate or purge caches. If you disable and then re-enable Cloud CDN, most or all of your cached content might still be cached. To prevent content from being served from cache, you must invalidate that content.

What's next