os_image – Добавление/удаление изображений из OpenStack Cloud
Описание
- Добавление или удаление изображений из репозитория изображений OpenStack
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать программа, прежде чем произойдет таймаут для вызовов API. Если этот параметр опущен, к библиотеке requests ничего не будет передано. | |
| 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 строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| is_public булево |
| Доступно ли изображение для публичного доступа. Обратите внимание, что публикация изображения требует роли администратора по умолчанию. |
| kernel - | Имя существующего ядра изображения, которое будет связано с этим изображением | |
| min_disk - | Минимальный объем диска (в ГБ), необходимый для загрузки этого изображения | |
| min_ram - | Минимальный объем ОЗУ (в МБ), необходимый для загрузки этого изображения | |
| name - / обязательно | Имя изображения при загрузке - или имя/ID изображения при удалении | |
| owner - | Владелец изображения | |
| properties - | Значение по умолчанию: {} | Дополнительные свойства, которые будут связаны с этим изображением |
| protected булево добавлено в 2.9 |
| Запретить удаление изображения |
| ramdisk - | Имя существующего изображения ramdisk, которое будет связано с этим изображением | |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть присутствовать или отсутствовать. |
| 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, затем из стандартных переменных окружения, и, наконец, явными параметрами в играх. Более подробную информацию можно найти на странице 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. [сообщество]
Авторы
- 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.9/modules/os_image_module.html
