os_project - Управление проектами OpenStack
Новая версия 2.0.
Обзор
- Управление проектами OpenStack. С помощью данного модуля можно создавать, обновлять или удалять проекты. Проект будет обновлен, если имя совпадает с существующим проектом, и состояние присутствует. Значение имени нельзя обновить без удаления и повторного создания проекта.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ждать подсистема сокетов, прежде чем истечёт время ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о домене, если облако её поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной авторизации, то здесь должно быть указано имя подключаемого модуля, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL к API. | |
| cert | Путь к клиенту сертификат, который следует использовать в рамках SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака с именем, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| description | По умолчанию: None | Описание проекта |
| domain_id | По умолчанию: None | Идентификатор домена для создания проекта в нём, если облако поддерживает домены. Параметр domain_id требует shade >= 1.8.0 Псевдонимы: domain |
| enabled | По умолчанию: да | Включён ли проект |
| interface (добавлен в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| name обязательно | Имя проекта | |
| region_name | Имя региона. | |
| state |
| Должно ли ресурс быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify |
| Необходимо ли проверять запросы SSL к API. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| wait |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут быть получены из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных среды, а затем, в последнюю очередь, явными параметрами в задачах. Более подробная информация доступна по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Create a project
- os_project:
cloud: mycloud
state: present
name: demoproject
description: demodescription
domain_id: demoid
enabled: True
# Delete a project
- os_project:
cloud: mycloud
state: absent
name: demoproject
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| project сложный | При успехе, когда состояние равно 'present' | Словарь, описывающий проект. | |
| enabled bool | Булево значение, указывающее, включён ли проект Пример: True | ||
| description строка | Описание проекта Пример: demodescription | ||
| name строка | Имя проекта Пример: demoproject | ||
| id строка | Идентификатор проекта Пример: f59382db809c43139982ca4189404650 | ||
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/os_project_module.html