google.cloud.gcp_compute_target_instance 模块 – 创建一个 GCP TargetInstance

注意

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

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

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

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

注意

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

概要 

表示一个 TargetInstance 资源，该资源定义了一个终止某些协议流量的端点实例。特别是，它们用于协议转发，其中转发规则可以将数据包发送到未经过 NAT 的目标实例。每个目标实例都包含一个虚拟机实例，该实例接收和处理来自相应转发规则的流量。

要求 

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

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	所用凭据的类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description 字符串	此资源的可选描述。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的 User Agent 字符串。
instance 字典 / 必需	虚拟机实例的 URL，该实例处理此目标实例的流量。接受自链接或格式为 `projects/project/zones/zone/instances/instance` 或 `zones/zone/instances/instance` 的部分路径。此字段表示指向 GCP 中实例资源的链接。可以通过两种方式指定它。首先，您可以放置一个字典，其中键为 “selfLink”，值为您的资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_instance 任务，然后将此实例字段设置为 “{{ name-of-resource }}”
name 字符串 / 必需	资源的名称。由客户端在创建资源时提供。名称的长度必须为 1-63 个字符，并符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，最后一个字符除外，该字符不能是短划线。
nat_policy 字符串	NAT 选项，用于控制如何将 IP NAT 到实例。目前仅支持 NO_NAT（默认值）。一些有效的选项包括：“NO_NAT” 默认值: `"NO_NAT"`
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / elements=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 且用户不希望使用默认电子邮件，则可以使用可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应存在于 GCP 中选项 `"present"` ← (默认) `"absent"`
zone 字符串 / 必需	目标实例所在的区域的 URL。

注释 

注意

API 参考：https://cloud.google.com/compute/docs/reference/v1/targetInstances
使用协议转发：https://cloud.google.com/compute/docs/protocol-forwarding
对于身份验证，您可以使用 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 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 instance
  google.cloud.gcp_compute_instance:
    name: "{{ resource_name }}"
    machine_type: n1-standard-1
    disks:
    - auto_delete: 'true'
      boot: 'true'
      initialize_params:
        source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
    labels:
      environment: production
    network_interfaces:
    - network: "{{ network }}"
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a target instance
  google.cloud.gcp_compute_target_instance:
    name: target
    instance: "{{ instance }}"
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

常见的返回值在这里文档化，以下是此模块特有的字段

键	描述
creationTimestamp 字符串	以 RFC3339 文本格式表示的创建时间戳。返回: 成功
description 字符串	此资源的可选描述。返回: 成功
instance 字典	虚拟机实例的 URL，该实例处理此目标实例的流量。接受自链接或格式为 `projects/project/zones/zone/instances/instance` 或 `zones/zone/instances/instance` 的部分路径。返回: 成功
name 字符串	资源的名称。由客户端在创建资源时提供。名称的长度必须为 1-63 个字符，并符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9][a-z0-9])?`，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，最后一个字符除外，该字符不能是短划线。返回:* 成功
natPolicy 字符串	NAT 选项，用于控制如何将 IP NAT 到实例。目前仅支持 NO_NAT（默认值）。返回: 成功
zone 字符串	目标实例所在的区域的 URL。返回: 成功

作者

Google Inc. (@googlecloudplatform)