gcp_compute_snapshot – Создаёт снимок GCP
Новая версия с 2.9.
Описание
- Представляет ресурс снимка постоянного диска.
- Используйте снимки для резервного копирования данных с постоянных дисков. Снимки отличаются от общедоступных и настраиваемых образов, которые в основном используются для создания экземпляров или настройки шаблонов экземпляров. Снимки полезны для периодического резервного копирования данных на постоянных дисках. Вы можете создавать снимки с постоянных дисков, даже если они подключены к работающим экземплярам.
- Снимки являются инкрементными, поэтому вы можете создавать регулярные снимки на постоянном диске быстрее и с гораздо меньшими затратами, чем если бы вы регулярно создавали полную копию диска.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| description строка | Необязательное описание этого ресурса. | ||
| env_type строка | Указывает, в какой среде Ansible вы запускаете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API. | ||
| labels словарь | Метки, применяемые к этому снимку. | ||
| name строка / обязательно | Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||
| project строка | Проект Google Cloud Platform, который нужно использовать. | ||
| scopes список | Массив используемых областей. | ||
| service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы, либо в словаре, либо как JSON-строка, представляющая его. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к JSON-файлу учетной записи службы, если в качестве типа выбран serviceaccount. | ||
| snapshot_encryption_key словарь | Ключ шифрования, предоставленный клиентом, для снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом. | ||
| kms_key_name строка | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| raw_key строка | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 RFC 4648 для шифрования или дешифрования этого ресурса. | ||
| source_disk словарь / обязательно | Ссылка на диск, используемый для создания этого снимка. Это поле представляет собой ссылку на ресурс диска GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_disk, а затем установить это поле source_disk в "{{ name-of-resource }}" | ||
| source_disk_encryption_key словарь | Ключ шифрования, предоставленный клиентом, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом. | ||
| kms_key_name строка | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| raw_key строка | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 RFC 4648 для шифрования или дешифрования этого ресурса. | ||
| state строка |
| Должен ли данный объект существовать в GCP | |
| zone строка | Ссылка на зону, в которой размещён диск. | ||
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/snapshots
- Официальная документация: https://cloud.google.com/compute/docs/disks/create-snapshots
- для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить 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-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
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 строка | success | Отметка времени создания в формате RFC3339. | |
| description строка | success | Необязательное описание этого ресурса. | |
| diskSizeGb целое число | success | Размер снимка в ГБ. | |
| id целое число | success | Уникальный идентификатор ресурса. | |
| labelFingerprint строка | success | Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во время обновлений. | |
| labels словарь | success | Метки, применяемые к этому снимку. | |
| licenses список | success | Список общедоступных лицензий, применяемых к этому снимку. Это может быть связано с тем, что исходный образ содержал лицензии (например, образ Windows). Вложенный объект snapshotEncryptionKey Шифрует снимок с использованием предоставленного клиентом ключа шифрования. | |
| name строка | success | Имя ресурса, предоставленное клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Точнее, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| snapshotEncryptionKey сложный | success | Ключ шифрования, предоставленный клиентом для снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом. | |
| kmsKeyName строка | success | Имя ключа шифрования, хранящегося в Google Cloud KMS. | |
| rawKey строка | success | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | success | RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного клиентом, защищающего этот ресурс. | |
| sourceDisk словарь | success | Ссылка на диск, используемый для создания этого снимка. | |
| sourceDiskEncryptionKey сложный | success | Ключ шифрования, предоставленный клиентом для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом. | |
| kmsKeyName строка | success | Имя ключа шифрования, хранящегося в Google Cloud KMS. | |
| rawKey строка | success | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| storageBytes целое число | success | Размер хранилища, используемого снимком. Так как снимки совместно используют хранилище, это число ожидается, что будет меняться при создании/удалении снимков. | |
| zone строка | success | Ссылка на зону, где размещен диск. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [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.9/modules/gcp_compute_snapshot_module.html