os_image - Добавление/удаление изображений из облака OpenStack
Новое в версии 2.0.
Обзор
- Добавление или удаление изображений из репозитория изображений OpenStack
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. | |
| checksum (добавлено в 2.5) | Контрольная сумма изображения | |
| cloud | Наименованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные среды OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, такую как в разделе clouds.yaml. | |
| container_format | По умолчанию: "bare" | Формат контейнера |
| disk_format | По умолчанию: "qcow2" | Формат диска, который загружается |
| filename | Путь к файлу, который необходимо загрузить | |
| id (добавлено в 2.4) | Идентификатор изображения | |
| interface (добавлено в 2.3) |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| is_public bool |
| Доступность изображения для общего доступа. Обратите внимание, что для опубликования изображения по умолчанию требуется роль администратора. |
| kernel | Имя существующего ядра изображения, которое будет ассоциировано с этим изображением | |
| key | Путь к ключу клиента для использования в транзакции SSL. | |
| min_disk | Минимальный размер диска (в ГБ), необходимый для загрузки этого изображения | |
| min_ram | Минимальный объем оперативной памяти (в МБ), необходимый для загрузки этого изображения | |
| name обязательно | Имя, которое должно быть присвоено изображению | |
| owner | Владелец изображения | |
| properties | По умолчанию: {} | Дополнительные свойства, которые необходимо ассоциировать с этим изображением |
| ramdisk | Имя существующего изображения ramdisk, которое будет ассоциировано с этим изображением | |
| region_name | Имя региона. | |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify bool |
| Следует ли проверять запросы API SSL. До версии 2.3 по умолчанию это было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об аутентификации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в сценариях. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Upload an image from a local file named cirros-0.3.0-x86_64-disk.img
- os_image:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
name: cirros
container_format: bare
disk_format: qcow2
state: present
filename: cirros-0.3.0-x86_64-disk.img
kernel: cirros-vmlinuz
ramdisk: cirros-initrd
properties:
cpu_arch: x86_64
distro: ubuntu
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- Monty Taylor (@emonty)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/os_image_module.html