openstack.cloud.os_keystone_identity_provider – управление поставщиком федерации идентификаторов
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Чтобы использовать его в книге задач, укажите: openstack.cloud.os_keystone_identity_provider.
Описание
- Управление поставщиком федерации идентификаторов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk >= 0.12.0
- openstacksdk >= 0.44
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать система сокетов, прежде чем истечёт время ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| 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. | |
| description строка | Описание поставщика идентификаторов. | |
| domain_id строка | Идентификатор домена, связанный с поставщиком идентификаторов. Федеративные пользователи, аутентифицированные с помощью поставщика идентификаторов, будут созданы в указанном домене. Требуется при создании нового поставщика идентификаторов. | |
| enabled булево |
| Включён ли поставщик идентификаторов или нет. По умолчанию будет true, когда создаётся новый поставщик идентификаторов.псевдонимы: is_enabled |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| name строка / обязательный | Имя поставщика идентификаторов. псевдонимы: id | |
| region_name строка | Имя региона. | |
| remote_ids список / элементы=строка | Список уникальных удалённых идентификаторов поставщика идентификаторов. По умолчанию при создании нового поставщика идентификаторов будет пустой список. | |
| state строка |
| Должен ли поставщик идентификаторов быть present или absent. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| 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 an identity provider
openstack.cloud.federation_idp:
cloud: example_cloud
name: example_provider
domain_id: 0123456789abcdef0123456789abcdef
description: 'My example IDP'
remote_ids:
- 'https://auth.example.com/auth/realms/ExampleRealm'
- name: Delete an identity provider
openstack.cloud.federation_idp:
cloud: example_cloud
name: example_provider
state: absent
Авторы
- 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_identity_provider_module.html
