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 хеш ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| licenses | Любые применимые публично доступные лицензии. | ||
| name | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| project | Проект 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 | |
| zone обязательно | Ссылка на ресурс зоны. | ||
Примечания
Примечание
- Для аутентификации можно установить 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: testObject
size_gb: 50
disk_encryption_key:
raw_key: 'SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0='
zone: 'us-central1-a'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| creation_timestamp str | success | Маркер времени создания в формате RFC3339. | |
| description str | success | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| disk_encryption_key complex | success | Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью предоставленного пользователем ключа, вам необходимо предоставить тот же ключ, если вы будете использовать диск позже (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, то диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для использования диска позже. | |
| raw_key str | success | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 str | success | Кодированный в RFC 4648 base64 хэш SHA-256 предоставленного пользователем ключа шифрования, который защищает этот ресурс. | |
| id int | success | Уникальный идентификатор ресурса. | |
| last_attach_timestamp str | success | Маркер времени последнего подключения в формате RFC3339. | |
| last_detach_timestamp str | success | Маркер времени последнего отключения в формате RFC3339. | |
| licenses list | success | Все применимые общедоступные лицензии. | |
| name str | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| size_gb int | success | Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его отдельно для создания пустого постоянного диска. Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка. | |
| source_image str | success | Образ источника, используемый для создания этого диска. Если образ источника удален, это поле не будет установлено. Для создания диска с одним из общедоступных образов операционной системы, укажите образ по его семейному имени. Например, укажите 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 complex | success | Ключ шифрования, предоставленный пользователем, для образа источника. Требуется, если образ источника защищен ключом шифрования, предоставленным пользователем. | |
| raw_key str | success | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 str | success | Кодированный в RFC 4648 base64 хэш SHA-256 предоставленного пользователем ключа шифрования, который защищает этот ресурс. | |
| source_image_id str | success | Значение ID образа, используемого для создания этого диска. Это значение идентифицирует точный образ, который использовался для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который был позже удален и воссоздан под тем же именем, идентификатор образа источника определит точную версию образа, которая использовалась. | |
| source_snapshot str | success | Источник снимка, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL-адрес ресурса. Например, следующие значения являются допустимыми: * https://www.googleapis.com/compute/v1/projects/project/global/ snapshots/snapshot * projects/project/global/snapshots/snapshot * global/snapshots/snapshot. | |
| source_snapshot_encryption_key complex | success | Ключ шифрования, предоставленный пользователем, для снимка источника. Требуется, если снимок источника защищен ключом шифрования, предоставленным пользователем. | |
| raw_key str | success | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |
| sha256 str | success | Кодированный в RFC 4648 base64 хэш SHA-256 предоставленного пользователем ключа шифрования, который защищает этот ресурс. | |
| source_snapshot_id str | success | Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который использовался для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, идентификатор снимка источника определит точную версию снимка, которая использовалась. | |
| type str | success | URL ресурса типа диска, описывающего тип диска, который следует использовать для создания диска. Укажите это при создании диска. | |
| users list | success | Ссылки на пользователей диска (присоединенные виртуальные машины) в формате: project/zones/zone/instances/instance. | |
| zone str | success | Ссылка на ресурс зоны. | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Для получения списка других модулей, также поддерживаемых сообществом 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.6/modules/gcp_compute_disk_module.html
