在 Ansible 中使用 Jinja 模板

介绍¶

Ansible 通过内置的 template 模块，提供了一种强大而直接的方式，可以使用 Jinja 模板管理配置。本文档探讨了在 Ansible 中使用 Jinja 模板的两种重要方法

将变量添加到配置文件
使用循环和复杂数据结构构建复杂文件。

将变量添加到配置文件¶

步骤 1：创建 Jinja 模板¶

创建一个 Jinja 模板文件，例如 sshd_config.j2，其中包含变量的占位符

# /path/to/sshd_config.j2

Port {{ ssh_port }}
PermitRootLogin {{ permit_root_login }}
# Add more variables as needed

步骤 2：使用 Ansible 模板模块¶

在您的 Ansible 剧本中，使用 template 模块用特定值渲染 Jinja 模板

---
- name: Generate sshd_config
  hosts: your_target_hosts
  tasks:
    - name: Template sshd_config
      template:
        src: /path/to/sshd_config.j2
        dest: /etc/ssh/sshd_config
      vars:
        ssh_port: 22
        permit_root_login: no
      # Add more variables as needed

步骤 3：应用配置更改¶

执行 Ansible 剧本以将更改应用于目标主机

ansible-playbook your_playbook.yml

此步骤确保配置更改在您的基础设施中一致地应用。

使用循环和复杂数据结构构建完整文件¶

步骤 1：增强 Jinja 模板¶

扩展您的 Jinja 模板以处理循环和复杂数据结构。以下是如何配置具有多个组件的假设应用程序的示例

# /path/to/app_config.j2

{% for component in components %}
[{{ component.name }}]
    Path = {{ component.path }}
    Port = {{ component.port }}
    # Add more configurations as needed
{% endfor %}

步骤 2：集成 Ansible 模板模块¶

在您的 Ansible 剧本中，集成 template 模块以生成完整的配置文件

---
- name: Generate Application Configuration
  hosts: your_target_hosts
  vars:
    components:
      - name: web_server
        path: /var/www/html
        port: 80
      - name: database
        path: /var/lib/db
        port: 3306
      # Add more components as needed
  tasks:
    - name: Template Application Configuration
      template:
        src: /path/to/app_config.j2
        dest: /etc/app/config.ini

执行 Ansible 剧本以将更改应用于目标主机

ansible-playbook your_playbook.yml

此步骤确保配置更改在您的基础设施中一致地应用。

Ansible template 模块允许您使用 Jinja 模板在剧本执行期间动态生成配置文件。此模块允许您分离配置逻辑和数据，使您的 Ansible 剧本更灵活、更易于维护。

关键特性¶

模板渲染
该模块渲染 Jinja 模板以创建具有动态内容的配置文件。
在剧本或清单中定义的变量可以注入到模板中，从而实现动态配置。
使用 Jinja2
template 模块利用 Jinja2 模板引擎，提供强大的功能，例如条件语句、循环和过滤器，用于高级模板操作。
源路径和目标路径
指定源 Jinja 模板文件和生成的配置文件的目标路径。
变量传递
变量可以在剧本任务中直接传递，也可以从外部文件加载，从而允许灵活且动态的配置生成。
幂等执行
模板模块支持幂等执行，确保模板仅在检测到更改时才应用。

剧本片段示例¶

---
- name: Generate Configuration File
  hosts: your_target_hosts
  tasks:
    - name: Template Configuration File
      template:
        src: /path/to/template.j2
        dest: /etc/config/config_file
      vars:
        variable1: value1
        variable2: value2

用例¶

配置管理
非常适合根据特定参数动态生成文件，从而管理系统配置。
应用程序设置
对于使用不同设置创建特定于应用程序的配置文件很有用。
基础设施即代码
通过允许根据变量对配置进行动态调整，促进基础设施即代码实践。

最佳实践¶

关注点分离
将实际配置逻辑保留在 Jinja 模板中，将其与剧本的主体结构分离。
版本控制
将 Jinja 模板存储在版本控制的存储库中，以更好地跟踪和协作。
可测试性
独立测试模板，以确保它们生成预期的配置输出。

通过利用template模块，Ansible用户可以增强配置任务的可管理性和灵活性，从而促进更加简化和高效的系统和应用程序设置方法。

参考资料¶

Ansible 模板模块文档.

作者：Srinivas Nishant Viswanadha

贡献者：Steven Spencer，Antoine Le Morvan，Ganna Zhyrnova