gcp_compute_http_health_check – Создаёт GCP HttpHealthCheck
Новое в версии 2.6.
Описание
- Ресурс HttpHealthCheck. Этот ресурс определяет шаблон, как отдельные виртуальные машины должны проверяться на работоспособность через HTTP.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| check_interval_sec - | Значение по умолчанию: 5 | Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд. псевдонимы: check_interval_seconds |
| description - | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| healthy_threshold - | Недоступный до сих пор экземпляр будет помечен как доступный после этого количества последовательных успехов. Значение по умолчанию — 2. | |
| host - | Значение заголовка host в запросе HTTP проверки работоспособности. Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. | |
| name - / обязательно | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| port - | Номер TCP-порта для запроса HTTP проверки работоспособности. Значение по умолчанию — 80. | |
| project - | Значение по умолчанию: null | Проект Google Cloud Platform, который следует использовать. |
| request_path - | Путь запроса HTTP проверки работоспособности. Значение по умолчанию — /. | |
| scopes - | Массив используемых областей. | |
| 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/latest/httpHealthChecks
- Добавление проверок работоспособности: https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключают друг друга.
Примеры
- name: create a http health check
gcp_compute_http_health_check:
name: "test_object"
healthy_threshold: 10
port: 8080
timeout_sec: 2
unhealthy_threshold: 5
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| check_interval_sec целое число | успех | Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд. |
| creation_timestamp строка | успех | Дата и время создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. |
| healthy_threshold целое число | успех | Недоступный до сих пор экземпляр будет помечен как доступный после этого количества последовательных успехов. Значение по умолчанию — 2. |
| host строка | успех | Значение заголовка host в запросе HTTP проверки работоспособности. Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. |
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определен сервером. |
| name строка | успех | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
| port целое число | успех | Номер TCP-порта для запроса HTTP проверки работоспособности. Значение по умолчанию — 80. |
| request_path строка | успех | Путь запроса HTTP проверки работоспособности. Значение по умолчанию — /. |
| timeout_sec целое число | успех | Сколько времени (в секундах) ожидать, прежде чем считать ошибку. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec имел большее значение, чем checkIntervalSec. |
| unhealthy_threshold целое число | успех | Доступный до сих пор экземпляр будет помечен как недоступный после этого количества последовательных ошибок. Значение по умолчанию — 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.7/modules/gcp_compute_http_health_check_module.html
