Documentation

gcp_compute_https_health_check – Creates a GCP HttpsHealthCheck

New in version 2.6.

Synopsis

  • An HttpsHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTPS.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
check_interval_sec
-
How often (in seconds) to send a health check. The default value is 5 seconds.
description
-
An optional description of this resource. Provide this property when you create the resource.
healthy_threshold
-
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host
-
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
- / required
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]([-a-z0-9]*[a-z0-9])?` 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
-
The TCP port number for the HTTPS health check request.
The default value is 80.
project
string
The Google Cloud Platform project to use.
request_path
-
The request path of the HTTPS health check request.
The default value is /.
scopes
list
Array of scopes to be used.
service_account_contents
string
A string representing the contents of a Service Account JSON file.
This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
service_account_email
string
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
path
The path of a Service Account JSON file if serviceaccount is selected as type.
state
-
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
timeout_sec
-
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.

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

Notes

Note

  • API Reference: https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks
  • Adding Health Checks: https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks
  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a https health check
  gcp_compute_https_health_check:
    name: test_object
    healthy_threshold: 10
    port: 8080
    timeout_sec: 2
    unhealthy_threshold: 5
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
checkIntervalSec
integer
success
How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp
string
success
Creation timestamp in RFC3339 text format.

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

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

host
string
success
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.

id
integer
success
The unique identifier for the resource. This identifier is defined by the server.

name
string
success
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]([-a-z0-9]*[a-z0-9])?` 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
integer
success
The TCP port number for the HTTPS health check request.
The default value is 80.

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

timeoutSec
integer
success
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.

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



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.