当前位置：首页 > news >正文

Ansible的脚本-playbook 剧本

news 2025/12/30 20:52:11

1.剧本（playbook）

1.playbook介绍

2. playbooks 的组成

3.案例：编写httpd的playbook

4.定义、引用变量

5.指定远程主机sudo切换用户

6.when条件判断

7.迭代

2.playbook的模块

1.Templates 模块

2.tags 模块

3.Roles 模块

1.剧本（playbook）

1.playbook介绍

playbook是ansible用于配置，部署，和管理被控节点的剧本。通过playbook的详细描述，执行其中的tasks，可以让远端主机达到预期的状态。playbook是由一个或多个”play”组成的列表。当对一台机器做环境初始化的时候往往需要不止做一件事情，这时使用playbook会更加适合。通过playbook你可以一次在多台机器执行多个指令。通过这种预先设计的配置保持了机器的配置统一，并很简单的执行日常任务。

ansible通过不同的模块实现相应的管理，管理的方式通过定义的清单文件(hosts)所管理的主机包括认证的方式连接的端口等。所有的功能都是通过调用不同的模块(modules)来完成不同的功能的。不管是执行单条命令还是play-book都是基于清单文件。

playbook格式：

（1）playbook由YMAL语言编写。YMAL格式是类似于JSON的文件格式，便于人理解和阅读，同时便于书写。

（2）一个剧本里面可以有多个play，每个play只能有一个tasks，每个tasks可以有多个name。

2. playbooks 的组成

Tasks：任务，即通过 task 调用 ansible 的模块将多个操作组织在一个playbook 中运行。
Variables：变量
Templates：模板
Handlers：处理器，当 changed 状态条件满足时，（notify）触发执行的操作。
Roles：角色

3.案例：编写httpd的playbook

vim test1.yaml
---     #yaml文件以---开头，以表明这是一个yaml文件，可省略
- name: first play     #定义一个play的名称，可省略gather_facts: false    #设置不进行facts信息收集，这可以加快执行速度，可省略hosts: webservers    #指定要执行任务的被管理主机组，如多个主机组用冒号分隔remote_user: root    #指定被管理主机上执行任务的用户tasks:     #定义任务列表，任务列表中的各任务按次序逐个在hosts中指定的主机上执行- name: test connection    #自定义任务名称ping:     #使用 module: [options] 格式来定义一个任务- name: disable selinuxcommand: '/sbin/setenforce 0'    #command模块和shell模块无需使用key=value格式ignore_errors: True     #如执行命令的返回值不为0，就会报错，tasks停止，可使用ignore_errors忽略失败的任务- name: disable firewalldservice: name=firewalld state=stopped    #使用 module: options 格式来定义任务，option使用key=value格式- name: install httpdyum: name=httpd state=latest- name: install configuration file for httpdcopy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf    #这里需要一个事先准备好的/opt/httpd.conf文件notify: "restart httpd"    #如以上操作后为changed的状态时，会通过notify指定的名称触发对应名称的handlers操作- name: start httpd serviceservice: enabled=true name=httpd state=startedhandlers:     #handlers中定义的就是任务，此处handlers中的任务使用的是service模块- name: restart httpd    #notify和handlers中任务的名称必须一致service: name=httpd state=restarted

1.Ansible 管理端编写好playbook剧本

2.在webservers端准备httpd模板配置文件

（3）在webservers端将准备好的httpd模板配置文件发送到Ansible管理端

(4)本机的httpd模板文件准备完成并且路径和剧本配置一致。

（5）执行playbook剧本

（6）检查生效的主机和指定从某个task开始运行

4.定义、引用变量

- name: second playhosts: dbserversremote_user: rootvars:                                                                        #定义变量- groupname: mysql                                                         #格式为 key: value- username: nginxtasks:- name: create groupgroup: name={{groupname}} system=yes gid=306                               #使用 {{key}} 引用变量
- name: create useruser: name={{username}} uid=306 group={{groupname}}- name: copy filecopy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt                  #在setup模块中可以获取facts变量信息ansible-playbook test2.yaml -e "username=nginx"                             #在命令行里定义变量

