文章目录

一：Playbook概述1.1：playbook格式1.2：inventory主机清单1.3：inventory变量1.31：inventory变量参数 1.4：YAML标记语言1.5：Playbook核心元素1.6：hosts和users介绍1.7：tasks列表和action1.8：Handlers介绍1.9：playbook使用变量的方法2.0：条件测试2.11：多条件判断2.12：组条件判断2.13：自定义变量进行条件测试 2.2：迭代2.3:Templates:模板文件以.j2后缀2.4:tags模块

一：Playbook概述

playbooks是 一个不同于使用Ansible命令行执行方式的模式，其功能更强大灵活。简单来说，playbook是一个非常简单的配置管理和多主机部署系统，不同于任何已经存在的模式，可作为一个适合部署复杂应用程序的基础。Playbook可以定制配置，可以按照指定的操作步骤有序执行，支持同步和异步方式。值得注意的是playbook是通过YAML格式来进行描述定义的

1.1：playbook格式

playbook由YMAL语言编写。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl等。MAL格式是类似于JSON的文件格式，便于人理解和阅读，同时便于书写。以下为playbook常用到的YMAL格式。

YMAL中的列表元素以”-”开头然后紧跟着一个空格，后面为元素内容。就像这样- host。同一个列表中的元素应该保持相同的缩进。否则会被当做错误处理。playbook中hosts，variables，roles，tasks等对象的表示方法都是键值中间以”:”分隔，”:”后面还要增加一个空格。剧本以.yml后缀

1.2：inventory主机清单

ansible默认的主机清单是/etc/ansible/hosts文件，主机清单可以手动设置，也可以通过Dynamic Inventory动态生成，一般主机名使用FQDN

vim /etc/ansible/hosts [webserver] #方括号设置组名 www1.example.org #定义被监控主机，这边可以是主机名也可以是IP地址，主机名需要修改/etc/hosts文件 www2.example.org:4444 #冒号后定义远程连接端口，默认是ssh的22端口

如果是名称类似的主机，可以使用列表的方式表示各个主机

[webserver] www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=123456 [dbbservers] db-[a:f].example.org

1.3：inventory变量

主机变量 [webserver] www1.magedu.com http_port=80 maxRequestsChild=808 www2.magedu.com http_port=8080 maxRequestsChild=909 组变量 [servers:vars] ntp_server=ntp.example.org nfs_server=nfs.example.org 组嵌套 [apache] http1.example.org http2.example.org [nginx] ngx1.example.org ngx2.example.org [webservers:children] apache nginx

1.31：inventory变量参数

参数说明ansible_ssh_host将要连接的远程主机名.与你想要设定的主机的别名不同的话,可通过此变量设置ansible_ssh_portssh端口号.如果不是默认的端口号,通过此变量设置ansible_ssh_user默认的 ssh 用户名ansible_ssh_passssh 密码(这种方式并不安全,我们强烈建议使用 --ask-pass 或 SSH 密钥)ansible_ssh_private_key_filessh 使用的私钥文件.适用于有多个密钥,而你不想使用 SSH 代理的情况ansible_ssh_common_args此设置附加到sftp，scp和ssh的缺省命令行ansible_sftp_extra_args此设置附加到默认sftp命令行ansible_scp_extra_args此设置附加到默认scp命令行ansible_ssh_extra_args此设置附加到默认ssh命令行ansible_ssh_pipelining确定是否使用SSH管道. 这可以覆盖ansible.cfg中得设置ansible_shell_type目标系统的shell类型.默认情况下,命令的执行使用 ‘sh’ 语法,可设置为 ‘csh’ 或 ‘fish’ansible_python_interpreter目标主机的 python 路径.适用于的情况: 系统中有多个 Python, 或者命令路径不是"/usr/bin/python",比如 *BSD, 或者 /usr/bin/pythonansible_*_interpreter这里的"*"可以是ruby 或perl 或其他语言的解释器，作用和ansible_python_interpreter 类似ansible_shell_executable这将设置ansible控制器将在目标机器上使用的shell，覆盖ansible.cfg中的配置，默认为/bin/sh

1.4：YAML标记语言

