google.cloud.gcp_compute_instance 模块 – 创建 GCP 实例
注意
此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install google.cloud
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定:google.cloud.gcp_compute_instance
。
注意
由于违反了 Ansible 包含要求,google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的完整性测试失败。有关更多信息,请参阅 讨论主题。
概要
实例是在 Google 基础架构上托管的虚拟机 (VM)。
要求
执行此模块的主机需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
---|---|
如果凭据类型为 accesstoken,则为 OAuth2 访问令牌。 |
|
使用的凭据类型。 选项
|
|
允许此实例发送和接收与不匹配的目标 IP 或源 IP 的数据包。如果您计划使用此实例转发路由,则需要此选项。 选项
|
|
机密计算的配置(需要将机器类型设置为任何 n2d-* 类型,以及 pd-ssd 类型的启动盘)。 |
|
启用机密计算。 选项
|
|
资源是否应受到删除保护。 选项
|
|
与从此模板创建的实例关联的磁盘数组。 |
|
指定在删除实例时(但在磁盘与实例分离时除外)是否会自动删除磁盘。 提示:应将磁盘设置为 autoDelete=true,以便在删除机器时不会留下剩余磁盘。 选项
|
|
指示这是一个启动盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。 选项
|
|
指定您选择的唯一设备名称,该名称将反映到在实例中运行的 Linux 操作系统的 /dev/disk/by-id/google-* 树中。此名称可用于在实例内引用设备以进行挂载、调整大小等操作。 |
|
使用客户提供的加密密钥对磁盘进行加密或解密。 |
|
指定一个 256 位客户提供的加密密钥,以 RFC 4648 base64 编码,用于加密或解密此资源。 |
|
指定一个 RFC 4648 base64 编码的、RSA 包装的 2048 位客户提供的加密密钥,用于加密或解密此资源。 |
|
为此磁盘分配一个基于零的索引,其中 0 保留给启动盘。例如,如果您有多个磁盘连接到实例,则每个磁盘都会有一个唯一的索引号。如果未指定,服务器将选择适当的值。 |
|
指定将与新实例一起创建的新磁盘的参数。使用初始化参数创建附加到新实例的启动盘或本地 SSD。 |
|
指定磁盘名称。如果未指定,则默认为使用实例的名称。 |
|
指定磁盘的以 2 为底的 GB 大小。 |
|
磁盘类型的引用。 指定要用于创建实例的磁盘类型。 如果未指定,则默认为 pd-standard。 |
|
创建此磁盘的源映像。创建新实例时,需要 initializeParams.sourceImage 或 disks.source 之一。要使用公共操作系统映像之一创建磁盘,请按其系列名称指定映像。 |
|
源映像的客户提供的加密密钥。如果源映像受客户提供的加密密钥保护,则需要此密钥。 实例模板不存储客户提供的加密密钥,因此,如果源映像使用您自己的密钥加密,则无法为托管实例组中的实例创建磁盘。 |
|
指定一个 256 位客户提供的加密密钥,以 RFC 4648 base64 编码,用于加密或解密此资源。 |
|
指定用于附加此磁盘的磁盘接口,即 SCSI 或 NVME。默认为 SCSI。 持久性磁盘必须始终使用 SCSI,如果您尝试以 SCSI 以外的任何格式附加持久性磁盘,则请求将失败。 一些有效的选项包括:“SCSI”、“NVME” |
|
附加此磁盘的模式,即 READ_WRITE 或 READ_ONLY。如果未指定,则默认以 READ_WRITE 模式附加磁盘。 一些有效的选项包括:“READ_WRITE”、“READ_ONLY” |
|
磁盘的引用。创建新实例时,需要 initializeParams.sourceImage 或 disks.source 之一。 如果需要,您还可以使用此属性附加现有的非根持久性磁盘。此字段仅适用于持久性磁盘。 此字段表示 GCP 中磁盘资源的链接。它可以通过两种方式指定。首先,您可以放置一个键为“selfLink”且值为资源 selfLink 的字典。或者,您可以将 `register: name-of-resource` 添加到 gcp_compute_disk 任务,然后将此 source 字段设置为“{{ name-of-resource }}” |
|
指定磁盘的类型,即 SCRATCH 或 PERSISTENT。如果未指定,则默认为 PERSISTENT。 一些有效的选项包括:“SCRATCH”、“PERSISTENT” |
|
指定您在哪个 Ansible 环境中运行此模块。 除非您知道自己在做什么,否则不应设置此选项。 这只会更改任何 API 请求的用户代理字符串。 |
|
附加到实例的加速器卡的类型和数量列表。 |
|
暴露给此实例的访客加速器卡数量。 |
|
要暴露给此实例的加速器类型资源的完整或部分 URL。 |
|
要创建的实例的主机名。指定的主机名必须符合 RFC1035。如果未指定主机名,则使用全局 DNS 时默认主机名为 [INSTANCE_NAME].c.[PROJECT_ID].internal,使用区域 DNS 时默认主机名为 [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal。 |
|
应用于此实例的标签。键值对列表。 |
|
定义虚拟机类型的机器类型引用。 |
|
要分配给从此模板创建的实例的元数据键值对。这些对可以包含自定义元数据或预定义键。 |
|
指定虚拟机实例的最小 CPU 平台。适用值是 CPU 平台的友好名称。 |
|
资源的名称,由客户端在最初创建资源时提供。资源名称必须为 1-63 个字符长,并符合 RFC1035。具体来说,名称必须为 1-63 个字符长,并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`,这意味着第一个字符必须是小写字母,所有后续字符必须是短横线、小写字母或数字,最后一个字符不能是短横线。 |
|
此接口的配置数组。这指定了此接口如何配置为与其他网络服务交互,例如连接到互联网。每个实例仅支持一个网络接口。 |
|
此接口的配置数组。目前,只支持一种访问配置 ONE_TO_ONE_NAT。如果没有指定 accessConfigs,则此实例将没有外部互联网访问。 |
|
此访问配置的名称。默认推荐名称为“External NAT”,但您可以使用任何您想要的任意字符串。例如,“My external IP”或“Network Access”。 |
|
地址引用。 与该实例关联的外部 IP 地址。 指定项目可用的未使用的静态外部 IP 地址,或保留此字段不定义以使用共享临时 IP 地址池中的 IP。如果您指定静态外部 IP 地址,它必须与实例区域相同的区域中。 此字段表示 GCP 中地址资源的链接。可以通过两种方式指定。首先,您可以放置一个字典,其中键为“address”,值为您的资源地址。或者,您可以将 `register: name-of-resource` 添加到 gcp_compute_address 任务中,然后将此 nat_ip 字段设置为“{{ name-of-resource }}”。 |
|
这表示用于配置此访问配置的网络层级。如果指定 AccessConfig 但没有有效的外部 IP 地址,则将使用此 networkTier 创建一个临时 IP。如果指定了具有有效外部 IP 地址的 AccessConfig,则它必须与拥有该 IP 的 Address 资源关联的 networkTier 匹配。 一些有效的选项包括:“PREMIUM”、“STANDARD”。 |
|
公共 PTR 记录的 DNS 域名。只有在启用 setPublicPtr 字段时才能设置此字段。 |
|
指定是否应创建公共 DNS PTR 记录以将实例的外部 IP 地址映射到 DNS 域名。 选项
|
|
配置类型。默认且唯一的选项是 ONE_TO_ONE_NAT。 一些有效的选项包括:“ONE_TO_ONE_NAT”。 |
|
此网络接口的别名 IP 范围数组。只能为子网模式网络上的网络接口指定。 |
|
此别名 IP 范围表示的 IP CIDR 范围。 此 IP CIDR 范围必须属于指定的子网,并且不能包含系统保留的或其他网络接口使用的 IP 地址。此范围可以是单个 IP 地址(例如 10.2.3.4)、子网掩码(例如 /24)或 CIDR 格式字符串(例如 10.1.2.0/24)。 |
|
可选的子网辅助范围名称,指定从中为该别名 IP 范围分配 IP CIDR 范围的辅助范围。如果未指定,则将使用子网的主范围。 |
|
指定现有网络的标题。不设置网络标题将选择默认网络接口,该接口可能已配置 SSH。 此字段表示 GCP 中网络资源的链接。可以通过两种方式指定。首先,您可以放置一个字典,其中键为“selfLink”,值为您的资源的 selfLink。或者,您可以将 `register: name-of-resource` 添加到 gcp_compute_network 任务中,然后将此 network 字段设置为“{{ name-of-resource }}”。 |
|
要为此网络接口分配给实例的 IPv4 内部网络地址。如果用户未指定,则系统将分配未使用的内部 IP。 |
|
VPC 网络的引用。 如果网络资源处于传统模式,请不要提供此属性。如果网络处于自动子网模式,则提供子网是可选的。如果网络处于自定义子网模式,则应指定此字段。 此字段表示 GCP 中子网资源的链接。可以通过两种方式指定。首先,您可以放置一个字典,其中键为“selfLink”,值为您的资源的 selfLink。或者,您可以将 `register: name-of-resource` 添加到 gcp_compute_subnetwork 任务中,然后将此 subnetwork 字段设置为“{{ name-of-resource }}”。 |
|
要使用的 Google Cloud Platform 项目。 |
|
设置此实例的调度选项。 |
|
指定如果 Compute Engine 终止实例(并非用户终止),是否应自动重启该实例。 您只能为标准实例设置自动重启选项。抢占式实例无法自动重启。 选项
|
|
定义此实例的维护行为。对于标准实例,默认行为为 MIGRATE。对于抢占式实例,默认行为且唯一可能的行为为 TERMINATE。 有关更多信息,请参阅设置实例调度选项。 |
|
定义实例是否为抢占式实例。这只能在创建实例期间设置,在实例创建后无法设置或更改。 选项
|
|
要使用的范围数组 |
|
服务帐户 JSON 文件的内容,可以是字典或表示它的 JSON 字符串。 |
|
如果选择 machineaccount 并且用户不希望使用默认邮箱,则可以选择服务帐户邮箱地址。 |
|
如果选择 serviceaccount 作为类型,则为服务帐户 JSON 文件的路径。 |
|
具有指定范围的服务帐户列表,为此实例授权。每个虚拟机实例只支持一个服务帐户。 |
|
服务帐户的邮箱地址。 |
|
要为此服务帐户提供的范围列表。 |
|
与屏蔽实例相关的各种参数的配置。 |
|
定义实例是否启用了完整性监控。 选项
|
|
定义实例是否启用了安全启动。 选项
|
|
定义实例是否启用了 vTPM。 选项
|
|
给定对象是否应存在于 GCP 中 选项
|
|
实例的状态。以下值之一:PROVISIONING、STAGING、RUNNING、STOPPING、SUSPENDING、SUSPENDED 和 TERMINATED。 作为用户,使用 RUNNING 保持机器“开启”,使用 TERMINATED 关闭机器。 一些有效的选项包括:“PROVISIONING”、“STAGING”、“RUNNING”、“STOPPING”、“SUSPENDING”、“SUSPENDED”、“TERMINATED”。 |
|
要应用于此实例的标签列表。标签用于标识网络防火墙的有效来源或目标,并在创建实例时由客户端指定。标签稍后可以通过 setTags 方法修改。列表中的每个标签必须符合 RFC1035。 |
|
为此请求指定指纹,它本质上是元数据内容的哈希值,用于乐观锁。 指纹最初由 Compute Engine 生成,并在每次修改或更新元数据的请求后都会更改。您必须始终提供最新的指纹哈希才能更新或更改元数据。 |
|
标签数组。每个标签必须为 1-63 个字符长,并符合 RFC1035。 |
|
机器所在区域的引用。 |
示例
- name: create a disk
google.cloud.gcp_compute_disk:
name: disk-instance
size_gb: 50
source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
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 network
google.cloud.gcp_compute_network:
name: network-instance
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a address
google.cloud.gcp_compute_address:
name: address-instance
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: address
- name: create a instance
google.cloud.gcp_compute_instance:
name: test_object
machine_type: n1-standard-1
disks:
- auto_delete: 'true'
boot: 'true'
source: "{{ disk }}"
- auto_delete: 'true'
interface: NVME
type: SCRATCH
initialize_params:
disk_type: local-ssd
metadata:
startup-script-url: gs:://graphite-playground/bootstrap.sh
cost-center: '12345'
labels:
environment: production
network_interfaces:
- network: "{{ network }}"
access_configs:
- name: External NAT
nat_ip: "{{ address }}"
type: ONE_TO_ONE_NAT
zone: us-central1-a
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
返回值
常见返回值已在此处记录 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
允许此实例发送和接收与不匹配的目标 IP 或源 IP 的数据包。如果您计划使用此实例转发路由,则需要此选项。 返回:成功 |
|
机密计算的配置(需要将机器类型设置为任何 n2d-* 类型,以及 pd-ssd 类型的启动盘)。 返回:成功 |
|
启用机密计算。 返回:成功 |
|
此实例使用的 CPU 平台。 返回:成功 |
|
RFC3339 文本格式的创建时间戳。 返回:成功 |
|
资源是否应受到删除保护。 返回:成功 |
|
与从此模板创建的实例关联的磁盘数组。 返回:成功 |
|
指定在删除实例时(但在磁盘与实例分离时除外)是否会自动删除磁盘。 提示:应将磁盘设置为 autoDelete=true,以便在删除机器时不会留下剩余磁盘。 返回:成功 |
|
指示这是一个启动盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。 返回:成功 |
|
指定您选择的唯一设备名称,该名称将反映到在实例中运行的 Linux 操作系统的 /dev/disk/by-id/google-* 树中。此名称可用于在实例内引用设备以进行挂载、调整大小等操作。 返回:成功 |
|
使用客户提供的加密密钥对磁盘进行加密或解密。 返回:成功 |
|
指定一个 256 位客户提供的加密密钥,以 RFC 4648 base64 编码,用于加密或解密此资源。 返回:成功 |
|
指定一个 RFC 4648 base64 编码的、RSA 包装的 2048 位客户提供的加密密钥,用于加密或解密此资源。 返回:成功 |
|
保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。 返回:成功 |
|
为此磁盘分配一个基于零的索引,其中 0 保留给启动盘。例如,如果您有多个磁盘连接到实例,则每个磁盘都会有一个唯一的索引号。如果未指定,服务器将选择适当的值。 返回:成功 |
|
指定将与新实例一起创建的新磁盘的参数。使用初始化参数创建附加到新实例的启动盘或本地 SSD。 返回:成功 |
|
指定磁盘名称。如果未指定,则默认为使用实例的名称。 返回:成功 |
|
指定磁盘的以 2 为底的 GB 大小。 返回:成功 |
|
磁盘类型的引用。 指定要用于创建实例的磁盘类型。 如果未指定,则默认为 pd-standard。 返回:成功 |
|
创建此磁盘的源映像。创建新实例时,需要 initializeParams.sourceImage 或 disks.source 之一。要使用公共操作系统映像之一创建磁盘,请按其系列名称指定映像。 返回:成功 |
|
源映像的客户提供的加密密钥。如果源映像受客户提供的加密密钥保护,则需要此密钥。 实例模板不存储客户提供的加密密钥,因此,如果源映像使用您自己的密钥加密,则无法为托管实例组中的实例创建磁盘。 返回:成功 |
|
指定一个 256 位客户提供的加密密钥,以 RFC 4648 base64 编码,用于加密或解密此资源。 返回:成功 |
|
保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。 返回:成功 |
|
指定用于附加此磁盘的磁盘接口,即 SCSI 或 NVME。默认为 SCSI。 持久性磁盘必须始终使用 SCSI,如果您尝试以 SCSI 以外的任何格式附加持久性磁盘,则请求将失败。 返回:成功 |
|
附加此磁盘的模式,即 READ_WRITE 或 READ_ONLY。如果未指定,则默认以 READ_WRITE 模式附加磁盘。 返回:成功 |
|
磁盘的引用。创建新实例时,需要 initializeParams.sourceImage 或 disks.source 之一。 如果需要,您还可以使用此属性附加现有的非根持久性磁盘。此字段仅适用于持久性磁盘。 返回:成功 |
|
指定磁盘的类型,即 SCRATCH 或 PERSISTENT。如果未指定,则默认为 PERSISTENT。 返回:成功 |
|
附加到实例的加速器卡的类型和数量列表。 返回:成功 |
|
暴露给此实例的访客加速器卡数量。 返回:成功 |
|
要暴露给此实例的加速器类型资源的完整或部分 URL。 返回:成功 |
|
要创建的实例的主机名。指定的主机名必须符合 RFC1035。如果未指定主机名,则使用全局 DNS 时默认主机名为 [INSTANCE_NAME].c.[PROJECT_ID].internal,使用区域 DNS 时默认主机名为 [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal。 返回:成功 |
|
资源的唯一标识符。此标识符由服务器定义。 返回:成功 |
|
用于此资源乐观锁的指纹。在更新期间内部使用。 返回:成功 |
|
应用于此实例的标签。键值对列表。 返回:成功 |
|
定义虚拟机类型的机器类型引用。有关当前有效机器类型的列表,请参阅 https://cloud.google.com/compute/docs/machine-types。 返回:成功 |
|
要分配给从此模板创建的实例的元数据键值对。这些对可以包含自定义元数据或预定义键。 返回:成功 |
|
指定虚拟机实例的最小 CPU 平台。适用值是 CPU 平台的友好名称。 返回:成功 |
|
资源的名称,由客户端在最初创建资源时提供。资源名称必须为 1-63 个字符长,并符合 RFC1035。具体来说,名称必须为 1-63 个字符长,并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`,这意味着第一个字符必须是小写字母,所有后续字符必须是短横线、小写字母或数字,最后一个字符不能是短横线。 返回:成功 |
|
此接口的配置数组。这指定了此接口如何配置为与其他网络服务交互,例如连接到互联网。每个实例仅支持一个网络接口。 返回:成功 |
|
此接口的配置数组。目前,只支持一种访问配置 ONE_TO_ONE_NAT。如果没有指定 accessConfigs,则此实例将没有外部互联网访问。 返回:成功 |
|
此访问配置的名称。默认推荐名称为“External NAT”,但您可以使用任何您想要的任意字符串。例如,“My external IP”或“Network Access”。 返回:成功 |
|
地址引用。 与该实例关联的外部 IP 地址。 指定项目可用的未使用的静态外部 IP 地址,或保留此字段不定义以使用共享临时 IP 地址池中的 IP。如果您指定静态外部 IP 地址,它必须与实例区域相同的区域中。 返回:成功 |
|
这表示用于配置此访问配置的网络层级。如果指定 AccessConfig 但没有有效的外部 IP 地址,则将使用此 networkTier 创建一个临时 IP。如果指定了具有有效外部 IP 地址的 AccessConfig,则它必须与拥有该 IP 的 Address 资源关联的 networkTier 匹配。 返回:成功 |
|
公共 PTR 记录的 DNS 域名。只有在启用 setPublicPtr 字段时才能设置此字段。 返回:成功 |
|
指定是否应创建公共 DNS PTR 记录以将实例的外部 IP 地址映射到 DNS 域名。 返回:成功 |
|
配置类型。默认且唯一的选项是 ONE_TO_ONE_NAT。 返回:成功 |
|
此网络接口的别名 IP 范围数组。只能为子网模式网络上的网络接口指定。 返回:成功 |
|
此别名 IP 范围表示的 IP CIDR 范围。 此 IP CIDR 范围必须属于指定的子网,并且不能包含系统保留的或其他网络接口使用的 IP 地址。此范围可以是单个 IP 地址(例如 10.2.3.4)、子网掩码(例如 /24)或 CIDR 格式字符串(例如 10.1.2.0/24)。 返回:成功 |
|
可选的子网辅助范围名称,指定从中为该别名 IP 范围分配 IP CIDR 范围的辅助范围。如果未指定,则将使用子网的主范围。 返回:成功 |
|
网络接口名称,由服务器生成。对于网络设备,这些是eth0、eth1等。 返回:成功 |
|
指定现有网络的标题。不设置网络标题将选择默认网络接口,该接口可能已配置 SSH。 返回:成功 |
|
要为此网络接口分配给实例的 IPv4 内部网络地址。如果用户未指定,则系统将分配未使用的内部 IP。 返回:成功 |
|
VPC 网络的引用。 如果网络资源处于传统模式,请不要提供此属性。如果网络处于自动子网模式,则提供子网是可选的。如果网络处于自定义子网模式,则应指定此字段。 返回:成功 |
|
设置此实例的调度选项。 返回:成功 |
|
指定如果 Compute Engine 终止实例(并非用户终止),是否应自动重启该实例。 您只能为标准实例设置自动重启选项。抢占式实例无法自动重启。 返回:成功 |
|
定义此实例的维护行为。对于标准实例,默认行为为 MIGRATE。对于抢占式实例,默认行为且唯一可能的行为为 TERMINATE。 有关更多信息,请参阅设置实例调度选项。 返回:成功 |
|
定义实例是否为抢占式实例。这只能在创建实例期间设置,在实例创建后无法设置或更改。 返回:成功 |
|
具有指定范围的服务帐户列表,为此实例授权。每个虚拟机实例只支持一个服务帐户。 返回:成功 |
|
服务帐户的邮箱地址。 返回:成功 |
|
要为此服务帐户提供的范围列表。 返回:成功 |
|
与屏蔽实例相关的各种参数的配置。 返回:成功 |
|
定义实例是否启用了完整性监控。 返回:成功 |
|
定义实例是否启用了安全启动。 返回:成功 |
|
定义实例是否启用了 vTPM。 返回:成功 |
|
实例的状态。以下值之一:PROVISIONING、STAGING、RUNNING、STOPPING、SUSPENDING、SUSPENDED 和 TERMINATED。 作为用户,使用 RUNNING 保持机器“开启”,使用 TERMINATED 关闭机器。 返回:成功 |
|
可选的、人类可读的状态解释。 返回:成功 |
|
要应用于此实例的标签列表。标签用于标识网络防火墙的有效来源或目标,并在创建实例时由客户端指定。标签稍后可以通过 setTags 方法修改。列表中的每个标签必须符合 RFC1035。 返回:成功 |
|
为此请求指定指纹,它本质上是元数据内容的哈希值,用于乐观锁。 指纹最初由 Compute Engine 生成,并在每次修改或更新元数据的请求后都会更改。您必须始终提供最新的指纹哈希才能更新或更改元数据。 返回:成功 |
|
标签数组。每个标签必须为 1-63 个字符长,并符合 RFC1035。 返回:成功 |
|
机器所在区域的引用。 返回:成功 |