Ansible-playbook 剧本
Playbook介绍
playbook是ansible用于配置,部署,和管理被控节点的剧本。通过playbook的详细描述,执行其中的tasks,可以让远端主机达到预期的状态。playbook是由一个或多个”play”组成的列表。 当对一台机器做环境初始化的时候往往需要不止做一件事情,这时使用playbook会更加适合。通过playbook你可以一次在多台机器执行多个指令。通过这种预先设计的配置保持了机器的配置统一,并很简单的执行日常任务。
工作原理:
ansible通过不同的模块实现相应的管理,管理的方式通过定义的清单文件(hosts)所管理的主机包括认证的方式连接的端口等。所有的功能都是通过调用不同的模块(modules)来完成不同的功能的。不管是执行单条命令还是play-book都是基于清单文件。执行的方式可以是对本地执行也可以通过ssh的方式对远程主机进行操作,常见的是通过ssh的方式,对远程主机进行操作。
playbook由YMAL语言编写。YMAL格式是类似于JSON的文件格式,便于人理解和阅读,同时便于书写。
一个剧本里面可以有多个play,每个play只能有一个tasks,每个tasks可以有多个name
核心元素:
Playbooks
Variables #变量元素,可传递给Tasks/Templates使用;
Tasks #任务元素,由模块定义的操作的列表,即调用模块完成任务;
Templates #模板元素,使用了模板语法的文本文件;
Handlers #处理器元素,通常指在某事件满足时触发的操作;
Roles #角色元素
playbook的基础组件:
name:
定义playbook或者task的名称(描述信息),每一个play都可以完成一个任务。
hosts:
playbook中的每一个paly的目的都是为了让某个或某些以某个指定用户的身份执行任务。hosts用于指定要执行指定任务的主机.
user :
remote_user则用于指定远程主机上的执行任务的用户,也可以使用user(基本上是root)
tasks :
任务列表play的主体部分是task list. task list中的各任务按次序逐个在hosts中指定的所有主机上执行,即在所有主机上完成第一个任务后再开始第二个。
vars:
定义变量(如果不使用内部变量需要提前定义)
vars_files:
调用定义变量文件
notify:
任务执行结果如果是发生更改了的则触发定义在handler的任务执行
handlers:
用于当前关注的资源发生变化时采取一定指定的操作
实例一:
[root@ansible-server ~]# cd /etc/ansible/
[root@ansible-server ansible]# vim test.yml #创建文件必须以.yml结尾
---
- hosts: webservers1
user: root
tasks:
- name: playbook_test
file: state=touch path=/tpm/playbook.txt
===========================================
参数解释:
hosts: 参数指定了对哪些主机进行操作;
user: 参数指定了使用什么用户登录远程主机操作;
tasks: 指定了一个任务.
name:参数同样是对任务的描述,在执行过程中会打印出来。
检测语法:
[root@ansible-server ansible]# ansible-playbook --syntax-check test.yml
playbook: test.yml
运行Playbook:
[root@ansible-server ansible]# ansible-playbook test.yml #加剧本名称
实例二
handlers:由特定条件触发的Tasks
handlers:处理器
notify:触发器
语法:
tasks:
- name: TASK_NAME
module: arguments #1.上面任务执行成功,然后
notify: HANDLER_NAME #2.通知他
handlers:
- name: HANDLER_NAME #3.一一对应,这里的描述与notify定义的必须一样
module: arguments #4.执行这个命令
=======================================================
[root@ansible-server ansible]# vim handlers.yml
- hosts: webservers1
user: root
tasks:
- name: test copy
copy: src=/root/a.txt dest=/mnt
notify: test handlers
handlers:
- name: test handlers
shell: echo "abcd" >> /mnt/a.txt
==============================================
说明:只有 copy 模块真正执行后,才会去调用下面的 handlers 相关的操作,追加内容。所以这种比较适合配置文件发生更改后,需要重启服务的操作。
检测语法:
[root@ansible-server ansible]# ansible-playbook --syntax-check handlers.yml
playbook: handlers.yml
[root@ansible-server ansible]# ansible-playbook handlers.yml
案例三
循环:迭代,需要重复执行的任务;
对迭代项的引用,固定变量名为”item”,使用with_item属性给定要迭代的元素;
元素:1.列表 ,2.字符串 3.字典
基于字符串列表元素实战:
[root@ansible-server ansible]# vim list.yml
- hosts: websrvs
remote_user: root
tasks:
- name: install packages
yum: name={{ item }} state=latest #相当于for循环里面的i
with_items: #取值 。但是不支持通配符
- httpd
- httpd-tools
- php
- php-mysql
- php-mbstring
- php-gd
检测语法:
[root@ansible-server ansible]# ansible-playbook --syntax-check list.yml
playbook: list.yml
执行:
[root@ansible-server ansible]# ansible-playbook list.yml
注意:with_items关键字后续版本中将会取消,可以使用loop关键代替。
使用loop关键字来定义参数
批量创建用户
[root@ansible-server ansible]# vim list2.yml
- hosts: test
tasks:
- name: Create Groups
group:
name: "{{ item }}"
loop:
- group1
- group2
- group3
- name: Create Users
user:
name: "{{ item.user }}"
group: "{{ item.group }}"
uid: "{{ item.uid }}"
loop:
- { user: jack,group: group1, uid: 2001 }
- { user: tom,group: group2, uid: 2002 }
- { user: alice,group: group3, uid: 2003 }
[root@ansible-server ansible]# ansible-playbook list2.yml
案例四、自定义vars_files变量
变量调用语法:
{{ var_name }}
====================================================
创建变量目录:
[root@ansible-server ~]# mkdir /etc/ansible/vars
[root@ansible-server ~]# cd /etc/ansible/vars/
[root@ansible-server vars]# vim file.yml #创建变量文件。
src_path: /root/test/a.txt
dest_path: /opt/test/
创建一个测试文件
[root@ansible-server vars]# mkdir /root/test
[root@ansible-server vars]# vim /root/test/a.txt #编辑测试文件
123
创建play-book引用变量文件:
[root@ansible-server vars]# cd /etc/ansible/
[root@ansible-server ansible]# vim vars.yml
- hosts: ansible-web1
user: root
vars_files:
- /etc/ansible/vars/file.yml
tasks:
- name: create directory
file: path={{ dest_path }} mode=755 state=directory
- name: copy file
copy: src={{ src_path }} dest={{ dest_path }}
检测语法:
[root@ansible-server vars]# cd ..
[root@ansible-server ansible]# ansible-playbook --syntax-check vars.yml
playbook: vars.yml
执行:
[root@ansible-server ansible]# ansible-playbook vars.yml
group模块参数:
name参数:必须参数,用于指定组名称。
state参数:用于指定组的状态,两个值可选,present,absent,默认为 present,设置为absent 表示删除组。
gid参数:用于指定组的gid。如果不指定为随机
system参数:如果是yes为系统组。--可选
======================
1.创建多个play
[root@ansible ~]# cd /etc/ansible/
[root@ansible ansible]# vim play.yml
- hosts: webserver1 #play1
user: root
tasks:
- name: create a group
group: name=mygrp system=yes
- name: create a user
user: name=tom group=mygrp system=yes
- hosts: webserver2 #play2
user: root
tasks:
- name: install apache
yum: name=httpd state=latest
- name: start httpd service
service: name=httpd state=started
==================================================
执行
[root@ansible ansible]# ansible-playbook play.yml
2.使用变量并不显示搜集主机相关信息
gather_facts参数:指定了在任务部分执行前,是否先执行setup模块获取主机相关信息,默认值为true,改成false之后在执行过程中不会搜集主机相关信息。
==========================================
[root@ansible ansible]# vim create_user.yml
- hosts: ansible-web1
user: root
gather_facts: false #是否执行setup模块,搜集对方机器的信息
vars: #自定义变量
- user: "jack" #user是自定义变量名称,“jack”是变量值
- src_path: "/root/a.txt" #同上
- dest_path: "/mnt/"
tasks:
- name: create user
user: name={{ user }}
- name: copy file
copy: src={{ src_path }} dest={{ dest_path }}
[root@ansible ansible]# vim /root/a.txt #创建测试文件
123
执行:
[root@ansible ansible]# ansible-playbook create_user.yml
以上就是基本的playbook剧本的编写案列,未完…待续