os_stack - Добавление/удаление стека Heat
Новое в версии 2.2.
Обзор
- Добавление или удаление стека в OpenStack Heat
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ждать сокет-слой перед истечением времени ожидания для API-запросов. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к файлу с пакетом сертификатов CA, который может использоваться для проверки SSL API-запросов. | |
| cert | Путь к клиенту сертификат для использования в рамках SSL-транзакции. | |
| cloud | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| environment | По умолчанию: None | Список файлов среды, которые должны быть использованы для создания стека. |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для получения из каталога служб. Псевдонимы: endpoint_type |
| key | Путь к клиенту ключу для использования в рамках SSL-транзакции. | |
| name обязательно | Имя стека, который должен быть создан, имя может содержать символы и цифры, без пробелов | |
| parameters | По умолчанию: None | Словарь параметров для создания стека |
| region_name | Имя региона. | |
| rollback | По умолчанию: no | Откатить создание стека |
| state |
| Указывает желаемое состояние ресурса |
| tag (добавлено в 2.5) | По умолчанию: None | Тег для стека, который должен быть создан, имя может содержать символы и цифры, без пробелов |
| template | По умолчанию: None | Путь к файлу шаблона для использования при создании стека |
| timeout | По умолчанию: 3600 | Максимальное количество секунд ожидания создания стека |
| verify |
| Нужно ли проверять SSL API-запросы. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| wait |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершён. |
Примечания
Примечание
- Могут использоваться стандартные переменные среды OpenStack, например,
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в playbooks. Более подробную информацию можно найти на странице 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 сложный тип | всегда | Информация о стеке | |
| identifier строка | Идентификатор текущего действия стека. Пример: test-stack/97a3f543-8136-4570-920e-fd7605c989d6 | ||
| description строка | Описание стека, предоставленное в шаблоне. Пример: Шаблон для создания нового экземпляра и сетей | ||
| links список словарей | Ссылки на текущий стек. Пример: [{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6'}] | ||
| outputs список словарей | Выходные данные, возвращаемые стеком. Пример: {'description': 'IP-адрес сервера server1 в частной сети', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'} | ||
| creation_time строка | Время выполнения действия. Пример: 2016-07-05T17:38:12Z | ||
| action строка | Действие, может быть Create или Update. Пример: CREATE | ||
| 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': 'Успешное завершение создания стека', 'status': 'COMPLETE', 'template_description': 'Шаблон для создания нового экземпляра и сетей', 'timeout_mins': 60, 'updated_time': null} | ||
| id строка | Идентификатор стека. Пример: 97a3f543-8136-4570-920e-fd7605c989d6 | ||
| name строка | Название стека Пример: test-stack | ||
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- 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.5/modules/os_stack_module.html
