Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_https_health_check — создание HttpsHealthCheck в GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_https_health_check.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Ресурс HttpsHealthCheck. Этот ресурс задаёт шаблон проверки работоспособности отдельных виртуальных машин по HTTPS.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если в качестве типа учётных данных указано accesstoken.

auth_kind

string / обязательный

Тип используемых учётных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

check_interval_sec

integer

Частота отправки проверок работоспособности (в секундах). Значение по умолчанию — 5 секунд.

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Это значение изменяет только строку User Agent для запросов API.

healthy_threshold

integer

Ранее неработающий экземпляр будет помечен как работоспособный после указанного количества последовательных успешных проверок. Значение по умолчанию — 2.

host

string

Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставить поле пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.

name

string / обязательный

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, то есть начинаться со строчной буквы; все последующие символы должны быть дефисами, строчными буквами или цифрами, а последний символ не может быть дефисом.

port

integer

Номер TCP-порта для запроса проверки работоспособности HTTPS.

Значение по умолчанию — 443.

project

string

Проект Google Cloud Platform, который следует использовать.

request_path

string

Путь запроса проверки работоспособности HTTPS.

Значение по умолчанию — /.

scopes

list / элементы=string

Массив областей доступа для использования

service_account_contents

jsonarg

Содержимое JSON-файла учётной записи службы — в виде словаря или JSON-строки, представляющей его.

service_account_email

string

Необязательный адрес электронной почты учётной записи службы, если выбрано значение machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

path

Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount.

state

string

Должен ли указанный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout_sec

псевдонимы: timeout_seconds

integer

Время ожидания (в секундах) до фиксации ошибки.

Значение по умолчанию — 5 секунд. Значение timeoutSec не должно превышать checkIntervalSec.

unhealthy_threshold

integer

Ранее работоспособный экземпляр будет помечен как неработоспособный после указанного количества последовательных сбоев. Значение по умолчанию — 2.

Примечания

Примечание

  • Справочник API: https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks
  • Добавление проверок работоспособности: https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks
  • Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
  • Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
  • Параметры 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

integer

Частота отправки проверок работоспособности (в секундах). Значение по умолчанию — 5 секунд.

Возвращается: при успехе

creationTimestamp

string

Временная метка создания в текстовом формате RFC3339.

Возвращается: при успехе

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

Возвращается: при успехе

healthyThreshold

integer

Ранее неработающий экземпляр будет помечен как работоспособный после указанного количества последовательных успешных проверок. Значение по умолчанию — 2.

Возвращается: при успехе

host

string

Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставить поле пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.

Возвращается: при успехе

id

integer

Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером.

Возвращается: при успехе

name

string

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, то есть начинаться со строчной буквы; все последующие символы должны быть дефисами, строчными буквами или цифрами, а последний символ не может быть дефисом.

Возвращается: при успехе

port

integer

Номер TCP-порта для запроса проверки работоспособности HTTPS.

Значение по умолчанию — 443.

Возвращается: при успехе

requestPath

string

Путь запроса проверки работоспособности HTTPS.

Значение по умолчанию — /.

Возвращается: при успехе

timeoutSec

integer

Время ожидания (в секундах) до фиксации ошибки.

Значение по умолчанию — 5 секунд. Значение timeoutSec не должно превышать checkIntervalSec.

Возвращается: при успехе

unhealthyThreshold

integer

Ранее работоспособный экземпляр будет помечен как неработоспособный после указанного количества последовательных сбоев. Значение по умолчанию — 2.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_https_health_check_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API