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 boolean	Варианты: нет да ←	Откат создания стека
state -	Варианты: present ← absent	Указывает желаемое состояние ресурса
tag - добавлен в 2.5		Тег для стека, который должен быть создан, имя может состоять из символов и цифр, без пробелов
template -		Путь к файлу шаблона для создания стека
timeout -	Значение по умолчанию: 3600	Максимальное количество секунд ожидания создания стека
verify boolean	Варианты: нет да	Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. алиасы: validate_certs
wait boolean	Варианты: нет да ←	Должен ли 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 строка		всегда	Идентификатор стека. Пример: 97a3f543-8136-4570-920e-fd7605c989d6
stack сложный		всегда	информация о стеке
	action строка		Действие, может быть Создать или Обновить. Пример: CREATE
	creation_time строка		Время выполнения действия. Пример: 2016-07-05T17:38:12Z
	description строка		Описание стека, предоставленное в шаблоне. Пример: Шаблон для создания нового экземпляра и сетей
	id строка		Идентификатор стека. Пример: 97a3f543-8136-4570-920e-fd7605c989d6
	identifier строка		Идентификатор текущего действия стека. Пример: test-stack/97a3f543-8136-4570-920e-fd7605c989d6
	links список словарей		Ссылки на текущий стек. Пример: [{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6'}]
	name строка		Имя стека Пример: test-stack
	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': 'Шаблон для создания нового экземпляра и сетей', 'timeout_mins': 60, 'updated_time': null}

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
Данный модуль поддерживается сообществом 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.7/modules/os_stack_module.html