gcp_compute_image_facts – Сбор фактов для образа GCP
Новое в версии 2.7.
Обзор
- Сбор фактов для образа GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.
Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей видимости. | |
| service_account_contents строка | Строка, представляющая содержимое JSON-файла учетной записи сервиса. Не следует передавать это как словарь, а строку, содержащую точное содержимое файла json учетной записи сервиса (валидный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к JSON-файлу учетной записи сервиса, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить 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: " a image facts"
gcp_compute_image_facts:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Значения возврата
Общие значения возврата описаны здесь, а следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| items сложный | всегда | Список элементов | ||
| archiveSizeBytes целое число | успех | Размер архива изображения tar.gz, хранящегося в Google Cloud Storage (в байтах). | ||
| creationTimestamp строка | успех | Маркер создания в формате RFC3339. | ||
| deprecated сложный | успех | Статус устаревания, связанный с этим изображением. | ||
| deleted строка | успех | Необязательный маркер времени RFC3339, начиная с которого состояние этого ресурса должно измениться на УДАЛЕННЫЙ. Это только информационная информация, и статус не изменится, пока клиент явно не изменит его. | ||
| deprecated строка | успех | Необязательный маркер времени RFC3339, начиная с которого состояние этого ресурса должно измениться на УСТАРЕВШИЙ. Это только информационная информация, и статус не изменится, пока клиент явно не изменит его. | ||
| obsolete строка | успех | Необязательный маркер времени RFC3339, начиная с которого состояние этого ресурса должно измениться на ЗАМЕНЁННЫЙ. Это только информационная информация, и статус не изменится, пока клиент явно не изменит его. | ||
| replacement строка | успех | URL рекомендуемой замены для устаревшего ресурса. Рекомендуемый ресурс замены должен быть того же типа, что и устаревший ресурс. | ||
| state строка | успех | Состояние устаревания этого ресурса. Может быть УСТАРЕВШИЙ, ЗАМЕНЁННЫЙ или УДАЛЁННЫЙ. Операции, создающие новый ресурс с использованием устаревшего ресурса, будут успешно выполнены, но с предупреждением, указывающим на устаревший ресурс и рекомендуя его замену. Операции, использующие устаревшие или удалённые ресурсы, будут отклонены и приведут к ошибке. | ||
| 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_facts_module.html