Ansible Jinja2 模板

文章目录

Ansible Jinja2 模板
一、Ansible Jinja2 模板背景介绍
二、JinJa2 模块
- 1.JinJa2 是什么？
- 2.Jinja2 必知会
- 3.Jinja2 逻辑控制
三、如何使用模板
四、实例演示

在这里插入图片描述

一、Ansible Jinja2 模板背景介绍

目前 nginx 的配置文件在所有的服务器上都是相同的，但是希望能根据每一台服务器的性能去定制服务器的启动进程。同时，定制每一台 nginx 服务的响应头，以便于当某台服务出现问题时能快速定位到具体的服务器。

要做这样的定制势必会导致一个问题，nginx 在每台物理服务器上的配置文件都不一样，这样的配置文件如何管理呢？在使用 copy 模块去做管理显然已经不合适。此时，使用ansible 提供的另一个模块（template）功能，他可以帮助我们完美的解决问题。

二、JinJa2 模块

要学会 ansible 中的模块（template）使用，前提我们必须要学会 JinJa2 模板。学会了它，就相当于学会了 ansible 模板。

1.JinJa2 是什么？

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

2.Jinja2 必知会

jinja2 文件以 .j2 为后缀，也可以不写后缀。
jinja2 中存在三种定界符
- 1、注释：{ # 注释内容 # }
- 2、变量引用：{{ var }}
- 3、逻辑表达：{% %}

3.Jinja2 逻辑控制

条件表达式

{% if %}
...
...
{% endif %}

栗子

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

循环控制

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

栗子

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

{#python 语法不通，模板中的循环内不能break或continue。但可以在迭代中过滤序列来跳过某些项#}
{% for host in groups['web_servers'] if host != "1.1.1.1" %}
{{ host }}
{% endfor %}

三、如何使用模板

一个基于 Facts 的Jinja2 实例

#cat config.j2
{# use variable example #}
welcome 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_toal']}},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

[root@master1 ~]# ansible-playbook -i hosts usejinja2.yml

PLAY [a template example] *****************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [192.168.200.183]
ok: [192.168.200.182]

TASK [update jinja2 config] ***************************************************************************
changed: [192.168.200.183]
changed: [192.168.200.182]

PLAY RECAP ********************************************************************************************
192.168.200.182            : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
192.168.200.183            : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[root@master1 ~]# 


[root@master2 ~]# cat /tmp/config.conf
welcome host master2, os is RedHat
today is 2023-01-12
cpucore numbers 1


mount /boot,total size is 1063256064,free size is 876158976
[root@master2 ~]# 

[root@web3 ~]# cat /tmp/config.conf
welcome host web3, os is RedHat
today is 2023-01-12
cpucore numbers 1


mount /boot,total size is 1063256064,free size is 876158976
[root@web3 ~]#

四、实例演示

Jinja2 模板以及如何在Ansible中使用模板，已经介绍完了。那么如何去实现我们的需求呢?

# 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;
}

继续优化我们的PlayBook, 让它支持模板

- 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