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 | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| healthy_threshold | После этого количества последовательных успешных проверок нездоровый экземпляр будет помечен как здоровый. Значение по умолчанию — 2. | |
| host | Значение заголовка 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_email | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. | |
| state обязательно |
| Требуется ли существование данного объекта в GCP |
| timeout_sec | Время ожидания (в секундах), прежде чем признать ошибку. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше, чем checkIntervalSec. псевдонимы: timeout_seconds | |
| unhealthy_threshold | После этого количества последовательных ошибок здоровый экземпляр будет помечен как нездоровый. Значение по умолчанию — 2. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить 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: testObject
healthy_threshold: 10
port: 8080
timeout_sec: 2
unhealthy_threshold: 5
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| check_interval_sec int | success | Периодичность проверки работоспособности (в секундах). Значение по умолчанию — 5 секунд. |
| creation_timestamp str | success | Дата и время создания в формате RFC3339. |
| description str | success | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. |
| healthy_threshold int | success | После этого количества последовательных успешных проверок нездоровый экземпляр будет помечен как здоровый. Значение по умолчанию — 2. |
| host str | success | Значение заголовка host в запросе проверки работоспособности по HTTPS. Если оставить пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется проверка работоспособности. |
| id int | success | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. |
| name str | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. |
| port int | success | Номер TCP-порта для запроса проверки работоспособности по HTTPS. Значение по умолчанию — 80. |
| request_path str | success | Путь запроса для проверки работоспособности по HTTPS. Значение по умолчанию — /. |
| timeout_sec int | success | Время ожидания (в секундах), прежде чем признать ошибку. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше, чем checkIntervalSec. |
| unhealthy_threshold int | success | После этого количества последовательных ошибок здоровый экземпляр будет помечен как нездоровый. Значение по умолчанию — 2. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробная информация об обслуживании модулей см. в разделе Техническое обслуживание модулей и поддержка.
Список других модулей, поддерживаемых сообществом 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.6/modules/gcp_compute_https_health_check_module.html
