Ansible-template模块动态生成特定文件

文章目录

一、Jinja2介绍
- 什么是
- - 主要特性
  - 安装
  - 基本用法
  - 进阶特性
  - 总结
- Jinja2与Ansible关系
- - 1. 模板引擎
  - 2. Ansible 的依赖
  - 3. 变量和模板
  - 4. 动态生成配置
  - 5. 社区和生态系统
  - 总结
二、Ansible如何使用Jinja2
- 使用`template`模块
- Jinja2文件中使用判断和循环
- - Jinja2文件中使用判断
  - - 语法
  - Jinja2文件中使用循环
  - - 语法
- 案例：Ansible动态生成并推送keepalived配置文件
- - 编写keepalived.j2文件
  - 编写ansible playbook文件
- 案例：Ansible动态生成并推送负载均衡Nginx配置文件
- - 编写xxx.j2文件
  - 编写ansible playbook文件

一、Jinja2介绍

什么是

Python的模板引擎，有自带的模板语法
Jinja2 是一个用于 Python 的现代和设计友好的模板引擎，广泛用于生成动态网页内容和其他文本文件。它是 Flask 等 Web 框架的默认模板引擎，但也可以独立使用。以下是对 Jinja2 的详细介绍，包括其特性、用法以及示例。

主要特性

简洁的语法：
Jinja2 提供了一种易于理解的模板语法，使得用户能够快速上手。模板中的变量通过双大括号 {{ }} 进行插入，控制结构（如循环和条件）通过 {% %} 语法实现。
控制结构：
支持条件语句（如 if、elif、else）和循环（如 for），允许用户在模板中实现复杂的逻辑。
过滤器：
Jinja2 提供了一系列内置的过滤器，可以在输出变量时进行格式化或处理。例如，可以使用 | length 来获取列表的长度，或使用 | upper 将字符串转换为大写。
宏和模板继承：
支持模板的继承和宏定义，使得模板的复用性和可维护性大大增强。用户可以定义一个基模板，然后在其他模板中扩展和覆盖特定部分。
自动转义：
Jinja2 会自动对输出的内容进行转义，以防止 XSS 攻击，确保生成的 HTML 是安全的。
扩展性：
可以通过自定义过滤器、测试和全局函数等方式扩展 Jinja2 的功能。

安装

要使用 Jinja2，可以通过 pip 安装：

# 需安装好python的pip才行
pip install Jinja2

基本用法

以下是一个使用 Jinja2 的简单示例：

创建模板：

<!-- template.html -->
<!DOCTYPE html>
<html>
<head>
    <title>{{ title }}</title>
</head>
<body>
    <h1>{{ header }}</h1>
    <ul>
    {% for item in items %}
        <li>{{ item }}</li>
    {% endfor %}
    </ul>
</body>
</html>

渲染模板：

from jinja2 import Environment, FileSystemLoader

# 创建 Jinja2 环境
env = Environment(loader=FileSystemLoader('templates'))

# 加载模板
template = env.get_template('template.html')

# 定义模板变量
context = {
    'title': 'My Page',
    'header': 'Welcome to My Page',
    'items': ['Item 1', 'Item 2', 'Item 3']
}

# 渲染模板
rendered_html = template.render(context)

# 输出结果
print(rendered_html)

进阶特性

模板继承：

创建一个基模板 base.html：

<!-- base.html -->
<!DOCTYPE html>
<html>
<head>
    <title>{% block title %}Default Title{% endblock %}</title>
</head>
<body>
    <header>
        <h1>{% block header %}Default Header{% endblock %}</h1>
    </header>
    <div>
        {% block content %}{% endblock %}
    </div>
</body>
</html>

子模板 child.html：

<!-- child.html -->
{% extends "base.html" %}

{% block title %}Child Page Title{% endblock %}
{% block header %}Child Page Header{% endblock %}
{% block content %}
    <p>This is the content of the child page.</p>
{% endblock %}

自定义过滤器：

可以定义自己的过滤器来处理模板中的数据：

def custom_filter(value):
    return value.upper()

env.filters['custom'] = custom_filter

然后在模板中使用：

{{ 'hello' | custom }}  <!-- 输出: HELLO -->

总结

Jinja2 是一个功能强大且灵活的模板引擎，适用于生成动态内容的场景。其简单的语法和丰富的功能使得它在 Web 开发中非常受欢迎。无论是用于小型项目还是大型应用，Jinja2 都能满足不同的需求。

*XSS解释：
XSS（Cross-Site Scripting，跨站脚本攻击）是一种常见的网络安全攻击手段，攻击者通过在网页中注入恶意脚本，利用其他用户的浏览器执行这些脚本，从而窃取用户信息或控制用户浏览器的行为。

在这段上下文中，提到Jinja2会自动转义输出内容，主要是为了防止XSS攻击，确保生成的HTML内容是安全的。具体来说：

自动转义：Jinja2在渲染模板时，会自动对变量进行HTML转义，将特殊字符转换为对应的HTML实体，如<转换为<，>转换为>等。这样可以避免变量中包含的HTML标签或JavaScript代码被浏览器执行。
防止XSS攻击：通过自动转义，即使模板中包含用户输入的数据，也不会被浏览器解析为HTML或JavaScript代码，从而有效防止XSS攻击。
确保HTML安全：转义后的HTML内容是安全的，不会执行任何恶意脚本，保证了网页内容的安全性。

