os_project – Управление проектами OpenStack
Обзор
- Управление проектами OpenStack. С помощью данного модуля можно создавать, обновлять или удалять проекты. Проект будет обновлен, если name совпадает с существующим проектом и state присутствует. Значение name нельзя обновить без удаления и повторного создания проекта.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должен ждать уровень сокета, прежде чем истечет время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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. | |
| description - | Описание проекта | |
| domain_id - | ID домена для создания проекта, если облако поддерживает домены. псевдонимы: domain | |
| enabled булево |
| Включен ли проект |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type |
| name - / обязательно | Имя проекта | |
| region_name строка | Название региона. | |
| state - |
| Должен ли ресурс присутствовать или отсутствовать. |
| 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/
Примеры
# Create a project
- os_project:
cloud: mycloud
endpoint_type: admin
state: present
name: demoproject
description: demodescription
domain_id: demoid
enabled: True
# Delete a project
- os_project:
cloud: mycloud
endpoint_type: admin
state: absent
name: demoproject
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| project сложный | При успехе, когда state равен 'present' | Словарь, описывающий проект. | |
| description строка | Описание проекта Пример: demodescription | ||
| enabled булево | Булево значение, указывающее, включен ли проект Пример: True | ||
| id строка | ID проекта Пример: f59382db809c43139982ca4189404650 | ||
| name строка | Имя проекта Пример: demoproject | ||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Alberto Gireud (@agireud)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_project_module.html
