Spec-Zone.ru › Ansible 2.6

gcp_compute_health_check - Создаёт GCP HealthCheck

Новое в версии 2.6.

  • Описание
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Описание

  • Ресурс HealthCheck. Этот ресурс определяет шаблон проверки работоспособности отдельных виртуальных машин с помощью одного из поддерживаемых протоколов.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
обязательно
    Варианты:
  • machineaccount
  • serviceaccount
  • application
Тип используемых учетных данных.
check_interval_sec Значение по умолчанию:
5
Периодичность проверки состояния (в секундах). Значение по умолчанию — 5 секунд.
description
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
healthy_threshold
Нездоровый экземпляр будет помечен как здоровый после такого количества последовательных успехов. Значение по умолчанию — 2.
http_health_check
Вложенный ресурс-объект.
host
Значение заголовка host в запросе проверки состояния HTTP.
Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется эта проверка состояния.
request_path
Путь запроса проверки состояния HTTP.
Значение по умолчанию — /.
port
Номер TCP-порта для запроса проверки состояния HTTP.
Значение по умолчанию — 80.
port_name
Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и порт, и имя порта, приоритет имеет порт.
proxy_header
    Варианты:
  • NONE
  • PROXY_V1
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд: NONE или PROXY_V1. По умолчанию — NONE.
https_health_check
Вложенный ресурс-объект.
host
Значение заголовка host в запросе проверки состояния HTTPS.
Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется эта проверка состояния.
request_path
Путь запроса проверки состояния HTTPS.
Значение по умолчанию — /.
port
Номер TCP-порта для запроса проверки состояния HTTPS.
Значение по умолчанию — 443.
port_name
Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и порт, и имя порта, приоритет имеет порт.
proxy_header
    Варианты:
  • NONE
  • PROXY_V1
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд: NONE или PROXY_V1. По умолчанию — NONE.
name
Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project
Используемый проект Google Cloud Platform.
scopes
обязательно
Массив используемых областей.
service_account_email
Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file
Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount.
ssl_health_check
Вложенный ресурс-объект.
request
Данные приложения, которые необходимо отправить после установления SSL-соединения (значение по умолчанию — пустое). Если и request, и response пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
response
Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки состояния SSL.
Значение по умолчанию — 443.
port_name
Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и порт, и имя порта, приоритет имеет порт.
proxy_header
    Варианты:
  • NONE
  • PROXY_V1
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд: NONE или PROXY_V1. По умолчанию — NONE.
state
обязательно
    Варианты:
  • present ←
  • absent
Нужно ли данному объекту существовать в GCP
tcp_health_check
Вложенный ресурс-объект.
request
Данные приложения, которые необходимо отправить после установления TCP-соединения (значение по умолчанию — пустое). Если и request, и response пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
response
Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки состояния TCP.
Значение по умолчанию — 443.
port_name
Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и порт, и имя порта, приоритет имеет порт.
proxy_header
    Варианты:
  • NONE
  • PROXY_V1
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд: NONE или PROXY_V1. По умолчанию — NONE.
timeout_sec Значение по умолчанию:
5
Время ожидания (в секундах) до объявления ошибки.
Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше, чем checkIntervalSec.

алиасы: timeout_seconds
type
    Варианты:
  • TCP
  • SSL
  • HTTP
Указывает тип проверки состояния: TCP, SSL, HTTP или HTTPS. Если не указано, по умолчанию — TCP. Должен быть указан ровно один параметр проверки состояния протокола, который должен соответствовать полю type.
unhealthy_threshold Значение по умолчанию:
2
Здоровый экземпляр будет помечен как нездоровый после такого количества последовательных сбоев. Значение по умолчанию — 2.

Примечания

Примечание

  • Для аутентификации можно установить 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 health check
  gcp_compute_health_check:
      name: testObject
      type: TCP
      tcp_health_check:
        port_name: service-health
        request: ping
        response: pong
      healthy_threshold: 10
      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.
http_health_check
complex
 success
Вложенный ресурс объекта.
host
str
 success
Значение заголовка host в запросе проверки работоспособности HTTP.
Если оставлено пустым (значение по умолчанию), будет использоваться публичный IP-адрес, от имени которого выполняется эта проверка работоспособности.
request_path
str
 success
Путь запроса для проверки работоспособности HTTP.
Значение по умолчанию — /.
port
int
 success
Номер TCP-порта для запроса проверки работоспособности HTTP.
Значение по умолчанию — 80.
port_name
str
 success
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт.
proxy_header
str
 success
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE.
https_health_check
complex
 success
Вложенный ресурс объекта.
host
str
 success
Значение заголовка host в запросе проверки работоспособности HTTPS.
Если оставлено пустым (значение по умолчанию), будет использоваться публичный IP-адрес, от имени которого выполняется эта проверка работоспособности.
request_path
str
 success
Путь запроса для проверки работоспособности HTTPS.
Значение по умолчанию — /.
port
int
 success
Номер TCP-порта для запроса проверки работоспособности HTTPS.
Значение по умолчанию — 443.
port_name
str
 success
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт.
proxy_header
str
 success
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE.
id
int
 success
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
name
str
 success
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
ssl_health_check
complex
 success
Вложенный ресурс объекта.
request
str
 success
Данные приложения для отправки после установления SSL-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
response
str
 success
Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
port
int
 success
Номер TCP-порта для запроса проверки работоспособности SSL.
Значение по умолчанию — 443.
port_name
str
 success
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт.
proxy_header
str
 success
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE.
tcp_health_check
complex
 success
Вложенный ресурс объекта.
request
str
 success
Данные приложения для отправки после установления TCP-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
response
str
 success
Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
port
int
 success
Номер TCP-порта для запроса проверки работоспособности TCP.
Значение по умолчанию — 443.
port_name
str
 success
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт.
proxy_header
str
 success
Указывает тип заголовка прокси, добавляемого перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE.
timeout_sec
int
 success
Сколько времени (в секундах) ждать перед заявлением об ошибке.
Значение по умолчанию — 5 секунд. Недопустимо, чтобы значение timeoutSec было больше, чем checkIntervalSec.
type
str
 success
Указывает тип проверки работоспособности, TCP, SSL, HTTP или HTTPS. Если не указано, по умолчанию — TCP. Должен быть указан ровно один из полей проверки работоспособности, специфичных для протокола, который должен соответствовать полю type.
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_health_check_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API