google.cloud.gcp_compute_image_info – Сбор информации о GCP-изображении
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_compute_image_info.
Обзор
- Сбор информации о GCP-изображении
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Изменяет только строку User Agent для любых запросов к API. | |
| filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список / элементы=строка | Массив используемых областей | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, его представляющей. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных окружения будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on an image
gcp_compute_image_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | ||
| archiveSizeBytes integer | успех | Размер архива изображения tar.gz, хранящегося в Google Cloud Storage (в байтах). | ||
| creationTimestamp string | успех | Маркер создания в формате RFC3339. | ||
| deprecated complex | успех | Статус устаревания, связанный с этим изображением. | ||
| deleted string | успех | Необязательная метка времени RFC3339, после которой состояние этого ресурса планируется изменить на УДАЛЕН. Это только информационное сообщение, и статус не изменится, пока клиент явно не изменит его. | ||
| deprecated string | успех | Необязательная метка времени RFC3339, после которой состояние этого ресурса планируется изменить на УСТАРЕВШИЙ. Это только информационное сообщение, и статус не изменится, пока клиент явно не изменит его. | ||
| obsolete string | успех | Необязательная метка времени RFC3339, после которой состояние этого ресурса планируется изменить на УСТАРЕЛ. Это только информационное сообщение, и статус не изменится, пока клиент явно не изменит его. | ||
| replacement string | успех | URL рекомендуемого ресурса-замены для устаревшего ресурса. Рекомендуемый ресурс-замена должен быть того же типа, что и устаревший ресурс. | ||
| state string | успех | Состояние устаревания этого ресурса. Может быть УСТАРЕВШИЙ, УСТАРЕЛ или УДАЛЕН. Операции, создающие новый ресурс с использованием устаревшего ресурса, будут успешными, но с предупреждением, указывающим на устаревший ресурс и рекомендующие его замену. Операции, использующие устаревшие или удалённые ресурсы, будут отклонены и приведут к ошибке. | ||
| description string | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| diskSizeGb integer | успех | Размер изображения при восстановлении на постоянный диск (в ГБ). | ||
| family string | успех | Название семейства изображений, к которому принадлежит это изображение. Вы можете создавать диски, указав семейство изображений вместо имени конкретного изображения. Семейство изображений всегда возвращает последнее изображение, которое не устарело. Имя семейства изображений должно соответствовать RFC1035. | ||
| guestOsFeatures complex | успех | Список функций для включения в гостевой операционной системе. Применимо только для загружаемых изображений. | ||
| type string | успех | Тип поддерживаемой функции. | ||
| id integer | успех | Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером. | ||
| imageEncryptionKey complex | успех | Шифрует изображение с помощью предоставленного клиентом ключа шифрования. После шифрования изображения с помощью предоставленного клиентом ключа, вам необходимо предоставить тот же ключ, если вы используете изображение позже (например, для создания диска из изображения). | ||
| rawKey string | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 string | успех | Закодированный в формате RFC 4648 base64 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | ||
| labelFingerprint string | успех | Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется внутри во время обновлений. | ||
| labels dictionary | успех | Метки, применяемые к этому изображению. | ||
| licenses list / elements=string | успех | Любой соответствующий URI лицензии. | ||
| name string | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| rawDisk complex | успех | Параметры изображения набора сырых данных. | ||
| containerType string | успех | Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это просто формат контейнера и передачи, а не формат выполнения. Предоставляется клиентом при создании образа диска. | ||
| sha1Checksum string | успех | Необязательная контрольная сумма SHA1 образа диска перед распаковкой. Это предоставляется клиентом при создании образа диска. | ||
| source string | успех | Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны предоставить либо это свойство, либо свойство sourceDisk, но не оба. | ||
| sourceDisk dictionary | успех | Исходный диск для создания этого изображения на его основе. Для создания изображения вы должны предоставить либо это свойство, либо свойство rawDisk.source, но не оба. | ||
| sourceDiskEncryptionKey complex | успех | Ключ шифрования, предоставленный клиентом, исходного диска. Требуется, если исходный диск защищен ключом шифрования, предоставленным клиентом. | ||
| rawKey string | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 string | успех | Закодированный в формате RFC 4648 base64 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | ||
| sourceDiskId string | успех | Значение идентификатора диска, использованного для создания этого изображения. Это значение может быть использовано для определения, было ли изображение взято с текущего или предыдущего экземпляра с данным именем диска. | ||
| sourceImage dictionary | успех | URL исходного изображения, используемого для создания этого изображения. Для создания изображения необходимо предоставить полный или частичный URL одного из следующих: * URL selfLink * Это свойство * URL rawDisk.source * URL sourceDisk. | ||
| sourceSnapshot dictionary | успех | URL исходного снимка, используемого для создания этого изображения. Для создания изображения необходимо предоставить полный или частичный URL одного из следующих: * URL selfLink * Это свойство * URL sourceImage * URL rawDisk.source * URL sourceDisk. | ||
| sourceType string | успех | Тип изображения, используемого для создания этого диска. По умолчанию и единственное значение — RAW. | ||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_image_info_module.html
