自动化运维工具--ansible详解（playbook与jinja2）

女爷i 2023-06-07 12:04 38阅读 0赞

# 一、Ansible playbook简介 #

playbook 是 ansible 用于配置，部署，和管理被控节点的剧本。 通过 playbook 的详细描述，执行其中  
的一系列 tasks ，可以让远端主机达到预期的状态。playbook 就像 Ansible 控制器给被控节点列出的的一系列 todo-list ，而被控节点必须要完成。 也可以这么理解，playbook 字面意思，即剧本，现实中由演员按照剧本表  
演，在Ansible中，这次由计算机进行表演，由计算机安装，部署应用，提供对外服务，以及组织计算机处理各种  
各样的事情。

# 二、使用场景 #

执行一些简单的任务，使用ad-hoc命令可以方便的解决问题，但是有时一个设施过于复杂，需要大量的操作时  
候，执行的ad-hoc命令是不适合的，这时最好使用playbook。 就像执行shell命令与写shell脚本一样，也可以  
理解为批处理任务，不过playbook有自己的语法格式。 使用playbook你可以方便的重用这些代码，可以移植  
到不同的机器上面，像函数一样，最大化的利用代码。在你使用Ansible的过程中，你也会发现，你所处理的大部  
分操作都是编写playbook。可以把常见的应用都编写成playbook，之后管理服务器会变得十分简单。

# 三、Ansible playbook格式 #

### 1、格式简介 ###

playbook由 YMAL语言编写。YAML( /ˈjæməl/ )参考了其他多种语言，包括：XML、C语言、Python、Perl 以  
及电子邮件格式RFC2822，Clark Evans在2001年5月在首次发表了这种语言，另外Ingy döt Net与OrenBen-Kiki也  
是这语言的共同设计者。 YMAL格式是类似于 JSON 的文件格式，便于人理解和阅读，同时便于书写。首先学  
习了解一下YMAL的格式，对我们后面书写playbook很有帮助。以下为playbook常用到的YMAL格式： 1、文  
件的第一行应该以 “—” (三个连字符)开始，表明YMAL文件的开始。 2、在同一行中，\#之后的内容表示注释，  
类似于shell，python和ruby。 3、YMAL中的列表元素以”-”开头然后紧跟着一个空格，后面为元素内容。  
4、同一个列表中的元素应该保持相同的缩进。否则会被当做错误处理。 5、play 中 hosts，variables，  
roles，tasks等对象的表示方法都是键值中间以":“分隔表示，”:"后面还要增加一个空格。

---
    #安装与运行mysql服务
    - hosts: node1
     remote_user: root
     tasks: 
     - name: install mysql-server package
     yum: name=mysql-server state=present
     - name: starting mysqld service
     service: name=mysql state=started

### 2、核心元素 ###

Hosts ：主机组； Tasks ：任务列表； Variables ：变量，设置方式有四种； Templates ：包含了模  
板语法的文本文件； Handlers ：由特定条件触发的任务；

### 3、基本组件 ###

Hosts ：运行指定任务的目标主机 remoute\_user ：在远程主机上执行任务的用户； sudo\_user ：  
tasks ：任务列表  
格式： tasks： – name: TASK\_NAME \# 这一步的名称 module:  
arguments notify: HANDLER\_NAME handlers: – name:  
HANDLER\_NAME \# 这一步操作目的（注释） module: arguments  
模块，模块参数 ：  
格式： (1) action: module arguments (2) module: arguments 注意：shell  
和command模块后面直接跟命令，而非key=value类的参数列表；  
handlers ：任务，在特定条件下触发；接收到其它任务的通知时被触发；

### 4、variables部分 ###

variables是变量，有四种定义方法

##### (1) facts:可直接调用 4 #####

##### (2) 用户自定义变量 1 #####

##### (3) 通过 roles 传递变量 3 #####

##### (4) Host Inventory 2 #####

后面的数字是读取优先级

### 5、模板 templates ###

### 6、角色定制：roles ###

