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 для шифрования или расшифровки этого ресурса. | ||
| labels - добавлено в 2.8 | Метки для применения к этому изображению. | ||
| licenses - | Любой применимый URI лицензии. | ||
| name - / обязательно | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| project строка | Проект Google Cloud Platform для использования. | ||
| raw_disk - | Параметры изображения необработанного диска. | ||
| container_type - |
| Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это всего лишь формат контейнера и передачи, а не формат выполнения. Предоставляется клиентом при создании образа диска. | |
| sha1_checksum - | Необязательная контрольная сумма SHA1 образа диска перед распаковкой. Это предоставляется клиентом при создании образа диска. | ||
| source - / обязательно | Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны указать либо это свойство, либо свойство sourceDisk, но не оба. | ||
| scopes список | Массив используемых областей. | ||
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а строка, содержащая точное содержимое файла service account json (валидный JSON). | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | ||
| source_disk - | Исходный диск для создания этого изображения. Вы должны указать либо это свойство, либо свойство rawDisk.source, но не оба, чтобы создать изображение. Это поле представляет ссылку на ресурс «Диск» в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Или вы можете добавить `register: имя-ресурса` в задачу gcp_compute_disk, а затем установить это поле source_disk в "{{ имя-ресурса }}" | ||
| source_disk_encryption_key - | Ключ шифрования, предоставленный пользователем, для исходного диска. Требуется, если исходный диск защищен ключом шифрования, предоставленным пользователем. | ||
| raw_key - | Указывает 256-битный предоставленный пользователем ключ шифрования, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. | ||
| source_disk_id - | Значение идентификатора диска, используемого для создания этого изображения. Это значение может быть использовано для определения того, был ли образ взят из текущего или предыдущего экземпляра данного имени диска. | ||
| source_type - |
| Тип образа, используемого для создания этого диска. Значение по умолчанию и единственное значение — RAW. | |
| state - |
| Необходимо ли наличие данного объекта в GCP | |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/v1/images
- Официальная документация: https://cloud.google.com/compute/docs/images
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге сценариев не установлены.
- Параметры 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| archiveSizeBytes целое число | успех | Размер архива изображения tar.gz, хранящегося в Google Cloud Storage (в байтах). | |
| creationTimestamp строка | успех | Маркер создания в формате RFC3339. | |
| deprecated сложный тип | успех | Статус устаревания, связанный с этим изображением. | |
| deleted строка | успех | Необязательный временной маркер RFC3339, начиная с которого состояние этого ресурса должно измениться на DELETED. Эта информация носит информационный характер, и статус не изменится, пока клиент явно его не изменит. | |
| deprecated строка | успех | Необязательный временной маркер RFC3339, начиная с которого состояние этого ресурса должно измениться на DEPRECATED. Эта информация носит информационный характер, и статус не изменится, пока клиент явно его не изменит. | |
| obsolete строка | успех | Необязательный временной маркер RFC3339, начиная с которого состояние этого ресурса должно измениться на OBSOLETE. Эта информация носит информационный характер, и статус не изменится, пока клиент явно его не изменит. | |
| replacement строка | успех | URL рекомендуемого замещения устаревшего ресурса. Рекомендуемый заменяющий ресурс должен быть того же типа, что и устаревший ресурс. | |
| state строка | успех | Состояние устаревания этого ресурса. Может быть DEPRECATED, OBSOLETE или DELETED. Операции, создающие новый ресурс, используя устаревший ресурс, будут выполнены успешно, но с предупреждением, указывающим на устаревший ресурс и рекомендующее его замену. Операции, использующие устаревшие или удаленные ресурсы, будут отклонены и приведут к ошибке. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| diskSizeGb целое число | успех | Размер изображения при восстановлении на постоянный диск (в ГБ). | |
| family строка | успех | Имя семейства изображений, к которому принадлежит это изображение. Вы можете создавать диски, указав семейство изображений вместо имени конкретного изображения. Семейство изображений всегда возвращает последнее не устаревшее изображение. Имя семейства изображений должно соответствовать RFC1035. | |
| guestOsFeatures сложный тип | успех | Список функций, которые необходимо включить в гостевую операционную систему. Применимо только для загружаемых изображений. В настоящее время можно включить только одну функцию, 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 целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | |
| imageEncryptionKey сложный тип | успех | Шифрует изображение с помощью предоставленного клиентом ключа шифрования. После шифрования изображения с помощью предоставленного клиентом ключа, необходимо предоставить тот же ключ, если вы используете изображение позже (например, для создания диска из изображения). | |
| rawKey строка | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате RFC 4648 base64 для шифрования или расшифрования этого ресурса. | |
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | |
| labelFingerprint строка | успех | Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во время обновлений. | |
| labels словарь | успех | Метки, применяемые к этому изображению. | |
| licenses список | успех | Любой применимый URI лицензии. | |
| name строка | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Конкретно, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| rawDisk сложный тип | успех | Параметры изображения raw-диска. | |
| containerType строка | успех | Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это просто формат контейнера и передачи, а не формат выполнения. Предоставляется клиентом при создании образа диска. | |
| sha1Checksum строка | успех | Необязательная контрольная сумма SHA1 образа диска перед распаковкой. Это предоставляется клиентом при создании образа диска. | |
| source строка | успех | Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны предоставить это свойство или свойство sourceDisk, но не оба. | |
| sourceDisk словарь | успех | Исходный диск для создания этого образа. Вы должны предоставить это свойство или свойство rawDisk.source, но не оба, чтобы создать образ. | |
| sourceDiskEncryptionKey сложный тип | успех | Ключ шифрования, предоставленный клиентом, для исходного диска. Требуется, если исходный диск защищен предоставленным клиентом ключом шифрования. | |
| rawKey строка | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате RFC 4648 base64 для шифрования или расшифрования этого ресурса. | |
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | |
| sourceDiskId строка | успех | Значение ID диска, используемого для создания этого образа. Это значение может быть использовано для определения, был ли образ взят с текущего или предыдущего экземпляра с заданным именем диска. | |
| sourceType строка | успех | Тип изображения, используемого для создания этого диска. По умолчанию и единственное значение — RAW. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/gcp_compute_image_module.html
