ansible.builtin.assemble 模块 – 从片段组装配置文件

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，您也可以使用简短的模块名称 assemble。但是，我们建议您使用 完全限定的集合名称 (FQCN) ansible.builtin.assemble，以便轻松链接到模块文档并避免与可能具有相同模块名称的其他集合发生冲突。

摘要

  • 从片段组装配置文件。

  • 通常，特定程序将使用单个配置文件，并且不支持 conf.d 样式结构，在这种结构中，可以轻松地从多个来源构建配置。 ansible.builtin.assemble 将获取一个可以是本地文件或已传输到系统的文件的目录，并将它们连接在一起以生成目标文件。

  • 文件按字符串排序顺序进行组装。

  • Puppet 将此想法称为片段。

注意

此模块具有相应的 操作插件。

参数

参数

注释

attributes

别名：attr

字符串

结果文件系统对象应具有的属性。

要获取支持的标志，请查看目标系统上 chattr 的手册页。

此字符串应包含与 lsattr 显示的顺序相同的属性。

= 运算符被假定为默认值，否则需要在字符串中包含 + 或 - 运算符。

backup

布尔值

创建备份文件（如果 true），包括时间戳信息，以便在您以某种方式错误地覆盖文件时可以取回原始文件。

选项

  • false ← (默认)

  • true

decrypt

布尔值

此选项控制使用 vault 自动解密源文件。

选项

  • false

  • true ← (默认)

delimiter

字符串

用于分隔文件内容的分隔符。

dest

路径 / 必需

使用所有源文件的连接创建的文件。

group

字符串

应拥有文件系统对象的组的名称，如同传递给 chown 一样。

当未指定时，它使用当前用户的当前组，除非您是 root 用户，在这种情况下，它可以保留以前的拥有权。

ignore_hidden

布尔值

一个布尔值，控制是否包含以 . 开头的文件。

选项

  • false ← (默认)

  • true

mode

任意

结果文件系统对象应具有的权限。

对于习惯于 /usr/bin/chmod 的用户，请记住模式实际上是八进制数。您必须向 Ansible 提供足够的信息才能正确解析它们。为了获得一致的结果，请引用八进制数（例如，'644' 或 '1777'），以便 Ansible 接收一个字符串并可以自行将字符串转换为数字。添加前导零（例如，0755）有时有效，但在循环和其他一些情况下可能会失败。

向 Ansible 提供一个不遵循上述任何规则的数字将导致一个十进制数，这将产生意外的结果。

从 Ansible 1.8 开始，模式可以指定为符号模式（例如，u+rwx 或 u=rw,g=r,o=r）。

如果未指定 mode 并且目标文件系统对象不存在，则在为新创建的文件系统对象设置模式时将使用系统上的默认 umask。

如果未指定 mode 并且目标文件系统对象存在，则将使用现有文件系统对象的模式。

指定 mode 是确保文件系统对象以正确的权限创建的最佳方法。有关更多详细信息，请参阅 CVE-2020-1736。

owner

字符串

应拥有文件系统对象的用户的名称，如同传递给 chown 一样。

当未指定时，它使用当前用户，除非您是 root 用户，在这种情况下，它可以保留以前的拥有权。

指定数字用户名将被假定为用户 ID 而不是用户名。避免使用数字用户名以避免此混淆。

regexp

字符串

仅当给定的正则表达式与文件名匹配时才组装文件。

如果未设置，则组装所有文件。

每个 \（反斜杠）必须转义为 \\ 以符合 YAML 语法。

使用 Python 正则表达式。

remote_src

布尔值

如果 false，它将在源/主机器上搜索 src。

如果 true，它将转到远程/目标机器以获取 src。

选项

  • false

  • true ← (默认)

selevel

字符串

SELinux 文件系统对象上下文的级别部分。

这是 MLS/MCS 属性，有时称为 range。

当设置为 _default 时，它将使用策略的 level 部分（如果可用）。

serole

字符串

SELinux 文件系统对象上下文的角色部分。

当设置为 _default 时，它将使用策略的 role 部分（如果可用）。

setype

字符串

SELinux 文件系统对象上下文的类型部分。

当设置为 _default 时，它将使用策略的 type 部分（如果可用）。

seuser

字符串

SELinux 文件系统对象上下文的用户部分。

默认情况下，它使用 system 策略（如果适用）。

当设置为 _default 时，它将使用策略的 user 部分（如果可用）。

src

路径 / 必需

一个已经存在的包含源文件的目录。

unsafe_writes

布尔值

影响何时使用原子操作来防止数据损坏或目标文件系统对象的不一致读取。

默认情况下，此模块使用原子操作来防止数据损坏或目标文件系统对象的不一致读取，但有时系统以阻止此操作的方式进行配置或损坏。一个示例是 docker 挂载的文件系统对象，无法从容器内部以原子方式更新，只能以不安全的方式写入。

此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全写入）。

重要！不安全写入容易受到竞争条件的影响，并可能导致数据损坏。

选项

  • false ← (默认)

  • true

validate

字符串

在复制到位之前运行的验证命令。

要验证的文件路径由 %s 传递，它必须存在，如下面的 sshd 示例所示。

命令以安全方式传递，因此 shell 功能（如扩展和管道）将不起作用。

属性

属性

支持

描述

action

支持：完全支持

指示其具有相应的 action 插件，因此某些选项部分可以在控制器上执行。

async

支持：不支持

支持与 async 关键字一起使用。

bypass_host_loop

支持：不支持

强制执行一个“全局”任务，该任务不会按主机执行，这会绕过按主机模板化以及串行、节流和其他循环考虑因素。

条件将像使用 run_once 一样工作，使用的变量将来自第一个可用的主机。

此操作在非锁步策略之外通常无法正常工作。

check_mode

支持：不支持

可以在 check_mode 下运行并返回更改状态预测，而无需修改目标，如果不受支持，则操作将被跳过。

diff_mode

支持：完全支持

在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

platform

平台： posix

可以对其进行操作的目标操作系统/系列。

safe_file_operations

支持：完全支持

使用 Ansible 的严格文件操作函数来确保正确的权限并避免数据损坏。

vault

支持：完全支持

可以自动解密 Ansible 保护的文件。

另请参阅

另请参阅

ansible.builtin.copy

将文件复制到远程位置。

ansible.builtin.template

将文件模板化到目标主机。

ansible.windows.win_copy

**ansible.windows.win_copy** 模块的官方文档。

示例

- name: Assemble from fragments from a directory
  ansible.builtin.assemble:
    src: /etc/someapp/fragments
    dest: /etc/someapp/someapp.conf

- name: Insert the provided delimiter between fragments
  ansible.builtin.assemble:
    src: /etc/someapp/fragments
    dest: /etc/someapp/someapp.conf
    delimiter: '### START FRAGMENT ###'

- name: Assemble a new "sshd_config" file into place, after passing validation with sshd
  ansible.builtin.assemble:
    src: /etc/ssh/conf.d/
    dest: /etc/ssh/sshd_config
    validate: /usr/sbin/sshd -t -f %s

作者

  • Stephen Fromm (@sfromm)