google.cloud.gcp_compute_image 模块 – 创建 GCP 镜像

注意

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

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

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

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

注意

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

概要 

表示一个镜像资源。
Google Compute Engine 使用操作系统镜像来创建实例的根持久性磁盘。创建实例时，您需要指定一个镜像。镜像包含引导加载程序、操作系统和根文件系统。Linux 操作系统镜像也能够在 Compute Engine 上运行容器。
镜像可以是公共的或自定义的。
公共镜像由 Google、开源社区和第三方供应商提供和维护。默认情况下，所有项目都可以访问这些镜像并使用它们来创建实例。自定义镜像仅对您的项目可用。您可以从根持久性磁盘和其他镜像创建自定义镜像。然后，使用自定义镜像创建实例。

要求 

执行此模块的主机需要以下要求。

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description 字符串	此资源的可选描述。创建资源时提供此属性。
disk_size_gb 整数	将镜像还原到持久性磁盘时的大小（以 GB 为单位）。
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
family 字符串	此镜像所属的镜像系列的名称。您可以通过指定镜像系列而不是特定镜像名称来创建磁盘。镜像系列始终返回其最新的未弃用的镜像。镜像系列的名称必须符合 RFC1035。
guest_os_features 列表 / 元素=字典	要在客户操作系统上启用的功能列表。仅适用于可引导镜像。
type 字符串 / 必需	支持的功能类型。一些有效的选项包括：“MULTI_IP_SUBNET”、“SECURE_BOOT”、“SEV_CAPABLE”、“UEFI_COMPATIBLE”、“VIRTIO_SCSI_MULTIQUEUE”、“WINDOWS”、“GVNIC”
image_encryption_key 字典	使用客户提供的加密密钥加密镜像。使用客户提供的密钥加密镜像后，如果稍后使用该镜像（例如，从该镜像创建磁盘），则必须提供相同的密钥。
raw_key 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。
labels 字典	应用于此镜像的标签。
licenses 列表 / 元素=字符串	任何适用的许可证 URI。
name 字符串 / 必需	资源的名称；创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。
project 字符串	要使用的 Google Cloud Platform 项目。
raw_disk 字典	原始磁盘镜像的参数。
container_type 字符串	用于编码和传输块设备的格式，应该是 TAR。这只是一个容器和传输格式，而不是运行时格式。创建磁盘镜像时由客户端提供。一些有效的选项包括：“TAR”
sha1_checksum 字符串	解包前磁盘镜像的可选 SHA1 校验和。创建磁盘镜像时由客户端提供。
source 字符串 / 必需	存储磁盘存储的完整 Google Cloud Storage URL。您必须提供此属性或 sourceDisk 属性，但不能同时提供两者。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不想使用默认邮箱，则可以选择的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
source_disk 字典	基于此源磁盘创建镜像。创建镜像时，必须提供此属性或 rawDisk.source 属性，但不能同时提供两者。此字段表示 GCP 中磁盘资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典；或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_disk 任务中，然后将此 source_disk 字段设置为“{{ name-of-resource }}”。
source_disk_encryption_key 字典	源磁盘的客户提供的加密密钥。如果源磁盘受客户提供的加密密钥保护，则需要此密钥。
raw_key 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。
source_disk_id 字符串	用于创建此镜像的磁盘的 ID 值。此值可用于确定镜像是取自给定磁盘名称的当前实例还是之前的实例。
source_image 字典	用于创建此镜像的源镜像的 URL。为了创建镜像，您必须提供以下其中一个的完整或部分 URL：* selfLink URL * 此属性 * rawDisk.source URL * sourceDisk URL。此字段表示 GCP 中镜像资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典；或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_image 任务中，然后将此 source_image 字段设置为“{{ name-of-resource }}”。
source_snapshot 字典	用于创建此镜像的源快照的 URL。为了创建镜像，您必须提供以下其中一个的完整或部分 URL：* selfLink URL * 此属性 * sourceImage URL * rawDisk.source URL * sourceDisk URL。此字段表示 GCP 中快照资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典；或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_snapshot 任务中，然后将此 source_snapshot 字段设置为“{{ name-of-resource }}”。
source_type 字符串	用于创建此磁盘的镜像类型。默认值且唯一值为 RAW。一些有效的选项包括：“RAW”
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`

注释 

注意

API 参考：https://cloud.google.com/compute/docs/reference/v1/images
官方文档：https://cloud.google.com/compute/docs/images
对于身份验证，您可以使用 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: disk-image
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: disk

- name: create a image
  google.cloud.gcp_compute_image:
    name: test_object
    source_disk: "{{ disk }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
archiveSizeBytes 整数	存储在 Google Cloud Storage 中的镜像 tar.gz 存档的大小（以字节为单位）。返回：成功
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。返回：成功
deprecated 复杂	与此镜像关联的弃用状态。返回：成功
deleted 字符串	一个可选的 RFC3339 时间戳，在此时间戳之后或之后，此资源的状态将更改为 DELETED。这仅供参考，除非客户端显式更改状态，否则状态不会更改。返回：成功
deprecated 字符串	一个可选的 RFC3339 时间戳，在此时间戳之后或之后，此资源的状态将更改为 DEPRECATED。这仅供参考，除非客户端显式更改状态，否则状态不会更改。返回：成功
obsolete 字符串	一个可选的 RFC3339 时间戳，在此时间戳之后或之后，此资源的状态将更改为 OBSOLETE。这仅供参考，除非客户端显式更改状态，否则状态不会更改。返回：成功
replacement 字符串	已弃用资源的建议替代资源的 URL。建议的替代资源必须与已弃用的资源相同。返回：成功
state 字符串	此资源的弃用状态。可以是 DEPRECATED、OBSOLETE 或 DELETED。使用已弃用资源创建新资源的操作将成功返回，但会发出警告，指出已弃用的资源并推荐其替代资源。使用 OBSOLETE 或 DELETED 资源的操作将被拒绝并导致错误。返回：成功
description 字符串	此资源的可选描述。创建资源时提供此属性。返回：成功
diskSizeGb 整数	将镜像还原到持久性磁盘时的大小（以 GB 为单位）。返回：成功
family 字符串	此镜像所属的镜像系列的名称。您可以通过指定镜像系列而不是特定镜像名称来创建磁盘。镜像系列始终返回其最新的未弃用的镜像。镜像系列的名称必须符合 RFC1035。返回：成功
guestOsFeatures 复杂	要在客户操作系统上启用的功能列表。仅适用于可引导镜像。返回：成功
type 字符串	支持的功能类型。返回：成功
id 整数	资源的唯一标识符。此标识符由服务器定义。返回：成功
imageEncryptionKey 复杂	使用客户提供的加密密钥加密镜像。使用客户提供的密钥加密镜像后，如果稍后使用该镜像（例如，从该镜像创建磁盘），则必须提供相同的密钥。返回：成功
rawKey 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。返回：成功
sha256 字符串	保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。返回：成功
labelFingerprint 字符串	用于此资源的乐观锁定的指纹。在更新期间内部使用。返回：成功
labels 字典	应用于此镜像的标签。返回：成功
licenses 列表 / 元素=字符串	任何适用的许可证 URI。返回：成功
name 字符串	资源的名称；创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9][a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。返回：*成功
rawDisk 复杂	原始磁盘镜像的参数。返回：成功
containerType 字符串	用于编码和传输块设备的格式，应该是 TAR。这只是一个容器和传输格式，而不是运行时格式。创建磁盘镜像时由客户端提供。返回：成功
sha1Checksum 字符串	解包前磁盘镜像的可选 SHA1 校验和。创建磁盘镜像时由客户端提供。返回：成功
source 字符串	存储磁盘存储的完整 Google Cloud Storage URL。您必须提供此属性或 sourceDisk 属性，但不能同时提供两者。返回：成功
sourceDisk 字典	基于此源磁盘创建镜像。创建镜像时，必须提供此属性或 rawDisk.source 属性，但不能同时提供两者。返回：成功
sourceDiskEncryptionKey 复杂	源磁盘的客户提供的加密密钥。如果源磁盘受客户提供的加密密钥保护，则需要此密钥。返回：成功
rawKey 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。返回：成功
sha256 字符串	保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。返回：成功
sourceDiskId 字符串	用于创建此镜像的磁盘的 ID 值。此值可用于确定镜像是取自给定磁盘名称的当前实例还是之前的实例。返回：成功
sourceImage 字典	用于创建此镜像的源镜像的 URL。为了创建镜像，您必须提供以下其中一个的完整或部分 URL：* selfLink URL * 此属性 * rawDisk.source URL * sourceDisk URL。返回：成功
sourceSnapshot 字典	用于创建此镜像的源快照的 URL。为了创建镜像，您必须提供以下其中一个的完整或部分 URL：* selfLink URL * 此属性 * sourceImage URL * rawDisk.source URL * sourceDisk URL。返回：成功
sourceType 字符串	用于创建此磁盘的镜像类型。默认值且唯一值为 RAW。返回：成功

作者

Google Inc. (@googlecloudplatform)