Модуль openstack.cloud.image – Управление образами службы OpenStack image (Glance).
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в playbook, укажите: openstack.cloud.image.
Краткое описание
- Создание или удаление образов в службе OpenStack image (Glance).
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Как долго слой сокета должен ждать перед истечением времени ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов. |
auth dictionary | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, требуемые этим плагином аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом. |
ca_cert aliases: cacert string | Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов API SSL. |
checksum string | Контрольная сумма образа. |
client_cert aliases: cert string | Путь к клиентскому сертификату, используемому как часть транзакции SSL. |
client_key aliases: 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 | Идентификатор образа при загрузке образа. Этот атрибут образа не может быть изменен. |
interface aliases: endpoint_type string | Тип URL конечной точки для извлечения из каталога служб. Варианты:
|
is_protected aliases: protected boolean | Запретить удаление образа. Варианты:
|
is_public boolean | Может ли образ быть доступен публично. Установка is_public в is_public устарел. Используйте visibility вместо is_public. Варианты:
|
kernel string | Имя существующего образа ядра, которое будет связано с этим образом. |
min_disk integer | Минимальный объем дискового пространства (в ГБ), необходимый для загрузки этого образа. |
min_ram integer | Минимальный объем оперативной памяти (в МБ), необходимый для загрузки этого образа. |
name string / required | Имя образа при загрузке — или имя/идентификатор образа при удалении. Если указан идентификатор, он может использоваться для изменения имени существующего образа. |
owner aliases: project string | Имя или идентификатор проекта, которому принадлежит образ. |
owner_domain aliases: project_domain string | Имя или идентификатор домена, которому принадлежит проект, владеющий образом. Может использоваться для идентификации уникального проекта при указании имени в аргументе проекта и существовании нескольких проектов с таким именем. |
properties dictionary | Дополнительные свойства, которые будут связаны с этим образом. По умолчанию: |
ramdisk string | Имя существующего образа ramdisk, который будет связан с этим образом. |
region_name string | Имя региона. |
sdk_log_level string | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
state string | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
tags list / elements=string | Список тегов, которые необходимо применить к образу. Значение по умолчанию: |
timeout integer | Как долго Ansible должен ждать запрашиваемый ресурс. Значение по умолчанию: |
validate_certs aliases: verify boolean | Следует ли проверять запросы SSL API. До Ansible 2.3 значение по умолчанию было Варианты:
|
visibility string | Видимость образа. Варианты:
|
volume string | ID тома для создания образа. Том должен быть в состоянии 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 |
Используется для привязки виртуальных ЦП (vCPUs) экземпляров к физическим ядрам ЦП (pCPUs) хоста. Возвращается: успех |
|
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 |
Включает виртуальное устройство сторожевого таймера, которое выполняет указанное действие, если сервер зависает. Возвращается: успех |
|
hypervisor_type string |
Тип гипервизора. Возвращается: успех |
|
id string |
Уникальный UUID. Возвращается: успех |
|
instance_type_rxtx_factor string |
Необязательное свойство позволяет созданным серверам иметь другой лимит пропускной способности, чем тот, который определен в сети, к которой они подключены. Возвращено: success |
|
instance_uuid string |
Для снимков это UUID сервера, используемый для создания этого образа. Возвращено: success |
|
boolean |
Управляет тем, отображается ли образ в ответе списка образов по умолчанию. Возвращено: success |
|
boolean |
Включает меню загрузки BIOS. Возвращено: success |
|
is_hw_vif_multiqueue_enabled boolean |
Включает функцию virtio-net multiqueue. Возвращено: success |
|
is_protected boolean |
Флаг защиты образа. Возвращено: success |
|
kernel_id string |
ID образа, хранящегося в службе образов, который должен использоваться в качестве ядра при загрузке образа в стиле AMI. Возвращено: success |
|
locations string |
Список URL-адресов для доступа к файлу образа во внешнем хранилище. Возвращено: success |
|
metadata string |
Метаданные местоположения. Возвращено: success |
|
min_disk integer |
Минимальный объем дискового пространства, требуемый для этого образа. Возвращено: success |
|
min_ram integer |
Минимальный объем ОЗУ, требуемый для этого образа. Возвращено: success |
|
name string |
Имя, присвоенное образу. Возвращено: success |
|
needs_config_drive boolean |
Указывает, требуется ли образу диск конфигурации. Возвращено: success |
|
needs_secure_boot boolean |
Требуется ли безопасная загрузка. Возвращено: success |
|
os_admin_user string |
Имя администратора операционной системы. Возвращено: success |
|
os_command_line string |
Командная строка ядра, которая будет использоваться драйвером libvirt. Возвращено: success |
|
os_distro string |
Обычное имя дистрибутива операционной системы в нижнем регистре. Возвращено: success |
|
os_require_quiesce string |
Если true, требуется остановка через агент гостевой системы QEMU. Возвращено: success |
|
os_shutdown_timeout string |
Время корректного завершения работы. Возвращено: success |
|
os_type string |
Установленная на образе операционная система. Возвращено: success |
|
os_version string |
Версия операционной системы, указанная дистрибутором. Возвращено: success |
|
owner string |
Владелец образа. Возвращено: success |
|
owner_id string |
ID владельца или проекта образа. Возвращено: success |
|
ramdisk_id string |
ID образа, хранящегося в службе образов, который должен использоваться в качестве RAM-диска при загрузке образа в стиле AMI. Возвращено: success |
|
schema string |
URL-адрес схемы, описывающей образ виртуальной машины. Возвращено: success |
|
size integer |
Размер образа. Возвращено: success |
|
status string |
Статус образа. Возвращено: success |
|
store string |
Glance попытается сохранить данные дискового образа во вспомогательном хранилище, указанном значением заголовка. Возвращено: success |
|
tags list / elements=string |
Список тегов, назначенных образу Возвращено: success |
|
updated_at string |
Метка времени последнего обновления образа. Возвращено: success |
|
url string |
URL для доступа к файлу образа, хранящемуся во внешнем хранилище. Возвращено: success |
|
virtual_size string |
Виртуальный размер образа. Возвращено: success |
|
visibility string |
Указывает, кто имеет доступ к образу. Возвращено: success |
|
vm_mode string |
Режим виртуальной машины. Возвращено: success |
|
vmware_adaptertype string |
Виртуальный SCSI или IDE контроллер, используемый гипервизором. Возвращено: success |
|
vmware_ostype string |
Операционная система, установленная в образе. Возвращено: success |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/image_module.html