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 请求的用户代理字符串。

instance

字典 / 必需

处理此目标实例流量的虚拟机实例的 URL。接受自链接或格式为“projects/project/zones/zone/instances/instance”或“zones/zone/instances/instance”的部分路径。

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

name

字符串 / 必需

资源的名称。在创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体而言，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。

nat_policy

字符串

控制如何将 IP NAT 到实例的 NAT 选项。

目前仅支持 NO_NAT（默认值）。

一些有效的选项包括：“NO_NAT”

默认值： "NO_NAT"

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

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

字符串

控制如何将 IP NAT 到实例的 NAT 选项。

目前仅支持 NO_NAT（默认值）。

返回：成功

zone

字符串

目标实例所在的区域的 URL。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)