gcp_compute_https_health_check – Создаёт GCP HttpsHealthCheck
Новая в версии 2.6.
Описание
- Ресурс HttpsHealthCheck. Этот ресурс определяет шаблон, по которому должны проверяться отдельные виртуальные машины на работоспособность через HTTPS.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| check_interval_sec целое число | Частота проверки работоспособности (в секундах). Значение по умолчанию — 5 секунд. | |
| description строка | Необязательное описание ресурса. Укажите это свойство при создании ресурса. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| healthy_threshold целое число | После этого количества последовательных успешных проверок нездоровый экземпляр будет помечен как здоровый. Значение по умолчанию — 2. | |
| host строка | Значение заголовка хоста в запросе проверки работоспособности HTTPS. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется проверка работоспособности. | |
| name строка / обязательно | Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна составлять от 1 до 63 символов, и она должна соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| port целое число | Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 80. | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| request_path строка | Путь запроса проверки работоспособности HTTPS. Значение по умолчанию — /. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |
| state строка |
| Вы должны ли создавать объект в GCP |
| timeout_sec целое число | Сколько времени (в секундах) ждать, прежде чем объявить о неудаче. Значение по умолчанию — 5 секунд. Недействительно, если значение timeoutSec больше, чем checkIntervalSec. Псевдонимы: timeout_seconds | |
| 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
- для аутентификации можно установить service_account_file используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| checkIntervalSec целое число | успех | Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд. |
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. |
| healthyThreshold целое число | успех | Состояние неработающего экземпляра будет изменено на работающий после этого количества последовательных успехов. Значение по умолчанию — 2. |
| host строка | успех | Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется эта проверка работоспособности. |
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. |
| port целое число | успех | Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 80. |
| requestPath строка | успех | Путь запроса для проверки работоспособности HTTPS. Значение по умолчанию — /. |
| timeoutSec целое число | успех | Время ожидания (в секундах) до объявления ошибки. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше checkIntervalSec. |
| unhealthyThreshold целое число | успех | Состояние работающего экземпляра будет изменено на неработающий после этого количества последовательных неудач. Значение по умолчанию — 2. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_https_health_check_module.html
