os_keystone_endpoint - Управление конечными точками сервиса OpenStack Identity
Новое в версии 2.5.
Обзор
- Создать, обновить или удалить конечные точки сервиса OpenStack Identity. Если сервис с тем же сочетанием service, interface и region уже существует, url и state (
presentилиabsent) будут обновлены.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- openstacksdk >= 0.13.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должно ожидать сокетное подключение перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключения к облаку. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о домене, если облако её поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые данному плагину. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Название плагина аутентификации для использования. Если облако использует что-то другое, чем аутентификацию по паролю, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| cacert | Путь к пакету сертификатов CA, который может быть использован для проверки запросов SSL API. | |
| cert | Путь к клиенту сертификату для использования в рамках SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| enabled | По умолчанию: "да" | Включен ли сервис. |
| interface обязательно (добавлено в 2.3) |
| Интерфейс сервиса. псевдонимы: endpoint_type |
| key | Путь к клиенту ключу для использования в рамках SSL-транзакции. | |
| region | Регион, к которому относится сервис. Обратите внимание, что для аутентификации используется region_name. | |
| region_name | Название региона. | |
| service обязательно | Название или идентификатор сервиса. | |
| state |
| Должен ли ресурс быть present или absent. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должен ожидать запрошенного ресурса. |
| url обязательно | URL сервиса. | |
| verify bool |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и наконец, из явных параметров в playbooks. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
- name: Create a service for glance
os_keystone_endpoint:
cloud: mycloud
service: glance
endpoint_interface: public
url: http://controller:9292
region: RegionOne
state: present
- name: Delete a service for nova
os_keystone_endpoint:
cloud: mycloud
service: nova
endpoint_interface: public
region: RegionOne
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| endpoint сложный | При успехе, когда state равно present
| Словарь, описывающий конечную точку. | |
| id строка | Идентификатор конечной точки. Пример: 3292f020780b4d5baf27ff7e1d224c44 | ||
| region строка | Имя региона. Пример: RegionOne | ||
| service_id строка | Идентификатор сервиса. Пример: b91f1318f735494a825a55388ee118f3 | ||
| interface строка | Интерфейс конечной точки. Пример: public | ||
| url строка | URL сервиса. Пример: http://controller:9292 | ||
| enabled логическое | Статус сервиса. Пример: True | ||
Статус
Данный модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщественный, что означает, что он поддерживается сообществом Ansible. См. Поддержка и обслуживание модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Mohammed Naser (@mnaser)
- Alberto Murillo (@albertomurillo)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/os_keystone_endpoint_module.html