openstack.cloud.os_stack – Добавление/Удаление стека Heat
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.os_stack.
Обзор
- Добавление или удаление стека в OpenStack Heat
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать соединение перед истечением времени ожидания для API-запросов. Если это значение опущено, в библиотеку запросов ничего не будет передано. | |
| 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. | |
| environment список / элементы=строка | Список файлов среды, которые должны использоваться для создания стека. | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| name строка / обязательно | Имя стека, который должен быть создан. Имя может состоять из букв и цифр, без пробелов | |
| parameters словарь | Словарь параметров для создания стека. | |
| region_name строка | Имя региона. | |
| rollback логическое |
| Откатить создание стека |
| state строка |
| Указывает желаемое состояние ресурса |
| tag строка | Тег для стека, который должен быть создан. Имя может состоять из букв и цифр, без пробелов | |
| template строка | Путь к файлу шаблона, который следует использовать для создания стека. | |
| timeout целое число | Значение по умолчанию: 3600 | Максимальное количество секунд ожидания создания стека. |
| validate_certs логическое |
| Выполнять ли проверку SSL API-запросов. До 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/
Примеры
---
- name: create stack
ignore_errors: True
register: stack_create
openstack.cloud.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 строка | успех | Действие, может быть Создать или Обновить. Пример: СОЗДАТЬ | |
| creation_time строка | успех | Время выполнения действия. Пример: 2016-07-05T17:38:12Z | |
| description строка | успех | Описание стека, предоставленное в шаблоне heat. Пример: Шаблон HEAT для создания нового экземпляра и сетей | |
| 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': 'Stack CREATE завершен успешно', 'status': 'COMPLETE', 'template_description': 'Шаблон HEAT для создания нового экземпляра и сетей', 'timeout_mins': 60, 'updated_time': null} | |
Авторы
- 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/os_stack_module.html
