目录
2.8.3 在一个 playbook 中使用 roles 的步骤
2.8.4.1 创建相应的目录和目录中的main.yml文件
一、playbook
playbook是剧本的意思
通过 task 调用 ansible 的模块将多个 play 组织在一 个playbook中运行。
playbook本身由以下各部分组成:
- Tasks: 任务,即调用模块完成的某操作
- Variables: 变量
- Templates: 模板
- Handlers: 处理器,当某条件满足时,触发执行的操作
- Roles: 角色
- playbook yaml语法是换行空两格,-和:后必须空一格
playbook由YMAL语言编写,YAML是一种非标记语言。是用来写配置文件的语言,非常简洁合强大
- YAML语法和其他语言类似,也可以表达散列表、标量等数据结构
- 结构通过空格来展示,
- 序列里配置项通过 - 来表示
- Map里的键值用:来分隔
- YAML的扩展名为yaml
1.1、playbook简介
- Playbooks 是 Ansible的配置、部署、编排语言,他们可以被描述为一个需要希望远程主机执行命令的方案,或者一组IT程序运行的命令集合
- Playbooks 与 ad-hoc相比,是一种完全不同的运用ansible的方式,是非常之强大的
- 简单来说,playbooks是一种简单的配置管理系统与多机器部署系统的基础,与现有的其他系统有不同之处,且非常适合于复杂应用的部署。
- playbook是ansible用于配置,部署,和管理被控节点的剧本。
- 通过playbook的详细描述,执行其中的一系列tasks,可以让远端主机达到预期的状态。playbook就像Ansible控制器给被控节点列出的的一系列to-do-list,而被控节点必须要完成。
- 也可以这么理解,playbook 字面意思,即剧本,现实中由演员按照剧本表演,在Ansible中,这次由计算机进行表演,由计算机安装,部署应用,提供对外服务,以及组织计算机处理各种各样的事情
1.2、playbook使用场景
执行一些简单的任务,使用ad-hoc命令可以方便的解决问题,但是有时一个设施过于复杂,需要大量的操作时候,执行的ad-hoc命令是不适合的,这时最好使用playbook。
就像执行shell命令与写shell脚本一样,也可以理解为批处理任务,不过playbook有自己的语法格式。
使用playbook你可以方便的重用这些代码,可以移植到不同的机器上面,像函数一样,最大化的利用代码。在你使用Ansible的过程中,你也会发现,你所处理的大部分操作都是编写playbook。可以把常见的应用都编写成playbook,之后管理服务器会变得十分简单。
1.3、yaml基本语法规则
1、大小写敏感
2、使用缩进表示层级关系
3、缩进时不允许使用tab键、只允许使用空格
4、缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
hosts | 定义节点,可以是组 |
---|---|
remote_user | 是你以什么用户身份进行登陆 |
tasks | 是你的任务 |
become:yes | 表示切换用户 |
become_user: mysql | 表示切换到mysql用户,配合上一条使用 |
- name: | 为下面执行的操作起名 |
1.4、yaml支持的数据结构
- 对象:键值对的集合,又被映射(mapping)/ 哈希(hashes)/ 字典(dictionary)
- 属组:一组按次序排列的值,又称为序列(sequence)/ 列表(list)
- 纯量:单个的、不可再分的值
1.5、playbook格式
playbook由YMAL语言编写。YMAL格式是类似于JSON的文件格式,便于人理解和阅读,同时便于书写。
一个剧本里面可以有多个play,每个play只能有一个tasks,每个tasks可以有多个name。
1.6、playbook示例
基本命令介绍
ansible-playbook xxx.yaml --syntax-check #检查yaml文件的语法是否正确
ansible-playbook xxx.yaml --list-task #检查tasks任务
ansible-playbook xxx.yaml --list-hosts #检查生效的主机
ansible-playbook xxx.yaml --start-at-task='xxx' #指定从某个task开始运行
- hosts: nginx #指定主机组,可以是一个或多个组
remote_user: root #指定远程主机执行的用户名
说明 | |
---|---|
-k(-ask-pass) | 用来交互输入ssh密码 |
-K(-ask-become-pass) | 用来交互输入sudo密码 |
-u | 指定用户 |
-e | 引入变量值 |
二、playbook实例
2.1、编写httpd的playbook
首先将前面做主机清单的配置进行修改,将端口号恢复为22端口,将被控端的端口修改完进行重启
[root@Ansible opt]#vim test1.yaml
--- #yaml文件以---开头,以表明这是一个yaml文件,可省略
- name: first play #定义一个play的名称,可省略
gather_facts: false #设置不进行facts信息收集,这可以加快执行速度,可省略
hosts: james23 #指定要执行任务的被管理主机组,如多个主机组用冒号分隔
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 enabled=no #使用 module: options 格式来定义任务,option使用key=value格式
- name: install httpd
yum: name=httpd state=latest
- name: install configuration 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,从而避免多次重启。
[root@Ansible opt]#ansible-playbook test1.yaml 运行playbook
---
- name: install httpd
gather_facts: false
hosts: james23
remote_user: root
tasks:
- name: test ping
ping:
- name: disable firewalld
service: name=firewalld state=stopped
- 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
notify: "restart httpd"
- name: start httpd service
service: enabled=true name=httpd state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
运行
[root@ansible01 opt]#ansible-playbook test.yaml
2.1.1 ansible-playbook命令使用
ansible-playbook用于运行剧本,-C测试运行结果,并不是真的执行任务
ansible-playbook test.yaml -C
ansible-playbook test.yaml --syntax-check #检查yaml文件的语法是否正确
ansible-playbook 文件.yaml --list-task #检查tasks任务
ansible-playbook test1.yaml --list-hosts #检查生效的主机
ansible-playbook test1.yaml --start-at-task='install httpd' #指定从某个task开始运行
2.2、定义、引用变量
---
- name: second play
hosts: james23
remote_user: root
vars: #定义变量
- groupname: mysql #格式为 key: value
- username: nginx
tasks:
- name: create group
group: name={{groupname}} system=yes gid=305 #使用 {{key}} 引用变量的值
- name: create user
user: name={{username}} uid=305 group={{groupname}}
- name: copy file
copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt #在setup模块中可以获取facts变量信息
ansible-playbook test1.yaml -e "username=nginx" #在命令行里定义变量
---
- name: second play
hosts: james23
remote_user: root
vars:
- groupname: kysw
- username: nginx
tasks:
- name: create group
group: name={{groupname}} system=yes gid=305
- name: create user
user: name={{username}} uid=305 group={{groupname}}
- name: copy file
copy: content="{{ansible_default_ipv4}}" dest=/opt/kysw.txt
ansible james23 -m setup | grep ansible_default
ansible-playbook test1.yaml
ansible-playbook test1.yaml -e "username=lyh" ##lyh用户先生效
ansible-playbook test1.yaml
查看用户和组
ansible james23 -a 'tail -3 /etc/group'
ansible james23 -a 'id testuser'
2.3、指定远程主机sudo切换用户
被控制端查看用户
id nginx
ansible管理端主机操作
---
- hosts: 192.168.10.101
remote_user: nginx #2.6版本以后的参数,之前是sudo,意思为切换用户运行
become: yes #指定sudo用户为root
become_user: root
执行playbook时:ansible-playbook test2.yml -K <密码>
[root@localhost playbook]#ansible-playbook test2.yaml -k -K
-k 指定ssh的登录密码
-K 大写需要输入用户的登录密码
要给nginx用户提权,这个也要提权,不然就会报错哦
echo "nginx ALL=(ALL) ALL" >> /etc/sudoers
2.4、when条件测试
---
- name: restart host
hosts: kobe24
remote_user: root
tasks:
- name: shutdown host
command: /sbin/shutdown -r now
when: ansible_default_ipv4.address == "192.168.10.102"
2.5、迭代
当有需要重复性执行的任务时,可以使用迭代机制。其使用格式为将需要迭代的内容定义为item变量引用,并通过with_items语句指明迭代的元素列表即可。
简单创建文件夹
---
- name: play1
hosts: james23
tasks:
- name: create dir
file: path={{item}} state=directory
with_items:
- /opt/jordan
- /opt/james
- /opt/kobe
- /opt/wade
- /opt/curry
- /opt/anthony
ansible-playbook test3.yaml
验证:
创建文件
---
- name: play1
hosts: james23
tasks:
- name: create dir
file: path={{item}} state=touch
with_items:
- /opt/jordan.txt
- /opt/james.txt
- /opt/kobe.txt
- /opt/wade.txt
- /opt/curry.txt
- /opt/anthony.txt
验证
用户更改或组的更改
---
- name: play1
hosts: kobe24
gather_facts: false
tasks:
- name: create directories
file:
path: "{{item}}"
state: directory
with_items:
- /opt/test1
- /opt/test2
- name: add users
user: name={{item.name}} state=present groups={{item.groups}}
with_items:
- name: test1
groups: wheel
- name: test2
groups: root
验证
2.6、Templates模块
Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件,可以看作是一个编译过的模板文件,用来产生目标文本,传递Python的变量给模板去替换模板中的标记。
先准备一个以 .j2 为后缀的 template 模板文件,设置引用的变量,cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2
2.6.1修改http.conf.j2
[root@ansible01 opt]#vim httpd.conf.j2
Listen {{http_port}} ##42行,修改
ServerName {{server_name}} ##95行,修改
DocumentRoot "{{root_dir}}" ##119行,修改
#修改完保存退出
2.6.2 修改ansible主机清单
[james23]
192.168.10.101 http_port=8080 service_name=www.kgc.com:8080
[kobe24]
192.168.10.102 http_port=8081 service_name=www.benet.com:8081
2.6.3 修改域名
[root@localhost opt]#vim /etc/hosts ##两台主机都需要修改
192.168.10.101 www.kgc.com
192.168.10.102 www.benet.com
2.6.4 编写yaml文件
---
- name: install httpd
hosts: all
remote_user: root
vars:
- pk: httpd
- service: httpd
tasks:
- name: install httpd pk
yum: name={{pk}} state=latest
- name: copy config file
template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
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
测试:
验证:
查看域名访问效果
2.6.5 ansible主机远程查看修改参数
ansible all -m shell -a 'cat /etc/httpd/conf/httpd.conf| grep -i "Servername"'
ansible all -m shell -a 'cat /etc/httpd/conf/httpd.conf| grep -i "Servername"'
ansible all -m shell -a 'cat /etc/httpd/conf/httpd.conf| grep -i "DocumentRoot"'
ansible all -a 'ls -l /etc/httpd'
2.7、tags模块
可以在一个playbook中为某个或某些任务定义“标签”,在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。
playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时,无论执行哪一个tags时,定义有always的tags都会执行。
2.7.1 编写yaml文件
指定tags执行标签
---
- name: ceshi tags
hosts: kobe24
remote_user: root
tasks:
- name: copy hosts file
copy: src=/etc/hosts dest=/opt/hosts
tags:
- hello
- name: touch file
file: path=/opt/nanjing state=touch
运行
检测:
ansible kobe24 -a 'ls -l /opt'
可以看到当指定标签tags就执行到标签为止
always应用
远程删除/opt/hosts
ansible kobe24 -a 'rm -rf /opt/hosts'
ansible kobe24 -a 'ls -l /opt'
编写yaml文件
---
- name: ceshi tags
hosts: kobe24
remote_user: root
tasks:
- name: copy hosts file
copy: src=/etc/hosts dest=/opt/hosts
tags:
- hello
- name: touch file
file: path=/opt/nanjing state=touch
tags:
- always
运行
ansible-playbook ta.yaml --tags="hello"
ansible kobe24 -a 'ls -l /opt'
查看添加了always之后,再指定标签执行,无论执行哪一个tags时,定义有always的tags都会执行。
2.8Roles模块
Ansible为了层次化、结构化地组织Playbook,使用了角色(roles),roles可以根据层次型结构自动装载变量文件、task以及handlers等。简单来讲,roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中,并可以便捷地include它们。roles一般用于基于主机构建服务的场景中,但也可以用于构建守护进程等场景中。
2.8.1 目录结构
yum -y install tree
cd /etc/ansible/
tree roles/
roles/
├── web/
│ ├── files/
│ ├── templates/
│ ├── tasks/
│ ├── handlers/
│ ├── vars/
│ ├── defaults/
│ └── meta/
└── db/
├── files/
├── templates/
├── tasks/
├── handlers/
├── vars/
├── defaults/
└── meta/
2.8.2 roles 内各目录含义解释
2.8.2.1files
- 用来存放由 copy 模块或 script 模块调用的文件。
2.8.2.2 templates
- 用来存放 jinjia2 模板,template 模块会自动在此目录中寻找 jinjia2 模板文件。
2.8.2.3 tasks
- 此目录应当包含一个main.yml 文件,用于定义此角色的任务列表,此文件可以使用 include 包含其它的位于此目录的 task 文件。
2.8.2.4 handlers
- 此目录应当包含一个main.yml 文件,用于定义此角色的任务列表,此文件可以使用 include 包含其它的位于此目录的 task 文件。
2.8.2.5 vars
- 此目录应当包含一个 main.yml 文件,用于定义此角色用到的变量。
2.8.2.6 defaults
- 此目录应当包含一个 main.yml 文件,用于为当前角色设定默认变量。
2.8.2.7 meta
- 此目录应当包含一个 main.yml 文件,用于定义此角色的特殊设定及其依赖关系。
2.8.3 在一个 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 文件,针对不同主机去调用不同的角色·2
vim /etc/ansible/site.yml·
---
- hosts: james23
remote_user: root
roles:
- httpd
- hosts: kobe24
remote
roles:
- mysql
(7)运行 ansible-playbook
cd /etc/ansible
ansible-playbook site.yml
2.8.4 Roles模块举例--LAMP
在Linux上面安装apache(httpd)、mysql和php服务
2.8.4.1 创建相应的目录和目录中的main.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
tree /etc/ansible/roles/
2.8.5 编写httpd 模块
2.8.5.1 编写yaml文件
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
2.8.5.2 定义变量
定义变量:可以定义在全局变量中,也可以定义在roles角色变量中,一般定义在角色变量中
vim /etc/ansible/roles/httpd/vars/main.yml
pkg: httpd
svc: httpd
2.8.6 编写mysql模块
2.8.6.1 编写yaml文件
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
2.8.6.2 定义变量
vim /etc/ansible/roles/mysql/vars/main.yml
pkg:
- mariadb
- mariadb-server
svc: mariadb
2.8.7 编写php模块
2.8.7.1 编写yaml文件
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
2.8.7.2 定义变量
vim /etc/ansible/roles/php/vars/main.yml
pkg:
- php
- php-fpm
svc: php-fpm
2.8.8 编写Roles示例并启动
vim /etc/ansible/site.yml
---
- hosts: all
remote_user: root
roles:
- httpd
- mysql
- php
cd /etc/ansible
ansible-playbook site.yml
2.8.8.1 运行yml文件
cd /etc/ansible/
ansible-playbook site.yml
2.8.9 验证查看服务状态
查看apache状态(httpd)
ansible all -a "systemctl status httpd"
查看数据库状态
ansible all -a "systemctl status mariadb"
查看php服务状态
ansible all -a "systemctl status php-fpm"