Linux playbook的使用

Linux playbook的使用

ansible的许多模块都是在命令行中执行的，每次只能执行一个模块。如果需要执行多个模块，且要写判断语句，判断模块是否执行成功了，如果没成功会怎么处理等。这时就需要写脚本了，ansible中的脚本叫作 playbook，每个 playbook中可以包含多个 play。

1.playbook的写法

playbook是以 yaml 或 yml 作为后缀的，每个play都可以使用两种格式来写。

（1）参数写在模块后面，命令如下。

 ‐ name: play的名称
 hosts:主机组1,主机组2,... #‐‐列出主机组
 tasks:
 ‐ name: 提示信息1
 模块1: argx1=vx1 argz2=vx2 #这种写法，“=”两边不要有空格
 ‐ name: 提示信息x
 模块x: rgxl=vxl argx2=vx2

一个 play 中可以包含多个 tasks，每个 task调用一个模块。

（2）参数分行写，一行一个参数，命令如下。

 ‐ hosts:主机组1，主机组2,... #‐‐列出主机组
 tasks:
 ‐ name:描述语句1
 模块1:
 argxl: vxl #这里指定模块的参数,注意冒号后面的空格
 argx2: vx2
 ‐ name:描述语句2
 模块x:
 argxl:vx1
 argx2:vx2

需要注意的是，YAML文件对缩进有极严格的要求,每个缩进都是两个空格，不要按【Tab】键。

一个完整的playbook中至少要包含一个 play，下面是一个包含两个play的playbook，命令如下。

 ‐‐‐
 ‐ name: 第一个play的名称
 hosts: 主机组1，主机组2，...#‐‐列出主机组
 tasks:
 ‐ name:提示信息1
 模块1:argxl‐vxl argx2=vx2
 ‐ name:提示信息×
 模块x:rgxl=vxl argx2=vx2
 ‐ name: 第二个play的名称
 hosts: 主机组3,主机组4,...#‐‐列出主机组
 gather facts: false
 tasks:
 ‐ name: 提示信息1
 模块1: argxl=vxl argx2=vx2
 ‐ name: 提示信息×
 模块x: rgxl=vxl argx2=Vx2

在写playbook时，一定要先写好框架，然后往框架中写内容。如果在多个主机组上做的是相同的操作，可以把它们放在同一个play中。如果在不同的主机组上做的是不同的操作，可以通过不同的play分别来实现。

这里第二个play中加了一句gather_facts: false，意思是在执行此play时不需要通过setup获取主机组的信息。所以，如果在tasks中没有使用到fact变量，建议加上这句，可以提升执行的速度。

写好之后运行playbook的方法是ansible playbook文件。

本章实验都在/home/lduan/demol下操作，先把demo1目录创建出来并把 ansible.cfg和hosts拷贝进去，命令如下。

[blab@rh1 ~]$ mkdir demo1
[blab@rh1 ~]$ cp ansible.cfg  hosts demo1/
[blab@rh1 ~]$ cd demo1/

练习1：写一个playbook文件test1.yaml，在server2和server3上打印主机名和IP。

因为在server2和 server3上做的是相同的操作，所以只要一个play即可。这个play中包含两个task: 一个用于打印主机名，另一个用于打印IP，命令如下。

[blab@rh1 demo1]$ cat test1.yaml
---
- hosts: rh2,rh3
  tasks:
          - name: 打印主机名
            debug: msg={{ansible_fqdn}}
          - name: 打印IP
            debug: msg={{ansible_default_ipv4.address}}

运行此playbook，命令如下。

[blab@rh1 demo1]$ ansible-playbook test1.yaml
PLAY [rh2,rh3] ****************************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [rh2]
ok: [rh3]

TASK [打印主机名] ******************************************************************************************
ok: [rh3] => {
    "msg": "rh3"
}
ok: [rh2] => {
    "msg": "rh2"
}

TASK [打印IP] *******************************************************************************************
ok: [rh2] => {
    "msg": "192.168.25.171"
}
ok: [rh3] => {
    "msg": "192.168.25.172"
}

PLAY RECAP ********************************************************************************************
rh2                        : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
rh3                        : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

写一个playbook文件test2.yaml，在server2上打印主机名，在server3上打印
IP。分析:因为在server2和 server3上做的是不同的操作，所以这里写两个play，一个play在server2上执行,另一个play在server3上执行。每个play中只要包含一个task即可，命令如下。

[blab@rh1 demo1]$ cat test2.yaml 
---
- name: 在rh2上的操作
  hosts: rh2
  tasks: 
  - name: 这是第一个操作，打印主机名
    debug: msg={{ansible_fqdn}}

- name: 在rh3上的操作
  hosts: rh3
  tasks:
  - name: 打印IP
    debug: msg={{ansible_default_ipv4.address}}

运行此playbook，命令如下。

[blab@rh1 demo1]$ ansible-playbook test2.yaml 

PLAY [在rh2上的操作] ***************************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [rh2]

TASK [这是第一个操作，打印主机名] **********************************************************************************
ok: [rh2] => {
    "msg": "rh2"
}

PLAY [在rh3上的操作] ***************************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [rh3]

