Google Compute Engine Region Health Check

google_compute_region_health_check (Terraform)

The Region Health Check in Compute Engine can be configured in Terraform with the resource name google_compute_region_health_check. The following sections describe 5 examples of how to use the resource and its parameters.

Example Usage from GitHub

byronwhitlock-google/AutoML-Labeling-Tool

resource "google_compute_region_health_check" "automl_health_check" {
  provider = google-beta

  project = var.project_id
  region  = var.region
  name    = var.automl_health_check

d1nesh12345/Iac-demo

resource "google_compute_region_health_check" "hc" {
  provider           = google
  name        = "http-health-check"
  description = "Health check via http"
  region             = "us-central1"
  timeout_sec         = 1

ericprocopio/automl-labeling-tool

resource "google_compute_region_health_check" "automl_health_check" {
  provider = google-beta

  project = var.project_id
  region  = var.region
  name    = var.automl_health_check

LisandroLuna/terraspace

resource "google_compute_region_health_check" "default" {
  name     = var.rhc_name // "l7-ilb-hc"
  region   = var.rhc_region // "europe-west1"
  http_health_check {
    port_specification = var.rhc_port_speci // "USE_SERVING_PORT"
  }

Pawel-Matuszny/terraweb

resource "google_compute_region_health_check" "hc" {
  provider           = google
  name               = "check-website-backend"
  check_interval_sec = 1
  timeout_sec        = 1
  region             = var.region

Parameters

• check_interval_sec optional - number

How often (in seconds) to send a health check. The default value is 5 seconds.

• creation_timestamp optional computed - string

Creation timestamp in RFC3339 text format.

• description optional - string

An optional description of this resource. Provide this property when you create the resource.

• healthy_threshold optional - number

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

• id optional computed - string
• name required - string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

• project optional computed - string
• region optional computed - string

The Region in which the created health check should reside. If it is not provided, the provider region is used.

• self_link optional computed - string
• timeout_sec optional - number

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

• type optional computed - string

The type of the health check. One of HTTP, HTTP2, HTTPS, TCP, or SSL.

• unhealthy_threshold optional - number

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

• grpc_health_check list block
  • grpc_service_name optional - string

  The gRPC service name for the health check. The value of grpcServiceName has the following meanings by convention: Empty serviceName means the overall status of all services at the backend. Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service. The grpcServiceName can only be ASCII.

  • port optional - number

  The port number for the health check request. Must be specified if portName and portSpecification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

  • port_name optional - string

  Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

  • port_specification optional - string

  Specifies how port is selected for health checking, can be one of the following values: 'USE_FIXED_PORT': The port number in 'port' is used for health checking. 'USE_NAMED_PORT': The 'portName' is used for health checking. * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

• http2_health_check list block
  • host optional - string

  The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

  • port optional - number

  The TCP port number for the HTTP2 health check request. The default value is 443.

  • port_name optional - string

  Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

  • port_specification optional - string

  Specifies how port is selected for health checking, can be one of the following values: 'USE_FIXED_PORT': The port number in 'port' is used for health checking. 'USE_NAMED_PORT': The 'portName' is used for health checking. * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

  • proxy_header optional - string

  Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]

  • request_path optional - string

  The request path of the HTTP2 health check request. The default value is /.

  • response optional - string

  The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

• http_health_check list block
  • host optional - string

  The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

  • port optional - number

  The TCP port number for the HTTP health check request. The default value is 80.

  • port_name optional - string

  Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

  • port_specification optional - string

  Specifies how port is selected for health checking, can be one of the following values: 'USE_FIXED_PORT': The port number in 'port' is used for health checking. 'USE_NAMED_PORT': The 'portName' is used for health checking. * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

  • proxy_header optional - string

  Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]

  • request_path optional - string

  The request path of the HTTP health check request. The default value is /.

  • response optional - string

  The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

• https_health_check list block
  • host optional - string

  The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

  • port optional - number

  The TCP port number for the HTTPS health check request. The default value is 443.

  • port_name optional - string

  Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

  • port_specification optional - string

  Specifies how port is selected for health checking, can be one of the following values: 'USE_FIXED_PORT': The port number in 'port' is used for health checking. 'USE_NAMED_PORT': The 'portName' is used for health checking. * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

  • proxy_header optional - string

  Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]

  • request_path optional - string

  The request path of the HTTPS health check request. The default value is /.

  • response optional - string

  The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

• ssl_health_check list block
  • port optional - number

  The TCP port number for the SSL health check request. The default value is 443.

  • port_name optional - string

  Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

  • port_specification optional - string

  Specifies how port is selected for health checking, can be one of the following values: 'USE_FIXED_PORT': The port number in 'port' is used for health checking. 'USE_NAMED_PORT': The 'portName' is used for health checking. * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

  • proxy_header optional - string

  Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]

  • request optional - string

  The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

  • response optional - string

  The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

• tcp_health_check list block
  • port optional - number

  The TCP port number for the TCP health check request. The default value is 80.

  • port_name optional - string

  Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

  • port_specification optional - string

  Specifies how port is selected for health checking, can be one of the following values: 'USE_FIXED_PORT': The port number in 'port' is used for health checking. 'USE_NAMED_PORT': The 'portName' is used for health checking. * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

  • proxy_header optional - string

  Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]

  • request optional - string

  The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

  • response optional - string

  The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

• timeouts single block
  • create optional - string
  • delete optional - string
  • update optional - string

Explanation in Terraform Registry

Health Checks determine whether instances are responsive and able to do work. They are an important part of a comprehensive load balancing configuration, as they enable monitoring instances behind load balancers. Health Checks poll instances at a specified interval. Instances that do not respond successfully to some number of probes in a row are marked as unhealthy. No new connections are sent to unhealthy instances, though existing connections will continue. The health check will continue to poll unhealthy instances. If an instance later responds successfully to some number of consecutive probes, it is marked healthy again and can receive new connections. To get more information about RegionHealthCheck, see:

• API documentation
• How-to Guides
  • Official Documentation

Tips: Best Practices for The Other Google Compute Engine Resources

In addition to the google_compute_disk, Google Compute Engine has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

google_compute_disk

Ensure the encryption key for your GCE disk is stored securely

It is better to store the encryption key for your GCE disk securely. Secret Manager could be used instead.

google_compute_firewall

Ensure your VPC firewall blocks unwanted outbound traffic

It is better to block unwanted outbound traffic not to expose resources in the VPC to unwanted attacks.

google_compute_instance

Ensure appropriate service account is assigned to your GCE instance

It is better to create a custom service account for the instance and assign it.

google_compute_project_metadata

Ensure OS login for your GCE instances is enabled at project level

It is better to enable OS login for your GCE instances. Enabling OS login ensures that SSH keys used to connect to instances are mapped with IAM users, allowing centralized and automated SSH key management.

google_compute_ssl_policy

Ensure to use modern TLS protocols

It's better to adopt TLS v1.2+ instead of outdated TLS protocols.

google_compute_subnetwork

Ensure VPC flow logging is enabled

It is better to enable VPC flow logging. VPC flow logging allows us to audit traffic in your network.