community.digitalocean.digitalocean 清单 – DigitalOcean 清单插件

注意

此清单插件是 community.digitalocean 集合 (版本 1.27.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.digitalocean。

要在 playbook 中使用它，请指定： community.digitalocean.digitalocean。

community.digitalocean 1.1.0 新增功能

概要

  • DigitalOcean (DO) 清单插件。

  • 从 DO API 获取 droplet 列表。

  • 使用以 ‘(do_hosts|digitalocean|digital_ocean).(yaml|yml)’ 结尾的配置文件。

参数

参数

注释

attributes

列表 / 元素=字符串

要作为主机变量添加到每个清单主机的 Droplet 属性。查看 DO API 文档以获取 https://docs.digitalocean.com/reference/api/api-reference/#operation/list_all_droplets 中属性的完整列表。

默认值： ["id", "name", "networks", "region", "size_slug"]

baseurl

字符串

DigitalOcean API 基本 URL。

默认值： "https://api.digitalocean.com/v2"

cache

布尔值

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

选项

  • false ← (默认)

  • true

配置

cache_connection

字符串

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

配置

cache_plugin

字符串

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

默认值： "memory"

配置

cache_prefix

字符串

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

默认值： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（秒）

默认值： 3600

配置

compose

字典

从 jinja2 表达式创建变量。

默认值： {}

filters

列表 / 元素=字符串

community.digitalocean 1.5.0 中添加

使用 Jinja 模板过滤主机。

如果未指定过滤器，则所有主机都将添加到清单。

默认值： []

groups

字典

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

默认值： {}

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 ← (默认值)

oauth_token

别名：api_token

字符串

DigitalOcean OAuth 令牌。

可以使用其他几个环境变量来提供此值。

例如：-DO_API_TOKEN，DO_API_KEY，DO_OAUTH_TOKEN 和 OAUTH_TOKEN。

pagination

整数

每个响应页面中的最大 Droplet 对象数。

如果与帐户相关的 Droplet 数超过此值，则查询将被分解为多个请求（页面）。

DigitalOcean 目前允许最大值为 200。

默认值：200

plugin

字符串 / 必需

DigitalOcean 库存插件的名称，这始终应该是community.digitalocean.digitalocean。

选项

  • "community.digitalocean.digitalocean"

strict

布尔值

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

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

选项

  • false ← (默认)

  • true

timeout

整数

用于轮询 DigitalOcean API 的超时时间（秒）。

默认值：30

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

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

选项

  • false ← (默认)

  • true

配置

validate_certs

布尔值

如果设置为no，则不会验证 SSL 证书。

仅应在使用自签名证书的个人控制站点上将此设置为no。

选项

  • false

  • true ← (默认值)

var_prefix

字符串

生成的变量名称的前缀（例如tags -> do_tags）

默认值："do_"

示例

# Using keyed groups and compose for hostvars
plugin: community.digitalocean.digitalocean
oauth_token: '{{ lookup("pipe", "./get-do-token.sh") }}'
attributes:
  - id
  - name
  - memory
  - vcpus
  - disk
  - size
  - image
  - networks
  - volume_ids
  - tags
  - region
keyed_groups:
  - key: do_region.slug
    prefix: 'region'
    separator: '_'
  - key: do_tags | lower
    prefix: ''
    separator: ''
compose:
  ansible_host: do_networks.v4 | selectattr('type','eq','public')
    | map(attribute='ip_address') | first
  class: do_size.description | lower
  distro: do_image.distribution | lower
filters:
  - '"kubernetes" in do_tags'
  - 'do_region.slug == "fra1"'

作者

  • Janos Gerzson (@grzs)

  • Tadej Borovšak (@tadeboro)

  • Max Truxa (@maxtruxa)

提示

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