gcp_healthcheck – Создание, обновление или удаление проверки состояния
Новое в версии 2.4.
УСТЕРЕШЕНО
| Удалён в Ansible: | |
|---|---|
| версия: 2.12 | |
| Почему: | Обновлённые модули выпущены с повышенной функциональностью |
| Альтернатива: | Используйте gcp_compute_health_check, gcp_compute_http_health_check или gcp_compute_https_health_check вместо этого. |
Описание
- Создать, обновить или удалить проверку состояния. В настоящее время поддерживаются только проверки состояния HTTP и HTTPS. Проверки состояния используются для мониторинга отдельных экземпляров, управляемых групп экземпляров и/или служб обратного канала. Проверки состояния являются многоразовыми.
- Для обзора проверок состояния в GCP посетите https://cloud.google.com/compute/docs/load-balancing/health-checks.
- Для получения API-сведений о проверках состояния HTTP см. https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks.
- См. https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks для получения более подробной информации об API проверки состояния HTTPS.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- google-api-python-client >= 1.6.2
- google-auth >= 0.9.0
- google-auth-httplib2 >= 0.0.2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| check_interval - | Значение по умолчанию: 5 | Частота (в секундах) отправки проверки состояния. |
| credentials_file - | Путь к JSON-файлу, связанному с электронной почтой учетной записи службы | |
| healthcheck_name - / обязательно | Имя проверки состояния. | |
| healthcheck_type - / обязательно |
| Тип проверки состояния. |
| healthy_threshold - | Значение по умолчанию: 2 | Неуспешный экземпляр будет помечен как успешный после этого количества последовательных успехов. |
| host_header - / обязательно | Значение по умолчанию: "" | Значение заголовка host в запросе проверки состояния. Если оставлено пустым, будет использован общедоступный IP-адрес, от имени которого выполняется эта проверка состояния. |
| port - | Номер TCP-порта для запроса проверки состояния. Значение по умолчанию 443 для HTTPS и 80 для HTTP. | |
| project_id - | Ваш идентификатор проекта GCP | |
| request_path - | Значение по умолчанию: "/" | Путь запроса для проверки состояния HTTPS. |
| service_account_email - | Электронная почта учетной записи службы | |
| service_account_permissions - добавлено в 2.0 |
| Разрешения учетной записи службы (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для получения подробной информации) |
| state - / обязательно |
| Состояние проверки состояния. |
| timeout - | Значение по умолчанию: 5 | Время ожидания ответа (в секундах), прежде чем считать это ошибкой. Недопустимо, чтобы время ожидания было больше, чем интервал проверки. |
| unhealthy_threshold - | Значение по умолчанию: 2 | Успешный экземпляр будет помечен как неуспешный после этого количества последовательных неудач. |
Примечания
Примечание
- В настоящее время поддерживаются только проверки состояния HTTP и HTTPS.
Примеры
- name: Create Minimum HealthCheck
gcp_healthcheck:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
healthcheck_name: my-healthcheck
healthcheck_type: HTTP
state: present
- name: Create HTTP HealthCheck
gcp_healthcheck:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
healthcheck_name: my-healthcheck
healthcheck_type: HTTP
host: my-host
request_path: /hc
check_interval: 10
timeout: 30
unhealthy_threshhold: 2
healthy_threshhold: 1
state: present
- name: Create HTTPS HealthCheck
gcp_healthcheck:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
healthcheck_name: "{{ https_healthcheck }}"
healthcheck_type: HTTPS
host_header: my-host
request_path: /hc
check_interval: 5
timeout: 5
unhealthy_threshold: 2
healthy_threshold: 1
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| healthcheck словарь | Всегда. Обратитесь к документации GCP для получения подробных описаний полей. | Словарь проверки состояния GCP Пример: {'name': 'my-hc', 'port': 443, 'requestPath': '/foo'} |
| healthcheck_name строка | Всегда | Имя проверки состояния Пример: my-url-map |
| healthcheck_type строка | Всегда | Тип проверки состояния Пример: HTTP |
| state строка | Всегда. | Состояние проверки состояния Пример: present |
Статус
- Этот модуль будет удалён в версии 2.12. [устаревший]
- Для получения дополнительной информации см. УСТЕРЕШЕНО.
Авторы
- Tom Melendez (@supertom) <tom@supertom.com>
Подсказка
Если вы заметите какие-либо проблемы в данной документации, вы можете изменить этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_healthcheck_module.html