目录

前言:

一、为什么选择模板而非直接修改文件？

二、Jinja2模板基础语法

基础示例：简单的变量替换

三、创建和部署模板

1. 模板文件结构

2. 编写SSH配置模板示例

3. 部署模板的Playbook

四、高级模板功能

1. 使用循环动态生成内容

2. 使用条件判断

3. 使用过滤器处理数据

五、ansible_managed指令

六、实际应用案例

案例1：动态生成Nginx虚拟主机配置

案例2：生成数据库配置文件

七、最佳实践与注意事项

1. 模板组织建议

2. 错误处理

3. 性能优化

4. 模板调试技巧

八、总结

---

前言:

在自动化运维中，配置管理是一个核心任务。虽然Ansible提供了lineinfile和blockinfile等模块来修改文件，但这些方法在处理复杂配置时往往不够高效且容易出错。本文将深入介绍Ansible中更强大的配置管理方法——使用Jinja2模板，它能让你的配置管理更加灵活、可维护。

---

一、为什么选择模板而非直接修改文件？

传统的文件修改方法存在以下问题：

• 难以处理复杂的配置逻辑

• 容易因多次执行产生重复内容

• 维护成本高，可读性差

而模板方法的优势在于：

• 动态生成：基于变量和事实自动生成配置

• 一致性：确保所有主机配置格式统一

• 可维护性：模板集中管理，修改一处即可更新所有主机

• 安全性：可包含管理注释，防止手动修改

---

二、Jinja2模板基础语法

Jinja2是Ansible使用的模板引擎，它使用特定的分隔符来标识不同类型的代码：

