ansible-playbook
ansible-playbook介绍1、playbook简介
playbook是ansible用于配置、部署和管理被控节点的剧本,通过playbook的详细描述,执行其中的一系列tasks,可以让远程主机达到预期的状态,playbook就像Ansible控制器给被控节点列出的一系列to-do-list,而被控节点必须要完成。
也可以这样理解,playbook字面意思,即剧本,现实中由演员按照剧本表演,在ansible中,这次是由计算机进行表演,由计算机安装,部署应用,提供对外服务,以及组织计算机处理各种各样的事情。
2、playbook使用场景
执行一些简单的任务,使用ad-hoc命令可以方便的解决问题,但是有时一个设施太过于复制,需要大量的操作时,执行ad-hoc命令就不太合适,这时最好使用playbook,就像执行shell命令与写shell脚本一样,也可以理解为批处理任务,不过playbook有自己的语法格式,具体可以看下面介绍。
使用playbook你可以方便的重用这些代码,可以移值到不同的机器上面,像函数一样,最大化的利用代码。在使用ansible的过程中,所处理的大部分操作都是需要编写playbook的。
3、YAML语法
playbook由YMAL语言编写,YMAL参考了其他多种语言,包括:XML、C语言、python、perl以及电子邮件格式RFC2822,Clark Evans在2001年5月在首次发表了这种语言,另外Ingy dot Net与Oren Ben-Kiki也是这种语言的共同设计者。
YAML介绍:yaml是一个可读性高的用来表达资料序列的格式。YAML Ain't Markup Language,即YAML不是XML。不过,在开发的这种语言时,YAML的意思其实是:“Yet Another Markup Language"(仍是一种标记语言)。其特性:
1
2
3
4
5
6
7
YAML的可读性好。
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强
更多的规范参见:http://www.yaml.org。
YAML的语法和其他高阶语言类似,并且可以简单表达清单、散列表、标量等数据结构。其结构(Structure)通过空格来展示,序列(Sequence)里的项用"-"来代表,Map里的键值对用":"分隔。下面是一个示例:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
name: John Smith
age: 41
gender: Male
spouse:
name: Jane Smith
age: 37
gender: Female
children:
- name: Jimmy Smith
age: 17
gender: Male
- name: Jenny Smith
age 13
gender: Female
YAML文件扩展名通常为.yaml,如example.yaml。
4、ansible-playbook语法
playbook是又一个或多个"play"组成的列表。play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲,所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中,即可以让他们联同起来按事先编排的机制同唱一台大戏。下面是一个简单示例:
1
2
3
4
5
6
7
8
9
10
11
12
13
- hosts: webnodes
vars:
http_port: 80
max_clients: 256
remote_user: root
tasks:
- name: ensure apache is at the latest version
yum: name=httpd state=latest
- name: ensure apache is running
service: name=httpd state=started
handlers:
- name: restart apache
service: name=httpd state=restarted
5、playbook基础组件
1
2
3
4
5
6
7
8
9
10
11
hosts:playbook中的每一个play的目的都是为了让某个或某些以某个指定用户的身份执行任务。
hosts用于指定要执行指定任务的主机,其可以是一个或多个由冒号分隔主机组。
user:remote_user则用于指定远程主机上的执行任务的用户。
任务列表:play的主体部分是task list. task list中的各任务按次序逐个在hosts中指定的所有主机
上执行,即在所有主机上完成第一个任务后再开始第二个。
action:任务执行过程
handlers:用于当前关注的资源发生变化时采取一定指定的操作
实例:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# cat web.yml
- hosts: webservers##主机组,在/etc/ansible/hosts中定义
remote_user: root##远程执行任务的用户
tasks: ##任务
- name: install httpd ##任务描述
command: yum -y install httpd##调用ansible的command模块安装httpd
- name: provide httpd.conf ##任务描述
copy: src="/root/httpd.conf" dest="/etc/httpd/conf/httpd.conf"##调用ansible的copy模块,httpd安装完成后将事先准备好的httpd.conf文件复制到目标主机的/etc/httpd/conf/目录下
tags: conf##给此任务打标记,可单独执行标记的任务,使用ansible-playbook -C 命令执行
notify:##文件内容变更通知
- server restart##通知到指定的任务
- name: server start##任务描述
service: name=httpd state=started enabled=true##调用ansible的service模块的属性定义安装完成httpd以后httpd服务的管理
handlers:##定义接受关注的资源变化后执行的动作
- name: server restart##任务描述
service: name=httpd state=restarted##当关注的资源发生变化后调用service模块,采取相应的动作
##执行过程如下:
# ansible-playbook web.yml
PLAY *************************************************************
GATHERING FACTS ***************************************************************
ok:
ok:
TASK: *********************************************************
changed:
changed:
TASK: ****************************************************
changed:
changed:
TASK: **********************************************************
changed:
changed:
NOTIFIED: ****************************************************
changed:
changed:
PLAY RECAP ********************************************************************
node1 : ok=5 changed=4 unreachable=0 failed=0
node2 : ok=5 changed=4 unreachable=0 failed=0
6、ansible的roles介绍
ansible的roles用于层次性、结构化的组织playbook。roles能够根据层次型结构自动装载变量文件、tasks及handlers等。要使用roles只需要playbook中使用include指令即可。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
1)、创建roles的步骤
(1)、创建以roles命名的目录;
(2)、在roles目录中分别创建以各角色名称命名的目录,如webservers等;
(3)、在每个角色命名的目录中分别创建files、handlers、meta、tasks、templates、和vars
目录;用不到的目录可以创建为空目录,也可以不创建。
(4)、在playbook文件中,调用各角色;
2)、roles内各目录可用的文件
tasks目录:至少应该包括一个名为main.yml的文件,其定义了此角色的任务列表;此文件可以使
用include包含其它的位于此目录中的task文件。
files目录:存放由copy或script等模块调用的文件;
templates目录:template模块会自动在此目录中寻找jinja2模版文件;
handlers目录:此目录中应当包含一个main.yml文件,用于定义此角色用到的各handler;在handl
er中使用include包含的其它的handler文件也应该位于此目录中;
vars目录:应当包含一个main.yml文件,用于定义此角色用到的变量;
meta目录:应当包含一个main.yml文件,用于定义此角色的特殊设定及其依赖关系;
default目录:为当前角色设定默认变量时使用此目录;应当包含一个main.yml文件;
3)、举例说明
root@mail playbook]# treeroles/
roles/ \\ansible所有的信息都放到此目录下面对应的目录中
└── nginx\\角色名称
├── default\\为当前角色设定默认变量时使用此目录,应当包含一个main.yml文件;
├── files\\存放有copy或script等模块调用的文件
├── handlers \\此目录总应当包含一个main.yml文件,用于定义各角色用到的各handler
├── meta \\应当包含一个main.yml,用于定义角色的特殊设定及其依赖关系;1.3及以后
版本支持
├── tasks \\至少包含一个名为main.yml的文件,定义了此角色的任务列表,可使用incl
ude指令
├── templates \\template模块会自动在此目录中寻找Jinja2模板文件
└── vars\\应当包含一个main.yml文件,用于定义此角色用到的变量
ansible的roles配置nginx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
1、准备目录
# mkdir -pv playbook/roles/nginx/{default,files,handlers,meta,tasks,templates,vars}
2、准备nginx的配置文件
# cd roles/nginx/templates
# ansible all -m setup |grep ansible_processor_cores
"ansible_processor_cores": 1,\\获取ansible的要调用的相关函数
"ansible_processor_cores": 1,\\获取ansible的要调用的相关函数
# vim nginx.conf
worker_processes {{ ansible_processor_cores }}; \\调用获取到的函数
3、准备Nginx的default.conf文件及rpm包
# ll nginx/files/
-rw-r--r-- 1 root root 2685 Jan 18 15:51 default.conf
-rw-r--r-- 1 root root 319456 Jan 18 15:52 nginx-1.4.7-1.el6.ngx.x86_64.rpm
4、在tasks目录中配置任务列表
# cd nginx/tasks/
# vim main.yml
- name: copy nginx.rpm
copy: src=nginx-1.4.7-1.el6.ngx.x86_64.rpmdest=/tmp/nginx-1.4.7-1.el6.ngx.x86_64.rpm
- name: install nginx
shell: yum -yinstall /tmp/nginx-1.4.7-1.el6.ngx.x86_64.rpm
- name: provides nginx.conf
template: src=nginx.confdest=/etc/nginx/nginx.conf
tags: nginxconf
notify:
- server restart
- name: provides default.conf
copy: src=default.conf dest=/etc/nginx/conf.d/default.conf
tags: nginxconf
- name: server start
service: name=nginx enabled=true state=started
5、在handlers目录中配置定义handler信息
# cd nginx/handlers/
# vim main.yml
- name: server restart
service: name=nginxstate=restarted
6、在roles同一级目录中创建site.yml文件
- hosts: webservers
remote_user: root
roles:
- nginx
7、应用配置
# ansible-playbook site.yml
PLAY *************************************************************
GATHERING FACTS ***************************************************************
ok:
ok:
TASK: ************************************************
ok:
ok:
TASK: *************************************************
changed:
changed:
TASK: *******************************************
changed:
changed:
TASK: *****************************************
changed:
changed:
TASK: **************************************************
changed:
changed:
NOTIFIED: ********************************************
changed:
changed:
PLAY RECAP ********************************************************************
node1 : ok=7 changed=5 unreachable=0 failed=0
node2 : ok=7 changed=5 unreachable=0 failed=0
8、查看webservers主机上是否已经启动nginx
# ansible webservers -m shell -a 'netstat -tnlp'
node2 | success | rc=0 >>
Active Internet connections (only servers)
Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name
tcp 0 0 0.0.0.0:80 0.0.0.0:* LISTEN 5497/nginx
tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 1174/sshd
tcp 0 0 :::22 :::* LISTEN 1174/sshd
node1 | success | rc=0 >>
Active Internet connections (only servers)
Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name
tcp 0 0 0.0.0.0:80 0.0.0.0:* LISTEN 5513/nginx
tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 1174/sshd
tcp 0 0 :::22 :::* LISTEN 1174/sshd
9、查看playbook目录总体结构:
# tree playbook/
playbook/
├── roles
│ └── nginx
│ ├── default
│ ├── files
│ │ ├── default.conf
│ │ └── nginx-1.4.7-1.el6.ngx.x86_64.rpm
│ ├── handlers
│ │ └── main.yml
│ ├── meta
│ ├── tasks
│ │ └── main.yml
│ ├── templates
│ │ └── nginx.conf
│ └── vars
└── site.yml
到此,ansible-playbook已总计完毕,仅个人总结学习。如有疑问,请查官方文档。也可交流,主要个人技术暂时还不强悍。。。大神吾喷。。。
页:
[1]