Ansible进阶学习之Playbooks(剧本)的理解使用

前言

上一篇文章为大家对“Ansible”简单入了个门，介绍了自动化运维发展，Ansible的基本原理以及基本模块的使用。本篇文章，我们将趁热打铁，学习Ansible的核心——playbook的使用。

看完本篇文章，你将收获：

为什么要引入playbook
YAML的基本语法和简介
playbook基础组件定义及具体使用

为什么要引入playbook?

我们都知道，Ansible实现管理主要有两种方式：

Ad-HOC	利用ansible命令直接完成管理，主要用于临时命令使用场景
playbook	ansible脚本，主要用于大型项目场景，需要前期的规划

其中Ad-HOC就是我们在之前文章里介绍的通过调用Ansible自带模块实现管理的方式，那小伙伴们有没有想过为什么要引入playbook的方式呢？

我们完成一个任务，例如安装部署一个httpd服务，我们需要调用ansible提供的多个模块（一个模块也可以称之为task）提供功能来完成。而playbook就是组织多个task的容器，他的实质就是一个文件，有着特定的组织格式，它采用的语法格式是YAML（Yet Another Markup Language）。

所以为了更好的理解和学习Playbooks，我们需要对YAML有一定的了解。

YAML

基本介绍

– YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。
– YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。
– YAML 的配置文件后缀为 .yml，如：runoob.yml 。

基本语法

大小写敏感
使用缩进表示层级关系
缩进时不允许使用 Tab 键，只允许使用空格
缩进的数目不重要，只要相同层级的元素左侧对齐即可

支持的数据结构

对象：键值对的集合，又称为映射（mapping）/哈希（hashes）/字典（dictionary）

对象：
一组键值对，使用冒号结构表示：
task:：install

字典：
每一个成员由键值对组成，注意冒号后面要有空格
martin:
        name: Martin D’vloper
         job: Developer
        skill: Elite
或者：
martin: {name: Martin D’vloper, job: Developer, skill: Elite}

数组：一组按次序排列的值，又称为序列（sequence）/ 列表（list）

列表：
每一个列表成员前面都要有一个短横线和一个空格：
fruits:
        - Apple
        - Orange
        - Strawberry
        - Mango
或者：
fruits: [‘Apple’, ‘Orange’, ‘Strawberry’, ‘Mango’]

纯量（scalars）：单个的，不可再分的值

数值：
number：12
float：12.30

字符:
str：这是一行字符

布尔值：
表示true的值
true，True，TRUE，yes，Yes，YES，on，ON，y，Y
表示false的值
false，False，FALSE，no，No，NO，off，OFF，n，N

Playbooks(剧本)

简介

Playbooks(剧本)是Ansible的配置、部署语言，由它对描述你想要远程机器执行的策略或步骤，使用YAML编写。playbooks是由一个或多个“play”（task）组成的列表。从根本上讲task就是调用ansible的一个模块（module）。将多个play组织在一个playbook中，运行时就会根据自上而下的顺序依次执行。

牛刀小试

在正式介绍playbook基础组件之前，我们先来写个简单的demo体验一下。

我们先写个简单的剧本，功能是对主机清单上申明的所有受控端进行网络连通性测试。

vim /etc/ansible/roles/ping.yml

然后通过ansible-playbook 文件名的形式进行执行。

是不是感觉跟我们用上一篇文章介绍的Ad-HOC的方式实现的效果差不多。

此言差矣，根据官网上的介绍，Playbooks 与 adhoc 相比,是一种完全不同的运用 ansible 的方式,是非常之强大的。究竟有多强大呢？接下来我们就先来看看playbook基本组件。

playbook基础组件

Playbooks结构：

Hosts：运行执行任务（task）的目标主机
remote_user：在远程主机上执行任务的用户
tasks：任务列表
handles：任务，与tasks不同的是只有在接收到通知时才会被触发
templates：使用模板语言的文本文件，使用jinja2语法
variables：变量，变量替换{{ variable_name }}

需要注意的是，整个playbook是以task为中心，表明要执行的任务。hosts和remote_user表明在哪些远程主机以何种身份执行。其他组件让其能够更加灵活。

下面详细介绍某些组件：

1、Hosts和Users

playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。hosts用于指定要执行指定任务的主机，其可以是一个或多个由冒号分隔主机组；remote_user则用于指定远程主机上的执行任务的用户。如下面示例中的：

- hosts: webnodesremote_user: root

不过，remote_user也可用于各task中。也可以通过指定其通过sudo的方式在远程主机上执行任务，其可用于play全局或某任务；此外，甚至可以在sudo时使用sudo_user指定sudo时切换的用户。

- hosts: webnodesremote_user: mageedutasks:- name: test connectionping:remote_user: mageedusudo: yes

比如我们再写一个简单的playbook，里面写了两个play，一个play是在nginx组的主机上都创建一个nginx组，nginx用户，另一个play是复制一个文件到mysql组的主机上：

vim /etc/ansible/roles/nginx.yml

查看ansible-playbook的使用方法

man ansible-playbook

非常详细，感兴趣的伙伴可以去了解一下

运行playbook

ansible-playbook nginx.yml

当然，还有更详细的用法，大家可以参考下面的内容

