自动化运维工具Ansible之playbooks剧本
目录
一、playbooks
1、playbooks简述
2、playbooks剧本格式
3、playbooks组成部分
4、playbooks启动及检测
5、playbooks模块实战实例1
6、vars模块实战实例2
7、when模块实战实例3
8、with_items循环模块实战实例4
9、template模块实战实例5
一、playbooks
1、playbooks简述
playbooks是ansible用于配置,部署,和管理被控节点的剧本。通过playbooks的详细描述,执行其中的tasks,可以让远端主机达到预期的状态。playbooks是由一个或多个”play”组成的列表。 当对一台机器做环境初始化的时候往往需要不止做一件事情,这时使用playbooks会更加适合。通过playbooks你可以一次在多台机器执行多个指令。通过这种预先设计的配置保持了机器的配置统一,并很简单的执行日常任务。
ansible通过不同的模块实现相应的管理,管理的方式通过定义的清单文件(hosts)所管理的主机包括认证的方式连接的端口等。所有的功能都是通过调用不同的模块(modules)来完成不同的功能的。不管是执行单条命令还是play-book都是基于清单文件。
2、playbooks剧本格式
playbooks由YMAL语言编写,YMAL格式是类似于JSON的文件格式,一个文件中有多个play,一个play中只能有一个tasks,一个tasks中可以有多个name任务。
注意事项:
①大小写明个
②通过缩进表示层级关系
③不支持制表符tab键缩进,只能使用空格缩进
④缩进的空格数目不重要,只要相同层级左右对齐,通常开头缩进2个空格
⑤#号注释
⑥符号字符后缩进1个空格,如冒号:逗号,横杠-后面空一个格
⑦如果包含特殊字符用单引号和双引号引起来会作为字符串处理,单引号不识别变量,双引号识别变量。
3、playbooks组成部分
模块名 | 作用 |
tasks | 任务,即通过task调用ansible的模块将多个操作组织在一个playbooks中运行 |
variables | 变量,使用{{}}调用,可简写vars |
templates | 模板 |
handlers | 处理器,当changed状态条带满足时,notify触发执行的操作,不会立即执行notify,要等playbooks中的所有任务完成才会执行notify,好处是可以多次触发notify单最后只执行一次对应的handlers。 |
roles | 角色 |
ignore_errors | 如果执行命令的返回值不为0则报错tasks停止默认,如果需要忽略报错则设置为false |
notify | 如果上面的条件成立则执行handlers模块的内容 |
whit_item | 定义循环的内容即列表,使用{{item}}调用每一次的值,即名称为item。遍历内容直到结束 |
when | 条件判断,提供唯一通用的条件判断,true时执行,否则不执行 |
become | 2.6版本以后的参数,之前是sudo,意思为切换用户运行 |
tags | 为某个或某些任务定义标签,playbooks执行时可以指定只执行某个标签,若标签为always则无论执行此playbooks的那个标签都会将有always标签的name一起执行 |
4、playbooks启动及检测
ansible-playbook 文件名.yaml
ansible-playbook 文件.yaml --start-at-task='任务名/标签' #从某个task开始执行或只执行某个标签的name
#启动此文件
补充参数:-k(-ask-pass):用来交互式输入ssh密码
-K(-ask-become-pass):用来交互式输入sudo密码
-U:指定用户
ansible-playbook 文件.yaml --list-task #检查yml文件
ansible-playbook 文件.yaml --list-hosts #检测主机
ansible-playbook 文件.yaml --syntax-check #检测语法
5、playbooks模块实战实例1
vim test1.yaml
#新建编辑yaml文件,内容如下
---
#ymal文件开头,可不写
- name: test
#定义play名称,可不写
gather_facts: false
#设置不进行facts信息收集,这可以加快执行速度,可省略默认开启
hosts: webservers
#要执行的组或者主机,webservers为组名需要在/etc/ansible/hosts中配置
remote_user: root
#执行时所使用的用户
tasks:
#定义任务列表,列表中任务按顺序执行
- name: test ping
#自定义name的任务名称
ping:
#第一个任务执行内容为使用ping模块ping,webservers组的主机
- name: test selinux
command: /sbin/setenforce 0
#第二个任务执行内容为使用command模块关闭selinux
ignore_errors: false
#若出现错误,忽略继续运行下面的任务,默认为true出错立即停止playbooks
- name: test stop firewalld
service: name=firewalld state=stopped
#第三个任务执行内容为使用service模块关闭firewalld防火墙
- name: test yum
yum: name=httpd state=latest
#第四个任务执行内容为使用yum模块安装httpd服务状态为latest
- name: test copy
copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
#第五个任务为使用copy模块将ansible上的/etc/httpd.conf文件拷贝到指定组的主配置文件下替换,注意此处需要在ansible的/opt目录上有一个httpd.conf的模版否则会报错
notify: "restart httpd"
#如果上面的copy任务成功,则调用handlers模块的restart httpd,注意要与下面handlers的name名称相同
- name: test start httpd
service: enabled=yes name=httpd state=started
#第六个任务执行内容为使用service模块启动httpd服务并设置开机自启
handlers:
- name: restart httpd
service: name=httpd state=restarted
#handlers模块,若notify成立则执行此模块内容调用service模块重启httpd服务。注意使用name名称调用
6、vars模块实战实例2
---
- name:
hosts: webservers
remote_user: root
ignore_errors: false
vars:
#使用变量模块
- groupname: testgroup
#定义变量groupname的值为testgroup
- username: testuser
#定义变量username的值为testuser
tasks:
- name: create group
group: name={{groupname}} gid=111
#第一个任务使用group模块调用定义的groupname变量创建组
- name: create user
user: name={{username}} uid=10086 group={{groupname}}
#第二个任务使用user模块调用定义的username变量创建用户指定uid和组
7、when模块实战实例3
---
- hosts: webservers
remote_user: root
tasks:
- name: test when
service: name=httpd state=stopped
when: ansible_default_ipv4.address == "192.168.30.12"
#当内置的变量ipv4.address等于192.168.30.12时调用service模块关闭httpd服务
8、with_items循环模块实战实例4
---
- name: test1
hosts: webservers
gather_facts: false
tasks:
- name: create directories
file:
path: "{{item}}"
state: directory
#路径调用变量item,变量值为下面的with_items的内容,一次执行一个有几个值执行几次,state为创建类型为目录
with_items:
- /tmp/test1
- /tmp/test2
- name: create file
file:
path: "{{item}}"
state: touch
#路径调用变量item,变量值为下面的with_items的内容,一次执行一个有几个值执行几次,state为创建类型为文件
with_items:
- /tmp/test1/a.txt
- /tmp/test2/b.txt
9、template模块实战实例5
1.先准备一个以 .j2 为后缀的 template 模板文件,设置引用的变量
cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2
#注意ansible本身要安装httpd,其他2台被控制的不能安装httpd
vim /opt/httpd.conf.j2
Listen {{http_port}} #42行,修改
ServerName {{server_name}} #95行,修改
DocumentRoot "{{root_dir}}" #119行,修改
#修改template配置文件模块的端口和主机名、根目录为变量
2.修改主机清单文件,使用主机变量定义一个变量名相同,而值不同的变量
vim /etc/ansible/hosts
[webservers1]
192.168.30.12 http_port=192.168.30.12:80 server_name=www.lhj1.com:80 root_dir=/var/www/html
[webservers2]
192.168.30.13 http_port=192.168.30.13:80 server_name=www.lhj2.com:80 root_dir=/var/www/html
3.主机添加hosts
vim /etc/hosts
192.168.30.12 www.lhj1.com
192.168.30.13 www.lhj2.com
4.编写playbook文件
vim httpd.yaml
---
- hosts: all
remote_user: root
gather_facts: false
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd
yum: name={{package}} state=latest
- name: con test
template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
#配置文件模板拷贝到httpd的子配置文件中
notify:
- restart httpd
- name: start httpd
service: name={{service}} state=started
handlers:
- name: restart httpd
service: name={{service}} state=restarted
5.最后在ansible上curl访问2个域名验证
10、tags模块实战实例6
---
- hosts: webservers1
remote_user: root
gather_facts: false
tasks:
- name: copy hosts
copy: src=/etc/hosts dest=/opt/hosts
tags:
- tags1
#自定义标签名,可以在执行yaml文件时使用 --tag="tags1"只执行此任务,always标签任务除外
- name: touch file
file: path=/opt/testhost state=touch
tags:
- always
#always标签,无论执行那个标签都会将此标签的任务内容执行