community.general.gcp_healthcheck – Создание, обновление или удаление проверки состояния.
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в книге задач, укажите: community.general.gcp_healthcheck.
УСТАРЕЛО
- Удалено в
-
версии 2.0.0
- Почему
-
Обновленные модули выпущены с повышенной функциональностью
- Альтернатива
-
Используйте google.cloud.gcp_compute_health_check, google.cloud.gcp_compute_http_health_check или google.cloud.gcp_compute_https_health_check вместо этого.
Описание
- Создание, обновление или удаление проверки состояния. В настоящее время поддерживаются только проверки состояния HTTP и HTTPS. Проверки состояния используются для мониторинга отдельных экземпляров, управляемых групп экземпляров и/или служб обратного канала. Проверки состояния являются многоразовыми.
- Посетите https://cloud.google.com/compute/docs/load-balancing/health-checks для обзора проверок состояния на GCP.
- См. https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks для получения сведений об API проверок состояния HTTP.
- См. 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 строка | Значение по умолчанию: "" | Значение заголовка хоста в запросе проверки состояния. Если оставлено пустым, будет использован общедоступный IP-адрес, от имени которого выполняется эта проверка состояния. |
| port целое число | Номер TCP-порта для запроса проверки состояния. Значение по умолчанию — 443 для HTTPS и 80 для HTTP. | |
| project_id строка | Ваш идентификатор проекта GCP | |
| request_path строка | Значение по умолчанию: "/" | Путь запроса для запроса проверки состояния HTTPS. |
| service_account_email строка | Электронный адрес учетной записи сервиса | |
| service_account_permissions список / элементы=строка | Разрешения учетной записи сервиса (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для получения подробной информации) Доступные варианты: bigquery, cloud-platform, compute-ro, compute-rw, useraccounts-ro, useraccounts-rw, datastore, logging-write, monitoring, sql-admin, storage-full, storage-ro, storage-rw, taskqueue, userinfo-email. | |
| state строка |
| Состояние проверки состояния. |
| timeout целое число | Значение по умолчанию: 5 | Сколько времени (в секундах) ждать ответа перед объявлением о сбое. Неверно, если значение таймаута больше, чем интервал проверки. |
| unhealthy_threshold целое число | Значение по умолчанию: 2 | Устойчивый экземпляр будет помечен как неустойчивый после этого количества последовательных сбоев. |
Примечания
Примечание
- В настоящее время поддерживаются только проверки состояния HTTP и HTTPS.
Примеры
- name: Create Minimum HealthCheck
community.general.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
community.general.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
community.general.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.0.0. [устарел]
- Для получения дополнительной информации см. УСТАРЕЛО.
Авторы
- 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.10/collections/community/general/gcp_healthcheck_module.html