google.cloud.gcp_compute清单 – Google Cloud Compute Engine清单源

注意

此清单插件是google.cloud集合（版本1.4.1）的一部分。

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要满足其他要求才能使用此清单插件，请参阅要求了解详情。

要在剧本中使用它，请指定：google.cloud.gcp_compute。

注意

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

概要

  • 从Google Cloud Platform GCE获取清单主机。

  • 使用以gcp_compute.(yml|yaml)或gcp.(yml|yaml)结尾的YAML配置文件。

要求

以下要求是在执行此清单的本地控制器节点上需要的。

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为accesstoken，则为OAuth2访问令牌。

配置

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "serviceaccount"

  • "machineaccount"

  • "accesstoken"

配置

cache

布尔值

切换以启用/禁用清单源数据的缓存，需要设置缓存插件才能工作。

选项

  • false ← (默认)

  • true

配置

cache_connection

字符串

缓存连接数据或路径，请阅读缓存插件文档了解详情。

配置

cache_plugin

字符串

要用于清单源数据的缓存插件。

默认值： "memory"

配置

cache_prefix

字符串

用于缓存插件文件/表的前缀

默认值： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（秒）

默认值： 3600

配置

compose

字典

从Jinja2表达式创建变量。

默认值： {}

filters

列表 / 元素=字符串

过滤器值对的列表。可用的过滤器列在https://cloud.google.com/compute/docs/reference/rest/v1/instances/aggregatedList中。列表中的每个附加过滤器都将添加为AND条件（filter1和filter2）

folders

列表 / 元素=字符串

包含多个项目的文件夹

groups

字典

根据Jinja2条件将主机添加到组。

默认值： {}

hostnames

列表 / 元素=字符串

描述应分配主机名的顺序的选项列表。当前支持的主机名是'public_ip'、'private_ip'、'name'或'labels.vm_name'。

默认值： ["public_ip", "private_ip", "name"]

keyed_groups

列表 / 元素=字典

根据变量的值将主机添加到组。

默认值： []

default_value

字符串

从 Ansible-core 2.12 版本开始加入

当主机变量的值为空字符串时的默认值。

此选项与keyed_groups[].trailing_separator互斥。

key

字符串

用于生成组的输入字典中的键

parent_group

字符串

键控组的父组

prefix

字符串

键控组名称将以此前缀开头

默认值： ""

separator

字符串

用于构建键控组名称的分隔符

默认值： "_"

trailing_separator

布尔值

从 Ansible-core 2.12 版本开始加入

将此选项设置为False 以省略主机变量值为空字符串时其后的keyed_groups[].separator。

此选项与keyed_groups[].default_value互斥。

选项

  • false

  • true ← (默认)

leading_separator

布尔值

从 Ansible-core 2.11 版本开始加入

与 keyed_groups 结合使用。

默认情况下，未提供前缀或分隔符的键控组的名称将以下划线开头。

这是因为默认前缀为“”而默认分隔符为“_”。

如果未给出前缀，则将此选项设置为 False 以省略开头的下划线（或其他分隔符）。

如果组名是从映射中导出的，则仍然使用分隔符来连接项目。

要完全不使用组名中的分隔符，请将键控组的分隔符设置为空字符串。

选项

  • false

  • true ← (默认)

name_suffix

字符串

自定义域名后缀。如果设置，此字符串将附加到所有主机。

默认值： ""

plugin

字符串 / 必需

确保这是“gcp_compute”插件的源文件的令牌。

选项

  • "google.cloud.gcp_compute"

  • "gcp_compute"

projects

列表 / 元素=字符串

要在其中描述 GCE 实例的项目列表。

retrieve_image_info

布尔值

使用 GCP 镜像名称填充返回的实例的image 主机事实

默认情况下，此插件不会尝试将实例的启动镜像解析为 GCP 中编目的镜像名称，因为此任务会带来性能开销。

除非启用此选项，否则image 主机变量将为null

选项

  • false ← (默认)

  • true

scopes

列表 / 元素=字符串

身份验证范围列表

默认值： ["https://www.googleapis.com/auth/compute"]

配置

service_account_contents

字符串

表示服务帐户 JSON 文件内容的字符串。这不应该作为字典传入，而应该是一个包含服务帐户 json 文件（有效的 JSON）的精确内容的字符串。

配置

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可以使用可选的服务帐户电子邮件地址。

配置

service_account_file

path

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

配置

strict

布尔值

如果为yes，则将无效条目作为致命错误，否则跳过并继续。

由于可以在表达式中使用事实，因此它们可能并不总是可用，我们默认忽略这些错误。

选项

  • false ← (默认)

  • true

use_contrib_script_compatible_sanitization

布尔值

默认情况下，此插件使用通用的组名清理方法来创建安全且可用的组名以在 Ansible 中使用。此选项允许您覆盖它，以便允许从旧的清单脚本迁移。

要使其工作，您还应关闭 TRANSFORM_INVALID_GROUP_CHARS 设置，否则核心引擎将仅在其之上使用标准清理方法。

这不是默认设置，因为此类名称会破坏某些功能，因为并非所有字符都是有效的 Python 标识符，组名最终会被用作 Python 标识符。

选项

  • false ← (默认)

  • true

use_extra_vars

布尔值

从 Ansible-core 2.11 版本开始加入

将额外的变量合并到可用于组合的变量中（最高优先级）。

选项

  • false ← (默认)

  • true

配置

vars_prefix

字符串

应用于主机变量的前缀，不包括事实和参数

默认值： ""

zones

列表 / 元素=字符串

要在其中描述 GCE 实例的区域列表。如果没有提供，则默认为给定项目可用的所有区域。

示例

plugin: google.cloud.gcp_compute
zones: # populate inventory with instances in these regions
  - us-east1-a
projects:
  - gcp-prod-gke-100
  - gcp-cicd-101
filters:
  - status = RUNNING
  - scheduling.automaticRestart = true AND status = RUNNING
service_account_file: /tmp/service_account.json
auth_kind: serviceaccount
scopes:
 - 'https://www.googleapis.com/auth/cloud-platform'
 - 'https://www.googleapis.com/auth/compute.readonly'
keyed_groups:
  # Create groups from GCE labels
  - prefix: gcp
    key: labels
name_suffix: .example.com
hostnames:
  # List host by name instead of the default public ip
  - name
compose:
  # Set an inventory parameter to use the Public IP address to connect to the host
  # For Private ip use "networkInterfaces[0].networkIP"
  ansible_host: networkInterfaces[0].accessConfigs[0].natIP

提示

每个条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。