Ansible playbook 详解

一、playbook流程介绍

playbook是由一个或者多个“play”组成的列表play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲，所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中，即可以让他们联同起来按照事先编排的机制同唱一台大戏。palybook采用YAML预言编写

二、yaml介绍

YAML是一个可读性高用来表达资料序列的格式。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言，另外Ingy dot Net与Oren Ben-Kiki也是这种语言的共同设计者。YAML Ain’t Markup Language，即TAML不是XML。不过，在开发这种语言时，YAML的意思其实是：Yet Another Markup Language（仍是一种标记语言）特性 YAML的可读性好 YAML和脚本语言的交互性好 YAML使用实现语言的数据类型 YAML有一个一致的信息模型 YAML易于实现 YAML可以基于流来处理 YAML表达能力强，扩展性好更多内容及规范参见http://www.yaml.org

三、YAML语法简介

1、注意

在单一档案中，可以连续三个连字号 “—” 区分多个档案。另外，还有选择性的连续三个点号 “…” 用来表示档案结尾次行开始正常写playbook的内容，一般建议些明该playbook的功能使用#号注释代码缩进必须是统一的，不能空格和tab混用缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判断配置的级别是通过缩进结合换行来实现的YAML文件内容和linux系统大小写判断方式保持一致，是区别大小写的，k/v的值均需大小写敏感k/v的值可同行写也可换行写。同行的话，使用：号分割v可是一个字符串，也可是另一个列表一个完成的代码块功能需最少元素包括 name: task一个name只能包括一个taskYAML文件扩展名通常为yml或者yaml

2、list：列表，其所有元素均使用“-”打头

示例：

# Alist of tasty fruits - Apple - Orange - Strawberry - Mango

3、Dictionary：字典，通常由说个key与value构成

示例：

--- # An employee record name:Example Developer job:Developer skill:Elite # 可将key:value放置于{}中进行表示，用“，”分隔多个key:value # 示例： --- # An employee record {name:Example Developer,job:Developer,skill:Elite} YAML的语法和其他高阶语言类似，并且可以简单表达清单，散列表、标量等数据结构。其 机构（Structure）通过空格来展示，序列（Sequence）里的项目“-”来代表，Map李的键值对用“：”分割。

