Ansible-Playbook 剧本编写

1. Playbook的结构

Ansible 的Playbook是一个包含多个Play的YAML文件，每个Play负责对指定的主机组执行一系列的任务。Playbook通常由以下几部分组成：

Tasks：每个任务会调用一个模块来在目标主机上执行操作。

Variables：通过定义和使用变量，使Playbook更具灵活性和可重用性。

Templates：通过Jinja2模板动态生成配置文件。

Handlers：用于响应任务执行后的变更（notify触发）。

Roles：把多个任务、变量、模板、文件、处理程序组织成模块化结构，便于复用。

2. Ansible Playbook示例

下面的示例展示了一个简单的Playbook，演示了基本的任务执行流程和Ansible模块使用。

vim test1.yaml --- #yaml文件以---开头，以表明这是一个yaml文件，可省略 - name: first play1 #定义一个play的名称，可省略 gather_facts: false #设置不进行facts信息收集，这可以加快执行速度，可省略 hosts: webservers #指定要执行任务的被管理主机组，如多个主机组用冒号分隔 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 #使用 module: options 格式来定义任务，option使用key=value格式 - 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 #这里需要一个事先准备好的/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，从而避免多次重启。

3.命令行运行Playbook

在运行Playbook时，可以使用一些常用参数来调整执行行为：

ansible-playbook test1.yaml # 运行 playbook ansible-playbook test1.yaml --syntax-check # 检查语法 ansible-playbook test1.yaml --list-task # 查看任务列表 ansible-playbook test1.yaml --list-hosts # 查看影响的主机 ansible-playbook test1.yaml --start-at-task='install httpd' # 从指定任务开始执行

如果要使用SSH密码或sudo密码，可以使用以下选项：

ansible-playbook test1.yaml -k # 提示输入 SSH 密码 ansible-playbook test1.yaml -K # 提示输入 sudo 密码

4.变量和引用

变量在Playbook中非常有用，它们可以通过 vars 或命令行进行定义。

--- - name: second play hosts: dbservers remote_user: root vars: groupname: mysql username: nginx tasks: - name: create group group: name={{ groupname }} system=yes gid=306 - name: create user user: name={{ username }} uid=306 group={{ groupname }} - name: copy file copy: content="{{ ansible_default_ipv4 }}" dest=/opt/vars.txt

在命令行中，变量也可以通过-e参数传递：

ansible-playbook test1.yaml -e "groupname=nginx"

5.条件判断when

在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。

when 用于根据条件执行任务。它的常见用法包括：

根据主机的 IP地址来执行任务：

//when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务 --- - hosts: all remote_user: root tasks: - name: shutdown host command: /sbin/shutdown -r now when: ansible_default_ipv4.address == "192.168.10.64" #when指令中的变量名不需要手动加上 {{}}

或根据主机名来执行：

when: inventory_hostname == "<主机名>"

6.迭代：使用with_items或loop

Ansible支持使用with_items或loop进行迭代。两者作用相同，loop是较新的推荐用法。

//Ansible提供了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。 --- - name: play1 hosts: dbservers gather_facts: false tasks: - name: create directories file: path: "{{ item }}" state: directory with_items: # 等同于loop： - /tmp/test1 - /tmp/test2 - name: add users user: name={{item.name}} state=present groups={{item.groups}} with_items: - name: test1 groups: wheel - name: test2 groups: root

7. Templates模块

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

Jinja2模板引擎在Ansible中用来动态生成文件。例如，在配置Apache时，可以使用模板文件来替换动态值。

（1）创建Jinja模板文件(.j2)：

#先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量 cp /opt/httpd.conf /opt/httpd.conf.j2 vim /opt/httpd.conf.j2 Listen {{http_port}} #42行，修改 ServerName {{server_name}} #95行，修改 DocumentRoot "{{root_dir}}" #119行，修改

（2）定义变量并在主机清单中指定：

#修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量 vim /etc/ansible/hosts [webservers] 192.168.10.14 http_port=80 server_name=www.xingguang.com root_dir=/etc/httpd/htdocs # www.xingguang.com 自己设自己的

（3）Playbook示例：

--- - hosts: all remote_user: root vars: package: httpd service: httpd tasks: - name: install httpd package yum: name={{ package }} state=latest - name: install configure 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

8. Tags模块

Tags允许你指定只执行某些特定任务。通过命令行传入--tags参数来执行带有特定标签的任务。

\\可以在一个playbook中为某个或某些任务定义“标签”，在执行此playbook时通过ansible-playbook命 令使用--tags选项能实现仅运行指定的tasks。 playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时，无论执行哪一个 tags时，定义有always的tags都会执行。 --- - hosts: webservers remote_user: root tasks: - name: Copy hosts file copy: src=/etc/hosts dest=/opt/hosts tags: - only 自定义 - name: touch file file: path=/opt/testhost state=touch tags: - always # 始终执行

9. Roles模块

9.1 Roles概念

Roles 数据中心有各种不同类型的主机。如web服务器、数据库服务器，基于开发环境的服务器。随着时间的推移，具有处理所有这些情况的任务和人员的Ansible playbook将变得庞大而复杂。

1）角色允许将复杂的剧本组织成独立的、更小的剧本和文件

2）角色提供了一种从外部文件加载任务、处理程序和变量的方法

3）角色也可关联和引用静态的文件和模板

4）角色可以编写成满足普通用途需求，并且能被重复利用

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

9.2 roles内各目录含义解释

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

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

tasks: 此目录应当包含一个main.yml文件，用于定义此角色的任务列表，此文件可以使用

include 包含其它的位于此目录的task文件。

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

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

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

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

Roles是将Playbook组织成模块化的结构，使其易于管理和重用。每个Role都有一套预定义的目录结构：

roles/ ├── web/ │ ├── files/ │ ├── templates/ │ ├── tasks/ │ ├── handlers/ │ ├── vars/ │ ├── defaults/ │ └── meta/ └── db/ ├── files/ ├── templates/ ├── tasks/ ├── handlers/ ├── vars/ ├── defaults/ └── meta/

9.3在一个playbook中使用roles的步骤:

（1）创建以roles命名的目录：

mkdir /etc/ansible/roles/ -p #yum装完默认就有

（2）创建全局变量目录（可选）：

mkdir /etc/ansible/group_vars/ -p touch /etc/ansible/group_vars/aaa #文件名自己定义，引用的时候注意

（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 文件，针对不同主机去调用不同的角色：

vim /etc/ansible/site.yml --- - hosts: webservers remote_user: root roles: - httpd - hosts: dbservers remote_user: root roles: - mysql

（7）运行ansible-playbook：

cd /etc/ansible ansible-playbook site.yml

9.4案列

（1）创建项目目录

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

（2）编写httpd模块

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 //定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中 vim /etc/ansible/roles/httpd/vars/main.yml pkg: httpd svc: httpd

（3）编写mysql模块

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 vim /etc/ansible/roles/mysql/vars/main.yml pkg: - mariadb - mariadb-server svc: mariadb

（4）编写php模块

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 vim /etc/ansible/roles/php/vars/main.yml pkg: - php - php-fpm svc: php-fpm

（5）编写roles

vim /etc/ansible/site2.yml --- - hosts: webservers remote_user: root roles: - httpd - mysql - php cd /etc/ansible ansible-playbook site2.yml