openstack.cloud.lb_pool модуль — Управление пулом балансировщиков нагрузки в облаке OpenStack.
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные условия. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: openstack.cloud.lb_pool.
Описание
- Добавление, обновление или удаление пула балансировщиков нагрузки из облака OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Сколько времени должна ожидать сокет-слой, прежде чем произойдёт таймаут для API-запросов. Если этот параметр опущен, ничего не будет передано в библиотеку requests. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые данному подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. |
auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то другое, кроме аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответственно. |
ca_cert псевдонимы: cacert строка | Путь к пакету сертификата CA, который может быть использован для проверки SSL API-запросов. |
client_cert псевдонимы: cert строка | Путь к клиенту сертификата, который будет использован в SSL-транзакции. |
client_key псевдонимы: key строка | Путь к ключу клиента, который будет использован в SSL-транзакции. |
cloud любой | Именованное облако или конфигурация облака для работы. Если cloud – строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud – словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml. |
description строка | Человекопонятное описание пула балансировщиков нагрузки. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки для извлечения из каталога сервиса. Варианты:
|
lb_algorithm строка | Алгоритм балансировки нагрузки для пула. Например, lb_algorithm может быть По умолчанию: |
listener строка | Имя или идентификатор слушателя, к которому принадлежит этот пул. Для создания пула необходимо указать либо listener, либо loadbalancer. Это свойство не может быть обновлено. |
loadbalancer строка | Имя или идентификатор балансировщика нагрузки, к которому принадлежит этот пул. Для создания пула необходимо указать либо listener, либо loadbalancer. Это свойство не может быть обновлено. |
name строка / обязательно | Имя, которое должно быть присвоено пулу. Это свойство не может быть обновлено. |
protocol строка | Протокол для пула. Например, protocol может быть Это свойство не может быть обновлено. По умолчанию: |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень логирования OpenStackSDK. Варианты:
|
sdk_log_path строка | Путь к лог-файлу OpenStackSDK. Если пусто, логи не записываются. |
state строка | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs aliases: verify boolean | Проверять ли сертификаты SSL API-запросов. До 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-balander pool
openstack.cloud.lb_pool:
cloud: mycloud
lb_algorithm: ROUND_ROBIN
loadbalancer: test-loadbalancer
name: test-pool
protocol: HTTP
state: present
- name: Delete a load-balander pool
openstack.cloud.lb_pool:
cloud: mycloud
name: test-pool
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
pool dictionary | Словарь, описывающий пул балансировщика нагрузки. Возвращается: При успешном завершении, когда state имеет значение |
|
alpn_protocols list / elements=string |
Список протоколов ALPN. Возвращается: при успехе |
|
created_at string |
Метка времени создания пула. Возвращается: при успехе |
|
description string |
Описание пула. Возвращается: при успехе |
|
health_monitor_id string |
ID контроллера работоспособности. Возвращается: при успехе |
|
id string |
Уникальный UUID. Возвращается: при успехе |
|
is_admin_state_up boolean |
Административное состояние пула. Возвращается: при успехе |
|
lb_algorithm string |
Алгоритм балансировки нагрузки для пула. Возвращается: при успехе |
|
listener_id string |
ID прослушивателя, к которому принадлежит пул. Возвращается: при успехе |
|
listeners list / elements=string |
Список ID прослушивателей. Возвращается: при успехе |
|
loadbalancer_id string |
ID балансировщика нагрузки, к которому принадлежит пул. Это поле устанавливается, когда пул не принадлежит ни одному прослушивателю в балансировщике нагрузки. Возвращается: при успехе |
|
loadbalancers list / elements=string |
Список ID балансировщиков нагрузки. Возвращается: при успехе |
|
members list / elements=string |
Список ID участников. Возвращается: при успехе |
|
name string |
Имя, данное пулу. Возвращается: при успехе |
|
operating_status string |
Рабочий статус пула. Возвращается: при успехе |
|
project_id string |
ID проекта. Возвращается: при успехе |
|
protocol string |
Протокол для пула. Возвращается: при успехе |
|
provisioning_status string |
Статус подготовки пула. Возвращается: при успехе |
|
session_persistence dictionary |
Объект JSON, указывающий на сохранение сеанса для пула. Возвращается: при успехе |
|
tags list / elements=string |
Список связанных тегов. Возвращается: при успехе |
|
tls_ciphers string |
Содержит строку шифров в формате OpenSSL. Возвращается: при успехе |
|
tls_enabled boolean |
Использовать TLS для соединений с серверами-участниками бэкенда. Возвращается: при успехе |
|
tls_versions список / элементы=строка |
Список версий протокола TLS, которые будут использоваться в пуле. Возвращаемое значение: успех |
|
updated_at строка |
Отметка времени обновления пула. Возвращаемое значение: успех |
Ссылки на коллекцию
© 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_pool_module.html