playbook
1. 实施playbook
1.1 Ansible Playbook与临时命令
临时命令可以作为一次性命令对一组目标主机运行一项简单的任务。不过，若要真正发挥Ansible的力量，需要了解如何使用playbook以便轻松重复的方式对一组目标主机执行多项复杂的任务。
play是针对清单中选定的主机运行的一组有序任务。playbook是一个文本文件，其中包含由一个或多个按特定顺序运行的play组成的列表。
Play可以将一系列冗长而复杂的手动管理任务转变为可轻松重复的例程，并且具有可预测的成功成果。在playbook中，可以将play内的任务序列保存为人类可读并可立即运行的形式。根据任务的编写方式，任务本身记录了部署应用或基础架构所需的步骤。
1.2 格式化Ansible Playbook
前面我们学习了临时命令模块，下面以一条命令做为案例来讲解下其在playbook中是如何编写的。
ansible all -m user -a 'name=zhangshan state=present'
这个任务可以将其编写为一个单任务的play并保存在playbook中。生成的playbook如下方所示：
//写一个名为playbook.yml的playbook文件，文件名无所谓，后缀必须是yml
[root@node1 ~]# vim playbook.yml
--- //文档开始标志
- hosts: all //所有受管主机
tasks: //任务
- name: create user zhangshan //任务的名字（创建用户）
user: //模块
name: zhangshan //参数
state: present //状态是present创建，absent是删除
注意： 格式十分严谨，每一个空格都是有意义的，不可以用tab键
laybook是以YAML格式编写的文本文件，通常使用扩展名yml保存。Playbook使用空格字符缩进来表示其数据结构。YAML对用于缩进的空格数量没有严格的要求，但有两个基本的规则：
- 处于层次结构中同一级别的数据元素（例如同一列表中的项目）必须具有相同的缩进量。
- 如果项目属于其他项目的子项，其缩进量必须大于父项
只有空格字符可用于缩进，不允许使用tab键。约定俗成的缩进量一般是一级2个空格。
Playbook开头的一行由三个破折号（---）组成，这是文档开始标记。其末尾可能使用三个圆点（...）作为文档结束标记，尽管在实践中这通常会省略。
在这两个标记之间，会以一个play列表的形式来定义playbook。YAML列表中的项目以一个破折号加空格开头。例如，YAML列表可能显示如下：
- apple
- orange
- grape
Play本身是一个键值对集合。同一play中的键应当使用相同的缩进量。以下示例显示了具有三个键的YAML代码片段。前两个键具有简单的值。第三个将含有三个项目的列表作为值。
- name: just an example
hosts: webservers
tasks:
- first
- second
- third
作为play中的一部分，tasks属性按顺序实际列出要在受管主机上运行的任务。列表中各项任务本身是一个键值对集合。
还以上面创建用户的play为例，play中唯一任务有两个键：
- name是记录任务用途的可选标签。最好命名所有的任务，从而帮助记录自动流程中的每一步用途。
- user是要为这个任务运行的模块。其参数作为一组键值对传递，它们是模块的子项（name、uid和state）。
下面再来看一个含有多项任务的tasks属性案例：
[root@node1 ~]# vim playbook.yml
---
- hosts: all
gather_facts: no
tasks:
- name: install httpd
dnf:
name: httpd
state: present
- name: start httpd
service:
name: httpd
state: started
1.3 运行playbook
absible-playbook命令可用于运行playbook。该命令在控制节点上执行，要运行的playbook的名称则作为参数传递。
ansible-playbook site.yml
在运行playbook时，将生成输出来显示所执行的play和任务。输出中也会报告执行的每一项任务的结果。
以下示例中显示了一个简单的playbook的内容，后面是运行它的结果。
[root@node1 ~]# vim playbook.yml
---
- hosts: all
gather_facts: no
tasks:
- name: install httpd
dnf:
name: httpd
state: present
- name: start httpd
service:
name: httpd
state: started
[root@node1 ~]# ansible-playbook playbook.yml
PLAY [all] *************************************************************************
TASK [install httpd] ***************************************************************
changed: [node2]
TASK [start httpd] *****************************************************************
changed: [node2]
PLAY RECAP *************************************************************************
node2 : ok=2 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
请注意，在playbook运行时，屏幕中会显示每个play和任务的name键的值。（Gathering Facts任务是一项特别的任务，setup模块通常在play启动时自动运行这项任务。）对于含有多个play和任务的playbook，设置name属性后可以更加轻松地监控playbook执行的进展。
通常而言，Ansible Playbook中的任务是幂等的，而且能够安全地多次运行playbook。如果目标受管主机已处于正确的状态，则不应进行任何更改。如果再次运行这个playbook，所有任务都会以状态OK传递，且不报告任何更改。
1.4 提高输出的详细程度
ansible-playbook命令提供的默认输出不提供详细的任务执行信息。ansible-playbook -v命令提供了额外的信息，总共有四个级别。
配置Playbook执行的输出详细程序
| 选项 | 描述 |
|---|---|
| -v | 显示任务结果 |
| -vv | 任务结果和任务配置都会显示 |
| -vvv | 包含关于与受管主机连接的信息 |
| -vvvv | 增加了连接插件相关的额外详细程序选项，包括受管主机上用于执行脚本的用户以及所执行的脚本 |
演示如下：
//-v 显示任务结果,其他的同理
[root@node1 ~]# ansible-playbook -v playbook.yml
Using /etc/ansible/ansible.cfg as config file
PLAY [all] *************************************************************************
TASK [install httpd] ***************************************************************
ok: [node2] => {"ansible_facts": {"discovered_interpreter_python": "/usr/libexec/platform-python"}, "changed": false, "msg": "Nothing to do", "rc": 0, "results": []}
TASK [start httpd] *****************************************************************
ok: [node2] => {"changed": false, "name": "httpd", "state": "started", "status": {"ActiveEnterTimestamp": "Thu 2021-01-07 22:34:02 CST", "ActiveEnterTimestampMonotonic":
........
........
........
sabled", "UtmpMode": "init", "Wants": "httpd-init.service", "WatchdogTimestamp": "Thu 2021-01-07 22:34:02 CST", "WatchdogTimestampMonotonic": "4542627824", "WatchdogUSec": "0"}}
PLAY RECAP *************************************************************************
node2 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
1.5 语法验证
在执行playbook之前，最好要进行验证，确保其内容的语法正确无误。ansible-playbook命令提供了一个--syntax-check选项，可用于验证playbook的语法。
下例演示了一个playbook成功通过语法验证：
[root@node1 ~]# ansible-playbook --syntax-check playbook.yml
playbook: playbook.yml
语法验证失败时，将报告语法错误。输出中包含语法问题在playbook中的大致位置。
下例演示了一个playbook语法验证失败的情况：
[root@node1 ~]# ansible-playbook --syntax-check playbook.yml
ERROR! We were unable to read either as JSON nor YAML, these are the errors we got from each:
JSON: Expecting value: line 1 column 1 (char 0)
Syntax Error while loading YAML.
did not find expected key
The error appears to be in '/root/playbook.yml': line 9, column 4, but may
be elsewhere in the file depending on the exact syntax problem.
The offending line appears to be:
state: present
- name: start httpd
^ here
//修改完错误之后，通过验证
[root@node1 ~]# ansible-playbook --syntax-check playbook.yml
playbook: playbook.yml
1.6 执行空运行
可以使用-C选项对playbook执行空运行。这会使Ansible报告在执行该playbook时将会发生什么更改，但不会对受管主机进行任何实际的更改。
下例演示了一个playbook的空运行，它包含单项任务，可确保在受管主机上安装了最新版本的httpd软件包。注意该空运行报告此任务会对受管主机产生的更改。
ansible-playbook -C webserver.yml
演示如下：
//-C只是演示，并不会真的去执行
[root@node1 ~]# ansible-playbook -C playbook.yml
PLAY [all] *************************************************************************
TASK [install httpd] ***************************************************************
changed: [node2]
TASK [start httpd] *****************************************************************
changed: [node2]
PLAY RECAP *************************************************************************
node2 : ok=2 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
2. 实施多个play
2.1 缩写多个play
Playbook是一个YAML文件，含有由一个或多个play组成的列表。记住一个play按顺序列出了要对清单中的选定主机执行的任务。因此，如果一个playbook中有多个play，每个play可以将其任务应用到单独的一组主机。
在编排可能涉及对不同主机执行不同任务的复杂部署时，这会大有帮助。我们可以这样进行编写：对一组主机运行一个play，完成后再对另一组主机运行另一个play。
缩写包含多个play的playbook非常简单。Playbook中的各个play编写为playbook中的顶级列表项。各个play是含有常用play关键字的列表项。
以下示例显示了含有两个play的简单playbook。第一个play针对192.168.153.10运行，第二个play则针对192.168.153.20运行。
---
# This is a simple playbook with two plays
- name: first play
hosts: 192.168.153.10
tasks:
- name: first task
yum:
name: httpd
status: present
- name: second task
service:
name: httpd
enabled: true
- name: second play
hosts: 192.168.153.20
tasks:
- name: first task
service:
name: mariadb
enabled: true
2.2 play中的远程用户和特权升级
Play可以将不同的远程用户或特权升级设置用于play，取代配置文件中指定的默认设置。这些在play本身中与hosts或tasks关键字相同的级别上设置。
2.2.1 用户属性
playbook中的任务通常通过与受管主机的网络连接来执行。与临时命令相同，用于任务执行的用户帐户取决于Ansible配置文件/etc/ansible/ansible.cfg中的不同关键字。运行任务的用户可以通过remote_user关键字来定义。不过，如果启用了特权升级，become_user等其他关键字也会发生作用。
如果用于任务执行的Ansible配置中定义的远程用户不合适，可以通过在play中使用remote_user关键字覆盖。
remote_user: remoteuser
2.2.2 特权升级属性
Ansible也提供额外的关键字，从而在playbook内定义特权升级参数。become布尔值关键字可用于启用或禁用特权升级，无论它在Ansible配置文件中的定义为何。它可取yes或true值来启用特权升级，或者取no或false值来禁用它。
become: true
如果启用了特权升级，则可以使用become_method关键字来定义特定play期间要使用的特权升级方法。
以下示例中指定sudo用于特权升级：
become_method: sudo
此外，启用了特权升级时，become_user关键字可定义特定play上下文内要用于特权升级的用户帐户。
become_user: privileged_user
2.3 查找用于任务的模块
2.3.1 模块文档
Ansible随附打包的大量模块为管理员提供了许多用于常见管理任务的工具。前面我们介绍了Ansible官方网站的帮助文档链接https://docs.ansible.com/。通过模块索引，可以很轻松的找到对应的模块。例如，适用于用户和服务管理的模块可以在Systems Modules下找到，而适合数据库管理的模块则可在Database Modules下找到。
对于每一个模块，Ansible官网提供了其功能摘要，以及关于如何通过模块的选项来调用各项具体功能的说明。文档还提供了实用的示例，演示各个模块的用法，以及任务中关键字的设置方法。
前面我们用到过ansible-doc -l命令。这将显示模块名称列表以及其功能的概要。
ansible-doc -l
使用ansible-doc [module name]命令来显示模块的详细文档。与Ansible官网一样，该命令提供模块功能的概要、其不同选项的详细信息，以及示例。
ansible-doc yum # 显示yum模块的帮助文档
ansible-doc命令还提供-s选项，它会生成示例输出，可以充当如何在playbook在使用特定模块的示范。此输出可以作为起步模板，包含在实施该模块以执行任务的playbook中。输出中包含的注释，提醒管理员各个选项的用法。下例演示了yum模块的这种输出：
ansible-doc -s yum
使用ansible-doc命令可以查找和了解如何使用模块。尽管command、shell和raw模块的用法可能看似简单，但在可能时，应尽量避免在playbook中使用它们因为它们可以取胜任意命令，因此使用这些模块时很容易写出非幂等的playbook。
例如，以下使用shell模块的任务为非幂等。每次运行play时，它都会重写/etc/resolv.conf，即使它已经包含了行nameserver 114.114.114.114。
- name: Non-idepotent approach with shell module
shell: echo "nameserver 114.114.114.114" > /etc/resolv.conf
可以通过多种方式编写以幂等方式使用shell模块的任务，而且有时候进行这些更改并使用shell是最佳的做法。但更快的方案或许是使用ansible-doc发现copy模块，再使用它获得所需的效果。
在以下示例中，如果/etc/resolv.conf文件已包含正确的内容，则不会重写该文件：
- name: Idempotent approach with copy module
copy:
dest: /etc/resolv.conf
content: "nameserver 114.114.114.114
"
copy模块可以测试来了解是否达到了需要的状态，如果已达到，则不进行任何更改。
注意：shell模块容许非常大的灵活性，但需要格外小心，从而确保它以幂等方式运行。
幂等的playbook可以重复运行，确保系统处于特定的状态，而不会破坏状态已经正确的系统。