os_stack – Добавление/удаление стека Heat
Обзор
- Добавление или удаление стека в OpenStack Heat
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная часть, прежде чем истечёт таймаут для вызовов API. Если этот параметр опущен, библиотека requests не получит его. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 - добавлен в 2.5 | Тег для стека, который должен быть создан, имя может содержать символы и цифры, без пробелов | |
| 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
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 или Update. Пример: CREATE | ||
| creation_time строка | Время выполнения действия. Пример: 2016-07-05T17:38:12Z | ||
| description строка | Описание стека, предоставленное в шаблоне. Пример: Шаблон HOT для создания нового экземпляра и сетей | ||
| 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': 'Шаблон HOT для создания нового экземпляра и сетей', '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.9/modules/os_stack_module.html