YAML：另一种标记语言。是用来写配置文件的语言，非常简洁和强大。 YAML语法和其他语言类似，也可以表达散列表、标量等数据结构。 结构通过空格来展示；序列里配置项通过-来代表；Map里键值用:来分隔;YAML的扩展名为yaml

基本语法规则

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

YAML支持的数据结构

1.对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary） 例如：name:Example Developer 键 值 2.数组：一组按次序排列的值，又称为序列（sequence） / 列表（list） 例如：-Apple -Orange 3.纯量：单个的、不可再分的值 例如：number：11.20 sure：true

yaml实例：

name:zhangsan age:20 name:lisi age:22 people： -name:zhangsan age:20 -name:lisi age:22

1.5：Playbook核心元素

名称含义Hosts执行的远程主机列表Tasks任务集，即调用模块完成的某操作Varniables变量，内置变量或自定义变量在playbook中调用Templates模板，即使用模板语法的文件，比如配置文件等Handlers处理器，和notity结合使用，由特定条件触发的操作，满足条件方才执行，否则不执行tags标签，指定某条任务执行，用于选择运行playbook中的部分代码Roles角色

示例

- hosts: webserver #定义的主机组，即应用的主机 vars: #定义变量 http_port: 80 max_clients: 200 user: root tasks: #执行的任务 - name: ensure apache is at the latest version yum: pkg=httpd state=latest - name: write the apache config file template: src=/srv/httpd.j2 dest=/etc/httpd.conf notify: - restart apache - name: ensure apache is running service: name=httpd state=started handlers: #处理器 - name: restart apache service: name=httpd state=restarted 执行一个playbook的格式 ansible-playbook [yaml文件名]

实例演示：

#执行剧本 ansible-playbook ping.yaml

参数:

-k(–ask-pass) 用来交互输入ssh密码 -K(-ask-become-pass) 用来交互输入sudo密码 -u 指定用户

补充命令:

#检查yaml文件的语法是否正确 ansible-playbook nginx.yaml --syntax-check #检查tasks任务 ansible-playbook nginx.yaml --list-task #检查生效的主机 ansible-playbook nginx.yaml --list-hosts #指定从某个task开始运行 ansible-playbook nginx.yaml --start-at-task='Copy Nginx.conf'

1.6：hosts和users介绍

实例演示:

vim /opt/shuai.yml - hosts: webservers #指定主机组，可以是一个或多个组。 remote_user: root #指定远程主机执行的用户名 #执行剧本 ansible-playbook a.yaml PLAY [webservers] ********************************************************************************************** TASK [Gathering Facts] ***************************************************************************************** Enter passphrase for key '/root/.ssh/id_rsa': ok: [20.0.0.46] PLAY RECAP ***************************************************************************************************** 20.0.0.46 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 '查看语法' ansible-playbook shuai.yml --syntax-check playbook: shuai.yml

在原有基础为每个任务定义远程执行用户

vim /opt/shuai.yml - hosts: webservers remote_user: root tasks: - name: test connection ping： remote_user: root '执行剧本' ansible-playbook shuai.yml

指定远程主机sudo切换主机

vim /opt/shuai.yml - hosts: webservers remote_user: root become: yes become_user: liu02 '执行剧本' ansible-playbook shuai.yml

1.7：tasks列表和action

1.Play的主体部分是task列表，task列表中的各任务按次序逐个在hosts中指定的主机上执行，即在所有主机上完成第一个任务后再开始第二个任务。 在运行playbook时（从上到下执行），如果一个host执行task失败，整个tasks都会回滚，请修正playbook 中的错误，然后重新执行即可。 Task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量，模块执行时幂等的，这意味着多次执行是安全的，因为其结果一致。 2.每一个task必须有一个名称name，这样在运行playbook时，从其输出的任务执行信息中可以很好的辨别出是属于哪一个task的。如果没有定义name，‘action’的值将会用作输出信息中标记特定的task。 3.定义一个task，常见的格式:”module: options” 例如：yum: name=httpd 4.ansible的自带模块中，command模块和shell模块无需使用key=value格式

示例

