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 - | Шифрует диск с использованием предоставленного пользователем ключа шифрования. После шифрования диска с помощью ключа, предоставленного пользователем, вам необходимо предоставить тот же ключ, если вы используете диск позже (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для последующего использования диска. | ||
| kms_key_name - | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| labels - добавлено в 2.7 | Метки для применения к этому диску. Список пар ключ-значение. | ||
| licenses - | Любые применимые общедоступные лицензии. | ||
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| physical_block_size_bytes - добавлено в 2.8 | Физический размер блока постоянного диска в байтах. Если поле не указано в запросе, используется значение по умолчанию. В настоящее время поддерживаются размеры 4096 и 16384, другие размеры могут быть добавлены в будущем. Если запрашивается неподдерживаемое значение, сообщение об ошибке будет содержать список поддерживаемых значений для проекта вызывающего. | ||
| project строка | Используемый проект Google Cloud Platform. | ||
| scopes список | Массив используемых областей. | ||
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Не следует передавать это как словарь, а как строку, содержащую точное содержимое файла json учетной записи службы (валидный JSON). | ||
| 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 - | Ключ шифрования, предоставленный пользователем, для исходного образа. Необходимо, если исходный образ защищен ключом шифрования, предоставленным пользователем. | ||
| kms_key_name - | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| source_snapshot - | Исходный снимок, используемый для создания этого диска. Вы можете указать его как частичный или полный URL-адрес ресурса. Это поле представляет ссылку на ресурс Snapshot в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. В качестве альтернативы, вы можете добавить `register: имя-ресурса` в задачу gcp_compute_snapshot и затем установить это поле source_snapshot на "{{ имя-ресурса }}" | ||
| source_snapshot_encryption_key - | Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем. | ||
| kms_key_name - | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| raw_key - | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| state - |
| Следует ли данному объекту существовать в GCP | |
| type - добавлено в 2.7 | URL ресурса типа диска, описывающего тип диска для использования при создании диска. Укажите это при создании диска. | ||
| zone - / обязательно | Ссылка на зону, где находится диск. | ||
Примечания
Примечание
- Справочник по API: https://cloud.google.com/compute/docs/reference/v1/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. - Для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| creationTimestamp строка | успешно | Отметка времени создания в формате RFC3339. | |
| description строка | успешно | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| diskEncryptionKey сложный | успешно | Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью ключа, предоставленного пользователем, вы должны предоставить тот же ключ, если в дальнейшем будете использовать диск (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если при создании диска вы не предоставите ключ шифрования, то диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно будет предоставлять ключ для дальнейшего использования диска. | |
| kmsKeyName строка | успешно | Имя ключа шифрования, хранящегося в Google Cloud KMS. | |
| 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, в будущем могут быть добавлены другие размеры. Если запрашивается неподдерживаемое значение, сообщение об ошибке будет содержать список поддерживаемых значений для проекта вызывающего. | |
| sizeGb целое число | успешно | Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его отдельно для создания пустого постоянного диска. Если вы укажете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка. | |
| sourceImage строка | успешно | Образ, используемый для создания этого диска. Если исходный образ удален, это поле не будет установлено. Для создания диска с одним из общедоступных образов операционных систем укажите имя семейства образа. Например, укажите 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 . | |
| sourceImageEncryptionKey сложный | успешно | Ключ шифрования, предоставленный пользователем, для исходного образа. Требуется, если исходный образ защищен ключом шифрования, предоставленным пользователем. | |
| kmsKeyName строка | успешно | Имя ключа шифрования, хранящегося в Google Cloud KMS. | |
| rawKey строка | успешно | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | успешно | RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | |
| sourceImageId строка | успешно | Значение ID образа, используемого для создания этого диска. Это значение идентифицирует точный образ, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который был позже удален и воссоздан под тем же именем, ID исходного образа идентифицирует точную версию образа, которая была использована. | |
| sourceSnapshot словарь | успешно | Исходный снимок, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL-адрес ресурса. | |
| sourceSnapshotEncryptionKey сложный | успешно | Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем. | |
| kmsKeyName строка | успешно | Имя ключа шифрования, хранящегося в Google Cloud KMS. | |
| rawKey строка | успешно | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 строка | успешно | RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | |
| sourceSnapshotId строка | успешно | Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, ID исходного снимка идентифицирует точную версию снимка, которая была использована. | |
| type строка | успешно | URL ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это при создании диска. | |
| users список | успешно | Ссылки на пользователей диска (присоединенные виртуальные машины) в формате: project/zones/zone/instances/instance . | |
| zone строка | успешно | Ссылка на зону, в которой находится диск. | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/gcp_compute_disk_module.html
