openstack.cloud.volume – Создание/удаление томов Cinder
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook укажите: openstack.cloud.volume.
Обзор
- Создание или удаление томов блочного хранилища cinder.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должен ожидать уровень сокета перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| bootable булево |
| Флаг bootable для тома. |
| 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. | |
| display_description строка | Строковое описание тома псевдонимы: description | |
| display_name строка / обязательный | Имя тома псевдонимы: name | |
| image строка | Имя или идентификатор образа для загрузки с тома | |
| interface строка |
| Тип URL конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type |
| metadata словарь | Метаданные для тома | |
| region_name строка | Имя региона. | |
| scheduler_hints словарь | Подсказки планировщика, передаваемые в API томов в виде словаря | |
| size целое число | Размер тома в ГБ. Этот параметр требуется, когда параметр state равен 'present'. | |
| snapshot_id строка | Идентификатор снимка тома для создания из него | |
| state строка |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| validate_certs булево |
| Нужно ли проверять SSL запросы к API. До Ansible 2.3 по умолчанию было yes.псевдонимы: verify |
| volume строка | Имя или ID тома для создания из него | |
| volume_type строка | Тип тома для тома | |
| wait булево |
| Должен ли Ansible ждать, пока запрошенный ресурс не будет завершён. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного задания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла yaml конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а в последнюю очередь из явных параметров в playbook. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Creates a new volume
- name: create a volume
hosts: localhost
tasks:
- name: create 40g test volume
openstack.cloud.volume:
state: present
cloud: mordred
availability_zone: az2
size: 40
display_name: test_volume
scheduler_hints:
same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0
Авторы
- 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/volume_module.html