四、playbook的核心元素(http://www.ansible.com.cn/)中文网

hosts 执行的远程主机列表tasks 任务集varniables 内置变量或自定义变量在playbook中调用templates 模板，可替换模板文件中的变量并实现一些简单逻辑文件hanslers 和notity结合使用，有特定条件出发操作，满足条件方可执行，否则不执行tags 标签 指定某条任务执行，用于选择运行playbook中部分代码。ansible具有幂等性，因此会自动化跳过没有变化的部分，即便如此，有些代码为此时其确实没有发生变化的时间依然会非常的长。此时，确信其没有变化，就可以通过tags跳过此些代码片段。

五、playbook基础组件

1、hosts：

playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。hosts用于指定要执行指定任务的主机，须事先定义在主机清单中

可以是如下形式： one.example.com one.example.com:two.example.com 192.168.1.50 192.168.1.* webserver:dbserver 两个组的并集 webserver:&dbserver 两个组的交集 webserver:!dbserver 在webserver组中 但不在dbserver组中 示例： - hosts：webserver:sbserver

2、remote_user:

可用于Host和task中。也可以通过制定其通过sudo的方式在远程主机上执行任务，其可用于play全局或某任务；此外；甚至可以在sudo时使用sudo_user: root时切换到用户。 - hosts: web remote_user: root tasks: - name: test connection ping remote_user: zhangwei sudo: yes #默认sudo为root sudo_user: wang #sudo为wang

3、tasks：任务列表

格式：

action: module argumentsmodule: arguments 【建议使用】注意：shell和command模块后面跟命令，而非key=value

某任务的状态在运行后为change时，可通过‘notify’通知给相应的handlers

某任务可以通过‘tags’打标签，而后可在ansible-playbook命令上使用-t指定进行调用

示例：

tasks： - name: disable selinux command: /sbin/setenforce 0

如果命令或脚本的退出码不为零，可以使用如下方式替代

tasks:

name: run this conamnd and ignore the result shell : /usr/bin/sommecommand || /bin/true

或者使用ignore_errors来忽略错误信息：

tasks: - name: run this conamnd and ignore the result shell : /usr/bin/sommecommand ignore_errors: True

六、 运行playbook方式

ansible-playbook <filename.yml> … [options]

常见选项

--check (-C)只检测可能会发生的改变，但不真正执行操作 --list-hosts 列出运行任务的主机 --limit 主机列表 只针对主机列表中的主机执行 -v 显示过程 -vv -vvv更详细

示例：

ansible-playbook file.yml --check 只检测 ansible-playbook file.yml ansible-playbook file.yml --limit webserver ansible-playbook file.yml --list-hosts # 查看主机 ansible-playbook file.yml --list-tasks #查看任务列表 ansible-playbook file.yml --list-tags # 查看标签

练习

注意 ：上图中copy连续使用两次，这是错误操作，这种操作只会执行最下面的copy，其余copy不会执行！！应该将其分开，分为两个name。

七、handlers和notify结合使用触发条件

handlers

是tasks列表，这些task与前述的task并没有本质上的不同，用于当关注的资源发生变化时，才会采取一定的操作

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

--- - hosts: all remote_user: root tasks: - name: install Apache yum: name=httpd state=installed - name: copy conf copy: src=/etc/httpd/conf/httpd.conf dest=/etc/httpd/conf/ backup=yes notify: service restart - name: service Apache service: name=httpd state=started enabled=yes handlers: - name: service restart service: name=httpd state=restarted # 小贴士：selinux的开启导致apache更换端口后启动不成功

八、playbook中tags的使用

ansible-playbook -t conf httpd.yml # 使用-t 指定标签名字】 ansible-playbook -t conf,service httpd.yml # 指定多个标签运行 ansible-playbook httpd.yml --list-tsgs #查看标签列表 注意：tags标签命名可以相同，不通模块下写入相同tags标签，执行时，打入标签的模块会同时执行

九、playbook中变量的使用

变量名：仅能由字母、数字和下划线组成，且只能以字母开头变量来源：

使用setup模块中的变量 ansible setup facts 远程主机的所有变量(系统自带变量)都可以直接调用 eg：

ansible all -m setup #查看远程主机的所有变量 ansible all -m setup -a 'filter=ansible_hostname'#过滤主机中的变量 ansible all -m setup -a 'filter=ansible_hostname' ##过滤主机的主机全名

这里查找到的变量可以直接在playbook中调用

在/etc/ansible/hosts中定义 普通变量：主机组中主机单独定义，优先级高与公共变量 公共组变量：针对主机组中所有主机定义统一变量 普通变量的优先级高于公共变量

通过命令行指定变量，优先级最高 ansible-playbook -e varname=value eg：

--- - hosts: web remote_user: root tasks: - name: install pkname yum: name={{ pkname }} - name: start serivece service: name={{ pkname }} state=started enabled=yes

ansible-playbook -e ‘pkname=httpd’ test.yml

在playbook中定义

vars: - var1: value1 - var2: value2

ansible-playbook test.yml

使用变量文件 可以单独顶一个文件存放变量值 eg：

[root@192-168-10-22 ansible]# cat vars.yml var1: vsftpd #注意空格 var2: httpd #注意空格 [root@192-168-10-22 ansible]# cat test.yml --- - hosts: web remote_user: root vars_files: #注意是var_files。“s” - vars.yml tasks: - name: install package yum: name={{ var1 }} - name: create file file: name=/data/{{ var2 }}.log state=touch

变量的优先级：命令行中的-e > playbook中定义的变量 > 主机清单中定义的变量

在role中定义