Spec-Zone.ru › Ansible

google.cloud.gcp_compute_region_disk модуль – Создаёт GCP RegionDisk

Примечание

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

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

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

Для использования в плейбуке укажите: google.cloud.gcp_compute_region_disk.

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

Обзор

  • Постоянные диски — это долговременные устройства хранения, которые работают аналогично физическим дискам в настольном компьютере или сервере. Compute Engine управляет оборудованием, обеспечивая избыточность данных и оптимизируя производительность для вас. Постоянные диски доступны в виде жёстких дисков (HDD) или твердотельных дисков (SSD).
  • Постоянные диски расположены независимо от виртуальных машин, поэтому вы можете отсоединять или перемещать постоянные диски, чтобы сохранить данные даже после удаления ваших виртуальных машин. Производительность постоянных дисков автоматически масштабируется в зависимости от размера, поэтому вы можете изменить размер существующих постоянных дисков или добавить больше постоянных дисков к экземпляру, чтобы удовлетворить требования к производительности и объёму хранения.
  • Добавьте постоянный диск к экземпляру, когда вам необходим надёжный и доступный объём хранения со стабильными характеристиками производительности.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип учетных данных, используемых для аутентификации.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

description

строка

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

disk_encryption_key

словарь

Шифрует диск с использованием предоставленного клиентом ключа шифрования.

После шифрования диска с помощью предоставленного клиентом ключа, необходимо указать тот же ключ при последующем использовании диска (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине).

Ключи шифрования, предоставленные клиентом, не защищают доступ к метаданным диска.

Если при создании диска ключ шифрования не указан, диск будет зашифрован автоматически сгенерированным ключом, и вам не нужно указывать ключ для последующего использования диска.

raw_key

строка

Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.

env_type

строка

Указывает среду Ansible, в которой выполняется этот модуль.

Это поле не должно устанавливаться, если вы не знаете, что делаете.

Это поле изменяет только строку User Agent для всех запросов к API.

labels

словарь

Метки, применяемые к этому диску. Список пар ключ-значение.

licenses

список / элементы=строка

Любые применимые общедоступные лицензии.

name

строка / обязательно

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.

physical_block_size_bytes

целое число

Физический размер блока постоянного диска в байтах. Если этот параметр не указан в запросе, используется значение по умолчанию. В настоящее время поддерживаются размеры 4096 и 16384, в будущем могут быть добавлены другие размеры.

Если запрошено недопустимое значение, сообщение об ошибке укажет поддерживаемые значения для проекта вызывающего.

project

строка

Проект Google Cloud Platform, который следует использовать.

region

строка / обязательно

Ссылка на регион, в котором находится диск.

replica_zones

список / элементы=строка / обязательно

URL-адреса зон, в которые должен быть дублирован диск.

scopes

список / элементы=строка

Массив используемых областей видимости

service_account_contents

jsonarg

Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо в виде JSON-строки, его представляющей.

service_account_email

строка

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

service_account_file

путь

Путь к файлу JSON учетной записи сервиса, если тип выбран как serviceaccount.

size_gb

целое число

Размер постоянного диска в ГБ. Этот параметр можно указать при создании постоянного диска с использованием параметра sourceImage или sourceSnapshot, или указать его отдельно для создания пустого постоянного диска.

Если этот параметр указан вместе с sourceImage или sourceSnapshot, значение sizeGb должно быть не меньше размера sourceImage или размера снимка.

source_snapshot

словарь

Исходный снимок, используемый для создания диска. Можно указать частичный или полный URL-адрес ресурса.

Это поле представляет ссылку на ресурс Snapshot в GCP. Его можно указать двумя способами. Во-первых, можно указать словарь с ключом 'selfLink' и значением selfLink вашего ресурса. В качестве альтернативы, можно добавить `register: name-of-resource` к задаче gcp_compute_snapshot, а затем установить это поле source_snapshot в «{{ name-of-resource }}»

source_snapshot_encryption_key

словарь