5.指定远程主机sudo切换用户

---
- hosts: dbservers
remote_user: zhangsan
become: yes #2.6版本以后的参数，之前是sudo，意思为切换用户运行
become_user: root #指定sudo用户为root
执行playbook时：ansible-playbook test3.yml -K <密码>

6.when条件判断

在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

vim test4.yaml
---
- hosts: all
remote_user: root
tasks:- name: shutdown hostcommand: /sbin/shutdown -r nowwhen: ansible_default_ipv4.address == "192.168.156.120" #when指令中的变量名不需要手动加上 {{}}或when: inventory_hostname == "<主机名>"ansible-playbook test4.yaml

7.迭代

Ansible提供了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。

vim test5.yaml
---
- name: play5hosts: dbserversgather_facts: falsetasks:- name: create directories      ##创建目录。目录名使用with_items里的循环file:path: "{{item}}"              ##由于值是{{....}} ,所以为了防止被认为是字典，要加上双引号.state: directorywith_items:                   #等同于 loop:- /tmp/test1- /tmp/test2- name: add users                ###使用循环创建用户，并添加附加组user: name={{item.name}} state=present groups={{item.groups}}with_items:- name: test1groups: wheel- name: test2groups: root或with_items:- {name:'test1', groups:'wheel'}- {name:'test2', groups:'root'}ansible-playbook test5.yaml

2.playbook的模块

1.Templates 模块

Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件，可以看作是一个编译过的模板文件，用来产生目标文本，传递Python的变量给模板去替换模板中的标记。

（1）先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量

cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2vim /opt/httpd.conf.j2
Listen {{http_port}}            #42行，修改
ServerName {{server_name}}  #95行，修改
DocumentRoot "{{root_dir}}"     #119行，修改 <Directory "{{root_dir}}">     #131修改 配置目录访问权限

（2）修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量

vim /etc/ansible/hosts
[webservers]
192.168.156.110 http_port=192.168.156.110:80 server_name=www.lhf.com:80 root_dir=/etc/httpd/htdocs[dbservers]
192.168.156.120 http_port=192.168.156.120:80 server_name=www.ysh.com:80 root_dir=/etc/httpd/htdocs

（3）编写 playbook

vim apache.yaml
---
- hosts: allremote_user: rootvars:- package: httpd- service: httpdtasks:- name: install httpd packageyum: name={{package}} state=latest- name: install configure filetemplate: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf #使用template模板notify:- restart httpd- name: create root dirfile: path=/etc/httpd/htdocs state=directory- name: start httpd serverservice: name={{service}} enabled=true state=startedhandlers:- name: restart httpdservice: name={{service}} state=restartedansible-playbook apache.yaml

（4）制作测试网页

ansible 192.168.156.110 -m shell -a "echo 'this is lhf template test' > /etc/httpd/htdocs/index.html"   #制作网页测试文件ansible 192.168.156.120 -m shell -a "echo 'this is ysh template test' > /etc/httpd/htdocs/index.html"<br><br>curl http://192.168.156.110   #登录访问查看<br><br>curl http://192.168.156.120<br>

2.tags 模块

可以在一个playbook中为某个或某些任务定义“标签”，在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。

vim webhosts.yaml
---
- hosts: webserversremote_user: roottasks:- name: Copy hosts filecopy: src=/etc/hosts dest=/opt/hoststags:- only                                                        #可自定义- name: touch filefile: path=/opt/testhost state=touchtags:- always                                                      #表示始终要运行的代码ansible-playbook webhosts.yaml --tags="only"vim dbhosts.yaml
---
- hosts: dbserversremote_user: roottasks:- name: Copy hosts filecopy: src=/etc/hosts dest=/opt/hoststags:- only- name: touch filefile: path=/opt/testhost state=touch　　
1
ansible-playbook dbhosts.yaml --tags="only"