vim a.yml - hosts: webservers remote_user: root tasks: - name: disable selinux command: '/sbin/setenforce 0' - name: install httpd yum: name=httpd - name: start httpd service: name=httpd state=started '执行剧本' ansible-playbook a.yml

假如task中有错误操作

- hosts: webservers remote_user: root tasks: - name: disable selinux command: '/sbin/setenforce 0' - name: disable firewalld yum: name=firewall state=stopped '只要play中执行的命令返回值不为0，就会报错 tasks停止' - name: start httpd service: name=httpd state=started '执行剧本' ansible-playbook a.yml PLAY [webservers] ********************************************************************************************** TASK [Gathering Facts] ***************************************************************************************** Enter passphrase for key '/root/.ssh/id_rsa': ok: [20.0.0.46] TASK [disable selinux] ***************************************************************************************** changed: [20.0.0.46] TASK [disable firewalld] *************************************************************************************** fatal: [20.0.0.46]: FAILED! => {"changed": false, "msg": "value of state must be one of: absent, installed, latest, present, removed, got: stopped"} PLAY RECAP ***************************************************************************************************** 20.0.0.46 : ok=2 changed=1 unreachable=0 failed=1 skipped=0 rescued=0 ignored=0

修改如下内容

vim a.yml - hosts: webservers remote_user: root tasks: - name: disable selinux command: '/sbin/setenforce 0' - name: disable firewalld yum: name=firewall state=stopped ignore_errors: true '忽略错误，强制返回成功 下面的语句继续执行' - name: start httpd service: name=httpd state=started '执行剧本' ansible-playbook a.yml ...省略信息.... TASK [disable firewalld] *************************************************************************************** fatal: [20.0.0.46]: FAILED! => {"changed": false, "msg": "value of state must be one of: absent, installed, latest, present, removed, got: stopped"} ...ignoring TASK [start httpd] ********************************************************************************************* ok: [20.0.0.46] PLAY RECAP ***************************************************************************************************** 20.0.0.46 : ok=4 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=1

1.8：Handlers介绍

Handlers也是一些task的列表，和一般的task并没有什么区别。 是由通知者进行的notify，如果没有被notify，则Handlers不会执行，假如被notify了，则Handlers被执行 不管有多少个通知者进行了notify，等到play中的所有task执行完成之后，handlers也只会被执行一次

示例

vim c.yml - hosts: webservers remote_user: root vars: - package: httpd - service: httpd tasks: - name: install httpd package yum: name={{package}} state=latest - name: install configuration file for httpd copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf notify: -restart httpd - name: start httpd service service: enabled=true name={{service}} state=started handlers: - name: restart httpd service: name={{service}} state=restarted #执行剧本 ansible-playbook c.yml

1.9：playbook使用变量的方法

通过ansible命令传递

示例

vim lisi.yml - hosts: mysql remote_user: root vars: - username: lisi tasks: - name: create user user: name={{username}} '执行剧本' ansible-playbook lisi.yml '或者-e后面加变量直接引用' - hosts: mysql remote_user: root vars: tasks: - name: create user user: name={{username}} 然后执行命令：ansible-playbook lisi.yml -e "user=lisi" 都是可行的

引用ansible的固定变量

- hosts: mysql remote_user: root tasks: - name: create file copy: content={{ansible_all_ipv4_addresses}} dest=/opt/add.txt '执行剧本' ansible-playbook lisi.yml '指定被管理者查看' cat /opt/add.txt ["20.0.0.47", "192.168.122.1"][root@localhost opt]#

2.0：条件测试

如果需要根据变量、facts（setup）或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试，在Playbook中条件测试使用when子句。 在task后添加when子句即可使用条件测试：when子句支持正则表达式或语法。

示例演示

vim lisi.yml - hosts: mysql remote_user: root tasks: - name: "shutdown CentOS" command: /sbin/shutdown -h now '-h:关机 -r：重启' when: ansible_distribution == "CentOS" '满足Centos就关机' '执行' ansible-playbook lisi.yml '发现mysql主机已经被关机'

2.11：多条件判断

vim lisi.yml - hosts: mysql remote_user: root tasks: - name: "shut down CentOS 7 systems" command: /sbin/shutdown -r now when: - ansible_distribution == "CentOS" - ansible_distribution_major_version == "7"

