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
required
    Choices:
  • machineaccount
  • serviceaccount
  • application
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 Default:
None
The Google Cloud Platform project to use.
request_path
The request path of the HTTPS health check request.
The default value is /.
scopes
Array of scopes to be used.
service_account_email
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
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

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: "service_account"
      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
check_interval_sec
int
success
How often (in seconds) to send a health check. The default value is 5 seconds.

creation_timestamp
str
success
Creation timestamp in RFC3339 text format.

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

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

host
str
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
int
success
The unique identifier for the resource. This identifier is defined by the server.

name
str
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
int
success
The TCP port number for the HTTPS health check request.
The default value is 80.

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

timeout_sec
int
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.

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



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Google Inc. (@googlecloudplatform)

Hint

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