分别去两台被管理主机上去查看文件创建情况

3.Roles 模块

Ansible为了层次化、结构化地组织Playbook，使用了角色（roles），roles可以根据层次型结构自动装载变量文件、task以及handlers等。简单来讲，roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中，并可以便捷地include它们。roles一般用于基于主机构建服务的场景中，但也可以用于构建守护进程等场景中。

1.roles 的目录结构

cd /etc/ansible/
tree roles/
roles/
├── web/
│ ├── files/
│ ├── templates/
│ ├── tasks/
│ ├── handlers/
│ ├── vars/
│ ├── defaults/
│ └── meta/
└── db/
├── files/
├── templates/
├── tasks/
├── handlers/
├── vars/
├── defaults/
└── meta/

2.roles 内各目录含义解释

（1）files
用来存放由 copy 模块或 script 模块调用的文件。

（2）templates
用来存放 jinjia2 模板，template 模块会自动在此目录中寻找 jinjia2 模板文件。

（3）tasks
此目录应当包含一个 main.yml 文件，用于定义此角色的任务列表，此文件可以使用 include 包含其它的位于此目录的 task 文件。

（4）handlers
此目录应当包含一个 main.yml 文件，用于定义此角色中触发条件时执行的动作。

（5）vars
此目录应当包含一个 main.yml 文件，用于定义此角色用到的变量。

（6）defaults
此目录应当包含一个 main.yml 文件，用于为当前角色设定默认变量。

（7）meta
此目录应当包含一个 main.yml 文件，用于定义此角色的特殊设定及其依赖关系。

3.在一个 playbook 中使用 roles 的步骤

（1）在一个 playbook 中使用 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/mysqlmkdir /etc/ansible/roles/php

（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}<strong><br></strong>mkdir /etc/ansible/roles/php/{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.ymltouch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml

（6）修改 site.yml 文件，针对不同主机去调用不同的角色

vim /etc/ansible/site.yml
---
- hosts: webserversremote_user: rootroles:- httpd
- hosts: dbserversremote_user: rootroles:- mysql

（7）运行 ansible-playbook

cd /etc/ansible
ansible-playbook site.yml

（8）编写httpd模块

写一个简单的tasks/main.yml

vim /etc/ansible/roles/httpd/tasks/main.yml
- name: install apacheyum: name={{pkg}} state=latest
- name: start apacheservice: enabled=true name={{svc}} state=started

定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中

vim /etc/ansible/roles/httpd/vars/main.yml
pkg: httpd
svc: httpd

（9）编写mysql模块

vim /etc/ansible/roles/mysql/tasks/main.yml
- name: install mysqlyum: name={{pkg}} state=latest
- name: start mysqlservice: enabled=true name={{svc}} state=startedvim /etc/ansible/roles/mysql/vars/main.yml
pkg:- mariadb- mariadb-server
svc: mariadb

（10）编写php模块

vim /etc/ansible/roles/php/tasks/main.yml
- name: install phpyum: name={{pkg}} state=latest
- name: start php-fpmservice: enabled=true name={{svc}} state=startedvim /etc/ansible/roles/php/vars/main.yml
pkg:- php- php-fpm
svc: php-fpm

（11）编写roles示例

vim /etc/ansible/site.yml
---
- hosts: webserversremote_user: rootroles:- httpd- mysql- phpcd /etc/ansible
ansible-playbook site.yml

目录

1.剧本（playbook）

1.playbook介绍

2. playbooks 的组成

3.案例：编写httpd的playbook

4.定义、引用变量

5.指定远程主机sudo切换用户

6.when条件判断

7.迭代

2.playbook的模块

1.Templates 模块

2.tags 模块

3.Roles 模块

1.剧本（playbook）

1.playbook介绍

2. playbooks 的组成

3.案例：编写httpd的playbook

4.定义、引用变量

5.指定远程主机sudo切换用户

6.when条件判断

7.迭代

2.playbook的模块

1.Templates 模块

2.tags 模块

3.Roles 模块

相关文章：