用法：
ansible-playbook <filename.yml> ... [options]<filename.yml>:yaml格式的playbook文件路径，必须指明[options]: 选项-C, --check：并不在远程主机上执行，只是测试。-i PATH, --inventory=PATH：资产的文件路径--flush-cache：清楚fact缓存--list-hosts：列出匹配的远程主机，并不执行任何动作-t, TAGS, --tags=TAGS：运行指定的标签任务--skip-tags:跳过指定的notify

运行结果：

2、任务列表(Tasks)和action

play的主体部分是task list。task list中的各任务按次序逐个在hosts中指定的所有主机上执行，即在所有主机上完成第一个任务后再开始第二个。在运行自下而下某playbook时，如果中途发生错误，所有已执行任务都可能回滚，因此，在更正playbook后重新执行一次即可。(因为具有幂等性)

task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致。

每个task都应该有其name，用于playbook的执行结果输出，建议其内容尽可能清晰地描述任务执行步骤。如果未提供name，则action的结果将用于输出。

定义task的可以使用“action: module options”(这个在较新版本上才能执行)或“module: options”的格式，推荐使用后者以实现向后兼容。如果action一行的内容过多，也可以使用在行首使用几个空白字符进行换行。

tasks:
- name: make sure apache is runningservice: name=httpd state=running

在众多模块中，只有command和shell模块仅需要给定一个列表而无需使用“key=value”格式，例如：

tasks:
- name: disable selinuxcommand: /sbin/setenforce 0

如果命令或脚本的退出码不为零，可能会阻止playbook继续往下执行可以使用如下方式替代：

tasks:
- name: run this command and ignore the resultshell: /usr/bin/somecommand || /bin/true

也就是说这个命令失败也是要继续往下走的，就是失败了但不要影响下面的操作。或者使用ignore_errors来忽略错误信息：

tasks:
- name: run this command and ignore the resultshell: /usr/bin/somecommandignore_errors: True

3、handlers

用于当关注的资源发生变化时采取一定的操作。

"notify"这个action可用于在每个play的最后被触发，这样可以避免多次有改变发生时每次都执行指定的操作，取而代之，仅在所有的变化发生完成后一次性地执行指定操作。在notify中列出的操作称为handler，也即notify中调用handler中定义的操作。

- name: template configuration filetemplate: src=template.j2 dest=/etc/foo.confnotify:- restart memcached- restart apache

handler是task列表，这些task与前述的task并没有本质上的不同。

handlers:
- name: restart memcachedservice:  name=memcached state=restarted
- name: restart apacheservice: name=apache state=restarted

为了方便大家理解，下面举个栗子：

比如有个配置apache的playbook，然后利用这个来说明handlers

先创建一个apache.yml，里面定义play安装启动apache

然后启动剧本运行

假如说某个时刻httpd.conf发生改变了，比如说不再监听在80，而是监听在8080端口，其他没变。修改/root/conf/httpd.conf，把端口改成8080，再执行这个playbook：

ansible-playbook apache.yml

到mysql组所在的主机192.168.100.110上查看端口，发现监听端口仍然是80：

[root@node02 ~]# ss -tnlp

一个程序的配置文件发生了改变，那么程序应该重读配置文件才对。然而默认情况下，你多次唱同一个剧本，如果那个task此前执行过，为了保证幂等性，它是不会再被执行。handlers就是为了解决这种问题而生的。Handlers也是任务，但它不是上来就执行的，只有某个条件满足时才会执行。所以我们去修改apache.yml：

修改/root/conf/httpd.conf，把端口改成8090，再执行这个playbook：

到mysql组所在的主机192.168.100.110上查看端口，发现监听端口改变了，变成了8090：

playbook中使用变量

【注意】：playbook中能使用的变量不仅仅是这里定义的变量，而且可以使用ansible中定义的所有变量。例如：

[root@node01 ~]# ansible 172.16.7.152 -m setup

另外，在inventory中定义的变量也可以在playbook中调用。例如:

[root@node01 ~]# vim /etc/ansible/hosts

巨人的肩膀

1、https://blog.51cto.com/13589448/2068546 《Ansible之playbook的使用》
2、https://blog.csdn.net/f8152/article/details/79994545 《YAML的基本语法和简介》
3、https://blog.csdn.net/snji_g/article/details/108553548 《Ansible命令运行方式及常用模块》
4、https://max.book118.com/html/2019/0906/8107016113002046.shtm 《Ansible自动化运维实践》
5、http://www.ansible.com.cn/docs/playbooks_intro.html 《Ansible中文权威指南》
6、https://www.runoob.com/w3cnote/yaml-intro.html 《Ansible入门教程》

彩蛋

相信看到这里的朋友，都是菌哥的真爱粉了，那不送小伙伴们点福利怎么行！关注『 猿人菌 』，后台回复“思维导图”，获取菌哥亲绘精美思维导图，货真价实，先到先得哦~

小结

本篇关于ansible进阶之playbook的使用到这里就结束了，受益的朋友记得点赞三连支持一波！你知道的越多，你不知道的也越多，我是Alice，我们下一期见！

文章持续更新，可以微信搜一搜「猿人菌」第一时间阅读，思维导图，大数据书籍，大数据高频面试题，海量一线大厂面经…期待您的关注!