openstack.cloud.federation_mapping – Управление отображением федерации
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Чтобы использовать его в playbook, укажите: openstack.cloud.federation_mapping.
Описание
- Управление отображением федерации.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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, который можно использовать для проверки запросов API SSL. псевдонимы: 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 | |
| name строка / обязательный | Имя отображения для управления. псевдонимы: id | ||
| region_name строка | Имя региона. | ||
| rules список / элементы=словарь | Правила, составляющие отображение. Это пары local и remote определений. Более подробную информацию о том, как это работает, см. в документации OpenStack https://docs.openstack.org/keystone/latest/admin/federation/mapping_combinations.html. Требуется, если state=present
| ||
| local список / элементы=словарь / обязательный | Информация о том, какие локальные атрибуты будут отображаться. | ||
| remote список / элементы=словарь / обязательный | Информация о том, какие удалённые атрибуты будут отображаться. | ||
| state строка |
| Нужно ли отображению быть present или absent. | |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. | |
| 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 new mapping
openstack.cloud.federation_mapping:
cloud: example_cloud
name: example_mapping
rules:
- local:
- user:
name: '{0}'
- group:
id: '0cd5e9'
remote:
- type: UserName
- type: orgPersonType
any_one_of:
- Contractor
- SubContractor
- name: Delete a mapping
openstack.cloud.federation_mapping:
name: example_mapping
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/federation_mapping_module.html