Ansible#Ansible-Jinja2模板介绍

Ansible Jinja2模板简单介绍

目前Nginx的配置文件在所有的服务器上都是相同的,但我希望能根据每一台服务器的性能去定制服务的启动进程。同时定制每一台Nginx服务的响应头，以便于当某台服务出现问题时能快速定位到具体的服务器。要做这样的定制势必会导致一个问题，Nginx 在每台物理服务器上的配置文件都不一样，这样的配置文件如何管理呢?再使用copy 模块去做管理显然已经不合适。此时使用Ansible 提供的另一个模板(template) 功能，它可以帮助我们完美的解决问题

用在配置文件里面有变量的情况下（要学会Ansible 中的模板(template)使用，前提我们必须要学会JinJa2模板。学会了它，就相当于我们学会了Ansible 模板）

１、JinJa2 是什么

Jinja2是基于Python书写的模板引擎。功能比较类似于PHP的smarty模板

２、 JinJa2 必知必会

jinja2可以引用所有有效变量
jinja2 文件以 .j2 为后缀， 也可以不写后缀。
jinja2 中存在三种定界符

• 注释: {# 注释内容 #}
• 变量引用: {{ var }}
• 逻辑表达: {% %}

３、 JinJa2 逻辑控制之条件表达式

{# jinja2里面不需要缩进的，当然如果使用了缩进，会显示空格 #}
{% if 条件表达式 %}
　　为真，显示内容部分
{% elif %}
...
{% else %}
...
{% endif %}

示例：
{# 如果定义了 idc 变量， 则输出 #}
{% if idc is defined %}
{{ idc }}
{% else %}
没有定义
{% endif %}

４、 JinJa2 逻辑控制之逻辑运算符

==
!=
> >=
< <=
is defined
is not defined
true
false
支持逻辑运算符: and or

５、Jinja2逻辑控制之循环控制

{% for %}
...
...
{% endfor %}

示例
{# 列举出 dbservers 这个 group 中的所有主机 #}
{% for host in groups['dbservers'] %}
　　{{ host }}
{% endfor %}

{#与Python语法不同，模板中的循环内不能break或continue。但你可以在迭代中过滤序列来跳过某些项#}
{#打印dbservers 组中的所有主机，但是不打印1.1.1.1 这台主机#}
{% for host in groups['dbservers'] if host != "1.1.1.1" %}
　　{{host}}
{% endfor %}

６、Jinja2模板的用法

模板里面的变量全部都是用 {{ }} 引号引起来
　　一个基于Facts的Jinja2 实例

# cat config.j2
{# use variable example #}
wlecome host {{ ansible_hostname }}, os is {{ ansible_os_family }}
today is {{ ansible_date_time.date  }}
cpucore numbers {{ ansible_processor_vcpus  }}

{# use condition example #}
{% if ansible_processor_vcpus > 1 %}
OS CPU more than one core
{% endif %}

{% for m in ansible_mounts if m['mount'] != "/" %}
mount {{ m['mount'] }}, total size is {{m['size_total']}}, free size is {{m['size_available']}}
{% endfor %}


　　在Ansible 中使用模板
　　---
- name: a template example
  hosts: all
  remote_user: root
  tasks:
    - name: update jinja2 config
      template: src=config.j2 dest=/tmp/config.conf

７、实战jinja2

# cat nginx.conf.j2
user              nginx;
{# start process equal cpu cores #}
worker_processes {{ ansible_processor_vcpus }};

error_log  /var/log/nginx/error.log;
pid        /var/run/nginx.pid;

events {
    worker_connections  1024;
}

http {
    include       /etc/nginx/mime.types;
    default_type  application/octet-stream;

    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

    sendfile        on;
    tcp_nopush     on;

    keepalive_timeout  0;

    gzip on;
    gzip_min_length  1k;
    gzip_buffers     8 64k;
    gzip_http_version 1.0;
    gzip_comp_level 5;
    gzip_types   text/plain application/x-javascript text/css application/json application/xml application/x-shockwave-flash application/javascript image/svg+xml image/x-icon;
    gzip_vary on;
    {# add_header {{ ansible_hostname }}; #}
    add_header x-hostname {{ ansible_hostname  }};

    include /etc/nginx/conf.d/*.conf;
}

- name: template playbook example
  hosts: webservers
  vars:
    createuser:
      - tomcat
      - www
      - mysql
  tasks:
    - name: create user
      user: name={{ item }} state=present
      with_items: "{{ createuser }}"

    - name: yum nginx webserver
      yum: name=nginx state=present

      # use ansible template
    - name: update nginx main config
      template: 
        src: nginx.conf.j2
        dest: /etc/nginx/nginx.conf
      tags: updateconfig
      notify: reload nginx server
      
    - name: add virtualhost config
      copy:
        src: www.qfedu.com.conf
        dest: /etc/nginx/conf.d/
      tags: updateconfig
      notify: reload nginx server
      
    - name: check nginx syntax
      shell: /usr/sbin/nginx -t
      register: nginxsyntax
      tags: updateconfig
      
    - name: check nginx running
      stat: path=/var/run/nginx.pid
      register: nginxrunning
      tags: updateconfig
        
    - name: print nginx syntax
      debug: var=nginxsyntax
      
    - name: start nginx server
      service: name=nginx state=started
      when:
        - nginxsyntax.rc == 0
        - nginxrunning.stat.exists == false
  handlers:
    - name: reload nginx server
      service: name=nginx state=started
      when:
        - nginxsyntax.rc == 0
        - nginxrunning.stat.exists == true

执行还是按照原来的方式执行即可

ansible-playbook -i hosts site.yml

Jinja模板的详细介绍

一、jinja2简介

1、jinja2模板

1️⃣：Ansible将jinja2模板系统用于模板文件，Ansible还使用jinja2语法来引用playbook中的变量

2️⃣：变量和逻辑表达式置于标记或分隔符之间；

例如，jinja2模板将{% EXPR %}用于表达式或逻辑（如循环），而{{ EXPR }}则用于向最终用户输出表达式或变量的结果
3️⃣：使用{# COMMENT #}语法括起不应出现在最终文件中的注释

演示实例：

[root@localhost ~]# cat myplay.j2
{# This is test jinja2 #}
{{ ansible_facts['default_ipv4']['address'] }}
{{ ansible_facts['hostsname'] }}

[root@localhost ~]# cat myplay.j2
{# This is test jinja2 #}
{{ ansible_facts[‘default_ipv4’][‘address’] }}
{{ ansible_facts[‘hostsname’] }}

二、构建jinja2模板

1、jinja2模板构成

1️⃣：jinja2模板由多个元素组成：数据、变量和表达式，在呈现jinja2模板时，这些变量和表达式被替换为对应的值

2️⃣：模板中使用的变量可以在playbook的vars部分中指定，也可以将受管主机的事实用作模板中的变量

3️⃣：可以使用ansible system_hostname -i inventory_file -m setup命令来获取与受管主机相关的事实

4️⃣：注意：包含jinja2模板的文件不需要有任何特定的文件扩展名（例如.j2）；但是，提供此类文件扩展名会让你更容易记住它是模板文件

演示实例：

[root@localhost ~]# cat myplay.j2
<VirtualHost {{ ansible_facts['default_ipv4']['address'] }}:80>
    DocumentRoot /var/www/html/{{ dir_name }}
</VirtualHost>

三、部署jinja2模板

1、使用template模块自定义模板

1️⃣：jinja2模板是功能强大的工具，可用于自定义要在受管主机上部署的配置文件

2️⃣：创建了适用于配置文件的jinja2模板后，它可以通过template模板部署到受管主机上，该模块支持将控制节点中的本地文件转移到受管主机

演示实例：

[root@localhost ~]# cat /opt/myplay.j2
<VirtualHost {{ ansible_facts['default_ipv4']['address'] }}:80>
    DocumentRoot /var/www/html/{{ dir_name }}
</VirtualHost>
 
 
[root@localhost ~]# cat /opt/playbook.yaml
---
- hosts: all
  gather_facts: no
  tasks:
    - name: gat template
      template:
        src: /opt/myplay.j2
        dest: /tmp/myplay

3️⃣：template模块还允许指定已部署文件的所有者、组、权限和SELINUX上下文，就像file模块一样

4️⃣：也可以取用validate选项运行任意命令（如visudo -c），在将文件复制到位之前检查该文件的语法是否正确

四、管理模板文件

1、使用ansible_managed管理模板文件

1️⃣：可使用ansible_managed指令中设置的"Ansible managed"字符串来给模板文件注释

2️⃣：ansible_managed指令在ansible.cfg文件中设置

演示实例：

[root@localhost ~]# vim /etc/ansible/ansible.cfg
ansible_managed = Ansible managed           //取消该行全面的注释

3️⃣：要将ansible_managed字符串包含在jinja2模板内，请使用下列语法

[root@localhost ~]# cat /opt/myplay.j2
{{ ansible_managed }}               //直接引用变量即可；也可以修改ansible.cfg文件中ansible managed指定的注释信息
<VirtualHost {{ ansible_facts['default_ipv4']['address'] }}:80>
    DocumentRoot /var/www/html/{{ dir_name }}
</VirtualHost>
 

五、控制结构

1、使用for循环

1️⃣：jinja2使用for语句来提供循环功能

演示实例一：使用变量替换变量

  //先在playbook中定义users变量
[root@localhost ~]# cat /opt/playbook.yaml
---
- hosts: all
  gather_facts: no
  vars:
    users:
      - zhangsan
      - lisi
      - wangwu
  tasks:
    - name: gat template
      template:
        src: /opt/myplay.j2
        dest: /tmp/myplay
 
 //查看jinja2模板文件
[root@localhost ~]# cat /opt/myplay.j2
{% for user in users %}
    {{ user }}
{% endfor %}

2️⃣：loop.index变量扩展至循环当前所处的索引号。它在循环第一次执行时值为1，每一次迭代递增1

演示实例二：使用loop.index变量展示索引号

[root@localhost opt]# cat myplay.j2
{% for user in users %}
{{ loop.index }} - {{ user }}
{% endfor %}
 
 //执行后，在受管主机上查看
[root@localhost tmp]# cat myplay
1 - zhangsan
2 - lisi
3 - wangwu
 

演示实例三：使用for语句，并添加条件判断

[root@localhost opt]# cat myplay.j2
{% for user in users if user != "lisi" %}
{{ loop.index }} - {{ user }}
{% endfor %}
  //这样添加判断，就排除了lisi用户
 
 //执行play后，在受管主机上查看
[root@localhost tmp]# cat myplay
1 - zhangsan
2 - wangwu
 

2、使用条件句

1️⃣：jinja2使用if语句来提供条件控制，如果满足某些条件，这允许用户在已部署的文件中放置一行

演示实例一：

//现在playbook中定义user变量
[root@localhost opt]# cat /opt/playbook.yaml
---
- hosts: all
  gather_facts: no
  vars:
    user:
      - zhangsan
      - lisi
      - wangwu
  tasks:
    - name: gat template
      template:
        src: /opt/myplay.j2
        dest: /tmp/myplay
 
 //查看jinja2模板文件
[root@localhost opt]# cat /opt/myplay.j2
{% if True %}
{{ user }}
{% endif %}
 
 //执行play后，在受管主机上查看
[root@localhost tmp]# cat myplay
['zhangsan', 'lisi', 'wangwu']

演示实例二：

[root@localhost opt]# cat /opt/myplay.j2
{% if 2 > 1 %}
{{ user }}
{% endif %}
 
 
 //执行play后，在受管主机上查看
[root@localhost tmp]# cat myplay
['zhangsan', 'lisi', 'wangwu']

2️⃣：注意，在jinja2模板中我们可以使用jinja2循环和条件，但不能在Ansible Playbook中使用（playbook中只能用loop和when）

3、变量和过滤器

1️⃣：jinja2提供了过滤器，更改模板表达式的输出格式（例如，输出到果JSON）

2️⃣：to_json过滤器使用JSON格式化表达式输出，to_yaml过滤器则使用YAML格式化表达式输出

演示实例一：使用to_json过滤

//查看jinja2模板文件
[root@localhost opt]# cat /opt/myplay.j2
{{ ansible_facts['default_ipv4'] | to_json }}
 
 
 //查看playbook
[root@localhost opt]# cat /opt/playbook.yaml
---
- hosts: all
  gather_facts: yes
  tasks:
    - name: gat template
      template:
        src: /opt/myplay.j2
        dest: /tmp/myplay
 
 
 //执行play后，在受管主机上查看
[root@localhost tmp]# cat myplay
{"gateway": "192.168.121.2", "interface": "eth0", "address": "192.168.121.81", "broadcast": "192.168.121.255", "netmask": "255.255.255.0", "network": "192.168.121.0", "macaddress": "00:0c:29:35:75:fc", "mtu": 1500, "type": "ether", "alias": "eth0"}　
 

演示实例二：使用to_yaml过滤

[root@localhost opt]# cat myplay.j2
{{ ansible_facts['default_ipv4'] | to_yaml }}
 
 
 //执行play后，在受管主机上查看
[root@localhost tmp]# cat myplay
{address: 192.168.121.81, alias: eth0, broadcast: 192.168.121.255, gateway: 192.168.121.2,
  interface: eth0, macaddress: '00:0c:29:35:75:fc', mtu: 1500, netmask: 255.255.255.0,
  network: 192.168.121.0, type: ether}

3️⃣：也有其他过滤器，如to_nice_json和to_nice_yaml过滤器，它们将表达式输出格式化为JSON或YAML等人类可读格式

演示实例一：使用to_nice_json过滤

[root@localhost opt]# cat myplay.j2
{{ ansible_facts['default_ipv4'] | to_nice_json }}
 
 
 //执行play后，在受管主机上查看
[root@localhost tmp]# cat myplay
{
    "address": "192.168.121.81",
    "alias": "eth0",
    "broadcast": "192.168.121.255",
    "gateway": "192.168.121.2",
    "interface": "eth0",
    "macaddress": "00:0c:29:35:75:fc",
    "mtu": 1500,
    "netmask": "255.255.255.0",
    "network": "192.168.121.0",
    "type": "ether"
}
 

演示实例二：使用to_nice_yaml过滤

[root@localhost opt]# cat myplay.j2
{{ ansible_facts['default_ipv4'] | to_nice_yaml }}
 
 
 //执行paly后，在受管主机上查看
[root@localhost tmp]# cat myplay
address: 192.168.121.81
alias: eth0
broadcast: 192.168.121.255
gateway: 192.168.121.2
interface: eth0
macaddress: 00:0c:29:35:75:fc
mtu: 1500
netmask: 255.255.255.0
network: 192.168.121.0
type: ether

4️⃣：from_json和from_yaml过滤器相应要求JSON或YAML格式的字符串，并对它们进行解析

4、变量测试

1️⃣：在Ansible Playbook中与when子句一同使用的表达式是jinja2表达式；用于测试返回值的内置Ansible测试包括failed、changed、successded和skipped