os_project – Управление проектами OpenStack
Новая версия с 2.0.
Обзор
- Управление проектами OpenStack. С помощью данного модуля можно создавать, обновлять или удалять проекты. Проект будет обновлен, если name совпадает с существующим проектом, и state присутствует. Значение name нельзя обновить без удаления и повторного создания проекта.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать система сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано. | |
| 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 Cert, который можно использовать для проверки запросов 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 - | Идентификатор домена для создания проекта в облаке, если облако поддерживает домены. псевдонимы: domain | |
| enabled булево |
| Включен ли проект |
| interface строка добавлен в 2.3 |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| name - / обязательно | Название проекта | |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемого ресурса. |
| validate_certs boolean |
| Подтверждать ли запросы SSL API. До Ansible 2.3 по умолчанию было yes. Псевдонимы: verify |
| wait boolean |
| Должен ли 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 строка | Идентификатор проекта Пример: 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.8/modules/os_project_module.html
