google.cloud.gcp_compute_health_check – Creates a GCP HealthCheck

Note

This plugin is part of the google.cloud collection.

To install it use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_health_check.

Synopsis

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

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
integer
Default:
"5"
How often (in seconds) to send a health check. The default value is 5 seconds.
description
string
An optional description of this resource. Provide this property when you create the resource.
env_type
string
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
grpc_health_check
dictionary
A nested object resource.
grpc_service_name
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
integer
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
string
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
healthy_threshold
integer
Default:
"2"
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
http2_health_check
dictionary
A nested object resource.
host
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
integer
The TCP port number for the HTTP2 health check request.
The default value is 443.
port_name
string
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
proxy_header
string
Default:
"NONE"
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
request_path
string
Default:
"/"
The request path of the HTTP2 health check request.
The default value is /.
response
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
dictionary
A nested object resource.
host
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
integer
The TCP port number for the HTTP health check request.
The default value is 80.
port_name
string
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
proxy_header
string
Default:
"NONE"
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
request_path
string
Default:
"/"
The request path of the HTTP health check request.
The default value is /.
response
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
dictionary
A nested object resource.
host
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
integer
The TCP port number for the HTTPS health check request.
The default value is 443.
port_name
string
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
proxy_header
string
Default:
"NONE"
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
request_path
string
Default:
"/"
The request path of the HTTPS health check request.
The default value is /.
response
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.
name
string / 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.
project
string
The Google Cloud Platform project to use.
scopes
list / elements=string
Array of scopes to be used
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
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.
ssl_health_check
dictionary
A nested object resource.
port
integer
The TCP port number for the SSL health check request.
The default value is 443.
port_name
string
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
proxy_header
string
Default:
"NONE"
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
request
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
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.
state
string
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
tcp_health_check
dictionary
A nested object resource.
port
integer
The TCP port number for the TCP health check request.
The default value is 443.
port_name
string
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
proxy_header
string
Default:
"NONE"
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
request
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
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.
timeout_sec
integer
Default:
"5"
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
type
string
Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Some valid choices include: "TCP", "SSL", "HTTP", "HTTPS", "HTTP2"
unhealthy_threshold
integer
Default:
"2"
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/rest/v1/healthChecks

  • Official Documentation: https://cloud.google.com/load-balancing/docs/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_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL 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 health check
  google.cloud.gcp_compute_health_check:
    name: test_object
    type: TCP
    tcp_health_check:
      port_name: service-health
      request: ping
      response: pong
    healthy_threshold: 10
    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.

grpcHealthCheck
complex
success
A nested object resource.

 
grpcServiceName
string
success
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
integer
success
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.

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

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

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

http2HealthCheck
complex
success
A nested object resource.

 
host
string
success
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
integer
success
The TCP port number for the HTTP2 health check request.
The default value is 443.

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

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

 
proxyHeader
string
success
Specifies the type of proxy header to append before sending data to the backend.

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

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

httpHealthCheck
complex
success
A nested object resource.

 
host
string
success
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
integer
success
The TCP port number for the HTTP health check request.
The default value is 80.

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

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

 
proxyHeader
string
success
Specifies the type of proxy header to append before sending data to the backend.

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

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

httpsHealthCheck
complex
success
A nested object resource.

 
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.

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

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

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

 
proxyHeader
string
success
Specifies the type of proxy header to append before sending data to the backend.

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

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

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.

sslHealthCheck
complex
success
A nested object resource.

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

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

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

 
proxyHeader
string
success
Specifies the type of proxy header to append before sending data to the backend.

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

tcpHealthCheck
complex
success
A nested object resource.

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

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

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

 
proxyHeader
string
success
Specifies the type of proxy header to append before sending data to the backend.

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

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.

type
string
success
Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

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



Authors

  • Google Inc. (@googlecloudplatform)