openstack.cloud.os_pool – Добавление/удаление пула в службе балансировки нагрузки из OpenStack Cloud
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в плейбуке укажите: openstack.cloud.os_pool.
Описание
- Добавить или удалить пул из службы балансировки нагрузки OpenStack.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Время ожидания сокета при вызове API-методов. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или project_domain_name), если их поддерживает облако. Для других плагинов этот параметр должен содержать требуемые параметры. Этот параметр не нужен, если указан параметр named cloud или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету сертификатов CA, который может использоваться для проверки SSL-запросов к API. алиасы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в ходе SSL-транзакции. алиасы: cert | |
| client_key строка | Путь к ключу клиента для использования в ходе SSL-транзакции. алиасы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml. | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога служб. алиасы: endpoint_type |
| lb_algorithm строка |
| Алгоритм балансировки нагрузки для пула. |
| listener строка | Имя или идентификатор слушателя, к которому принадлежит этот пул. Для создания пула необходимо указать либо loadbalancer, либо listener. | |
| loadbalancer строка | Имя или идентификатор балансировщика нагрузки, к которому принадлежит этот пул. Для создания пула необходимо указать либо loadbalancer, либо listener. | |
| name строка / обязательно | Имя, которое нужно присвоить пулу. | |
| protocol строка |
| Протокол для пула. |
| region_name строка | Имя региона. | |
| state строка |
| Требуется ли наличие ресурса. |
| timeout целое число | По умолчанию: 180 | Время ожидания модуля до перехода пула в состояние ACTIVE. |
| validate_certs булево |
| Нужно ли проверять SSL API-запросы. До Ansible 2.3 по умолчанию было yes.алиасы: verify |
| wait булево |
| Нужно ли ждать, пока пул станет ACTIVE. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в плейбуках. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Create a pool, wait for the pool to be active.
- openstack.cloud.lb_pool:
cloud: mycloud
endpoint_type: admin
state: present
name: test-pool
loadbalancer: test-loadbalancer
protocol: HTTP
lb_algorithm: ROUND_ROBIN
# Delete a pool
- openstack.cloud.lb_pool:
cloud: mycloud
endpoint_type: admin
state: absent
name: test-pool
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| id строка | При успехе, когда состояние равно 'present' | UUID пула. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69 | |
| listener сложный | При успехе, когда состояние равно 'present' | Словарь, описывающий пул. | |
| description строка | успех | Описание пула. Пример: описание | |
| id строка | успех | Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69 | |
| is_admin_state_up булево | успех | Административное состояние пула. Пример: True | |
| lb_algorithm строка | успех | Алгоритм балансировки нагрузки для пула. Пример: ROUND_ROBIN | |
| listener_id строка | успех | Идентификатор слушателя, к которому относится пул. Пример: 956aa716-9c2f-11e8-83b3-44a8422643a4 | |
| listeners список / элементы=строка | успех | Список идентификаторов слушателей. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] | |
| loadbalancer_id строка | успех | Идентификатор балансировщика нагрузки, к которому относится пул. Это поле устанавливается, когда пул не принадлежит ни одному слушателю в балансировщике нагрузки. Пример: 7c4be3f8-9c2f-11e8-83b3-44a8422643a4 | |
| loadbalancers список / элементы=строка | успех | Список идентификаторов балансировщиков нагрузки. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] | |
| members список / элементы=строка | успех | Список идентификаторов членов. Пример: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] | |
| name строка | успех | Имя, заданное пулу. Пример: test | |
| operating_status строка | успех | Рабочее состояние пула. Пример: ONLINE | |
| protocol строка | успех | Протокол для пула. Пример: HTTP | |
| provisioning_status строка | успех | Состояние подготовки пула. Пример: ACTIVE | |
Авторы
- OpenStack Ansible SIG
© 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/openstack/cloud/os_pool_module.html
