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 文件系统对象上下文的 user 部分。

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

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

src

路径 / 必需

一个已存在的目录，其中包含源文件。

unsafe_writes

布尔值

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

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

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

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

选项

  • false ← (默认)

  • true

validate

字符串

在复制到目标位置之前要运行的验证命令。

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

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

属性

属性

支持

描述

action

支持：完全支持

表示此操作具有相应的动作插件，因此部分选项可以在控制器上执行。

异步

支持：无

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

绕过主机循环

支持：无

强制执行“全局”任务，该任务不会按主机执行，这将绕过按主机进行的模板化、序列化、节流和其他循环考虑因素。

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

此操作在非锁步策略中将无法正常工作。

检查模式

支持：无

可以在检查模式下运行，并返回更改状态预测，而不会修改目标，如果不受支持，则会跳过操作。

差异模式

支持：完全支持

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

平台

平台： 类 Unix

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

安全文件操作

支持：完全支持

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

保险库

支持：完全支持

可以自动解密 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)