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 - / обязательно		Варианты: machineaccount serviceaccount application	Тип используемых учетных данных.
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	Тип поддерживаемой функции. В настоящее время поддерживается только 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 -		По умолчанию: null	Используемый проект Google Cloud Platform.
raw_disk -			Параметры изображения raw диска.
	container_type -	Варианты: TAR	Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это всего лишь формат контейнера и передачи, а не формат выполнения. Предоставляется клиентом при создании изображения диска.
	sha1_checksum -		Необязательная сумма проверки SHA1 изображения диска до распаковки. Предоставляется клиентом при создании изображения диска.
	source -		Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны указать это свойство или свойство sourceDisk, но не оба.
scopes -			Массив используемых областей.
service_account_email -			Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file -			Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount.
source_disk -			Ссылка на объект gcompute_disk. Вы должны указать это свойство или свойство rawDisk.source, но не оба, чтобы создать изображение.
source_disk_encryption_key -			Предоставленный пользователем ключ шифрования исходного диска. Требуется, если исходный диск защищен предоставленным пользователем ключом шифрования.
	raw_key -		Указывает 256-битный предоставленный пользователем ключ шифрования, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.
	sha256 -		Закодированный в RFC 4648 base64 хэш SHA-256 предоставленного пользователем ключа шифрования, защищающего этот ресурс.
source_disk_id -			Значение ID диска, используемого для создания этого изображения. Это значение может быть использовано для определения, было ли изображение взято с текущего или предыдущего экземпляра с заданным именем диска.
source_type -		Варианты: RAW	Тип изображения, используемого для создания этого диска. По умолчанию и единственное значение — RAW.
state -		Варианты: present ← absent	Существует ли данный объект в 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 }}"
      state: present
  register: disk

- name: create a image
  gcp_compute_image:
      name: "test_object"
      source_disk: "{{ disk }}"
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Возвращаемые значения

Общие значения возвращаемых данных описаны здесь, ниже приведены поля, уникальные для данного модуля:

Ключ		Возвращаемое значение	Описание
archive_size_bytes целое число		успешно	Размер архива tar.gz изображения, хранящегося в Google Cloud Storage (в байтах).
creation_timestamp строка		успешно	Отметка времени создания в формате RFC3339.
deprecated сложное		успешно	Статус устаревания, связанный с этим изображением.
	deleted строка	успешно	Необязательная отметка времени RFC3339, после которой состояние этого ресурса предполагается изменить на УДАЛЕНО. Это только информационно и статус не изменится, если клиент явно его не изменит.
	deprecated строка	успешно	Необязательная отметка времени RFC3339, после которой состояние этого ресурса предполагается изменить на УСТАРЕВШИЙ. Это только информационно и статус не изменится, если клиент явно его не изменит.
	obsolete строка	успешно	Необязательная отметка времени RFC3339, после которой состояние этого ресурса предполагается изменить на УСТЕРЕВШИЙ. Это только информационно и статус не изменится, если клиент явно его не изменит.
	replacement строка	успешно	URL рекомендуемой замены для устаревшего ресурса. Рекомендуемый ресурс замены должен быть того же типа, что и устаревший ресурс.
	state строка	успешно	Состояние устаревания этого ресурса. Может быть УСТАРЕВШИЙ, УСТЕРЕВШИЙ или УДАЛЁННЫЙ. Операции, которые создают новый ресурс с использованием устаревшего ресурса, будут выполнены успешно, но с предупреждением, указывающим на устаревший ресурс и рекомендуя замену. Операции, использующие устаревшие или удаленные ресурсы, будут отклонены и приведут к ошибке.
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-изображение. Это значение носит чисто информационный характер и не включает или выключает какие-либо функции.
id целое число		успешно	Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
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])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
raw_disk сложное		успешно	Параметры изображения необработанного диска.
	container_type строка	успешно	Формат, используемый для кодирования и передачи блока устройства, который должен быть TAR. Это просто контейнер и формат передачи, а не формат выполнения. Предоставляется клиентом при создании образа диска.
	sha1_checksum строка	успешно	Необязательная контрольная сумма SHA1 изображения диска перед распаковкой. Это предоставляется клиентом при создании образа диска.
	source строка	успешно	Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны предоставить либо это свойство, либо свойство sourceDisk, но не оба.
source_disk словарь		успешно	Ссылается на объект gcompute_disk. Вы должны предоставить либо это свойство, либо свойство rawDisk.source, но не оба, для создания изображения.
source_disk_encryption_key сложное		успешно	Ключ шифрования, предоставленный клиентом, для исходного диска. Требуется, если исходный диск защищен ключом шифрования, предоставленным клиентом.
	raw_key строка	успешно	Указывает 256-битный предоставленный клиентом ключ шифрования, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.
	sha256 строка	успешно	Закодированный в RFC 4648 base64 SHA-256 хеш предоставленного клиентом ключа шифрования, который защищает этот ресурс.
source_disk_id строка		успешно	Значение ID диска, используемого для создания этого изображения. Это значение может использоваться для определения, было ли изображение взято с текущего или предыдущего экземпляра диска с заданным именем.
source_type строка		успешно	Тип изображения, используемого для создания этого диска. Значение по умолчанию и единственное значение — RAW.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/gcp_compute_image_module.html