openstack.cloud.endpoint – Управление конечными точками сервиса идентификации OpenStack
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Чтобы использовать его в книге задач, укажите: openstack.cloud.endpoint.
Обзор
- Создание, обновление или удаление конечных точек сервиса идентификации OpenStack. Если сервис с тем же сочетанием service, interface и region существует, url и state (
presentилиabsent) будут обновлены.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk >= 0.12.0
- openstacksdk >= 0.13.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать сокет-слой перед истечением времени ожидания для вызовов API. Если это значение опущено, библиотеке requests ничего не будет передано. | |
| auth словарь | Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды 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. | |
| enabled логическое значение |
| Включен ли сервис. |
| endpoint_interface строка / обязательно |
| Интерфейс сервиса. |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| region строка | Регион, к которому принадлежит сервис. Обратите внимание, что region_name используется для аутентификации. | |
| region_name строка | Имя региона. | |
| service строка / обязательно | Имя или идентификатор сервиса. | |
| state строка |
| Должен ли ресурс быть present или absent. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| url строка / обязательно | URL сервиса. | |
| validate_certs логическое значение |
| Нужно ли проверять запросы SSL API. До Ansible 2.3 это значение по умолчанию было yes.псевдонимы: verify |
| wait логическое значение |
| Должен ли 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 service for glance
openstack.cloud.endpoint:
cloud: mycloud
service: glance
endpoint_interface: public
url: http://controller:9292
region: RegionOne
state: present
- name: Delete a service for nova
openstack.cloud.endpoint:
cloud: mycloud
service: nova
endpoint_interface: public
region: RegionOne
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| endpoint сложный | При успешном выполнении, когда state равно present
| Словарь, описывающий конечную точку. | |
| enabled логическое значение | успех | Статус сервиса. Пример: True | |
| id строка | успех | Идентификатор конечной точки. Пример: 3292f020780b4d5baf27ff7e1d224c44 | |
| interface строка | успех | Интерфейс конечной точки. Пример: public | |
| region строка | успех | Имя региона. Пример: RegionOne | |
| service_id строка | успех | Идентификатор сервиса. Пример: b91f1318f735494a825a55388ee118f3 | |
| url строка | успех | URL сервиса. Пример: http://controller:9292 | |
Авторы
- 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/endpoint_module.html