playbook的使用

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

1.playbook的写法

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

????????参数写在模块后面，命令如下

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

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

????????参数分行写，一行一个参数，命令如下

‐ 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 文件。

????????本章实验都在/root/jiayi下操作，先把jiayi目录创建出来并把 ansible.cfg和hosts拷贝进去

[root@RHEL ~]# mkdir jiayi
[root@RHEL ~]# cp ansible.cfg hosts jiayi/
[root@RHEL ~]# cd jiayi/

????????写一个playbook文件test1.yaml，在RHEL2和RHEL3上打印主机名和IP

????????分析：因为在RHEL2和RHEL3上做的是相同的操作，所以只要一个play即可。这个play中包含两个task: 一个用于打印主机名，另一个用于打印IP

[root@RHEL jiayi]# cat test1.yaml 
---
- hosts: RHEL2,RHEL3
  tasks:
  - name: 打印主机名
    debug: msg={{ansible_fqdn}}
  - name: 打印IP
    debug: msg={{ansible_default_ipv4.address}} 

????????运行此playbook

[root@RHEL jiayi]# ansible-playbook test1.yaml 

PLAY [RHEL2,RHEL3] ******************************************************************************************************************

TASK [Gathering Facts] **************************************************************************************************************
ok: [RHEL2]
ok: [RHEL3]

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

TASK [打印IP] *************************************************************************************************************************
ok: [RHEL2] => {
    "msg": "192.168.10.20"
}
ok: [RHEL3] => {
    "msg": "192.168.10.30"
}

PLAY RECAP **************************************************************************************************************************
RHEL2                      : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
RHEL3                      : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0  

????????写一个playbook文件test2.yaml，在server2上打印主机名，在server3上打印IP。

????????分析:因为在RHEL2和RHEL3上做的是不同的操作，所以这里写两个play，一个play在RHEL2上执行,另一个play在RHEL3上执行。每个play中只要包含一个task即可

[root@RHEL jiayi]# cat test2.yaml 
---
- name: 在RHEL2上的操作
  hosts: RHEL2
  tasks:
  - name: 打印主机名
    debug: msg={{ansible_fqdn}}

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

运行此playbook

[root@RHEL jiayi]# ansible-playbook test2.yaml 

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

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

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

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

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

TASK [打印IP] *************************************************************************************************************************
ok: [RHEL3] => {
    "msg": "192.168.10.30"
}

PLAY RECAP **************************************************************************************************************************
RHEL2                      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
RHEL3                      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

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

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

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

????????分析：因为在RHEL2和RHEL3上做的是不同的操作，所以这里写两个play.

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

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

[root@RHEL jiayi]# cat test3.yaml 
---
- name: 在RHEL2上操作---安装vsftpd，启动服务，开启防火墙
  hosts: RHEL2
  tasks:
  - name: 一.安装vsftpd
    yum: name=vsftpd state=installed
  - name: 二.启动服务
    service: name=vsftpd state=started enabled=yes
  - name: 三.开启防火墙
    firewalld: service=ftp state=enabled immediate=yes permanent=yes

- name: 在RHEL3上操作---安装httpd，启动服务，开启防火墙
  hosts: RHEL3
  tasks:
  - name: 一.安装httpd
    yum: name=httpd state=installed
  - name: 二.启动服务
    service: name=httpd state=started enabled=yes
  - name: 三.开启防火墙
    firewalld: service=http state=enabled immediate=yes permanent=yes

????????运行此playbook

[root@RHEL jiayi]# ansible-playbook test3.yaml 

PLAY [在RHEL2上操作---安装vsftpd，启动服务，开启防火墙] **********************************************************************************************

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

TASK [一.安装vsftpd] *******************************************************************************************************************
changed: [RHEL2]

TASK [二.启动服务] ***********************************************************************************************************************
changed: [RHEL2]

TASK [三.开启防火墙] **********************************************************************************************************************
changed: [RHEL2]

PLAY [在RHEL3上操作---安装httpd，启动服务，开启防火墙] ***********************************************************************************************

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

