google.cloud.gcp_compute_https_health_check 模块 – 创建 GCP HttpsHealthCheck

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_https_health_check。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

摘要

  • HttpsHealthCheck 资源。此资源定义了如何通过 HTTPS 检查各个 VM 的运行状况的模板。

要求

执行此模块的主机需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

check_interval_sec

整数

发送健康检查的频率（以秒为单位）。默认值为 5 秒。

description

字符串

此资源的可选描述。创建资源时提供此属性。

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

healthy_threshold

整数

在连续成功这么多次后，先前不健康的实例将被标记为健康。默认值为 2。

host

字符串

HTTPS 健康检查请求中主机头的值。如果留空（默认值），则将使用代表执行此健康检查的公共 IP。

name

字符串 / 必需

资源的名称。创建资源时由客户端提供。名称必须是 1-63 个字符长，并符合 RFC1035。具体来说，名称必须是 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。

port

整数

HTTPS 健康检查请求的 TCP 端口号。

默认值为 443。

project

字符串

要使用的 Google Cloud Platform 项目。

request_path

字符串

HTTPS 健康检查请求的请求路径。

默认值为 /。

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

state

字符串

给定对象是否应该存在于 GCP 中

选项

  • "present" ← (默认)

  • "absent"

timeout_sec

别名：timeout_seconds

整数

在声明失败之前要等待的时间（以秒为单位）。

默认值为 5 秒。timeoutSec 的值不能大于 checkIntervalSec。

unhealthy_threshold

整数

在连续失败这么多次后，先前健康的实例将被标记为不健康。默认值为 2。

注释

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks

  • 添加健康检查：https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

  • 只有在未设置 playbook 值时，才会使用环境变量值。

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: create a HTTPS health check
  google.cloud.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

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

checkIntervalSec

整数

发送健康检查的频率（以秒为单位）。默认值为 5 秒。

返回：成功

creationTimestamp

字符串

RFC3339 文本格式的创建时间戳。

返回：成功

description

字符串

此资源的可选描述。创建资源时提供此属性。

返回：成功

healthyThreshold

整数

在连续成功这么多次后，先前不健康的实例将被标记为健康。默认值为 2。

返回：成功

host

字符串

HTTPS 健康检查请求中主机头的值。如果留空（默认值），则将使用代表执行此健康检查的公共 IP。

返回：成功

id

整数

资源的唯一标识符。此标识符由服务器定义。

返回：成功

name

字符串

资源的名称。创建资源时由客户端提供。名称必须是 1-63 个字符长，并符合 RFC1035。具体来说，名称必须是 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。

返回：成功

port

整数

HTTPS 健康检查请求的 TCP 端口号。

默认值为 443。

返回：成功

请求路径

字符串

HTTPS 健康检查请求的请求路径。

默认值为 /。

返回：成功

超时秒数

整数

在声明失败之前要等待的时间（以秒为单位）。

默认值为 5 秒。timeoutSec 的值不能大于 checkIntervalSec。

返回：成功

不健康阈值

整数

在连续失败这么多次后，先前健康的实例将被标记为不健康。默认值为 2。

返回：成功

作者

  • 谷歌公司 (@googlecloudplatform)