google.cloud.gcp_compute_disk 模块 – 创建 GCP 磁盘

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_disk。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。请参阅 讨论主题 获取更多信息。

概要

  • 持久性磁盘是持久性存储设备，其功能类似于台式机或服务器中的物理磁盘。Compute Engine 管理这些设备背后的硬件，以确保数据冗余并优化您的性能。持久性磁盘可作为标准硬盘驱动器 (HDD) 或固态驱动器 (SSD) 提供。

  • 持久性磁盘独立于您的虚拟机实例，因此您可以分离或移动持久性磁盘以保留数据，即使在删除实例之后也是如此。持久性磁盘性能会随着大小自动扩展，因此您可以调整现有持久性磁盘的大小或向实例添加更多持久性磁盘以满足您的性能和存储空间要求。

  • 当您需要具有稳定性能特征的可靠且经济高效的存储时，请向您的实例添加持久性磁盘。

要求

以下是执行此模块的主机所需的条件。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

字符串

此资源的可选描述。创建资源时提供此属性。

disk_encryption_key

字典

使用客户提供的加密密钥加密磁盘。

使用客户提供的密钥加密磁盘后，如果以后使用该磁盘（例如，创建磁盘快照或映像，或将磁盘附加到虚拟机），则必须提供相同的密钥。

客户提供的加密密钥无法保护对磁盘元数据的访问。

如果在创建磁盘时未提供加密密钥，则将使用自动生成的密钥加密磁盘，并且以后无需提供密钥即可使用该磁盘。

kms_key_name

字符串

存储在 Google Cloud KMS 中的加密密钥的名称。

您的项目的 Compute Engine 系统服务帐户 (`service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com`) 必须具有 `roles/cloudkms.cryptoKeyEncrypterDecrypter` 才能使用此功能。

kms_key_service_account

字符串

用于给定 KMS 密钥的加密请求的服务帐户。

如果不存在，则使用 Compute Engine 服务代理服务帐户。

raw_key

字符串

指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 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 项目。

provisioned_iops

整数

指示必须为磁盘预配多少 IOPS。

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

size_gb

整数

持久性磁盘的大小（以 GB 为单位）。您可以使用 sourceImage 或 sourceSnapshot 参数创建持久性磁盘时指定此字段，或者单独指定它以创建空持久性磁盘。

如果同时指定此字段以及 sourceImage 或 sourceSnapshot，则 sizeGb 的值不得小于 sourceImage 的大小或快照的大小。

source_image

字符串

创建此磁盘所用的源镜像。如果源镜像已删除，则不会设置此字段。

要使用公共操作系统镜像之一创建磁盘，请按其族名称指定镜像。例如，指定 family/debian-9 以使用最新的 Debian 9 镜像：projects/debian-cloud/global/images/family/debian-9 或者，使用公共操作系统镜像的特定版本：projects/debian-cloud/global/images/debian-9-stretch-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 中的加密密钥的名称。

kms_key_service_account

字符串

用于给定 KMS 密钥的加密请求的服务帐户。

如果不存在，则使用 Compute Engine 服务代理服务帐户。

raw_key

字符串

指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。

source_snapshot

字典

用于创建此磁盘的源快照。您可以将其提供为资源的部分或完整 URL。

此字段代表 GCP 中快照资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_snapshot 任务中，然后将此 source_snapshot 字段设置为“{{ name-of-resource }}”。

source_snapshot_encryption_key

字典

源快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则需要此密钥。

kms_key_name

字符串

存储在 Google Cloud KMS 中的加密密钥的名称。

kms_key_service_account

字符串

用于给定 KMS 密钥的加密请求的服务帐户。

如果不存在，则使用 Compute Engine 服务代理服务帐户。

raw_key

字符串

指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。

state

字符串

给定对象是否应存在于 GCP 中

选项

  • "present" ← (默认)

  • "absent"

type

字符串

描述要用于创建磁盘的磁盘类型的磁盘类型资源的 URL。创建磁盘时提供此信息。

zone

字符串 / 必需

磁盘所在的区域的引用。

