Spec-Zone.ru › Ansible

openstack.cloud.stack модуль – Добавление/удаление стека Heat

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: openstack.cloud.stack.

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

Описание

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

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

целое число

Сколько времени должна ждать сокет-слой перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку запросов.

auth

словарь

Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.

auth_type

строка

Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.

ca_cert

псевдонимы: cacert

строка

Путь к пакету сертификата CA, который может использоваться для проверки запросов API SSL.

client_cert

псевдонимы: cert

строка

Путь к клиенту сертификату для использования в рамках транзакции SSL.

client_key

псевдонимы: key

строка

Путь к ключу клиента для использования в рамках транзакции SSL.

cloud

любой тип

Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.

environment

список / элементы=строка

Список файлов среды, которые должны быть использованы для создания стека.

interface

псевдонимы: endpoint_type

строка

Тип URL конечной точки для извлечения из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

строка / обязательно

Имя стека.

Значение должно быть уникальным в рамках проекта.

Имя должно начинаться с буквы ASCII и может содержать буквы ASCII, цифры, нижние подчёркивания, точки и дефисы. В частности, имя должно соответствовать регулярному выражению ^[a-zA-Z][a-zA-Z0-9_.-]{0,254}$.

При удалении или отказе от стека его имя не станет доступным для повторного использования до тех пор, пока удаление не завершится успешно.

parameters

словарь

Словарь параметров для создания стека

По умолчанию: {}

region_name

строка

Имя региона.

rollback

логическое

Откатить создание стека

Варианты:

  • false ← (по умолчанию)
  • true

sdk_log_level

строка

Уровень ведения журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

строка

Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан.

state

строка

Укажите желаемое состояние ресурса

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: tag

строка

Один или несколько тегов в виде строк для сопоставления со стеком.

Для сопоставления нескольких тегов со стеком разделяйте теги запятыми. Например, tag1,tag2.

template

строка

Путь к файлу шаблона для использования при создании стека

timeout

целое число

Максимальное количество секунд ожидания создания стека

По умолчанию: 3600

validate_certs

aliases: verify

boolean

Проверка SSL API-запросов.

До Ansible 2.3 это по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ожидать завершения запрошенного ресурса.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Можно использовать стандартные переменные среды OpenStack, такие как OS_USERNAME, вместо явного указания значений.
  • Информация об авторизации задаётся openstacksdk, что означает, что значения могут браться из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbook'ах. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: create stack
  openstack.cloud.stack:
    name: "teststack"
    tag: "tag1,tag2"
    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
        node_count: 2
        name: undercloud
        image: CentOS
        my_flavor: m1.large

Значения возврата

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

Ключ

Описание

stack

dictionary

Информация о стеке

Возвращается: всегда

added

list / elements=string

Список объектов ресурсов, которые будут добавлены.

Возвращается: при успехе

capabilities

list / elements=string

Список возможностей шаблона, совместимого с AWS.

Возвращается: при успехе

created_at

string

Время создания.

Возвращается: при успехе

Пример: "2016-07-05T17:38:12Z"

deleted

list / elements=string

Список объектов ресурсов, которые будут удалены.

Возвращается: при успехе

deleted_at

string

Время удаления.

Возвращается: при успехе

Пример: "2016-07-05T17:38:12Z"

description

string

Описание стека, предоставленное в шаблоне Heat.

Возвращается: при успехе

Пример: "HOT template to create a new instance and networks"

environment

dictionary

JSON-окружение для стека.

Возвращается: при успехе

environment_files

list / elements=string

Упорядоченный список имен файлов окружения, найденных в словаре файлов.

Возвращается: при успехе

files

dictionary

Дополнительные файлы, на которые ссылается шаблон или среда

Возвращается: при успехе

files_container

string

Имя контейнера swift с дочерними шаблонами и файлами.

Возвращается: при успехе

id

string

ID стека.

Возвращается: при успехе

Пример: "97a3f543-8136-4570-920e-fd7605c989d6"

is_rollback_disabled

boolean

Будет ли стек поддерживать откат.

Возвращается: при успехе

links

list / elements=dictionary

Ссылки на текущий стек.

Возвращается: при успехе

Пример: "[{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/ 97a3f543-8136-4570-920e-fd7605c989d6']"

name

string

Имя стека

Возвращается: при успехе

Пример: "test-stack"

notification_topics

string

События, связанные со стеком.

Возвращается: при успехе

Пример: "HOT template to create a new instance and networks"

outputs

list / elements=dictionary

Результат, возвращаемый стеком.

Возвращается: при успехе

Пример: "[{'description': 'IP of server1 in private network', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'}]"

owner_id

string

ID родительского стека, если таковой имеется.

Возвращается: при успехе

parameters

dictionary

Параметры текущего стека

Возвращается: при успехе

Пример: "{'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack_name': 'test-stack', 'stack_status': 'CREATE_COMPLETE', 'stack_status_reason': 'Stack CREATE completed successfully', 'status': 'COMPLETE', 'template_description': 'HOT template to create a new instance and nets', 'timeout_mins': 60, 'updated_time': null}"

parent_id

string

ID родительского стека, если таковой имеется.

Возвращается: при успехе

replaced

string

Список объектов ресурсов, которые будут заменены.

Возвращаемое значение: success

status

string

Статус стека.

Возвращаемое значение: success

status_reason

string

Объяснение того, как стек переходит в текущее состояние.

Возвращаемое значение: success

tags

list / элементы=string

Список строк, используемых в качестве тегов стека.

Возвращаемое значение: success

template

dictionary

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

Возвращаемое значение: success

template_description

string

Текстовое описание шаблона стека.

Возвращаемое значение: success

template_url

string

URL, где можно найти шаблон стека.

Возвращаемое значение: success

timeout_mins

string

Таймаут операции стека в минутах.

Возвращаемое значение: success

unchanged

list / элементы=string

Список объектов ресурсов, которые останутся неизменными, если стек…

Возвращаемое значение: success

updated

list / элементы=string

Список объектов ресурсов, свойства которых будут обновлены.

Возвращаемое значение: success

updated_at

string

Маркер времени последнего обновления стека.

Возвращаемое значение: success

user_project_id

string

Идентификатор проекта пользователя, созданного для данного стека.

Возвращаемое значение: success

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/stack_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API