TASK [一.安装httpd] ********************************************************************************************************************
changed: [RHEL3]

TASK [二.启动服务] ***********************************************************************************************************************
changed: [RHEL3]

TASK [三.开启防火墙] **********************************************************************************************************************
changed: [RHEL3]

PLAY RECAP **************************************************************************************************************************
RHEL2                      : ok=4    changed=3    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
RHEL3                      : ok=4    changed=3    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0 

????????查看RHEL2和RHEL3确认服务开启

[root@RHEL2 ~]# systemctl status vsftpd
● vsftpd.service - Vsftpd ftp daemon
   Loaded: loaded (/usr/lib/systemd/system/vsftpd.service; enabled; vendor preset: disabled)
   Active: active (running) since Tue 2023-12-19 21:04:19 EST; 46s ago
  Process: 2266 ExecStart=/usr/sbin/vsftpd /etc/vsftpd/vsftpd.conf (code=exited, status=0/SUCCESS)
 Main PID: 2267 (vsftpd)
    Tasks: 1 (limit: 24728)
   Memory: 580.0K
   CGroup: /system.slice/vsftpd.service
           └─2267 /usr/sbin/vsftpd /etc/vsftpd/vsftpd.conf

[root@RHEL3 ~]# systemctl status httpd
● httpd.service - The Apache HTTP Server
   Loaded: loaded (/usr/lib/systemd/system/httpd.service; enabled; vendor preset: disabled)
   Active: active (running) since Wed 2023-12-20 10:04:32 CST; 43s ago
     Docs: man:httpd.service(8)
 Main PID: 6132 (httpd)
   Status: "Running, listening on: port 80"
    Tasks: 213 (limit: 24601)
   Memory: 25.3M
   CGroup: /system.slice/httpd.service
           ├─6132 /usr/sbin/httpd -DFOREGROUND
           ├─7916 /usr/sbin/httpd -DFOREGROUND
           ├─7917 /usr/sbin/httpd -DFOREGROUND
           ├─7918 /usr/sbin/httpd -DFOREGROUND
           └─7919 /usr/sbin/httpd -DFOREGROUND

2.错误处理

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

2.1 ignore_errors

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

[root@RHEL jiayi]# cat test4.yaml 
---
- hosts: RHEL2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg={{default_xxx}}

  - name: bb
    debug: msg={{2222}}

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

[root@RHEL jiayi]# ansible-playbook test4.yaml 

PLAY [RHEL2] ************************************************************************************************************************

TASK [aa] ***************************************************************************************************************************
fatal: [RHEL2]: 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 '/root/jiayi/test4.yaml': line 5, column 5, but may\nbe elsewhere in the file depending on the exact s
yntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n  - name: aa\n    ^ here\n"}

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

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

[root@RHEL jiayi]# cat test4.yaml 
---
- hosts: RHEL2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg={{default_xxx}}
    ignore_errors: true
  - name: bb
    debug: msg={{2222}}

????????这里添加了ignore_errors：true忽略报错信息。

????????下面运行test4.yaml查看结果

[root@RHEL jiayi]# ansible-playbook test4.yaml 

PLAY [RHEL2] ************************************************************************************************************************

TASK [aa] ***************************************************************************************************************************
fatal: [RHEL2]: 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 '/root/jiayi/test4.yaml': line 5, column 5, but may\nbe elsewhere in the file depending on the exact s
yntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n  - name: aa\n    ^ here\n"}
...ignoring

TASK [bb] ***************************************************************************************************************************
ok: [RHEL2] => {
    "msg": "2222"
}

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

????????可以看到，即使task aa出错了，但是后续的 task bb仍然继续执行。

2.2 fail语句

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

[root@RHEL jiayi]# cat test5.yaml 
---
- hosts: RHEL2
  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查看结果

[root@RHEL jiayi]# ansible-playbook test5.yaml 

PLAY [RHEL2] ************************************************************************************************************************

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

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

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

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