Google Compute Engine HTTPS Health Check
This page shows how to write Terraform for Compute Engine HTTPS Health Check and write them securely.
google_compute_https_health_check (Terraform)
The HTTPS Health Check in Compute Engine can be configured in Terraform with the resource name google_compute_https_health_check
. The following sections describe 1 example of how to use the resource and its parameters.
Example Usage from GitHub
resource "google_compute_https_health_check" "this" {
check_interval_sec = var.check_interval_sec
description = var.description
healthy_threshold = var.healthy_threshold
host = var.host
name = var.name
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.
-
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.
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.
-
port
optional - number
The TCP port number for the HTTPS health check request. The default value is 80.
-
project
optional computed - string -
request_path
optional - string
The request path of the HTTPS health check request. The default value is /.
-
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.
-
unhealthy_threshold
optional - number
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
Explanation in Terraform Registry
An HttpsHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTPS.
Note: google_compute_https_health_check is a legacy health check. The newer google_compute_health_check should be preferred for all uses except Network Load Balancers which still require the legacy version. To get more information about HttpsHealthCheck, see:
- API documentation
- How-to Guides
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.
Frequently asked questions
What is Google Compute Engine HTTPS Health Check?
Google Compute Engine HTTPS Health Check is a resource for Compute Engine of Google Cloud Platform. Settings can be wrote in Terraform.
Where can I find the example code for the Google Compute Engine HTTPS Health Check?
For Terraform, the niveklabs/google source code example is useful. See the Terraform Example section for further details.