TASK [打印IP] *******************************************************************************************
ok: [rh3] => {
    "msg": "192.168.25.172"
}

PLAY RECAP ********************************************************************************************
rh2                        : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
rh3                        : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0  

写一个playbook 文件 test3.yaml，要求如下。

（1）在server2上安装vsftpd，启动并开机自动启动vsftpd,设置防火墙开放ftp服务。

（2）在server3上安装 httpd，启动并开机自动启动httpd，设置防火墙开放http服务。

因为在server2和 server3上做的是不同的操作，所以这里写两个play。

第一个play在server2上执行，包含3个task，分别用于安装、服务管理、防火墙设置。

第二个 play在server3上执行，包含3个task，分别用于安装、服务管理、防火墙设置。

[blab@rh1 demo1]$ cat test3.yaml 
---
- name: 在rh2上的操作
  hosts: rh2
  tasks:
  - name: 这是第一个操作
    yum: name=vsftpd state=installed
  - name: 这是第二个操作
    service: name=vsftpd state=started enabled=yes
  - name: 这是第三个操作
    firewalld: service=ftp state=enabled immediate=yes permanent=yes

- name: 在rh3上的操作
  hosts: rh3
  tasks:
  - name: 这是第一个操作
    yum: name=httpd state=installed
  - name: 这是第二个操作
    service: name=httpd state=started enabled=yes
  - name: 这是第三个操作
    firewalld: service=http state=enabled immediate=yes permanent=yes

运行此playbook，命令如下。

[blab@rh1 demo1]$ ansible-playbook test3.yaml 

PLAY [在rh2上的操作] ***************************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [rh2]

TASK [这是第一个操作] ****************************************************************************************
ok: [rh2]

TASK [这是第二个操作] ****************************************************************************************
ok: [rh2]

TASK [这是第三个操作] ****************************************************************************************
ok: [rh2]

PLAY [在rh3上的操作] ***************************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [rh3]

TASK [这是第一个操作] ****************************************************************************************
ok: [rh3]

TASK [这是第二个操作] ****************************************************************************************
changed: [rh3]

TASK [这是第三个操作] ****************************************************************************************
changed: [rh3]

PLAY RECAP ********************************************************************************************
rh2                        : ok=4    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
rh3                        : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

2.错误处理

在写playbook时，会遇到各种各样的问题，例如，命令出错了,或者引用的变量不存在等。playbook具备一定的错误处理能力。

2.1 ignore_errors

执行一个playbook时，如果其中的某个task出错，则后续的task就不再继续执行了。看下面的例子，编写test4.yaml的内容如下。

[blab@rh1 demo1]$ cat test4.yaml 
---
- hosts: rh2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg={{default_xxx}}
  - name: bb
    debug: msg="22222"

这里写了两个task，一个是aa，另一个是bb，aa这个 task 中引用了一个不存在的变量default_xxx，所以导致aa这个task报错。如果某个task出错,则后续的task就不再继续执行了，所以bb这个 task不会继续执行了。

如果想让task aa出错时不影响后续task的执行，那么可以在task aa中添加
ignore_errors:true来忽略这个报错继续往下执行，命令如下。

[blab@rh1 demo1]$ cat test4.yaml 
---
- hosts: rh2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg={{default_xxx}}
    ignore_errors: true
  - name: bb
    debug: msg="22222"

这里添加了ignore_errors：true忽略报错信息。下面运行test4.yaml查看结果，如下所示。

blab@rh1 demo1]$ ansible-playbook test4.yaml 

PLAY [rh2] ********************************************************************************************

TASK [aa] *********************************************************************************************
fatal: [rh2]: FAILED! => {"msg": "The task includes an option with an undefined variable. The error was: 'default_xxx' is undefined\n\nThe error appears to be in '/home/blab/demo1/test4.yaml': line 5, column 5, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n  - name: aa\n    ^ here\n"}
...ignoring

TASK [bb] *********************************************************************************************
ok: [rh2] => {
    "msg": "22222"
}

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

2.2 fail语句

fail模块和debug模块一样，都是用来打印信息的，区别在于debug执行完成之后会继续进行后续模块的操作，而fail打印完报错信息之后会退出整个playbook。编写test5.yaml的内容如下。

[blab@rh1 demo1]$ cat test5.yaml 
---
- hosts: rh2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg="111"
  - name: bb
    fail: msg="222"
  - name: cc
    debug: msg="333"

这里写了3个task，其中task aa和 task cc使用debug打印信息, task bb使用fail打印信息。下面运行此playbook查看结果,如下所示。

[blab@rh1 demo1]$ ansible-playbook test5.yaml 

PLAY [rh2] ********************************************************************************************

TASK [aa] *********************************************************************************************
ok: [rh2] => {
    "msg": "111"
}

TASK [bb] *********************************************************************************************
fatal: [rh2]: FAILED! => {"changed": false, "msg": "222"}

PLAY RECAP ********************************************************************************************
rh2                        : ok=1    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0   

可以看到，task aa正确执行之后，继续执行task bb。因为 task bb用的是fail来打印信,所以执行完成之后就退出 playbook了，task cc并没有执行。