google.cloud.gcp_compute_health_check module – Creates a GCP HealthCheck
Note
This module is part of the google.cloud collection (version 1.0.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
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.
~>**NOTE**: Legacy HTTP(S) health checks must be used for target pool-based network load balancers. See the [official guide](https://cloud.google.com/load-balancing/docs/health-check-concepts#selecting_hc) for choosing a type of health check.
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 |
Comments |
---|---|
The type of credential used. Choices:
|
|
How often (in seconds) to send a health check. The default value is 5 seconds. Default: |
|
An optional description of this resource. Provide this property when you create the resource. |
|
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. |
|
A nested object resource. |
|
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.
The grpcServiceName can only be ASCII. |
|
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 as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
|
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” |
|
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. Default: |
|
A nested object resource. |
|
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. |
|
The TCP port number for the HTTP2 health check request. The default value is 443. |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
|
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” |
|
Specifies the type of proxy header to append before sending data to the backend. Some valid choices include: “NONE”, “PROXY_V1” Default: |
|
The request path of the HTTP2 health check request. The default value is /. Default: |
|
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. |
|
A nested object resource. |
|
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. |
|
The TCP port number for the HTTP health check request. The default value is 80. |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
|
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” |
|
Specifies the type of proxy header to append before sending data to the backend. Some valid choices include: “NONE”, “PROXY_V1” Default: |
|
The request path of the HTTP health check request. The default value is /. Default: |
|
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. |
|
A nested object resource. |
|
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. |
|
The TCP port number for the HTTPS health check request. The default value is 443. |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
|
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” |
|
Specifies the type of proxy header to append before sending data to the backend. Some valid choices include: “NONE”, “PROXY_V1” Default: |
|
The request path of the HTTPS health check request. The default value is /. Default: |
|
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 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. |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
A nested object resource. |
|
The TCP port number for the SSL health check request. The default value is 443. |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
|
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” |
|
Specifies the type of proxy header to append before sending data to the backend. Some valid choices include: “NONE”, “PROXY_V1” Default: |
|
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. |
|
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. |
|
Whether the given object should exist in GCP Choices:
|
|
A nested object resource. |
|
The TCP port number for the TCP health check request. The default value is 443. |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
|
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” |
|
Specifies the type of proxy header to append before sending data to the backend. Some valid choices include: “NONE”, “PROXY_V1” Default: |
|
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. |
|
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. |
|
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. Default: |
|
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” |
|
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. Default: |
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 |
Description |
---|---|
How often (in seconds) to send a health check. The default value is 5 seconds. Returned: success |
|
Creation timestamp in RFC3339 text format. Returned: success |
|
An optional description of this resource. Provide this property when you create the resource. Returned: success |
|
A nested object resource. Returned: 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.
The grpcServiceName can only be ASCII. Returned: 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. Returned: success |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Returned: 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. Returned: success |
|
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. Returned: success |
|
A nested object resource. Returned: 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. Returned: success |
|
The TCP port number for the HTTP2 health check request. The default value is 443. Returned: success |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Returned: 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. Returned: success |
|
Specifies the type of proxy header to append before sending data to the backend. Returned: success |
|
The request path of the HTTP2 health check request. The default value is /. Returned: 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. Returned: success |
|
A nested object resource. Returned: 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. Returned: success |
|
The TCP port number for the HTTP health check request. The default value is 80. Returned: success |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Returned: 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. Returned: success |
|
Specifies the type of proxy header to append before sending data to the backend. Returned: success |
|
The request path of the HTTP health check request. The default value is /. Returned: 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. Returned: success |
|
A nested object resource. Returned: 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. Returned: success |
|
The TCP port number for the HTTPS health check request. The default value is 443. Returned: success |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Returned: 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. Returned: success |
|
Specifies the type of proxy header to append before sending data to the backend. Returned: success |
|
The request path of the HTTPS health check request. The default value is /. Returned: 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. Returned: success |
|
The unique identifier for the resource. This identifier is defined by the server. Returned: 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. Returned: success |
|
A nested object resource. Returned: success |
|
The TCP port number for the SSL health check request. The default value is 443. Returned: success |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Returned: 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. Returned: success |
|
Specifies the type of proxy header to append before sending data to the backend. Returned: 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. Returned: 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. Returned: success |
|
A nested object resource. Returned: success |
|
The TCP port number for the TCP health check request. The default value is 443. Returned: success |
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Returned: 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. Returned: success |
|
Specifies the type of proxy header to append before sending data to the backend. Returned: 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. Returned: 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. Returned: 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. Returned: 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. Returned: success |
|
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. Returned: success |