google.cloud.gcp_compute_snapshot модуль – Создает снимок GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные зависимости. Подробнее см. Требования.

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_snapshot.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Представляет ресурс снимка диска постоянного хранения.
Используйте снимки для резервного копирования данных с дисков постоянного хранения. Снимки отличаются от общедоступных и пользовательских образов, которые в основном используются для создания экземпляров или настройки шаблонов экземпляров. Снимки полезны для периодического резервного копирования данных на дисках постоянного хранения. Вы можете создавать снимки с дисков постоянного хранения, даже если они подключены к работающим экземплярам.
Снимки являются инкрементными, поэтому вы можете создавать регулярные снимки на диске постоянного хранения быстрее и значительно дешевле, чем если бы вы регулярно создавали полную копию диска.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / required	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Необязательное описание этого ресурса.
env_type string	Указывает, в какой среде Ansible вы запускаете этот модуль. Это не должно быть установлено, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
labels dictionary	Метки для применения к этому снимку.
name string / required	Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project string	Проект Google Cloud Platform для использования.
scopes list / elements=string	Массив областей для использования
service_account_contents jsonarg	Содержимое файла Service Account JSON, либо в словаре, либо в виде JSON-строки, которая его представляет.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к файлу Service Account JSON, если в качестве типа выбран serviceaccount.
snapshot_encryption_key dictionary	Предоставленный клиентом ключ шифрования снимка. Требуется, если исходный снимок защищен предоставленным клиентом ключом шифрования.
kms_key_name string	Имя ключа шифрования, хранящегося в Google Cloud KMS.
kms_key_service_account string	Учетная запись службы, используемая для запроса шифрования для данного ключа KMS. При отсутствии используется учетная запись службы агента службы Compute Engine.
raw_key string	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 RFC 4648 для шифрования или дешифрования этого ресурса.
source_disk dictionary / required	Ссылка на диск, используемый для создания этого снимка. Это поле представляет собой ссылку на ресурс Disk в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «name» и значением имени вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` в задачу gcp_compute_disk, а затем установить это поле source_disk в «{{ name-of-resource }}»
source_disk_encryption_key dictionary	Предоставленный клиентом ключ шифрования исходного снимка. Требуется, если исходный снимок защищен предоставленным клиентом ключом шифрования.
kms_key_name string	Имя ключа шифрования, хранящегося в Google Cloud KMS.
kms_key_service_account string	Учетная запись службы, используемая для запроса шифрования для данного ключа KMS. При отсутствии используется учетная запись службы агента службы Compute Engine.
raw_key string	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 RFC 4648 для шифрования или дешифрования этого ресурса.
state string	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (default) `"absent"`
storage_locations list / elements=string	Расположение хранилища Cloud Storage bucket снимка (региональное или многорегиональное).

zone

string

Ссылка на зону, в которой размещён диск.

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/snapshots
Официальная документация: https://cloud.google.com/compute/docs/disks/create-snapshots
для аутентификации можно установить service_account_file, используя переменную среды GCP_SERVICE_ACCOUNT_FILE.
для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить access_token, используя переменную среды GCP_ACCESS_TOKEN.
Для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге сценариев не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a disk
  google.cloud.gcp_compute_disk:
    name: disk-snapshot
    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 snapshot
  google.cloud.gcp_compute_snapshot:
    name: test_object
    source_disk: "{{ disk }}"
    zone: us-central1-a
    labels:
      my_label: value
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ	Описание
creationTimestamp строка	Маркер создания в формате RFC3339. Возвращается: успех
description строка	Необязательное описание этого ресурса. Возвращается: успех
diskSizeGb целое число	Размер снимка в ГБ. Возвращается: успех
id целое число	Уникальный идентификатор ресурса. Возвращается: успех
labelFingerprint строка	Отпечаток метки, используемый для оптимистической блокировки этого ресурса. Используется во внутренних обновлениях. Возвращается: успех
labels словарь	Метки, применяемые к этому снимку. Возвращается: успех
licenses список / элементы=строка	Список общедоступных лицензий, применяемых к этому снимку. Это может быть связано с тем, что к исходному изображению были прикреплены лицензии (например, к изображению Windows). Вложенный объект snapshotEncryptionKey Шифрует снимок с помощью предоставленного клиентом ключа шифрования. Возвращается: успех
name строка	Имя ресурса, предоставленное клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается:* успех
snapshotEncryptionKey сложная	Ключ шифрования, предоставленный клиентом, для снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом. Возвращается: успех
kmsKeyName строка	Имя ключа шифрования, хранящегося в Google Cloud KMS. Возвращается: успех
kmsKeyServiceAccount строка	Учетная запись службы, используемая для запроса шифрования для данного ключа KMS. Если отсутствует, используется учетная запись службы агента Compute Engine. Возвращается: успех
rawKey строка	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. Возвращается: успех
sha256 строка	Закодированный в RFC 4648 base64 хеш SHA-256 предоставленного клиентом ключа шифрования, который защищает этот ресурс. Возвращается: успех
sourceDisk словарь	Ссылка на диск, используемый для создания этого снимка. Возвращается: успех
sourceDiskEncryptionKey сложная	Ключ шифрования, предоставленный клиентом, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом. Возвращается: успех
kmsKeyName строка	Имя ключа шифрования, хранящегося в Google Cloud KMS. Возвращается: успех
kmsKeyServiceAccount строка	Учетная запись службы, используемая для запроса шифрования для данного ключа KMS. Если отсутствует, используется учетная запись службы агента Compute Engine. Возвращается: успех
rawKey строка	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. Возвращается: успех
storageBytes целое число	Размер используемого хранилища снимка. Поскольку снимки используют общее хранилище, это число, ожидается, изменится при создании/удалении снимка. Возвращается: успех

storageLocations список / элементы=строка	Расположение хранилища Cloud Storage снимка (региональное или многорегиональное). Возвращается: успех
zone строка	Ссылка на зону, где размещён диск. Возвращается: успех

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_snapshot_module.html