openstack.cloud.project – Управление проектами OpenStack

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в книге задач, укажите: openstack.cloud.project.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление проектами OpenStack. С помощью данного модуля можно создавать, обновлять или удалять проекты. Проект будет обновлён, если name соответствует существующему проекту и присутствует state. Значение name нельзя обновить без удаления и повторного создания проекта.

Требования

Ниже перечислены требования к хосту, на котором выполняется данный модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должно ждать сокетное соединение перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests.
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 строка		ID домена для создания проекта в нём, если облако поддерживает домены. псевдонимы: domain
enabled булево	Варианты: нет да ←	Включён ли проект
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
name строка / обязательный		Имя проекта
properties словарь	По умолчанию: {}	Дополнительные свойства, которые необходимо связать с этим проектом. Требуется openstacksdk>0.45.
region_name строка		Имя региона
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/

Примеры

# Create a project
- openstack.cloud.project:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: demoproject
    description: demodescription
    domain_id: demoid
    enabled: True
    properties:
      internal_alias: demo_project

# Delete a project
- openstack.cloud.project:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: demoproject

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ		Возвращаемое значение	Описание
project сложное		При успехе, когда state равен 'present'	Словарь, описывающий проект.
	description строка	успех	Описание проекта Пример: demodescription
	enabled булево	успех	Булево значение, указывающее, включён ли проект Пример: True
	id строка	успех	ID проекта Пример: f59382db809c43139982ca4189404650
	name строка	успех	Название проекта Пример: demoproject

Авторы

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/project_module.html