举个例子，假设用户输入了如下内容：

<script>alert('XSS')</script>

如果不进行转义，直接输出到HTML中，浏览器会执行其中的JavaScript代码，弹出警告框。而Jinja2会自动将其转义为：

&lt;script&gt;alert('XSS')&lt;/script&gt;

这样浏览器就不会执行其中的JavaScript代码，而是将其作为普通文本显示。

总之，Jinja2的自动转义功能可以有效地防止XSS攻击，确保生成的HTML内容是安全的。

Jinja2与Ansible关系

Jinja2 和 Ansible 之间的关系主要体现在以下几个方面：

1. 模板引擎

Jinja2 是一个强大的 Python 模板引擎，用于动态生成文本内容。它可以用于生成 HTML、XML、JSON 等格式的文档。Jinja2 允许开发者使用变量、控制结构（如条件语句和循环）来生成复杂的文本输出。

2. Ansible 的依赖

Ansible 是一个开源的自动化工具，用于配置管理、应用程序部署和任务自动化。Ansible 使用 Jinja2 作为其模板引擎。这意味着在 Ansible 中，用户可以使用 Jinja2 语法来创建动态配置文件和脚本。

3. 变量和模板

在 Ansible 中，Jinja2 被广泛应用于以下方面：

变量替换：用户可以在 Ansible 任务和剧本中定义变量，然后在配置文件、脚本或命令中使用这些变量。例如：
```
tasks:
  - name: Create a configuration file
    template:
      src: my_template.j2
      dest: /etc/my_config.conf
```
在 my_template.j2 中，您可以使用 Jinja2 语法来动态插入变量值。
条件语句和循环：通过 Jinja2，Ansible 用户可以在模板中使用条件语句和循环，从而生成不同的输出。例如：
```
{% for user in users %}
User: {{ user.name }}
{% if user.admin %}
Role: admin
{% endif %}
{% endfor %}
```

4. 动态生成配置

Jinja2 的强大功能使得 Ansible 能够在部署时动态生成配置文件。这对于需要根据不同环境（如开发、测试和生产）调整配置的情况尤为重要。

5. 社区和生态系统

Jinja2 是 Ansible 生态系统的一部分，许多 Ansible 的模块和角色依赖于 Jinja2 提供的模板功能。Ansible 的文档和社区也提供了大量的 Jinja2 示例，帮助用户更好地利用这一功能。

总结

简单来说，Jinja2 是 Ansible 的核心组件之一，负责动态生成内容，使得 Ansible 在自动化任务和配置管理时更加灵活和强大。通过使用 Jinja2，Ansible 用户可以轻松创建复杂的配置和脚本，以适应多变的需求。

二、Ansible如何使用Jinja2

使用`template`模块

- name: Template a file to /etc/files.conf
  template:
    src: /mytemplates/foo.j2
    dest: /etc/file.conf
    owner: bin
    group: wheel
    mode: '0644'

Jinja2文件中使用判断和循环

Jinja2文件中使用判断

*shell判断：
在这里插入图片描述

语法


{% if 条件1 %}
动作1
{% elif 条件2 %}
动作2
{% else %}
动作3
{% endif %}

解释：
如果满足条件1，执行动作1，如果不满足条件1，但满足条件2，则执行动作2；
如果条件1、2都不满足，那么执行动作3

Jinja2文件中使用循环

语法

{% for n in 条件 %}
动作
{% endfor %}

案例：Ansible动态生成并推送keepalived配置文件

已知：主机清单有如下配置：

[lb_servers]
lb01		ansible_ssh_host=172.16.1.5
lb02		ansible_ssh_host=172.16.1.6

编写keepalived.j2文件

global_defs {
	router_id {{ansible_hostname}}
}

vrrp_instance VI_lb {
	<% if ansible_hostname == 'lb01' %>
		state MASTER
		priority 100
	<% else %>
		state BACKUP
		priority 99
	<% endif %>	
	
	virtual_router_id 43
	authentication {
		auth_type PASS
		auth_pass 1234
	}
	virtual_ipaddress {
		10.0.0.43/32
	}
	...
}

编写ansible playbook文件

---
- name: the play1
  hosts: lb_servers
  become: no
  tasks:
    - name: 安装keepalived
    - name: 配置keepalived
      template:
        src: keeplived.j2
        dest: /etc/keeplived/keepalive.conf
      notify: restart_keepalived
  handlers:
    - name: restart_keepalived
      service:
        name: keepalived
        state: restarted

案例：Ansible动态生成并推送负载均衡Nginx配置文件

编写xxx.j2文件

upstream backend {
<% for n in range(1,11) %>
	server 172.16.1.{{n}};
<% endfor %>
}

server{
	listen 80;
	server_name xxx.com;
	location /{
		proxy_pass http://backend;
	}
}

编写ansible playbook文件

---
- name: the play1
  hosts: all
  become: no
  tasks:
    - name: the task1
      template:
        src: xxx.j2
        dest: /etc/nginx/conf.d/xxx.conf 
	  when: ansible_hostname is match 'lb*'