Ansible的脚本——playbook剧本
目录
playbook简介
playbook本身由以下各部分组成
编写playbook
示例1：yum安装nginx
解析
运行playbook
示例2：yum安装nginx
运行playbook
检查yaml文件的语法是否正确
检查tasks任务
检查生效的主机
指定从某个task开始运行
定义、引用变量
示例：定义变量
示例：引用fact中的变量
迭代
with_item 单循环输出
with_list 每组列表一起循环的输出
with_together 同一列表位置数据组合输出的循环
with_nested 列表数据循环匹配的循环（根据列表个数定义有多少层的循环）
when条件判断
when条件还可以通过 ！=（不等于条件来进行判断）
Templates 模块
过程演示
单标签的使用
多标签的运用
通用标签always的运用
Roles 模块
简述Ansible角色
roles 的目录结构
roles 内各目录含义解释
在一个 playbook 中使用 roles 的步骤
总结
迭代循环方式
when
playbook简介
playbook是 一个不同于使用Ansible命令行执行方式的模式，其功能更强大灵活。简单来说，playbook是一个非常简单的配置管理和多主机部署系统，不同于任何已经存在的模式，可作为一个适合部署复杂应用程序的基础。Playbook可以定制配置，可以按照指定的操作步骤有序执行，支持同步和异步方式。我们完成一个任务，例如安装部署一个httpd服务，我们需要多个模块（一个模块也可以称之为task）提供功能来完成。而playbook就是组织多个task的容器，他的实质就是一个文件，有着特定的组织格式，它采用的语法格式是YAML。
playbook本身由以下各部分组成
- Tasks：任务，即通过 task调用 ansible的模板将多个操作组织在一个playbook中运行
- Variables：变量
- Templates：模板
- Handlers：处理器，当notify所在任务满足changed状态条件时，触发执行的操作
- Roles：角色
编写playbook
示例1：yum安装nginx
vim test1.yaml
--- #yaml文件以---开头，以表明这是一个yaml文件，可省略
- name: first play #定义一个play的名称，可省略
gather_facts: false #设置不进行facts信息收集，这可以加快执行速度，可省略
hosts: webservers #指定要执行任务的被管理主机组，如多个主机组用冒号分隔
remote_user: root #指定被管理主机上执行任务的用户
tasks: #定义任务列表，任务列表中的各任务按次序逐个在hosts中指定的主机上执行
- name: test connection #自定义任务名称
ping: #使用 module: [options] 格式来定义一个任务
- name: disable selinux
command: '/sbin/setenforce 0' #command模块和shell模块无需使用key=value格式
ignore_errors: True #如执行命令的返回值不为0，就会报错，tasks停止，可使用ignore_errors忽略失败的任务
- name: disable firewalld
service: name=firewalld state=stopped #使用 module: options 格式来定义任务，option使用key=value格式
- name: mount cdrom
mount: src=/dev/sr0 path=/mnt state=mounted fstype=iso9660
ignore_errors: True
- name: install httpd
yum: name=httpd state=latest
- name: install configuration file for httpd
copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf #这里需要一个事先准备好的/opt/httpd.conf文件
notify: "restart httpd" #如以上操作后为changed的状态时，会通过notify指定的名称触发对应名称的handlers操作
- name: start httpd service
service: enabled=true name=httpd state=started
handlers: #handlers中定义的就是任务，此处handlers中的任务使用的是service模块
- name: restart httpd #notify和handlers中任务的名称必须一致
service: name=httpd state=restarted
##Ansible在执行完某个任务之后并不会立即去执行对应的handler，而是在当前play中所有普通任务都执行完后再去执行handler，这样的好处是可以多次触发notify，但最后只执行一次对应的handler，从而避免多次重启。
复制代码解析
执行状态返回
用该剧本进行防火墙的关闭，其中一台已经关闭防火墙，另一台未关闭。
其中已经为所设配置而状态未改变的，会显示为ok。
状态发生改变的，会显示为changed。
ignore_errors: True
如执行命令的返回值不为0，就会报错，tasks停止，可使用ignore_errors忽略失败的任务
其中一台远程主机selinux设为永久关闭，并重启，使得selinux状态为disabled。另一台selinux依然为开启状态。
如果不设置ignore_errors: True，因为selinux状态为disabled，返回值不为0，所以该主机的task会停止。另一台主机不受影响，依然会继续任务的进行。
设置ignore_errors: True，就会忽略，继续后面进行任务。
运行playbook
准备工作
事先准备好一个/opt/httpd.conf文件
运行展示
运行该剧本
远程主机的httpd已经运行
浏览器访问也没有问题
示例2：yum安装nginx
- name: second play
gather_facts: false
hosts: webservers
remote_user: root
tasks:
- name: disable selinux
command: '/usr/sbin/setenforce 0'
ignore_errors: true
- name: disable firewalld
service: name=firewalld state=stopped enabled=no
- name: upload nginx.repo
copy: src=/etc/yum.repos.d/nginx.repo dest=/etc/yum.repos.d/nginx.repo
- name: install nginx
yum: name=nginx state=latest
- name: prepare httpd configuration file
copy: src=/opt/default.confdest=/etc/nginx/conf.d/default.conf
notify: " restart nginx"
- name: start nginx
service: name=nginx state=started enabled=yes
handlers:
- name: restart nginx
service: name=nginx state=restarted
复制代码运行playbook
ansible-playbook test1.yaml
//补充参数：
-k（–ask-pass）：用来交互输入ssh密码
-K（-ask-become-pass）：用来交互输入sudo密码
-u：指定用户
ansible-playbook test1.yaml --syntax-check #检查yaml文件的语法是否正确
ansible-playbook test1.yaml --list-task #检查tasks任务
ansible-playbook test1.yaml --list-hosts #检查生效的主机
ansible-playbook test1.yaml --start-at-task='install httpd' #指定从某个task开始运行
复制代码检查yaml文件的语法是否正确
此状态表示没有问题
刻意制造一个错误，再进行检测
检查tasks任务
此状态表示没有问题
用于检测tasks中出现的错误
检查生效的主机
指定从某个task开始运行
指定从install httpd开始进行
定义、引用变量
- name: second play
hosts: dbservers
remote_user: root
vars: #定义变量
- groupname: mysql #格式为 key: value
- username: nginx
tasks:
- name: create group
group: name={{groupname}} system=yes gid=306 #使用 {{key}} 引用变量的值
- name: create user
user: name={{username}} uid=306 group={{groupname}}
- name: copy file
copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt #gather_facts设为true，进行facts信息收集，在setup模块中可以获取facts变量信息
复制代码示例：定义变量
运行结果
变量可命令行里定义
格式：ansible-playbook 剧本文件名 -e "变量名=定义的值"
示例：引用fact中的变量
setup 可以收集该组中所有的节点信息，所以setup中fact信息，有时候会剧本编写中需要，而fact的信息也是可以通过变量的方式进行调用
获取远程主机IP地址：
运行结果
执行后，获取到地址并输入到远程主机文件中。
注意：
引用fact中的变量时，不能设置为gather_facts: false，设置后将获取不到变量
迭代
Ansible提供了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。
- with_items：{{item}}会把所有的列表展开进行遍历输出，with_flattened也可以替代with_items
- with_list：{{item}}会把每个列表当作一个整体输出。如果每个列表中只有一个值，则效果与with items一致。loop也可以替代ith
- with_together：{{item}}引用时会把每个列表相同位置的值对齐合并后输出
- with nested：{{item}}引用时会把每个列表的值两两组合循环输出
with_item 单循环输出
两个列表时，with_item 循环输出
遍历定义的变量
不止一种变量时
列表也可以横向表示：
with_list 每组列表一起循环的输出
with_together 同一列表位置数据组合输出的循环
两个列表数量不一样
with_nested 列表数据循环匹配的循环（根据列表个数定义有多少层的循环）
when条件判断
在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。
when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务
vim demo7.yaml
---
- hosts: all
remote_user: root
tasks:
- name: stop httpd
service: name=httpd state=stopped enabled=no
when: ansible_default_ipv4.address == "192.168.44.30" #when指令中的变量名不需要手动加上 {{}}
或
when: inventory_hostname == "<主机名>"
ansible-playbook demo7.yaml
复制代码
原本两台远程主机httpd为开启，且开机自启动
如果不符合条件直接跳过
其中一台已经关闭httpd，另一台未改变。
when条件还可以通过 ！=（不等于条件来进行判断）
vim demo7.yaml
---
- hosts: all
remote_user: root
tasks:
- name: stop httpd
service: name=httpd state=stopped enabled=no
when: ansible_default_ipv4.address != "192.168.44.30" #when指令中的变量名不需要手动加上 {{}}
或
when: inventory_hostname == "<主机名>"
ansible-playbook demo7.yaml
复制代码
Templates 模块
Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件，可以看作是一个编译过的模板文件，用来产生目标文本，传递Python的变量给模板去替换模板中的标记。
过程演示
- 先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量
cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2
vim /opt/httpd.conf.j2
Listen {{http_port}} #42行，修改
ServerName {{server_name}} #95行，修改
DocumentRoot "{{root_dir}}" #119行，修改
复制代码
- 修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量
[webservers]
192.168.44.30 http_port=192.168.44.30:80 server_name=www.test1.com:80 root_dir=/etc/httpd/htdocs
[dbservers]
192.168.44.40 http_port=192.168.44.40:80 server_name=www.test2.com:80 root_dir=/etc/httpd/htdocs
复制代码
- 编写 playbook
vim apache.yaml
---
- hosts: all
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd package
yum: name={{package}} state=latest
- name: install configure file
template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf #使用template模板
notify:
- restart httpd
- name: create root dir
file: path=/etc/httpd/htdocs state=directory
- name: start httpd server
service: name={{service}} enabled=true state=started
handlers:
- name: restart httpd
service: name={{service}} state=restarted
ansible-playbook apache.yaml
复制代码
查看结果：
tags 模块
可以在一个playbook中为某个或某些任务定义“标签”，在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。
playbook还提供了一个特殊的tags为always。作用就是当使用always作为tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。
单标签的使用
vim test1.yaml
---
- name: this is a play for testing variables
hosts: webservers
remote_user: root
tasks:
- name: position 1
debug:
msg: 'ls /opt'
tags:
- only
- name: position 2
debug:
msg: 'ls /mnt'
ansible-playbook test1.yaml --tags="only"
复制代码
多标签的运用
---
- name: this is a play for testing variables
hosts: webservers
remote_user: root
tasks:
- name: position 1
debug:
msg: '测试标签1'
tags:
- one
- name: position 2
debug:
msg: '测试标签2'
tags:
- two
- name: position 3
debug:
msg: '测试标签3'
tags:
- one
复制代码
通用标签always的运用
- name: this is a play for testing variables
hosts: webservers
remote_user: root
tasks:
- name: position 1
debug:
msg: '测试标签1'
tags:
- one
- name: position 2
debug:
msg: '测试标签always'
tags:
- always
- name: position 3
debug:
msg: '测试标签3'
tags:
- one
复制代码
Roles 模块
Ansible为了层次化、结构化地组织Playbook，使用了角色（roles），roles可以根据层次型结构自动装载变量文件、task以及handlers等。简单来讲，roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中，并可以便捷地include它们。roles一般用于基于主机构建服务的场景中，但也可以用于构建守护进程等场景中。
简述Ansible角色
数据中心有各种不同类型的主机。如web服务器、数据库服务器，基于开发环境的服务器。随着时间的推移，具有处理所有这些情况的任务和人员的Ansible playbook将变得庞大而复杂。
- 角色允许将复杂的剧本组织成独立的、更小的剧本和文件。
- 角色提供了一种从外部文件加载任务、处理程序和变量的方法。
- 角色也可关联和引用静态的文件和模板。
- 角色可以编写成满足普通用途需求，并且能被重复利用。
- 定义角色的文件具有特定的名称，并以严格的目录结构进行组织。
roles 的目录结构
cd /etc/ansible/
tree roles/
roles/ #剧本
├── web/ #角色，相当于 playbook 中的 每一个 play 主题
│ ├── files/ #普通文件
│ ├── templates/ #模板文件
│ ├── tasks/ #包含该角色要执行的任务列表
│ ├── handlers/ #处理器,不仅该角色可以使用，其他角色也能使用
│ ├── vars/ #其他变量
│ ├── defaults/ #默认变量
│ └── meta/ #元数据
└── db/
├── files/
├── templates/
├── tasks/
├── handlers/
├── vars/
├── defaults/
└── meta/
复制代码roles 内各目录含义解释
- files：用来存放由 copy 模块或 script 模块调用的文件。
- templates：用来存放 jinjia2 模板，template 模块会自动在此目录中寻找 jinjia2 模板文件。
- tasks：此目录应当包含一个 main.yml 文件，用于定义此角色的任务列表，此文件可以使用 include 包含其它的位于此目录的 task 文件。
- handlers：此目录应当包含一个 main.yml 文件，用于定义此角色中触发条件时执行的动作。
- vars：此目录应当包含一个 main.yml 文件，用于定义此角色用到的变量。
- defaults：此目录应当包含一个 main.yml 文件，用于为当前角色设定默认变量。
- meta：此目录应当包含一个 main.yml 文件，用于定义此角色的特殊设定及其依赖关系。
在一个 playbook 中使用 roles 的步骤
（1）创建以 roles 命名的目录
mkdir /etc/ansible/roles/ -p #yum装完默认就有
（2）创建全局变量目录（可选）
mkdir /etc/ansible/group_vars/ -p
touch /etc/ansible/group_vars/all #文件名自己定义，引用的时候注意
（3）在 roles 目录中分别创建以各角色名称命名的目录，如 httpd、mysql
mkdir /etc/ansible/roles/httpd
mkdir /etc/ansible/roles/mysql
（4）在每个角色命名的目录中分别创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建
mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta}
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta}
（5）在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名
touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
（6）修改 site.yml 文件，针对不同主机去调用不同的角色
vim /etc/ansible/site.yml
---
- hosts: webservers
remote_user: root
roles:
- httpd
- hosts: dbservers
remote_user: root
roles:
- mysql
（7）运行 ansible-playbook
cd /etc/ansible
ansible-playbook site.yml
示例：
mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta} -p
touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml
------编写httpd模块------
写一个简单的tasks/main.yml
vim /etc/ansible/roles/httpd/tasks/main.yml
- name: install apache
yum: name={{pkg}} state=latest
- name: start apache
service: enabled=true name={{svc}} state=started
//定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
vim /etc/ansible/roles/httpd/vars/main.yml
pkg: httpd
svc: httpd
-------编写mysql模块-------
vim /etc/ansible/roles/mysql/tasks/main.yml
- name: install mysql
yum: name={{pkg}} state=latest
- name: start mysql
service: enabled=true name={{svc}} state=started
vim /etc/ansible/roles/mysql/vars/main.yml
pkg:
- mariadb
- mariadb-server
svc: mariadb
-------编写php模块-----
vim /etc/ansible/roles/php/tasks/main.yml
- name: install php
yum: name={{pkg}} state=latest
- name: start php-fpm
service: enabled=true name={{svc}} state=started
vim /etc/ansible/roles/php/vars/main.yml
pkg:
- php
- php-fpm
svc: php-fpm
-----编写roles示例-----
vim /etc/ansible/site.yml
---
- hosts: webservers
remote_user: root
roles:
- httpd
- mysql
- php
cd /etc/ansible
ansible-playbook site.yml
复制代码总结
迭代循环方式
- with_items：{{item}}会把所有的列表展开进行遍历输出，with_flattened也可以替代with_items
- with_list：{{item}}会把每个列表当作一个整体输出。如果每个列表中只有一个值，则效果与with items一致。loop也可以替代ith
- with_together：{{item}}引用时会把每个列表相同位置的值对齐合并后输出
- with nested：{{item}}引用时会把每个列表的值两两组合循环输出
when
when判断返回值为true，即条件成立时执行当前任务，条件不成立则不执行当前任务when: inventoryhostname =='主机名|IP'when: facts信息字段!='XXXXXXX'