**1. 在roles目录下生成对应的目录结构**

[root@server ansible]# cd roles/
    [root@server roles]# ls
    [root@server roles]# mkdir -pv ./{nginx,mysql,httpd}/{files,templates,vars,tasks,handlers,meta,default}
    [root@server roles]# tree
    .
    ├── httpd
    │   ├── default
    │   ├── files
    │   ├── handlers
    │   ├── meta
    │   ├── tasks
    │   ├── templates
    │   └── vars
    ├── mysql
    │   ├── default
    │   ├── files
    │   ├── handlers
    │   ├── meta
    │   ├── tasks
    │   ├── templates
    │   └── vars
    └── nginx
        ├── default
        ├── files
        ├── handlers
        ├── meta
        ├── tasks
        ├── templates
        └── vars
    
    24 directories, 0 files

**2. 定义配置文件**  
　　我们需要修改的配置文件为`/tasks/main.yml`，下面，我们就来修改一下：

[root@server roles]# vim nginx/tasks/main.yml
    - name: cp
      copy: src=nginx-1.10.2-1.el7.ngx.x86_64.rpm dest=/tmp/nginx-1.10.2-1.el7.ngx.x86_64.rpm
    - name: install
      yum: name=/tmp/nginx-1.10.2-1.el7.ngx.x86_64.rpm state=latest
    - name: conf
      template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
      tags: nginxconf
      notify: new conf to reload
    - name: start service
      service: name=nginx state=started enabled=true

**3. 放置我们所需要的文件到指定目录**  
　　因为我们定义的角色已经有了新的组成方式，所以我们需要把文件都放到指定的位置，这样，才能让配置文件找到这些并进行加载。  
　　rpm包放在`files`目录下，模板放在`templates`目录下：

[root@server nginx]# cp /tmp/nginx-1.10.2-1.el7.ngx.x86_64.rpm ./files/
    [root@server nginx]# cp /tmp/nginx.conf.j2 ./templates/
    [root@server nginx]# tree
    .
    ├── default
    ├── files
    │   └── nginx-1.10.2-1.el7.ngx.x86_64.rpm
    ├── handlers
    ├── meta
    ├── tasks
    │   └── main.yml
    ├── templates
    │   └── nginx.conf.j2
    └── vars
    
    7 directories, 3 files

**4. 修改变量文件**  
　　我们在模板中定义的变量，也要去配置文件中加上：

[root@server nginx]# vim vars/main.yml
    nginxprot: 9999

**5. 定义handlers文件**  
　　我们在配置文件中定义了`notify`，所以我么也需要定义`handlers`，我们来修改配置文件：

[root@server nginx]# vim handlers/main.yml
    - name: new conf to reload
      service: name=nginx state=restarted

**6. 定义剧本文件**  
　　接下来，我们就来定义剧本文件，由于大部分设置我们都单独配置在了roles里面，所以，接下来剧本就只需要写一点点内容即可：

[root@server ansible]# vim roles.yml 
    - hosts: web
      remote_user: root
      roles:
        - nginx

**7. 启动服务**  
　　剧本定义完成以后，我们就可以来启动服务了：

[root@server ansible]# ansible-playbook roles.yml
    
    PLAY [web] *********************************************************************
    
    TASK [setup] *******************************************************************
    ok: [192.168.37.122]
    ok: [192.168.37.133]
    
    TASK [nginx : cp] **************************************************************
    ok: [192.168.37.122]
    ok: [192.168.37.133]
    
    TASK [nginx : install] *********************************************************
    changed: [192.168.37.122]
    changed: [192.168.37.133]
    
    TASK [nginx : conf] ************************************************************
    changed: [192.168.37.122]
    changed: [192.168.37.133]
    
    TASK [nginx : start service] ***************************************************
    changed: [192.168.37.122]
    changed: [192.168.37.133]
    
    RUNNING HANDLER [nginx : new conf to reload] ***********************************
    changed: [192.168.37.122]
    changed: [192.168.37.133]
    
    PLAY RECAP *********************************************************************
    192.168.37.122             : ok=6    changed=4    unreachable=0    failed=0   
    192.168.37.133             : ok=6    changed=4    unreachable=0    failed=0

