在 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 Playbook 中，使用 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 Playbook 以将更改应用于目标主机。

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 Playbook 中，集成 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 Playbook 以将更改应用于目标主机。

ansible-playbook your_playbook.yml

此步骤可确保配置更改在您的基础架构中得到一致的应用。

Ansible 的 template 模块允许您使用 Jinja 模板在 Playbook 执行期间动态生成配置文件。此模块使您可以分离配置逻辑和数据，从而使您的 Ansible Playbook 更具灵活性和可维护性。

主要功能¶

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

示例 Playbook 代码片段¶

---
- 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 模板中，并将其与 Playbook 的主结构分开。
版本控制
将 Jinja 模板存储在版本控制的存储库中，以便更好地跟踪和协作。
可测试性
独立测试模板，以确保它们产生预期的配置输出。

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

参考文献¶

Ansible Template 模块文档.

作者：Srinivas Nishant Viswanadha

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