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