openstack.cloud.lb_health_monitor модуль — Управление монитором состояния в пуле балансировщиков OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Чтобы использовать его в плейбуке, укажите: openstack.cloud.lb_health_monitor.
Описание
- Добавление, обновление или удаление монитора состояния из пула балансировщиков в облаке OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Как долго сокетный уровень должен ждать перед истечением времени ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов. |
auth dictionary | Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, которые требуются этому плагину аутентификации. Этот параметр не требуется, если предоставлено имя облака или присутствуют переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует что-то отличное от парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом. |
ca_cert aliases: cacert string | Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API. |
client_cert aliases: cert string | Путь к клиентскому сертификату, используемому в качестве части транзакции SSL. |
client_key aliases: key string | Путь к клиентскому ключу, используемому в качестве части транзакции SSL. |
cloud any | Именованное облако или конфигурация облака, с которым нужно работать. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или если присутствуют переменные среды OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml. |
delay integer | Интервал, в секундах, между проверками работоспособности. Требуется, когда state равен |
expected_codes string | Список кодов состояния HTTP, ожидаемых в ответе от участника, чтобы объявить его работоспособным. Укажите одно из следующих значений. Например, expected_codes может быть одним значением, таким как Значение expected_codes по умолчанию в Octavia — |
health_monitor_timeout aliases: resp_timeout integer | Время, в секундах, по истечении которого проверка работоспособности завершается по таймауту. Должно быть меньше, чем delay. Требуется, когда state равен |
http_method string | Метод HTTP, который монитор работоспособности использует для запросов. Например, http_method может быть Значение http_method по умолчанию в Octavia — |
interface aliases: endpoint_type string | Тип URL-адреса конечной точки для получения из каталога служб. Варианты:
|
is_admin_state_up aliases: admin_state_up boolean | Включен или выключен монитор работоспособности. Варианты:
|
max_retries integer | Количество успешных проверок перед изменением операционного состояния участника на ONLINE. Требуется, когда state равен |
max_retries_down integer | Количество допустимых сбоев проверки перед изменением операционного состояния участника на ERROR. Допустимое значение от 1 до 10. |
name string / required | Имя, которое должно быть присвоено монитору работоспособности. Этот атрибут не может быть обновлен. |
pool string | Имя или идентификатор пула, который должен контролироваться монитором работоспособности. Требуется, когда state равен Этот атрибут не может быть обновлен. |
region_name string | Имя региона. |
sdk_log_level string | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записываться |
state string | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout integer | Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: |
type string | Тип монитора работоспособности. Например, type может быть Это свойство не может быть обновлено. По умолчанию: |
url_path string | Путь к HTTP URL запроса, отправляемого монитором для проверки состояния члена бэкенда. Должен быть строкой, начинающейся с прямой косой черты ( По умолчанию в Octavia используется путь |
validate_certs aliases: verify boolean | Нужно ли проверять запросы API SSL. До Ansible 2.3 это значение по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ждать, пока запрошенный ресурс завершит работу. Варианты:
|
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации определяется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Create a load-balancer health monitor
openstack.cloud.lb_health_monitor:
cloud: devstack
delay: 10
expected_codes: '200'
health_monitor_timeout: 5
http_method: GET
is_admin_state_up: true
max_retries: 3
max_retries_down: 4
name: healthmonitor01
pool: lb_pool
state: present
url_path: '/status'
- name: Delete a load-balancer health monitor
openstack.cloud.lb_health_monitor:
cloud: devstack
name: healthmonitor01
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
health_monitor dictionary | Словарь, описывающий монитор работоспособности балансировщика нагрузки. Возвращается: При успехе, когда state равен |
|
created_at string |
Дата и время в UTC, когда ресурс был создан. Возвращается: успех |
|
delay integer |
Время в секундах между отправкой зондов участникам. Возвращается: успех |
|
expected_codes string |
Список кодов состояния HTTP, ожидаемых в ответе от участника, чтобы объявить его работоспособным. Возвращается: успех |
|
http_method string |
Метод HTTP, который монитор работоспособности использует для запросов. Возвращается: успех |
|
id string |
UUID монитора работоспособности. Возвращается: успех |
|
is_admin_state_up boolean |
Административное состояние ресурса. Возвращается: успех |
|
max_retries integer |
Количество успешных проверок перед изменением операционного статуса участника на ONLINE. Возвращается: успех |
|
max_retries_down integer |
Количество допустимых сбоев проверки перед изменением операционного статуса участника на ERROR. Возвращается: успех |
|
name string |
Чёткие имя ресурса. Возвращается: успех |
|
operating_status string |
Операционный статус ресурса. Возвращается: успех |
|
pool_id string |
Идентификатор пула. Возвращается: успех |
|
pools list / elements=string |
Список идентификаторов связанных пулов. Возвращается: успех |
|
project_id string |
Идентификатор проекта, которому принадлежит этот ресурс. Возвращается: успех |
|
provisioning_status string |
Статус подготовки ресурса. Возвращается: успех |
|
tags list / elements=string |
Список связанных тегов. Возвращается: успех |
|
timeout integer |
Максимальное время в секундах, которое монитор ожидает подключения, прежде чем истечет время ожидания. Возвращается: успех |
|
type string |
Тип монитора работоспособности. Возвращается: успех |
|
updated_at string |
Дата и время в UTC, когда ресурс был последний раз обновлен. Возвращается: успех |
|
url_path string |
Путь HTTP URL запроса, отправленного монитором для проверки работоспособности участника бэкенда. Возвращается: успех |
Сводка ссылок на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/lb_health_monitor_module.html