gcp_compute_region_disk – Создаёт GCP RegionDisk
Новое в версии 2.8.
Обзор
- Постоянные диски — это долговременные устройства хранения, которые работают аналогично физическим дискам в настольном компьютере или сервере. Compute Engine управляет оборудованием за этими устройствами, чтобы обеспечить избыточность данных и оптимизировать производительность для вас. Постоянные диски доступны в виде стандартных жёстких дисков (HDD) или твердотельных накопителей (SSD).
- Постоянные диски расположены независимо от ваших виртуальных машин, поэтому вы можете отсоединить или переместить постоянные диски, чтобы сохранить данные даже после удаления ваших виртуальных машин. Производительность постоянных дисков автоматически масштабируется с размером, поэтому вы можете изменить размер существующих постоянных дисков или добавить больше постоянных дисков в виртуальную машину, чтобы удовлетворить требования к производительности и объёму хранения.
- Добавьте постоянный диск к вашей виртуальной машине, когда вам требуется надёжное и доступное хранилище с постоянными характеристиками производительности.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| description - | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| disk_encryption_key - | Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью ключа, предоставленного пользователем, вы должны предоставить тот же ключ, если вы используете диск позже (например, для создания моментального снимка диска или образа или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставляете ключ шифрования при создании диска, тогда диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для использования диска позже. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или расшифрования этого ресурса. | ||
| 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 строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка, содержащая точное содержимое файла service account 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: имя-ресурса` к задаче gcp_compute_snapshot и затем установить это поле source_snapshot в "{{ имя-ресурса }}" | ||
| source_snapshot_encryption_key - | Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищён ключом шифрования, предоставленным пользователем. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или расшифрования этого ресурса. | ||
| state - |
| Указывает, должен ли данный объект существовать в GCP | |
| type - | URL-адрес ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это при создании диска. | ||
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/beta/regionDisks
- Добавление или изменение размера региональных постоянных дисков: https://cloud.google.com/compute/docs/disks/regional-persistent-disk
- Для аутентификации можно установить 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: create a region disk
gcp_compute_region_disk:
name: test_object
size_gb: 50
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 строка | успешно | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | успешно | Кодированный в RFC 4648 base64 хеш SHA-256 предоставленного пользователем ключа шифрования, защищающего этот ресурс. | |
| sourceSnapshotId строка | успешно | Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует точную версию снимка, которая была использована для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который позже был удален и воссоздан под тем же именем, идентификатор исходного снимка будет идентифицировать точную версию снимка, которая была использована. | |
| type строка | успешно | URL ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это при создании диска. | |
| users список | успешно | Ссылки на пользователей диска (подключенные инстансы) в формате: project/zones/zone/instances/instance . | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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_region_disk_module.html
