google.cloud.gcp_compute_health_check_info 模块 – 收集 GCP 健康检查信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP 健康检查信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

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

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

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

filters

列表 / 元素=字符串

过滤器值对的列表。此处列出了可用的过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。

列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 和 filter2)。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

注释

注意

  • 对于身份验证，您可以使用 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: get info on a health check
  gcp_compute_health_check_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

此处记录了常见的返回值 此处，以下是此模块独有的字段

键

描述

resources

复杂

资源列表

返回：始终

checkIntervalSec

整数

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

返回：成功

creationTimestamp

字符串

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

返回：成功

description

字符串

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

返回：成功

grpcHealthCheck

复杂

嵌套对象资源。

返回：成功

grpcServiceName

字符串

健康检查的 gRPC 服务名称。

grpcServiceName 的值按照惯例具有以下含义：- 空 serviceName 表示后端所有服务的整体状态。

  • 非空 serviceName 表示该 gRPC 服务的健康状况，由服务所有者定义。

grpcServiceName 只能是 ASCII。

返回：成功

port

整数

健康检查请求的端口号。

如果未设置 portName 和 portSpecification 或 port_specification 为 USE_FIXED_PORT，则必须指定。有效值为 1 到 65535。

返回：成功

portName

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

返回：成功

portSpecification

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：使用 `port` 中的端口号进行健康检查。

* `USE_NAMED_PORT`：使用 `portName` 进行健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，使用为每个网络端点指定的端口进行健康检查。对于其他后端，使用后端服务中指定的端口或命名端口进行健康检查。

如果未指定，则 gRPC 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

返回：成功

healthyThreshold

整数

在此许多连续成功之后，到目前为止不健康的实例将被标记为健康。默认值为 2。

返回：成功

http2HealthCheck

复杂

嵌套对象资源。

返回：成功

host

字符串

HTTP2 健康检查请求中 host 标头的值。

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

返回：成功

port

整数

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

默认值为 443。

返回：成功

portName

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

返回：成功

portSpecification

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：使用 `port` 中的端口号进行健康检查。

* `USE_NAMED_PORT`：使用 `portName` 进行健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，使用为每个网络端点指定的端口进行健康检查。对于其他后端，使用后端服务中指定的端口或命名端口进行健康检查。

如果未指定，HTTP2 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

返回：成功

proxyHeader

字符串

指定在向后端发送数据之前要附加的代理头类型。

返回：成功

requestPath

字符串

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

默认值为 /。

返回：成功

response

字符串

与响应数据开头匹配的字节。如果留空（默认值），任何响应都表示健康。响应数据只能是 ASCII。

返回：成功

httpHealthCheck

复杂

嵌套对象资源。

返回：成功

host

字符串

HTTP 健康检查请求中 host 头的值。

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

返回：成功

port

整数

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

默认值为 80。

返回：成功

portName

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

返回：成功

portSpecification

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：使用 `port` 中的端口号进行健康检查。

* `USE_NAMED_PORT`：使用 `portName` 进行健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，使用为每个网络端点指定的端口进行健康检查。对于其他后端，使用后端服务中指定的端口或命名端口进行健康检查。

如果未指定，HTTP 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

返回：成功

proxyHeader

字符串

指定在向后端发送数据之前要附加的代理头类型。

返回：成功

requestPath

字符串

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

默认值为 /。

返回：成功

response

字符串

与响应数据开头匹配的字节。如果留空（默认值），任何响应都表示健康。响应数据只能是 ASCII。

返回：成功

httpsHealthCheck

复杂

嵌套对象资源。

返回：成功

host

字符串

HTTPS 健康检查请求中 host 头的值。

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

返回：成功

port

整数

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

默认值为 443。

返回：成功

portName

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

返回：成功

portSpecification

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：使用 `port` 中的端口号进行健康检查。

* `USE_NAMED_PORT`：使用 `portName` 进行健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，使用为每个网络端点指定的端口进行健康检查。对于其他后端，使用后端服务中指定的端口或命名端口进行健康检查。

如果未指定，HTTPS 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

返回：成功

proxyHeader

字符串

指定在向后端发送数据之前要附加的代理头类型。

返回：成功

requestPath

字符串

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

默认值为 /。

返回：成功

response

字符串

与响应数据开头匹配的字节。如果留空（默认值），任何响应都表示健康。响应数据只能是 ASCII。

返回：成功

id

整数

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

返回：成功

logConfig

复杂

配置此健康检查的日志记录。

返回：成功

enable

布尔值

指示是否导出日志。默认值为 false，这意味着不会进行任何健康检查日志记录。

返回：成功

name

字符串

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

返回：成功

sslHealthCheck

复杂

嵌套对象资源。

返回：成功

port

整数

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

默认值为 443。

返回：成功

portName

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

返回：成功

portSpecification

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：使用 `port` 中的端口号进行健康检查。

* `USE_NAMED_PORT`：使用 `portName` 进行健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，使用为每个网络端点指定的端口进行健康检查。对于其他后端，使用后端服务中指定的端口或命名端口进行健康检查。

如果未指定，SSL 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

返回：成功

proxyHeader

字符串

指定在向后端发送数据之前要附加的代理头类型。

返回：成功

request

字符串

建立 SSL 连接后要发送的应用程序数据（默认值为空）。如果 request 和 response 都为空，则仅建立连接就表示健康。请求数据只能是 ASCII。

返回：成功

response

字符串

与响应数据开头匹配的字节。如果留空（默认值），任何响应都表示健康。响应数据只能是 ASCII。

返回：成功

tcpHealthCheck

复杂

嵌套对象资源。

返回：成功

port

整数

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

默认值为 443。

返回：成功

portName

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

返回：成功

portSpecification

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：使用 `port` 中的端口号进行健康检查。

* `USE_NAMED_PORT`：使用 `portName` 进行健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，使用为每个网络端点指定的端口进行健康检查。对于其他后端，使用后端服务中指定的端口或命名端口进行健康检查。

如果未指定，TCP 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

返回：成功

proxyHeader

字符串

指定在向后端发送数据之前要附加的代理头类型。

返回：成功

request

字符串

建立 TCP 连接后要发送的应用程序数据（默认值为空）。如果 request 和 response 都为空，则仅建立连接就表示健康。请求数据只能是 ASCII。

返回：成功

response

字符串

与响应数据开头匹配的字节。如果留空（默认值），任何响应都表示健康。响应数据只能是 ASCII。

返回：成功

timeoutSec

整数

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

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

返回：成功

type

字符串

指定 healthCheck 的类型，可以是 TCP、SSL、HTTP 或 HTTPS。如果未指定，则默认为 TCP。必须指定一个协议特定的健康检查字段，并且必须与 type 字段匹配。

返回：成功

unhealthyThreshold

整数

在此数量的连续失败后，先前健康的实例将被标记为不健康。默认值为 2。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)