os_stack — Добавление/удаление стека Heat

Новая версия 2.2.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Добавление или удаление стека в OpenStack Heat

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout		Сколько времени (в секундах) сокет должен ждать при таймауте вызовов API. Если этот параметр опущен, он не будет передан в библиотеку запросов.
auth		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей, этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь нужно указать имя подключаемого модуля и соответствующим образом обновить содержимое параметра auth.
availability_zone		Игнорируется. Присутствует для обратной совместимости.
cacert		Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL.
cert		Путь к клиенту сертификата для использования в рамках транзакции SSL.
cloud		Имя облака или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию имени облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
environment		Список файлов среды, которые должны использоваться для создания стека.
interface (добавлено в 2.3)	Варианты: public ← internal admin	Тип URL конечной точки для извлечения из каталога сервиса. Псевдонимы: endpoint_type
key		Путь к ключу клиента для использования в рамках транзакции SSL.
name обязательно		Имя стека, который должен быть создан. Имя может содержать символы и цифры, без пробелов.
parameters		Словарь параметров для создания стека.
region_name		Имя региона.
rollback bool	Варианты: no yes ←	Откатить создание стека.
state	Варианты: present ← absent	Указывает желаемое состояние ресурса.
tag (добавлено в 2.5)		Тег для стека, который должен быть создан, имя может содержать символы и цифры, без пробелов.
template		Путь к файлу шаблона для создания стека.
timeout	По умолчанию: 3600	Максимальное время ожидания создания стека в секундах.
verify bool	Варианты: no yes	Включает/отключает проверку запросов API SSL. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs
wait bool	Варианты: no yes ←	Должен ли 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

Примеры

---
- name: create stack
  ignore_errors: True
  register: stack_create
  os_stack:
    name: "{{ stack_name }}"
    tag: "{{ tag_name }}"
    state: present
    template: "/path/to/my_stack.yaml"
    environment:
    - /path/to/resource-registry.yaml
    - /path/to/environment.yaml
    parameters:
        bmc_flavor: m1.medium
        bmc_image: CentOS
        key_name: default
        private_net: "{{ private_net_param }}"
        node_count: 2
        name: undercloud
        image: CentOS
        my_flavor: m1.large
        external_net: "{{ external_net_param }}"

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

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

Ключ		Возвращаемое значение	Описание
id строка		всегда	ID стека. Пример: 97a3f543-8136-4570-920e-fd7605c989d6
stack сложный тип		всегда	Информация о стеке
	action строка		Действие, может быть Create или Update. Пример: CREATE
	creation_time строка		Время выполнения действия. Пример: 2016-07-05T17:38:12Z
	description строка		Описание стека, предоставленное в шаблоне. Пример: HOT шаблон для создания нового экземпляра и сетей
	id строка		ID стека. Пример: 97a3f543-8136-4570-920e-fd7605c989d6
	name строка		Имя стека Пример: test-stack
	identifier строка		Идентификатор текущего действия стека. Пример: test-stack/97a3f543-8136-4570-920e-fd7605c989d6
	links список словарей		Ссылки на текущий стек. Пример: [{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6']
	outputs список словарей		Выходные данные, возвращённые стеком. Пример: {'description': 'IP-адрес сервера1 в частной сети', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'}
	parameters словарь		Параметры текущего стека Пример: {'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack_name': 'test-stack', 'stack_status': 'CREATE_COMPLETE', 'stack_status_reason': 'Стек CREATE завершен успешно', 'status': 'COMPLETE', 'template_description': 'HOT шаблон для создания нового экземпляра и сетей', 'timeout_mins': 60, 'updated_time': null}

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Mathieu Bultel (matbu), Steve Baker (steveb)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/os_stack_module.html