分隔符	用途	示例
{{ ... }}	变量替换	{{ ip_address }}
{% ... %}	控制结构	{% if condition %}
{# ... #}	注释（不输出）	{# 这是注释 #}

基础示例：简单的变量替换

{# 这是一个注释，不会出现在最终文件中 #}
服务器IP: {{ server_ip }}
主机名: {{ ansible_facts['hostname'] }}

渲染结果：

服务器IP: 192.168.1.10
主机名: webserver01

三、创建和部署模板

1. 模板文件结构

建议将模板文件放在项目目录的templates/子目录中，并使用.j2扩展名：

my-playbook/
├── templates/
│   ├── sshd_config.j2
│   └── hosts.j2
├── playbook.yml
└── vars.yml

2. 编写SSH配置模板示例

templates/sshd_config.j2:

{{ ansible_managed }}
# 此文件由Ansible自动生成，请勿手动修改

# 基本连接设置
Port {{ ssh_port }}
ListenAddress {{ ansible_facts['default_ipv4']['address'] }}

# 主机密钥配置
HostKey /etc/ssh/ssh_host_rsa_key
HostKey /etc/ssh/ssh_host_ecdsa_key

# 认证设置
PermitRootLogin {{ root_login_allowed | default('no') }}
PasswordAuthentication {{ password_auth_enabled | default('no') }}

# 安全增强
MaxAuthTries 3
ClientAliveInterval 300
ClientAliveCountMax 2

3. 部署模板的Playbook

playbook.yml:

- name: 配置SSH服务
  hosts: webservers
  vars:
    ssh_port: 2222
    root_login_allowed: "no"
    password_auth_enabled: "yes"
  tasks:
    - name: 部署SSH配置
      ansible.builtin.template:
        src: templates/sshd_config.j2
        dest: /etc/ssh/sshd_config
        owner: root
        group: root
        mode: '0600'
        validate: /usr/sbin/sshd -t -f %s
      notify: 重启SSH服务
  
  handlers:
    - name: 重启SSH服务
      ansible.builtin.service:
        name: sshd
        state: restarted

参数说明：

• src: 模板源文件路径

• dest: 目标文件路径

• validate: 部署前验证配置语法

• notify: 触发handler重启服务

---

四、高级模板功能

1. 使用循环动态生成内容

示例：生成/etc/hosts文件

{{ ansible_managed }}
# 本地主机地址
127.0.0.1   localhost localhost.localdomain
::1         localhost localhost.localdomain

# 服务器集群地址
{% for host in groups['web_servers'] %}
{{ hostvars[host]['ansible_facts']['default_ipv4']['address'] }}   {{ hostvars[host]['ansible_facts']['hostname'] }}.{{ domain_name }}
{% endfor %}

# 数据库服务器
{% for host in groups['db_servers'] %}
{{ hostvars[host]['ansible_facts']['default_ipv4']['address'] }}   db{{ loop.index }}.{{ domain_name }}
{% endfor %}

相关Playbook变量：

vars:
  domain_name: "example.com"

2. 使用条件判断

示例：根据操作系统生成不同的配置

{{ ansible_managed }}

# 日志配置
LogLevel INFO

# 根据操作系统设置不同的超时时间
{% if ansible_facts['os_family'] == "RedHat" %}
# RHEL/CentOS特有设置
ClientAliveInterval 60
{% elif ansible_facts['os_family'] == "Debian" %}
# Debian/Ubuntu特有设置
ClientAliveInterval 120
{% else %}
# 默认设置
ClientAliveInterval 90
{% endif %}

# 仅在生产环境启用严格模式
{% if environment == "production" %}
StrictModes yes
PermitEmptyPasswords no
{% else %}
# 开发环境放宽限制
StrictModes no
{% endif %}

3. 使用过滤器处理数据

{# JSON格式化输出 #}
配置摘要: {{ config_summary | to_nice_json }}

{# YAML格式化输出 #}
服务列表:
{{ services | to_nice_yaml }}

{# 字符串操作 #}
数据库名: {{ db_name | upper }}
文件路径: {{ file_path | basename }}

{# 列表操作 #}
用户列表: {{ users | join(', ') }}

{# 默认值 #}
端口号: {{ http_port | default(8080) }}

{# 安全相关 #}
密码哈希: {{ password | password_hash('sha512') }}

---

五、ansible_managed指令

为了防止手动修改Ansible管理的文件，可以在模板顶部添加管理注释：

ansible.cfg配置：

[defaults]
ansible_managed = 此文件由Ansible管理，最后修改于: %Y-%m-%d %H:%M:%S

模板中使用：

{{ ansible_managed }}
# 以下是自动生成的配置
# 任何手动修改将在下次Ansible执行时被覆盖

---

六、实际应用案例

案例1：动态生成Nginx虚拟主机配置

templates/nginx-site.j2:

{{ ansible_managed }}

server {
    listen {{ http_port | default(80) }};
    server_name {{ server_name }};
    
    root {{ web_root }};
    index index.html index.htm;
    
    {% if enable_ssl %}
    # SSL配置
    listen 443 ssl;
    ssl_certificate /etc/ssl/certs/{{ ssl_cert }};
    ssl_certificate_key /etc/ssl/private/{{ ssl_key }};
    {% endif %}
    
    {% if enable_gzip %}
    # 压缩配置
    gzip on;
    gzip_types text/plain text/css application/json;
    {% endif %}
    
    # 访问日志
    access_log /var/log/nginx/{{ server_name }}-access.log;
    
    # 错误页面
    error_page 404 /404.html;
    error_page 500 502 503 504 /50x.html;
    
    location = /50x.html {
        root /usr/share/nginx/html;
    }
}

案例2：生成数据库配置文件

templates/my.cnf.j2:

{{ ansible_managed }}

[mysqld]
# 基础配置
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock

# 连接设置
max_connections={{ max_connections | default(100) }}
max_connect_errors=10

# 内存配置
{% if memory_size_mb > 4096 %}
# 大内存优化
innodb_buffer_pool_size={{ (memory_size_mb * 0.5) | int }}M
key_buffer_size=256M
{% else %}
# 小内存配置
innodb_buffer_pool_size={{ (memory_size_mb * 0.3) | int }}M
key_buffer_size=128M
{% endif %}

# 复制配置（仅在从服务器启用）
{% if db_role == "slave" %}
server-id=2
relay-log=relay-bin
read-only=1
{% endif %}

[mysql]
default-character-set=utf8mb4

---

七、最佳实践与注意事项

1. 模板组织建议

• 按服务或功能组织模板文件

• 使用有意义的文件名

• 为复杂模板添加文档注释

• 将常用变量提取到group_vars或host_vars中

2. 错误处理

{# 使用default过滤器避免未定义变量错误 #}
端口: {{ http_port | default(80) }}

{# 使用defined测试变量是否存在 #}
{% if db_host is defined %}
数据库主机: {{ db_host }}
{% else %}
{# 提供默认值或报错 #}
数据库主机: localhost
{% endif %}

3. 性能优化

• 避免在模板中进行复杂计算

• 对于大量数据的循环，考虑使用专门的任务

• 使用| default()过滤器提供默认值，减少条件判断

4. 模板调试技巧

- name: 调试模板输出
  ansible.builtin.template:
    src: templates/config.j2
    dest: /tmp/debug_output.conf
  register: template_result
  check_mode: yes

- name: 显示生成的配置
  ansible.builtin.debug:
    msg: "{{ template_result.diff.before | default('') }}"

八、总结

Jinja2模板为Ansible配置管理提供了强大的动态生成能力。通过合理使用变量、循环、条件判断和过滤器，你可以创建灵活、可维护的配置文件模板。记住以下关键点：

1. 分离逻辑与数据：模板定义结构，变量提供数据

2. 保持模板简洁：复杂逻辑考虑移到playbook或自定义过滤器

3. 充分利用事实：使用ansible_facts获取主机信息

4. 注重可读性：添加注释，使用清晰的变量名

5. 确保幂等性：模板每次执行结果应一致