Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.stack.

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

Краткое описание

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

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

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

auth

dictionary

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

auth_type

string

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

ca_cert

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

string

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

client_cert

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

string

Путь к сертификату клиента, используемому при SSL-соединении.

client_key

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

string

Путь к ключу клиента, используемому при SSL-соединении.

cloud

any

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

environment

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

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

interface

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

string

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

Варианты:

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

name

string / обязательный

Имя стека.

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

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

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

parameters

dictionary

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

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

region_name

string

Имя региона.

rollback

boolean

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

Варианты:

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

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение не указано, журнал не записывается

state

string

Задаёт требуемое состояние ресурса

Варианты:

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

tags

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

string

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

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

template

string

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

timeout

integer

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

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

validate_certs

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

boolean

Следует ли проверять запросы к API по SSL.

До 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, затем из стандартных переменных окружения и, наконец, из явно заданных параметров в плейбуках. Дополнительную информацию см. на странице 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.

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

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

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

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

status

string

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

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

status_reason

string

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

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

tags

list / elements=string

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

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

template

dictionary

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

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

template_description

string

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

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

template_url

string

URL-адрес, по которому находится шаблон стека.

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

timeout_mins

string

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

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

unchanged

list / elements=string

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

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

updated

list / elements=string

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

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

updated_at

string

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

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

user_project_id

string

ID проекта пользователя, созданного для этого стека.

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

Авторы

  • OpenStack Ansible SIG

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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