Ansible Playbook详解
简介
Inventory支持对主机进行分组,每个组内可以定义多个主机,每个主机都可以定义在任何一个或多个主机组内。
inventory 文件
默认路径为/etc/ansible/hosts
Ansible Inventory 文件是一个纯文本文件,用于定义 Ansible 执行命令的目标主机和组,以及这些主机和组的变量和属性。
Inventory 文件的构成包括:
主机与组
主机:一个主机就是目标机器,可以是 IP 地址、域名或在 SSH 配置中定义的别名,也可以使用 ansible_host 指定。
组:可以将多个主机划分到同一个组中,并可以对组进行操
[webserver]
192.168.118.30
192.168.118.40
[databaseserver]
192.168.118.50
192.168.118.60
变量
-
主机变量:为单个主机指定变量,使用主机名或 IP 地址作为标识符,变量可以设置为一个或多个值
-
组变量:在组名之后,使用
vars
关键字设置变量,可以在组间共享变量
#所有主机指定 `ansible_ssh_user` 变量,这意味着每个主机都具有该变量。
#为每个主机定义唯一的 `name` 变量。
[WebServer]
192.168.118.30 name=webserver1
192.168.118.40 name=webserver2
[DatabaseServer]
192.168.118.50 name=dbserver1
192.168.118.60 name=dbserver2
[all:vars]
ansible_ssh_user=centos
组的嵌套
- 将一个组嵌套到另一个组中,在 Inventory 文件中使用
:children
关键字
[WebServer]
192.168.118.30
192.168.118.40
[DatabaseServer]
192.168.118.50
192.168.118.60
[Production:children]
WebServer
DatabaseServer
别名
- 使用 Alias(别名)来引用 Inventory 中的主机
[WebServer]
192.168.118.30
192.168.118.40
[DatabaseServer]
192.168.118.50
192.168.118.60
[Web:children]
WebServer
[Db:children]
DatabaseServer
[Production]
@Web
@Db
inventory 中的变量
在hosts 文件中为主机或组定义变量,在playbook 中可以直接调用变量
Inventory变量名 | 含义 |
---|---|
ansible_host | ansible连接节点时的IP地址 |
ansible_port | 连接对方的端口号,ssh连接时默认为22 |
ansible_user | 连接对方主机时使用的用户名。不指定时,将使用执行ansible或ansible-playbook命令的用户 |
ansible_password | 连接时的用户的ssh密码,仅在未使用密钥对验证的情况下有效 |
ansible_ssh_private_key_file | 指定密钥认证ssh连接时的私钥文件 |
ansible_ssh_common_args | 提供给ssh、sftp、scp命令的额外参数 |
ansible_become | 允许进行权限提升 |
ansible_become_method | 指定提升权限的方式,例如可使用sudo/su/runas等方式 |
ansible_become_user | 提升为哪个用户的权限,默认提升为root |
ansible_become_password | 提升为指定用户权限时的密码 |
Playbook 剧本
简介
Playbook 剧本是由一个或多个play组成的列表。
play的主要功能在于将预定义的一组主机,装扮成事先通过ansible中的task定义好的角色。
Task实际是调用ansible的一个module,将多个play组织在一个playbook中,即可以让它们联合起来,按事先编排的机制执行预定义的动作
Playbook 文件是采用YAML语言编写的。
Playbook的组成部分
Tasks:任务,即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行;
Variables:变量;
Templates:模板;
Handlers:处理器,当changed状态条件满足时,(notify)触发执行的操作;
Roles:角色。
编写Playbook
基本格式
- 在单一文件第一行,用连续三个连字号“-” 开始,还有选择性的连续三个点号( … )用来表示文件的结尾;
- 次行开始正常写Playbook的内容,一般建议写明该Playbook的功能;
- 使用#号注释代码;
- 缩进必须是统一的,不能空格和tab混用;
- 缩进的级别也必须是一致的,同样的缩进代表同样的级别,程序判别配置的级别是通过缩进结合换行来实现的;
- YAML文件内容是区别大小写的,key/value的值均需大小写敏感;
- 多个key/value可同行写也可换行写,同行使用,分隔;
- v可是个字符串,也可是另一个列表;
- 一个完整的代码块功能需最少元素需包括 name 和 task;
- 一个name只能包括一个task;
- YAML文件扩展名通常为yml或yaml;
xxx.yaml/xxx.yml
--- #表示开始
- name: #指定play的名称
hosts: #指定主机清单中定义的主机组名
remote_user: #指定远程主机的执行用户
grather_facts: ture|fales #指定是否要收集远程主机的facts信息
vars: #自定义变量,只能在当前play有效
- 变量1: 值1 #格式为key: value
- 变量2: 值2
tasks: #定义任务列表,默认从上往下依次执行
- name: #定义任务的名称
模块名: 模块参数
ignore errors: true #忽略任务的失败
- name: #可以定义多个任务
模块名: 模块参数
notify: 任务名 #如以上操作后为changed的状态时,会通过notify指定的名称触发对应名称的handlers操作
##条件判断##
- name:
模块名: 模块参数
when: #定义条件表达式(== != > < >= <=),条件成立时执行此task任务,否则不执行任务
##循环##
- name:
模块名: 模块参数={{item}}
with_items: #定义循环列表
##tags模块,标签##
- name:
模块名: 模块参数
tags:
- 标签1
- 标签2
handlers:
- name: 任务名 #和notify中的任务名相同
模块名: 模块参数
编写yum安装nginx的playbook
cd /etc/ansible
#编写yaml文件,安装nginx的剧本
vim nginx.yaml
---
- name: first play
hosts: dbservers
remote_user: root
gather_facts: false
tasks:
- name: firewalld
service: name=firewalld state=stopped enabled=no
- name: selinux
command: '/usr/sbin/setenforce 0 '
ignore_errors: true
- name: mount
mount: src=/dev/sr0 path=/mnt state=mounted fstype=iso9660
- name: local.repo
copy: src=/etc/yum.repos.d/local.repo dest=/etc/yum.repos.d/
- name: epel.repo
copy: src=/etc/yum.repos.d/epel.repo dest=/etc/yum.repos.d/
- name: nginx install
yum: name=nginx state=latest
- name: configuration file
copy: src=/usr/local/nginx/conf/nginx.conf dest=/etc/nginx/nginx.conf
notify: "reload nginx"
- name: start nginx
service: name=nginx state=started enabled=yes
handlers:
- name: reload nginx
service: name=nginx state=reloaded
#运行
ansible-playbook nginx.yaml
systemctl status firewalld
getenforce
systemctl status nginx
Playbook的模块
Template配置模板模块
用于生成配置模板文件,配合hosts中定义的变量,或者剧本中定义的变量,为不同主机生成不同的配置参数。
Jinja是基于Python的模板引擎。
Template类是Jinja的一个重要组件,可以看作是一个编译过的模板文件,用来产生目标文本,传递Python的变量给模板去替换模板中的标记
使用
先准备一个xxx.j2配置模板文件,在文件中使用{{变量名}}引用主机变量或者vars字段自定义的变量 以及 facts信息字段做变量的值;
在playbook剧本中的task任务定义template模块配置
template: src--xxx.j2 文件路径 dest-远程主机文件路径
tags模块
可以在一个playbook中为某个或某些任务定义“标签”,在执行此playbook时通过ansible-playbook命令使用–tags选项能实现仅运行指定的tasks。
playbook还提供了一个特殊的tags为always。
作用就是当使用always作为tags的task时,无论执行哪一个tags时,定义有always的tags都会执行
Roles模块
Roles用于层次性、结构化地组织playbook,适用于代码复用度较高的场景。
Roles模块的作用
将playbook剧本中的各个play视作一个角色,将各个角色的tasks任务、vars变量、templates模板、files文件等内容放置在指定角色的目录中统一管理。
需要的时候可以在playbook中使用roles角色直接调用,即roles角色可以在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/
目录 | 含义 |
---|---|
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
#创建以 roles 命名的目录
mkdir /etc/ansible/roles/ -p #yum装完默认就有
#创建全局变量目录
mkdir /etc/ansible/group_vars/ -p
touch /etc/ansible/group_vars/all #文件名自己定义,引用的时候注意
#在 roles 目录中分别创建以各角色名称命名的目录
mkdir /etc/ansible/roles/httpd
mkdir /etc/ansible/roles/mysql
#在每个角色命名的目录中分别创建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}
#在每个角色的 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
#修改 site.yml 文件,针对不同主机去调用不同的角色
vim /etc/ansible/site.yml
---
- hosts: webservers
remote_user: root
roles:
- httpd
- hosts: dbservers
remote_user: root
roles:
- mysql