Модуль openstack.cloud.image — управление образами в службе образов OpenStack (Glance).
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем могут потребоваться дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.image.
Краткое описание
- Создание и удаление образов в службе образов OpenStack (Glance).
Требования
Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Как долго уровень сокетов должен ожидать ответа, прежде чем истечёт время ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для стратегии плагина аутентификации облака. Для стандартного плагина password в нём должны содержаться auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано имя облака или заданы переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если в облаке используется не парольная аутентификация, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов ЦС, который можно использовать для проверки SSL-запросов API. |
checksum string | Контрольная сумма образа. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому в SSL-транзакции. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому в SSL-транзакции. |
cloud any | Именованное облако или конфигурация облака, с которыми следует работать. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
container_format string | Формат контейнера. Этот атрибут образа нельзя изменить. Примеры: По умолчанию: |
disk_format string | Формат загружаемого диска. Этот атрибут образа нельзя изменить. Примеры: По умолчанию: |
filename string | Путь к файлу, который необходимо загрузить. Этот атрибут образа нельзя изменить. |
id string | Идентификатор образа при его загрузке. Этот атрибут образа нельзя изменить. |
import_method string | Метод импорта образа. Не все развёртывания поддерживают все методы. Поддерживаются web-download и glance-download. Действия создания не поддерживают copy-image. Метод импорта glance-direct удалён, поэтому в этом случае можно использовать use_import. Варианты:
|
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
is_protected псевдонимы: protected boolean | Запретить удаление образа. Варианты:
|
is_public boolean | Можно ли получить публичный доступ к образу. Для установки is_public в значение Параметр is_public устарел. Вместо него используйте visibility. Варианты:
|
kernel string | Имя существующего образа ядра, который будет связан с этим образом. |
min_disk integer | Минимальный объём дискового пространства (в ГБ), необходимый для загрузки этого образа. |
min_ram integer | Минимальный объём оперативной памяти (в МБ), необходимый для загрузки этого образа. |
name string / обязательный | Имя образа при загрузке либо имя/идентификатор образа при удалении. Если указать этот параметр вместе с id, его можно использовать для изменения имени существующего образа. |
owner псевдонимы: project string | Имя или идентификатор проекта, которому принадлежит образ. |
owner_domain псевдонимы: project_domain string | Имя или идентификатор домена, к которому относится проект — владелец образа. Можно использовать для однозначного определения проекта, если в качестве аргумента project указано имя и существует несколько проектов с таким именем. |
properties dictionary | Дополнительные свойства, связанные с этим образом. По умолчанию: |
ramdisk string | Имя существующего образа ramdisk, который будет связан с этим образом. |
region_name string | Имя региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся. |
state string | Должен ли ресурс существовать, отсутствовать или быть неактивным. Варианты:
|
tags list / элементы=string | Список тегов для применения к образу. По умолчанию: |
timeout integer | Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: |
uri string | Требуется только при использовании метода импорта web-download. По этому URL данные доступны службе образов. |
use_import boolean | Использовать метод ‘glance-direct’ механизма совместимого импорта образов. Используйте его только при необходимости, например если нужно, чтобы облако преобразовало формат образа. Варианты:
|
validate_certs псевдонимы: verify boolean | Следует ли проверять SSL-запросы API. До Ansible 2.3 значение по умолчанию было Варианты:
|
visibility string | Видимость образа. Варианты:
|
volume string | Идентификатор тома, из которого создаётся образ. Том должен находиться в состоянии AVAILABLE. Параметр volume устарел. Вместо него используйте модуль openstack.cloud.volume. |
wait boolean | Должен ли Ansible ожидать завершения операции над запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из YAML-файла конфигурации /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров плейбука. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Upload an image from a local file named cirros-0.3.0-x86_64-disk.img
openstack.cloud.image:
cloud: devstack-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
tags:
- custom
properties:
cpu_arch: x86_64
distro: ubuntu
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
image dictionary | Словарь с описанием образа Glance. Возвращается: При успешном выполнении, если значение state равно |
|
architecture string |
Архитектура ЦП, которую должен поддерживать гипервизор. Возвращается: при успешном выполнении |
|
checksum string |
Контрольная сумма образа. Возвращается: при успешном выполнении |
|
container_format string |
Формат контейнера образа. Возвращается: при успешном выполнении |
|
created_at string |
Временная отметка создания образа. Возвращается: при успешном выполнении |
|
direct_url string |
URL для доступа к файлу образа, хранящемуся во внешнем хранилище. Возвращается: при успешном выполнении |
|
disk_format string |
Формат диска образа. Возвращается: при успешном выполнении |
|
file string |
URL файла образа виртуальной машины. Возвращается: при успешном выполнении |
|
filters dictionary | Дополнительные свойства, связанные с образом. Возвращается: при успешном выполнении |
|
has_auto_disk_config boolean |
Указывает, изменяется ли автоматически размер корневого раздела диска перед загрузкой экземпляра. Возвращается: при успешном выполнении |
|
hash_algo string |
Алгоритм, используемый для вычисления криптографического хеша данных образа. Возвращается: при успешном выполнении |
|
hash_value string |
Шестнадцатеричное представление криптографического хеша данных образа, вычисленного с помощью алгоритма, имя которого указано в свойстве os_hash_algo. Возвращается: при успешном выполнении |
|
hw_cpu_cores string |
Используется для привязки виртуальных ЦП (vCPU) экземпляров к физическим ядрам ЦП (pCPU) хоста. Возвращается: при успешном выполнении |
|
hw_cpu_policy string |
Шестнадцатеричное представление криптографического хеша данных образа. Возвращается: при успешном выполнении |
|
hw_cpu_sockets string |
Предпочтительное количество сокетов, доступных гостевой системе. Возвращается: при успешном выполнении |
|
hw_cpu_thread_policy string |
Определяет, как использовать аппаратные потоки ЦП в архитектуре с одновременной многопоточностью (SMT). Возвращается: при успешном выполнении |
|
hw_cpu_threads string |
Предпочтительное количество потоков, доступных гостевой системе. Возвращается: при успешном выполнении |
|
hw_disk_bus string |
Указывает тип контроллера диска, к которому подключаются дисковые устройства. Возвращается: при успешном выполнении |
|
hw_machine_type string |
Позволяет загрузить систему ARM с указанным типом машины. Возвращается: при успешном выполнении |
|
hw_qemu_guest_agent string |
Логическое значение в виде строки: если указано ‘true’, экземпляру будет доступен гостевой агент QEMU. Возвращается: при успешном выполнении |
|
hw_rng_model string |
Добавляет экземплярам образа устройство генерации случайных чисел. Возвращается: при успешном выполнении |
|
hw_scsi_model string |
Разрешает использование VirtIO SCSI (virtio-scsi) для доступа вычислительных экземпляров к блочным устройствам. Возвращается: при успешном выполнении |
|
hw_video_model string |
Используемый видеодрайвер образа. Возвращается: при успешном выполнении |
|
hw_video_ram string |
Максимальный объем оперативной памяти для видеоадаптера образа. Возвращается: при успешном выполнении |
|
hw_vif_model string |
Указывает модель виртуального сетевого интерфейса. Возвращается: при успешном выполнении |
|
hw_watchdog_action string |
Включает виртуальное аппаратное устройство watchdog, выполняющее указанное действие при зависании сервера. Возвращается: при успешном выполнении |
|
hypervisor_type string |
Тип гипервизора. Возвращается: при успешном выполнении |
|
id string |
Уникальный UUID. Возвращается: при успешном выполнении |
|
instance_type_rxtx_factor string |
Необязательное свойство позволяет создавать серверы с ограничением пропускной способности, отличным от указанного в подключенной к ним сети. Возвращается: при успешном выполнении |
|
instance_uuid string |
Для образов-снимков — UUID сервера, использованного для создания этого образа. Возвращается: при успешном выполнении |
|
boolean |
Определяет, отображается ли образ в ответе со списком образов по умолчанию. Возвращается: при успешном выполнении |
|
boolean |
Включает меню загрузки BIOS. Возвращается: при успешном выполнении |
|
is_hw_vif_multiqueue_enabled boolean |
Включает функцию virtio-net multiqueue. Возвращается: при успешном выполнении |
|
is_protected boolean |
Флаг защиты образа. Возвращается: при успешном выполнении |
|
kernel_id string |
Идентификатор образа, хранящегося в службе Image и используемого в качестве ядра при загрузке образа типа AMI. Возвращается: при успешном выполнении |
|
locations string |
Список URL для доступа к файлу образа во внешнем хранилище. Возвращается: при успешном выполнении |
|
metadata string |
Метаданные местоположения. Возвращается: при успешном выполнении |
|
min_disk integer |
Минимальный объем дискового пространства, необходимый для этого образа. Возвращается: при успешном выполнении |
|
min_ram integer |
Минимальный объем оперативной памяти, необходимый для этого образа. Возвращается: при успешном выполнении |
|
name string |
Имя, присвоенное образу. Возвращается: при успешном выполнении |
|
needs_config_drive boolean |
Указывает, требуется ли образу конфигурационный диск. Возвращается: при успешном выполнении |
|
needs_secure_boot boolean |
Указывает, требуется ли безопасная загрузка (Secure Boot). Возвращается: при успешном выполнении |
|
os_admin_user string |
Имя пользователя-администратора операционной системы. Возвращается: при успешном выполнении |
|
os_command_line string |
Командная строка ядра, используемая драйвером libvirt. Возвращается: при успешном выполнении |
|
os_distro string |
Общепринятое название дистрибутива операционной системы в нижнем регистре. Возвращается: при успешном выполнении |
|
os_require_quiesce string |
Если значение равно true, при создании снимка требуется приостановка операций через гостевой агент QEMU. Возвращается: при успешном выполнении |
|
os_shutdown_timeout string |
Время, отводимое на корректное завершение работы. Возвращается: при успешном выполнении |
|
os_type string |
Операционная система, установленная в образе. Возвращается: при успешном выполнении |
|
os_version string |
Версия операционной системы, указанная дистрибьютором. Возвращается: при успешном выполнении |
|
owner string |
Владелец образа. Возвращается: при успешном выполнении |
|
owner_id string |
Идентификатор владельца или проекта, которому принадлежит образ. Возвращается: при успешном выполнении |
|
ramdisk_id string |
Идентификатор образа, хранящегося в службе Image и используемого в качестве ramdisk при загрузке образа типа AMI. Возвращается: при успешном выполнении |
|
schema string |
URL схемы, описывающей образ виртуальной машины. Возвращается: при успешном выполнении |
|
size integer |
Размер образа. Возвращается: при успешном выполнении |
|
status string |
Статус образа. Возвращается: при успешном выполнении |
|
store string |
Glance попытается сохранить данные образа диска в базовом хранилище, указанном значением заголовка. Возвращается: при успешном выполнении |
|
tags list / elements=string |
Список тегов, назначенных образу. Возвращается: при успешном выполнении |
|
updated_at string |
Временная отметка обновления образа. Возвращается: при успешном выполнении |
|
url string |
URL для доступа к файлу образа, хранящемуся во внешнем хранилище. Возвращается: при успешном выполнении |
|
virtual_size string |
Виртуальный размер образа. Возвращается: при успешном выполнении |
|
visibility string |
Указывает, кто имеет доступ к образу. Возвращается: при успешном выполнении |
|
vm_mode string |
Режим виртуальной машины. Возвращается: при успешном выполнении |
|
vmware_adaptertype string |
Виртуальный контроллер SCSI или IDE, используемый гипервизором. Возвращается: при успешном выполнении |
|
vmware_ostype string |
Операционная система, установленная в образе. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/image_module.html