注释

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/v1/disks

  • 添加永久性磁盘：https://cloud.google.com/compute/docs/disks/add-persistent-disk

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

  • 只有在未设置 playbook 值时，才会使用环境变量值。

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: create a disk
  google.cloud.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 中的加密密钥的名称。

您的项目的 Compute Engine 系统服务帐户 (`service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com`) 必须具有 `roles/cloudkms.cryptoKeyEncrypterDecrypter` 才能使用此功能。

已返回：成功

kmsKeyServiceAccount

字符串

用于给定 KMS 密钥的加密请求的服务帐户。

如果不存在，则使用 Compute Engine 服务代理服务帐户。

已返回：成功

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，将来可能会添加其他大小。

如果请求了不受支持的值，则错误消息将列出调用者的项目的支持值。

已返回：成功

provisionedIops

整数

指示必须为磁盘预配多少 IOPS。

已返回：成功

sizeGb

整数

持久性磁盘的大小（以 GB 为单位）。您可以使用 sourceImage 或 sourceSnapshot 参数创建持久性磁盘时指定此字段，或者单独指定它以创建空持久性磁盘。

如果同时指定此字段以及 sourceImage 或 sourceSnapshot，则 sizeGb 的值不得小于 sourceImage 的大小或快照的大小。

已返回：成功

sourceImage

字符串

创建此磁盘所用的源镜像。如果源镜像已删除，则不会设置此字段。

要使用公共操作系统镜像之一创建磁盘，请按其族名称指定镜像。例如，指定 family/debian-9 以使用最新的 Debian 9 镜像：projects/debian-cloud/global/images/family/debian-9 或者，使用公共操作系统镜像的特定版本：projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD 要使用您创建的私有镜像创建磁盘，请使用以下格式指定镜像名称：global/images/my-private-image 您也可以按其镜像族指定私有镜像，这将返回该族中镜像的最新版本。将镜像名称替换为 family/family-name：global/images/family/my-private-family。

已返回：成功

sourceImageEncryptionKey

复杂

源镜像的客户提供的加密密钥。如果源镜像受客户提供的加密密钥保护，则需要此密钥。

已返回：成功

kmsKeyName

字符串

存储在 Google Cloud KMS 中的加密密钥的名称。

已返回：成功

kmsKeyServiceAccount

字符串

用于给定 KMS 密钥的加密请求的服务帐户。

如果不存在，则使用 Compute Engine 服务代理服务帐户。

已返回：成功

rawKey

字符串

指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。

已返回：成功

sha256

字符串

保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。

已返回：成功

sourceImageId

字符串

用于创建此磁盘的镜像的 ID 值。此值标识用于创建此永久性磁盘的确切镜像。例如，如果您从后来被删除并在同名下重新创建的镜像创建了永久性磁盘，则源镜像 ID 将标识使用的镜像的确切版本。

已返回：成功

sourceSnapshot

字典

用于创建此磁盘的源快照。您可以将其提供为资源的部分或完整 URL。

已返回：成功

sourceSnapshotEncryptionKey

复杂

源快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则需要此密钥。

已返回：成功

kmsKeyName

字符串

存储在 Google Cloud KMS 中的加密密钥的名称。

已返回：成功

kmsKeyServiceAccount

字符串

用于给定 KMS 密钥的加密请求的服务帐户。

如果不存在，则使用 Compute Engine 服务代理服务帐户。

已返回：成功

rawKey

字符串

指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。

已返回：成功

sha256

字符串

保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。

已返回：成功

sourceSnapshotId

字符串

用于创建此磁盘的快照的唯一 ID。此值标识用于创建此永久性磁盘的确切快照。例如，如果您从后来被删除并在同名下重新创建的快照创建了永久性磁盘，则源快照 ID 将标识使用的快照的确切版本。

已返回：成功

type

字符串

描述要用于创建磁盘的磁盘类型的磁盘类型资源的 URL。创建磁盘时提供此信息。

已返回：成功

users

列表 / 元素=字符串

磁盘用户的链接（附加实例），格式为：project/zones/zone/instances/instance。

已返回：成功

zone

字符串

磁盘所在的区域的引用。

已返回：成功

作者

  • Google Inc. (@googlecloudplatform)