Ключ шифрования, предоставленный клиентом, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом.
END_OF_DOCUMENT_MARKER

raw_key

string

Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.

state

string

Указывает, должен ли данный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

type

string

URL ресурса типа диска, описывающего тип диска, который необходимо использовать для создания диска. Укажите его при создании диска.

Примечания

Примечание

  • Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/regionDisks
  • Добавление или изменение размера региональных постоянных дисков: https://cloud.google.com/compute/docs/disks/regional-persistent-disk
  • для аутентификации можно установить 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 region disk
  google.cloud.gcp_compute_region_disk:
    name: test_object
    size_gb: 500
    disk_encryption_key:
      raw_key: SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=
    region: us-central1
    replica_zones:
    - https://www.googleapis.com/compute/v1/projects/google.com:graphite-playground/zones/us-central1-a
    - https://www.googleapis.com/compute/v1/projects/google.com:graphite-playground/zones/us-central1-b
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ

Описание

creationTimestamp

строка

Дата и время создания в формате RFC3339.

Возвращается: успех

description

строка

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

Возвращается: успех

diskEncryptionKey

сложное

Шифрует диск с помощью предоставленного пользователем ключа шифрования.

После шифрования диска с помощью предоставленного пользователем ключа, вы должны предоставить тот же ключ, если позже будете использовать диск (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине).

Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска.

Если вы не предоставите ключ шифрования при создании диска, диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для дальнейшего использования диска.

Возвращается: успех

rawKey

строка

Указывает 256-битный предоставленный пользователем ключ шифрования, закодированный в RFC 4648 base64 для шифрования или расшифрования данного ресурса.

Возвращается: успех

sha256

строка

RFC 4648 base64 закодированный SHA-256 хэш предоставленного пользователем ключа шифрования, защищающего данный ресурс.

Возвращается: успех

id

целое число

Уникальный идентификатор ресурса.

Возвращается: успех

labelFingerprint

строка

Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во внутренних обновлениях.

Возвращается: успех

labels

словарь

Метки для применения к этому диску. Список пар ключ-значение.

Возвращается: успех

lastAttachTimestamp

строка

Последняя метка времени подключения в формате RFC3339.

Возвращается: успех

lastDetachTimestamp

строка

Последняя метка времени отключения в формате RFC3339.

Возвращается: успех

licenses

список / элементы=строка

Любые применимые публично видимые лицензии.

Возвращается: успех

name

строка

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.

Возвращается: успех

physicalBlockSizeBytes

целое число

Физический размер блока постоянного диска в байтах. Если он не указан в запросе, используется значение по умолчанию. В настоящее время поддерживаются размеры 4096 и 16384, в будущем могут быть добавлены другие размеры.

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

Возвращается: успех

region

строка

Ссылка на регион, в котором находится диск.

Возвращается: успех

replicaZones

список / элементы=строка

URL зон, в которые должен быть реплицирован диск.

Возвращается: успех

sizeGb

целое число

Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его самостоятельно для создания пустого постоянного диска.

Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка.

Возвращается: успех

sourceSnapshot

словарь

Источник снимка, используемого для создания этого диска. Вы можете указать его как частичный или полный URL-адрес ресурса.

Возвращается: успех

sourceSnapshotEncryptionKey

сложное

Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем.

Возвращается: успех

rawKey

string

Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 по RFC 4648 для шифрования или дешифрования данного ресурса.

Возвращается: success

sha256

string

Значение RFC 4648 base64 закодированного хэша SHA-256 ключа шифрования, предоставленного клиентом, который защищает этот ресурс.

Возвращается: success

sourceSnapshotId

string

Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который использовался для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, идентификатор исходного снимка идентифицирует точную версию снимка, которая была использована.

Возвращается: success

type

string

URL ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это значение при создании диска.

Возвращается: success

users

list / elements=string

Ссылки на пользователей диска (подключённые виртуальные машины) в формате: project/zones/zone/instances/instance.

Возвращается: success

Авторы

  • 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_region_disk_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API