启动过后照例查看端口号：

[root@server ansible]# ansible web -m shell -a "ss -ntulp |grep 9999"
    192.168.37.122 | SUCCESS | rc=0 >>
    tcp    LISTEN     0      128       *:9999                  *:*                   users:(("nginx",pid=7831,fd=6),("nginx",pid=7830,fd=6),("nginx",pid=7829,fd=6))
    
    192.168.37.133 | SUCCESS | rc=0 >>
    tcp    LISTEN     0      128       *:9999                  *:*                   users:(("nginx",pid=9654,fd=6),("nginx",pid=9653,fd=6),("nginx",pid=9652,fd=6))

可以看出我们的剧本已经执行成功。

# 四、Ansible使用jinja2管理配置文件以及jinja2语法简介 #

### 1、Jinja2介绍 ###

Jinja2是基于python的模板引擎，功能比较类似于PHP的smarty，J2ee的Freemarker和velocity。它能完全支持unicode，并具有集成的沙箱执行环境，应用广泛。jinja2使用BSD授权

Jinja2的语法是由variables(变量)和statement(语句)组成，如下；

#### 1、variables：可以输出数据 ####

my_variables

\{ \{ some\_dudes\_name | capitalize \}\}

#### 2、statements: 可以用来创建条件和循环等 ####

if语句：
    { % if my_conditional %} 
    ...
    { % endif %}
    for 语句：
    { % for item in all_items %}
    `item` 
    ……
    { % endfor %}

从上面第二个variables的例子中可以看出，jinja2支持使用带过滤器的Unix型管道操作符，有很多的内置过滤器可供使用。我们可以仅仅用一堆简单if和for就可以建立几乎任何的常规配置文件，不过如果你有意更进一步，jinja2 documentation （http://jinja.pocoo.org/docs/dev/）包含了很多有趣的东西可供了解。我们可以看到ansible允许在模板中使用诸如绘制时间此类的一些额外的模板变量

第一个例子：引用变量

#cd roles/template/
    .
    ├── meta
    │   └── main.yml
    ├── tasks
    │   ├── template.yml  
    │   └── main.yml
    ├── templates
    │   ├── order.j2
    └── vars
        └── main.yml

总调度yml文件：

#cat templates.yml
    ---
    - hosts: 10.0.90.27
      user: root
      gather_facts: false
      roles:
       - role: template

注意:这里 - role: template 和 - template 是一样的！

其他yml文件，如下：

#cat tasks/main.yml
    - include: template.yml
    
    #cat tasks/template.yml
    - name: create { {  PROJECT }} directory
      file: dest=/data/{ {  PROJECT }} state=directory
    - name: template transfor java dir
      template: src=order.j2 dest=/data/{ {  PROJECT }}/order.conf
      
    #cat templates/order.j2
    project: { {  PROJECT }}
    switch: { {  SWITCH }}
    dbport: { {  DBPORT }}
    
    #cat vars/main.yml
    PROJECT: "JAVA"
    SWITCH: "ON"
    DBPORT: "8080"
    
    测试：
    # ansible-playbook templates.yml --syntax-check
    playbook: templates.yml
    
    执行：
    # ansible-playbook templates.yml 
    PLAY [10.0.90.27] **************************************************************
    TASK [template : include] ***************************************************
    included: /etc/ansible/roles/template/tasks/template.yml for 10.0.90.27
    TASK [template : create JAVA directory] *************************************
    changed: [10.0.90.27]
    TASK [template : template transfor java dir] ********************************
    changed: [10.0.90.27]
    PLAY RECAP *********************************************************************
    10.0.90.27                 : ok=3    changed=2    unreachable=0    failed=0   
    #到10.0.90.27查看结果
    
    #cat /data/JAVA/order.conf
    project: JAVA
    switch: ON
    dbport: 8080