2.12：组条件判断

vim lisi.yml - hosts: mysql remote_user: root tasks: - name: "shut down CentOS 6 and Debian 7 systems" command: /sbin/shutdown -t now when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "6") or (ansible_distribution == "Debian" and ansible_distribution_major_version == "7") '执行副本' ansible-playbook lisi.yml

2.13：自定义变量进行条件测试

vim when.yml - hosts: all vars: exist: "True" 'True被管理者opt目录创建test.txt文件 改为False删除' tasks: - name: creaet file command: touch /tmp/test.txt when: exist | match("True") - name: delete file command: rm -rf /tmp/test.txt when: exist | match("False") #执行剧本 ansible-playbook when.yml

2.2：迭代

当有需要重复性执行的任务时，可以使用迭代机制。其使用格式为将需要迭代的内容定义为item变量引用，并通过with_items语句指明迭代的元素列表即可。

示例安装lamp

vim tt.yml - hosts: webserver remote_user: root tasks: - name: "Install Packages" yum: name={{ item }} state=latest with_item: - httpd - mysql-server - php '执行剧本' ansible-playbook tt.yml '查看' tail -3 /etc/passwd httpd:x:1001:1001::/home/httpd:/bin/bash mysql-server:x:1002:1002::/home/mysql-server:/bin/bash php:x:1003:1003::/home/php:/bin/bash

也可以自行定义

vim e.yml - hosts: webservers remote_user: root tasks: - name: "Add users" user: name={{ item.name }} state=present groups={{ item.groups }} with_items: - { name:'test1', groups:'wheel'} - { name:'test2', groups:'root'} '执行剧本' ansible-playbook e.yml #在所有主机上查看是否有指定添加的用户 tail -5 /etc/passwd

2.3:Templates:模板文件以.j2后缀

Jinja是基于 Python的模板引擎。 Template类是 Jinja的另一个重要组件,可以看 作是一个编译过的模板文件,用来产生目标文本,传递 Python的变量给模板去替换模 板中的标记。

示例

从被管理端复制一份httpd.conf到管理端opt目录下 scp root@20.0.0.47:/etc/httpd/conf/httpd.conf ./ vim /opt/httpd.conf Listen {{http_port}} '//后面添加变量' ServerName {{server_name}} MaxClients {{access_num}} '重命名为模板' mv httpd.conf httpd.conf.j2 '参数赋值' vim /etc/ansible/hosts [mysql] 20.0.0.47 http_port:20.0.0.47:80 server_name="www.yun.com:80" access_num=200

编写剧本

vim mei.yml - hosts: mysql remote_user: root vars: - package: httpd - service: httpd tasks: - name: install httpd package yum: name={{package}} state=latest #安装最新版本的httpd - name: install configure file template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf #使用模板并根据变量进行配置 notify: - restart httpd #调用handler - name: start httpd server service: name={{service}} enabled=true state=started #开启服务 handlers: - name: restart httpd service: name={{service}} state=restarted '运行剧本' ansible-playbook mei.yml '被管理者过滤查看信息' #在两台被管理服务器上查看 grep -i listen /etc/httpd/conf/httpd.conf grep -i maxClient /etc/httpd/conf/httpd.conf grep -i servername /etc/httpd/conf/httpd.conf

2.4:tags模块

在一个playbook中，我们一般会定义很多个task，如果我们只想执行其中的某一个task或多个task时就可以使用tags标签功能了。 格式如下：

- hosts: mysql remote_user: root tasks: - name: Copy hosts file copy: src=/etc/hosts dest=/opt/qie tags: - only '只会执行上上面的命令 下面不执行' - name: touch file file: path=/opt/op state=touch '执行剧本' ansible-playbook cp.yml --tags="only"

事实上，不光可以为单个或多个task指定同一个tags。playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。

- hosts: mysql remote_user: root tasks: - name: Copy hosts file copy: src=/etc/hosts dest=/opt/qie tags: - only - name: touch file file: path=/opt/op state=touch - always '只要带有always都会执行' #执行剧本 ansible-playbook cp.yml --tags="only" '在被管理器查看即可' ls /opt