openstack.cloud.lb_health_monitor – Добавить/удалить монитор состояния к пулу в службе балансировки нагрузки из OpenStack Cloud

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в книге задач, укажите: openstack.cloud.lb_health_monitor.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Добавление или удаление монитора состояния к/из пула в службе балансировки нагрузки OpenStack.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state_up boolean	Варианты: no yes ←	Состояние администратора монитора состояния, true для включенного, false для выключенного.
api_timeout integer		Сколько времени (в секундах) уровень сокета должен ожидать перед таймаутом вызовов API. Если это опущено, в библиотеку requests ничего не будет передано.
auth dictionary		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, это будет содержать auth_url, username, password, project_name и любую информацию о домене (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type string		Имя плагина авторизации для использования. Если облако использует что-то другое, помимо аутентификации по паролю, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone string		Игнорируется. Существует для обратной совместимости.
ca_cert string		Путь к пакету CA-сертификата, который может быть использован для проверки SSL-запросов API. псевдонимы: cacert
client_cert string		Путь к клиенту сертификату для использования в рамках SSL-транзакции. псевдонимы: cert
client_key string		Путь к ключу клиента для использования в рамках SSL-транзакции. псевдонимы: key
cloud raw		Имя облака или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
delay string / required		Интервал (в секундах) между проверками состояния.
expected_codes string	Значение по умолчанию: 200	Список HTTP-кодов состояния, ожидаемых в ответе от члена, чтобы объявить его здоровым. Укажите одно из следующих значений: Одно значение, например 200 Список, например 200, 202 Диапазон, например 200-204
http_method string	Варианты: GET ← CONNECT DELETE HEAD OPTIONS PATCH POST PUT TRACE	HTTP-метод, используемый монитором состояния для запросов. Один из CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT или TRACE. По умолчанию используется GET.
interface string	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога услуг. псевдонимы: endpoint_type
max_retries string / required		Количество успешных проверок перед изменением оперативного статуса члена на ONLINE.
max_retries_down string	Значение по умолчанию: 3	Количество разрешенных сбоев проверок перед изменением оперативного статуса члена на ERROR. Допустимое значение от 1 до 10. По умолчанию 3.
name string / required		Имя, которое должно быть задано монитору состояния.
pool string / required		Имя или идентификатор пула, отслеживаемого монитором состояния.
region_name string		Имя региона.
resp_timeout integer / required		Время (в секундах) после которого проверка состояния таймаутится. Должно быть меньше, чем delay.
state string	Варианты: present ← absent	Ресурс должен быть present или absent.
timeout integer	Значение по умолчанию: 180	Сколько времени Ansible должен ждать запрошенного ресурса.
type string	Варианты: HTTP ← HTTPS PING SCTP TCP TLS-HELLO UDP-CONNECT	Одно из HTTP, HTTPS, PING, SCTP, TCP, TLS-HELLO или UDP-CONNECT.
url_path string	Значение по умолчанию: "/"	HTTP-путь URL-адреса запроса, отправляемого монитором для проверки состояния члена бэкенда. Должно быть строкой, начинающейся с косой черты (/). Путь URL-адреса по умолчанию — /.
validate_certs boolean	Варианты: no ← yes	Должны ли SSL-запросы API проверяться. До Ansible 2.3, это было установлено по умолчанию как `yes`. псевдонимы: verify
wait boolean	Варианты: no yes ←	Должен ли Ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

Стандартные переменные среды OpenStack, такие как OS_USERNAME, могут быть использованы вместо явного указания значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем из явных параметров в задачах. Дополнительную информацию можно найти на https://docs.openstack.org/openstacksdk/

Примеры

#Create a healtmonitor named healthmonitor01 with method HEAD url_path /status and expect code 200
- openstack.cloud.lb_health_monitor:
    auth:
      auth_url: "{{keystone_url}}"
      username: "{{username}}"
      password: "{{password}}"
      project_domain_name: "{{domain_name}}"
      user_domain_name: "{{domain_name}}"
      project_name: "{{project_name}}"
    wait: true
    admin_state_up: True
    expected_codes: '200'
    max_retries_down: '4'
    http_method: GET
    url_path: "/status"
    pool: '{{pool_id}}'
    name: 'healthmonitor01'
    delay: '10'
    max_retries: '3'
    resp_timeout: '5'
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:

Ключ		Возвращаемое значение	Описание
health_monitor сложный		При успехе, когда `state=present`	Словарь, описывающий монитор состояния.
	admin_state_up булево	При успехе, когда `state=present`	Административное состояние ресурса.
	created_at строка	При успехе, когда `state=present`	UTC дата и время создания ресурса.
	delay целое число	При успехе, когда `state=present`	Время в секундах между отправкой зондов членам.
	expected_codes строка	При успехе, когда `state=present`	Список ожидаемых HTTP-кодов состояния в ответе от члена, подтверждающих его работоспособность.
	http_method строка	При успехе, когда `state=present`	HTTP-метод, используемый монитором состояния для запросов.
	id строка	При успехе, когда `state=present`	UUID монитора состояния.
	max_retries строка	При успехе, когда `state=present`	Количество успешных проверок перед изменением оперативного состояния члена на ONLINE.
	max_retries_down строка	При успехе, когда `state=present`	Количество разрешённых сбоев проверок перед изменением оперативного состояния члена на ERROR.
	name строка	При успехе, когда `state=present`	Имя ресурса, понятное человеку.
	operating_status строка	При успехе, когда `state=present`	Оперативное состояние ресурса.
	pool_id строка	При успехе, когда `state=present`	Идентификатор пула.
	project_id строка	При успехе, когда `state=present`	Идентификатор проекта, владеющего этим ресурсом.
	provisioning_status строка	При успехе, когда `state=present`	Статус подготовки ресурса.
	timeout целое число	При успехе, когда `state=present`	Максимальное время в секундах, которое монитор ожидает подключения перед истечением времени ожидания.
	type строка	При успехе, когда `state=present`	Тип монитора состояния.
	updated_at строка	При успехе, когда `state=present`	UTC дата и время последнего обновления ресурса.
	url_path строка	При успехе, когда `state=present`	HTTP URL путь запроса, отправляемого монитором для проверки работоспособности члена бэкенда.

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/openstack/cloud/lb_health_monitor_module.html