gcp_compute_image - Создаёт изображение GCP
Новая версия с 2.6.
Описание
- Представляет ресурс изображения.
- Google Compute Engine использует образы операционных систем для создания корневых постоянных дисков для ваших виртуальных машин. Вы указываете образ при создании виртуальной машины. Образы содержат загрузчик, операционную систему и корневую файловую систему. Образы Linux также способны запускать контейнеры в Compute Engine.
- Образы могут быть публичными или пользовательскими.
- Публичные образы предоставляются и поддерживаются Google, сообществами с открытым исходным кодом и сторонними поставщиками. По умолчанию все проекты имеют доступ к этим образам и могут использовать их для создания виртуальных машин. Пользовательские образы доступны только для вашего проекта. Вы можете создать пользовательский образ из корневых постоянных дисков и других образов. Затем используйте пользовательский образ для создания виртуальной машины.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind обязательно |
| Тип используемых учетных данных. | |
| description | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| disk_size_gb | Размер образа при восстановлении на постоянный диск (в ГБ). | ||
| family | Имя семейства образов, к которому принадлежит данный образ. Вы можете создать диски, указав семейство образов вместо имени конкретного образа. Семейство образов всегда возвращает свой последний не устаревший образ. Имя семейства образов должно соответствовать RFC1035. | ||
| guest_os_features | Список функций, которые необходимо включить в гостевой ОС. Применимо только для загрузочных образов. В настоящее время можно включить только одну функцию, VIRTIO_SCSI_MULTIQUEUE, которая позволяет каждой виртуальной ЦП иметь свою очередь. Для образов Windows вы можете включить VIRTIO_SCSI_MULTIQUEUE только в образах с версией драйвера 1.2.0.1621 или выше. Образы Linux с ядром версии 3.17 и выше будут поддерживать VIRTIO_SCSI_MULTIQUEUE. Для новых образов Windows сервер также может заполнить это поле значением WINDOWS, чтобы указать, что это образ Windows. Это значение является чисто информативным и не включает или отключает какие-либо функции. | ||
| type |
| Тип поддерживаемой функции. В настоящее время поддерживается только VIRTIO_SCSI_MULTIQUEUE. Для новых образов Windows сервер также может заполнить это свойство значением WINDOWS, чтобы указать, что это образ Windows. Это значение является чисто информативным и не включает или отключает какие-либо функции. | |
| image_encryption_key | Шифрует образ с использованием предоставленного пользователем ключа шифрования. После шифрования образа с использованием ключа, предоставленного пользователем, необходимо предоставить тот же ключ, если вы используете образ позже (например, для создания диска из образа). | ||
| raw_key | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. | ||
| sha256 | Закодированный в RFC 4648 base64 SHA-256 хеш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| licenses | Любой применимый URI лицензии. | ||
| name обязательно | Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. Точнее, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| project | Проект Google Cloud Platform для использования. | ||
| raw_disk | Параметры образа raw диска. | ||
| container_type |
| Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это просто формат контейнера и передачи, а не формат выполнения. Предоставляется клиентом при создании образа диска. | |
| sha1_checksum | Необязательная контрольная сумма SHA1 образа диска до распаковки. Это предоставляется клиентом при создании образа диска. | ||
| source | Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны указать либо это свойство, либо свойство sourceDisk, но не оба одновременно. | ||
| scopes обязательно | Массив используемых областей. | ||
| service_account_email | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | ||
| source_disk | Ссылка на ресурс диска. | ||
| source_disk_encryption_key | Ключ шифрования, предоставленный пользователем, для исходного диска. Необходим, если исходный диск защищен ключом шифрования, предоставленным пользователем. | ||
| raw_key | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. | ||
| sha256 | Закодированный в RFC 4648 base64 SHA-256 хеш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| source_disk_id | Значение идентификатора диска, используемого для создания этого образа. Это значение может быть использовано для определения того, был ли образ взят из текущего или предыдущего экземпляра с заданным именем диска. | ||
| source_type |
| Тип образа, используемого для создания этого диска. Значение по умолчанию и единственное значение — RAW. | |
| state обязательно |
| Должен ли данный объект существовать в GCP | |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a disk
gcp_compute_disk:
name: 'disk-image'
zone: us-central1-a
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
scopes:
- https://www.googleapis.com/auth/compute
state: present
register: disk
- name: create a image
gcp_compute_image:
name: testObject
source_disk: "{{ disk }}"
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| archive_size_bytes int | success | Размер архива изображения tar.gz, хранящегося в Google Cloud Storage (в байтах). | |
| creation_timestamp str | success | Маркер времени создания в формате RFC3339. | |
| deprecated complex | success | Статус устаревания, связанный с этим изображением. | |
| deleted str | success | Необязательный маркер времени RFC3339, начиная с которого состояние этого ресурса планируется изменить на УДАЛЕННЫЙ. Это только информационное сообщение, и статус не изменится, пока клиент явно не изменит его. | |
| deprecated str | success | Необязательный маркер времени RFC3339, начиная с которого состояние этого ресурса планируется изменить на УСТАРЕВШИЙ. Это только информационное сообщение, и статус не изменится, пока клиент явно не изменит его. | |
| obsolete str | success | Необязательный маркер времени RFC3339, начиная с которого состояние этого ресурса планируется изменить на УСТАРЕВШИЙ. Это только информационное сообщение, и статус не изменится, пока клиент явно не изменит его. | |
| replacement str | success | URL предложенной замены для устаревшего ресурса. Предложенный ресурс замены должен быть такого же типа, как и устаревший ресурс. | |
| state str | success | Состояние устаревания этого ресурса. Может быть УСТАРЕВШИЙ, УСТАРЕВШИЙ или УДАЛЕННЫЙ. Операции, создающие новый ресурс с использованием устаревшего ресурса, будут выполнены успешно, но с предупреждением об устаревшем ресурсе и рекомендацией по его замене. Операции с использованием устаревших или удаленных ресурсов будут отклонены и приведут к ошибке. | |
| description str | success | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| disk_size_gb int | success | Размер изображения при восстановлении на постоянный диск (в ГБ). | |
| family str | success | Имя семейства изображений, к которому принадлежит это изображение. Вы можете создавать диски, указывая семейство изображений вместо имени конкретного изображения. Семейство изображений всегда возвращает последнее изображение, которое не устарело. Имя семейства изображений должно соответствовать RFC1035. | |
| guest_os_features complex | success | Список функций для включения в гостевой ОС. Применимо только для загрузочных изображений. В настоящее время можно включить только одну функцию, VIRTIO_SCSI_MULTIQUEUE, которая позволяет каждой виртуальной ЦП иметь свою очередь. Для Windows-изображений вы можете включить VIRTIO_SCSI_MULTIQUEUE только для изображений с версией драйвера 1.2.0.1621 или выше. Linux-изображения с версиями ядра 3.17 и выше будут поддерживать VIRTIO_SCSI_MULTIQUEUE. Для новых Windows-изображений сервер может также заполнить это поле значением WINDOWS, чтобы указать, что это Windows-изображение. Это значение является чисто информативным и не включает или выключает какие-либо функции. | |
| type str | success | Тип поддерживаемой функции. В настоящее время поддерживается только VIRTIO_SCSI_MULTIQUEUE. Для более новых Windows-изображений сервер также может заполнить это свойство значением WINDOWS, чтобы указать, что это Windows-изображение. Это значение является чисто информативным и не включает или выключает какие-либо функции. | |
| id int | success | Уникальный идентификатор ресурса. Этот идентификатор определен сервером. | |
| image_encryption_key complex | success | Шифрует изображение с помощью предоставленного клиентом ключа шифрования. После шифрования изображения с использованием предоставленного клиентом ключа необходимо предоставить тот же ключ, если изображение используется позже (например, для создания диска из изображения). | |
| raw_key str | success | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 str | success | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного клиентом, который защищает этот ресурс. | |
| licenses list | success | Любой применимый URI лицензии. | |
| name str | success | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| raw_disk complex | success | Параметры изображения сырого диска. | |
| container_type str | success | Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это просто контейнер и формат передачи, а не формат выполнения. Предоставляется клиентом при создании изображения диска. | |
| sha1_checksum str | success | Необязательная контрольная сумма SHA1 изображения диска до распаковки. Это предоставляется клиентом при создании изображения диска. | |
| source str | success | Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны указать либо это свойство, либо свойство sourceDisk, но не оба. | |
| source_disk dict | success | Ссылка на ресурс диска. | |
| source_disk_encryption_key complex | success | Ключ шифрования, предоставленный клиентом, для исходного диска. Требуется, если исходный диск защищен ключом шифрования, предоставленным клиентом. | |
| raw_key str | success | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 str | success | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного клиентом, который защищает этот ресурс. | |
| source_disk_id str | success | Идентификатор значения диска, использованного для создания этого изображения. Это значение может быть использовано для определения, было ли изображение взято с текущего или предыдущего экземпляра данного имени диска. | |
| source_type str | success | Тип изображения, используемого для создания этого диска. По умолчанию и единственное значение - RAW. | |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантирует обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gcp_compute_image_module.html
