community.docker.docker_machine inventory – Docker Machine 资源清单

注意

此资源清单插件是 community.docker 集合 (版本 4.1.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.docker。您需要其他要求才能使用此资源清单插件，有关详细信息，请参阅 要求。

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

概要

  • 从 Docker Machine 获取资源清单主机。

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

  • 该插件设置标准主机变量 ansible_host、ansible_port、ansible_user 和 ansible_ssh_private_key。

  • 该插件将 Docker Machine 的“env”输出变量存储在以 dm_ 为前缀的主机变量中。

要求

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

参数

参数

注释

compose

字典

从 jinja2 表达式创建变量。

默认值： {}

daemon_env

字符串

是否应获取 Docker daemon 连接环境变量，以及如果无法获取它们该如何处理。

使用 require 和 require-silently 获取它们，并跳过无法获取它们的任何主机。如果选择的是 require，则会针对任何跳过的主机发出警告。

使用 optional 和 optional-silently 获取它们，并且不跳过无法获取它们的任何主机。如果选择的是 optional，则会针对无法获取它们的任何主机发出警告。

使用 skip，不要尝试获取 Docker daemon 连接环境变量。

如果成功获取，这些变量将以 dm_ 为前缀并作为主机变量存储。

选项

  • "require" ← (默认)

  • "require-silently"

  • "optional"

  • "optional-silently"

  • "skip"

filters

列表 / 元素=字典

在 community.docker 3.5.0 中添加

一个包含/排除筛选器的列表，允许选择/取消选择此资源清单的主机。

筛选器按顺序处理，直到找到第一个 filters[].exclude 或 filters[].include 匹配的筛选器。如果 filters[].exclude 匹配，则排除该主机；如果 filters[].include 匹配，则包含该主机。如果没有筛选器匹配，则包含该主机。

exclude

字符串

一个 Jinja2 条件。如果它与主机匹配，则 **排除** 该主机。

只能指定filters[].exclude或filters[].include两者之一。

include

字符串

一个Jinja2条件。如果它与主机匹配，则该主机将被包含。

只能指定filters[].exclude或filters[].include两者之一。

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

plugin

字符串 / 必需

确保这是docker_machine插件的源文件的标记。

选项

  • "docker_machine"

  • "community.docker.docker_machine"

running_required

布尔值

当true时，Docker Machine 指示状态不是running的主机将被跳过。

选项

  • false

  • true ← (默认)

strict

布尔值

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

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

选项

  • false ← (默认)

  • true

use_extra_vars

布尔值

在ansible-core 2.11中添加

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

选项

  • false ← (默认)

  • true

配置

verbose_output

布尔值

当true时，包含所有可用的节点元数据（例如Image、Region、Size）作为名为docker_machine_node_attributes的JSON对象。

选项

  • false

  • true ← (默认)

备注

注意

  • 配置文件必须是YAML文件，其文件名以docker_machine.yml或docker_machine.yaml结尾。其他文件名将不被接受。

示例

# Minimal example
plugin: community.docker.docker_machine

# Example using constructed features to create a group per Docker Machine driver
# (https://docs.docker.net.cn/machine/drivers/), for example:
#   $ docker-machine create --driver digitalocean ... mymachine
#   $ ansible-inventory -i ./path/to/docker-machine.yml --host=mymachine
#   {
#     ...
#     "digitalocean": {
#       "hosts": [
#           "mymachine"
#       ]
#     ...
#   }
strict: false
keyed_groups:
  - separator: ''
    key: docker_machine_node_attributes.DriverName

# Example grouping hosts by Digital Machine tag
strict: false
keyed_groups:
  - prefix: tag
    key: 'dm_tags'

# Example using compose to override the default SSH behaviour of asking the user to accept the remote host key
compose:
  ansible_ssh_common_args: '"-o StrictHostKeyChecking=accept-new"'

作者

  • Ximon Eighteen (@ximon18)

提示

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