os_image – Добавление/удаление изображений из облака OpenStack
Новое в версии 2.0.
Описание
- Добавление или удаление изображений из хранилища изображений OpenStack
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени (в секундах) слой сокета должен ожидать перед истечением времени ожидания для API-запросов. Если этот параметр опущен, в библиотеку запросов ничего не будет передано. | |
| 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 | |
| checksum - добавлен в 2.5 | Контрольная сумма образа | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках SSL-транзакции. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках SSL-транзакции. псевдонимы: key | |
| 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 булево |
| Доступен ли образ для публичного доступа. Обратите внимание, что для публикации образа по умолчанию требуется роль администратора. |
| kernel - | Имя существующего ядра образа, которое будет ассоциировано с этим образом | |
| min_disk - | Минимальный объём диска (в ГБ), необходимый для загрузки этого образа |
| min_ram - | Минимальный объем оперативной памяти (в МБ), необходимый для загрузки этого образа. | |
| name - / обязательно | Имя образа при загрузке — или имя/ID образа при удалении. | |
| owner - | Владелец образа. | |
| properties - | По умолчанию: {} | Дополнительные свойства, которые необходимо связать с этим образом. |
| ramdisk - | Имя существующего образа ramdisk, который будет связан с этим образом. | |
| region_name строка | Имя региона. | |
| state - |
| Должен ли ресурс быть present или absent. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| 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, затем из стандартных переменных среды, а затем, наконец, из явных параметров в play. Более подробная информация доступна по адресу https://docs.openstack.org/openstacksdk/
Примеры
# 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
os_user_domain_name: Default
os_project_domain_name: Default
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
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/os_image_module.html
