google.cloud.gcp_compute_region_disk 模块 – 创建 GCP 区域磁盘

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：google.cloud.gcp_compute_region_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 字典	使用客户提供的加密密钥加密磁盘。 在使用客户提供的密钥加密磁盘后，如果您稍后使用该磁盘（例如，创建磁盘快照或映像，或将磁盘连接到虚拟机），则必须提供相同的密钥。 客户提供的加密密钥不保护对磁盘元数据的访问。 如果在创建磁盘时未提供加密密钥，则将使用自动生成的密钥加密磁盘，并且您无需提供密钥即可稍后使用该磁盘。
raw_key 字符串	指定以 RFC 4648 base64 编码的 256 位客户提供的加密密钥，以加密或解密此资源。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
labels 字典	要应用于此磁盘的标签。键值对列表。
licenses 列表 / elements=字符串	任何适用的公开可见的许可证。
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 列表 / elements=字符串 / 必需	应将磁盘复制到的区域的 URL。
scopes 列表 / elements=字符串	要使用的范围数组
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_snapshot 字典	用于创建此磁盘的源快照。您可以提供资源的完整或部分 URL。 此字段表示 GCP 中快照资源的链接。它可以以两种方式指定。首先，您可以放置一个字典，其中键为 “selfLink”，值为您的资源的 selfLink。或者，您可以向 gcp_compute_snapshot 任务添加 `register: name-of-resource`，然后将此 source_snapshot 字段设置为 “{{ name-of-resource }}”
source_snapshot_encryption_key 字典	源快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则为必需项。
raw_key 字符串	指定以 RFC 4648 base64 编码的 256 位客户提供的加密密钥，以加密或解密此资源。
state 字符串	给定的对象是否应存在于 GCP 中 选择 "present" ← (默认) "absent"
type 字符串	描述用于创建磁盘的磁盘类型的磁盘类型资源 URL。创建磁盘时提供此项。

说明

注意

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

• 添加或调整区域持久磁盘的大小：https://cloud.google.com/compute/docs/disks/regional-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 region disk
  google.cloud.gcp_compute_region_disk:
    name: test_object
    size_gb: 500
    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 字符串	指定以 RFC 4648 base64 编码的 256 位客户提供的加密密钥，以加密或解密此资源。 返回值： 成功
sha256 字符串	保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码的 SHA-256 哈希。 返回值： 成功
id 整数	资源的唯一标识符。 返回值： 成功
labelFingerprint 字符串	用于此资源乐观锁定的指纹。在更新期间内部使用。 返回值： 成功
labels 字典	要应用于此磁盘的标签。键值对列表。 返回值： 成功
lastAttachTimestamp 字符串	RFC3339 文本格式的上次附加时间戳。 返回值： 成功
lastDetachTimestamp 字符串	RFC3339 文本格式的上次分离时间戳。 返回值： 成功
licenses 列表 / elements=字符串	任何适用的公开可见的许可证。 返回值： 成功
name 字符串	资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。 返回值： 成功
physicalBlockSizeBytes 整数	持久磁盘的物理块大小，以字节为单位。如果请求中不存在，则使用默认值。当前支持的大小为 4096 和 16384，将来可能会添加其他大小。 如果请求了不支持的值，则错误消息将列出调用者项目支持的值。 返回值： 成功
region 字符串	对磁盘所在的区域的引用。 返回值： 成功
replicaZones 列表 / elements=字符串	应将磁盘复制到的区域的 URL。 返回值： 成功
sizeGb 整数	持久磁盘的大小，以 GB 为单位指定。使用 sourceImage 或 sourceSnapshot 参数创建持久磁盘时，可以指定此字段，或者单独指定此字段以创建空持久磁盘。 如果将此字段与 sourceImage 或 sourceSnapshot 一起指定，则 sizeGb 的值不得小于 sourceImage 或快照的大小。 返回值： 成功
sourceSnapshot 字典	用于创建此磁盘的源快照。您可以提供资源的完整或部分 URL。 返回值： 成功
sourceSnapshotEncryptionKey 复杂	源快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则为必需项。 返回值： 成功
rawKey 字符串	指定以 RFC 4648 base64 编码的 256 位客户提供的加密密钥，以加密或解密此资源。 返回值： 成功
sha256 字符串	保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码的 SHA-256 哈希。 返回值： 成功
sourceSnapshotId 字符串	用于创建此磁盘的快照的唯一 ID。此值标识用于创建此持久磁盘的确切快照。例如，如果您从后来删除并以相同名称重新创建的快照创建了持久磁盘，则源快照 ID 将标识所使用的快照的确切版本。 返回值： 成功
type 字符串	描述用于创建磁盘的磁盘类型的磁盘类型资源 URL。创建磁盘时提供此项。 返回值： 成功
users 列表 / elements=字符串	以以下形式链接到磁盘的用户（附加的实例）：project/zones/zone/instances/instance 。 返回值： 成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）