gcp_compute_disk – Создаёт диск GCP
Новая в версии 2.6.
Обзор
- Долговременные диски — это долговечные устройства хранения данных, которые работают аналогично физическим дискам в настольном компьютере или сервере. 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 для шифрования или дешифрования этого ресурса. | ||
| sha256 - | RFC 4648 base64 закодированный SHA-256 хэш предоставленного пользователем ключа шифрования, который защищает этот ресурс. | ||
| labels - добавлен в 2.7 | Метки, применяемые к этому диску. Список пар ключ-значение. | ||
| licenses - | Любые применимые общедоступные лицензии. | ||
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||
| project - | По умолчанию: null | Проект Google Cloud Platform, который следует использовать. | |
| scopes - | Массив используемых областей. | ||
| service_account_email - | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file - | Путь к файлу JSON учетной записи сервиса, если выбран тип serviceaccount. | ||
| size_gb - | Размер долговременного диска в ГБ. Вы можете указать это поле при создании долговременного диска, используя параметр sourceImage или sourceSnapshot, или указать его для создания пустого долговременного диска. Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка. | ||
| source_image - | Исходный образ, используемый для создания этого диска. Если исходный образ удалён, это поле не будет установлено. Чтобы создать диск с одним из общедоступных образов операционной системы, укажите образ по его семейному имени. Например, укажите family/debian-8 для использования последнего образа Debian 8: projects/debian-cloud/global/images/family/debian-8 Или используйте определённую версию общедоступного образа операционной системы: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD Чтобы создать диск с частным образом, который вы создали, укажите имя образа в формате: global/images/my-private-image Вы также можете указать частный образ по его семейству образа, что возвращает последнюю версию образа в этом семействе. Замените имя образа на family/family-name: global/images/family/my-private-family. | ||
| source_image_encryption_key - | Ключ шифрования, предоставленный пользователем, для исходного образа. Необходим, если исходный образ защищён ключом шифрования, предоставленным пользователем. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 - | RFC 4648 base64 закодированный SHA-256 хэш предоставленного пользователем ключа шифрования, который защищает этот ресурс. | ||
| source_snapshot - | Исходный снимок, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL-адрес ресурса. Например, следующие значения допустимы: * `https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot` * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` . | ||
| source_snapshot_encryption_key - | Ключ шифрования, предоставленный пользователем, для исходного снимка. Необходим, если исходный снимок защищён ключом шифрования, предоставленным пользователем. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 - | RFC 4648 base64 закодированный SHA-256 хэш предоставленного пользователем ключа шифрования, который защищает этот ресурс. | ||
| state - |
| Определяет, должен ли данный объект существовать в GCP | |
| type - добавлен в 2.7 | URL ресурса типа диска, описывающего тип диска, который следует использовать для создания диска. Укажите это при создании диска. | ||
| zone - / обязательно | Ссылка на зону, в которой находится диск. | ||
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/latest/disks
- Добавление постоянного диска: https://cloud.google.com/compute/docs/disks/add-persistent-disk
- Для аутентификации можно установить service_account_file используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes используя переменную среды
GCP_SCOPES. - Значения переменных окружения будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a disk
gcp_compute_disk:
name: "test_object"
size_gb: 50
disk_encryption_key:
raw_key: SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=
zone: us-central1-a
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| creation_timestamp строка | успех | Дата и время создания в формате RFC3339. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| disk_encryption_key сложное | успех | Шифрует диск с использованием предоставленного пользователем ключа шифрования. После шифрования диска с помощью предоставленного пользователем ключа, вы должны предоставить тот же ключ, если вы используете диск позже (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставляете ключ шифрования при создании диска, то диск будет зашифрован с использованием автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для использования диска позже. | |
| raw_key строка | успех | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | |
| id целое число | успех | Уникальный идентификатор ресурса. | |
| labels словарь | успех | Метки для применения к этому диску. Список пар ключ-значение. | |
| last_attach_timestamp строка | успех | Дата и время последнего подключения в формате RFC3339. | |
| last_detach_timestamp строка | успех | Дата и время последнего отсоединения в формате RFC3339. | |
| licenses список | успех | Любые применимые публично видимые лицензии. | |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Конкретно, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| size_gb целое число | успех | Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска с параметрами sourceImage или sourceSnapshot, или указать его самостоятельно для создания пустого постоянного диска. Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка. | |
| source_image строка | успех | Образ, используемый для создания этого диска. Если образ удален, это поле не будет установлено. Чтобы создать диск с одним из общедоступных образов операционной системы, укажите образ по его семейному имени. Например, укажите family/debian-8 для использования последнего образа Debian 8: projects/debian-cloud/global/images/family/debian-8. В качестве альтернативы используйте конкретную версию общедоступного образа операционной системы: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD. Чтобы создать диск с приватным образом, который вы создали, укажите имя образа в следующем формате: global/images/my-private-image. Вы также можете указать приватный образ по его семейству образов, что возвращает последнюю версию образа в этом семействе. Замените имя образа на family/family-name: global/images/family/my-private-family. | |
| source_image_encryption_key сложное | успех | Ключ шифрования, предоставленный пользователем, для исходного образа. Требуется, если исходный образ защищен ключом шифрования, предоставленным пользователем. | |
| raw_key строка | успех | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | |
| source_image_id строка | успех | Значение ID образа, используемого для создания этого диска. Это значение идентифицирует точный образ, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который был позже удален и воссоздан под тем же именем, ID исходного образа идентифицирует точную версию образа, которая была использована. | |
| source_snapshot словарь | успех | Исходный снимок, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL к ресурсу. Например, следующие являются допустимыми значениями: * `https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot` * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot`. | |
| source_snapshot_encryption_key сложное | успех | Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем. | |
| raw_key строка | успех | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | |
| source_snapshot_id строка | успех | Уникальный ID снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, ID исходного снимка идентифицирует точную версию снимка, которая была использована. | |
| type строка | успех | URL ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это при создании диска. | |
| users список | успех | Ссылки на пользователей диска (присоединённые инстансы) в формате: project/zones/zone/instances/instance. | |
| zone строка | успех | Ссылка на зону, в которой находится диск. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/gcp_compute_disk_module.html
