Ansible的脚本 --- playbook 剧本

Ansible的脚本 --- playbook 剧本
目录

playbook的简介

什么是playbook

playbook组成

应用实例

Templates 模块

tags 模块

Roles 模块

playbook的简介

什么是playbook

Ansible Playbook 是设定自动化任务的一种蓝图，可在无需人工干预或有限干预的前提下执行复杂的 IT 操作。Ansible Playbook 对一组或一类共同构成 Ansible 清单的主机执行。

Ansible Playbook 本质上是一些框架，是一些预先编写的代码，开发人员可以用作临时模板或起始模板。Ansible Playbook 常被用于自动化 IT 基础架构（例如，操作系统和 Kubernetes 平台）、网络、安全系统，以及开发人员角色（例如 Git）。

Ansible Playbook 可以帮助 IT 人员进行应用、服务、服务器节点或其他设备的编程，无需花费人力去从头创建所有事物。Ansible Playbook 及其中的条件、变量和任务，都可以无限期保存、分享或重复使用。

playbook组成

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

应用实例

使用playbook安装启用httpd服务

编写xxx.yaml文件
```
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 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，从而避免多次重启。
```
用yum先下载httpd，将其配置文件/etc/httpd/conf/httpd.conf复制到/opt目录下
```
运行playbook
ansible-playbook test1.yaml
//补充参数：
-k（–ask-pass）：用来交互输入ssh密码
-K（-ask-become-pass）：用来交互输入sudo密码
-u：指定用户
ansible-playbook test1.yaml --syntax-check    #检查yaml文件的语法是否正确
ansible-playbook test1.yaml --list-task       #检查tasks任务
ansible-playbook test1.yaml --list-hosts      #检查生效的主机
ansible-playbook test1.yaml --start-at-task='install httpd'     #指定从某个task开始运行
```
Templates 模块

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

template配置模板模块
1. 先准备一个 XXX.j2 配置模板文件，在模板文件中使用 {{变量名}} 格式引用主机变量、组变量、facts信息字段变量或vars字段自定义的变量的值
2. 编辑 playbook 文件，在文件中的 tasks 任务中定义 template 模块配置（template: src=XXX.j2文件路径 dest=远程主机文件路径）
范例：

1.先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量
```
cp /etc/httpd/conf/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.80.11 http_port=192.168.80.11:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs
 
[dbservers]
192.168.80.12 http_port=192.168.80.12:80 server_name=www.benet.com:80 root_dir=/etc/httpd/htdocs
```
3.编写 playbook
```
vim apache.yaml
---
- 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     #使用template模板
      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
 
ansible-playbook apache.yaml
```
tags 模块

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

范例：
```
vim webhosts.yaml
---
- 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    #表示始终要运行的代码
 
ansible-playbook webhosts.yaml --tags="only"
 
vim dbhosts.yaml
---
- hosts: dbservers
  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
 
 
ansible-playbook dbhosts.yaml --tags="only"
//分别去两台被管理主机上去查看文件创建情况
```
Roles 模块

roles用于层次性、结构化地组织playbook。roles能够根据层次型结构自动装载变量文件、tasks以及handlers等。要使用roles只需要在playbook中使用include指令引入即可。
简单来讲，roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中，并可以便捷的include它们的一种机制。roles一般用于基于主机构建服务的场景中，但也可以是用于构建守护进程等场景中。主要使用场景代码复用度较高的情况下。

假如我们现在有3个被管理主机，第一个要配置成httpd，第二个要配置成haproxy服务器，第三个要配置成MySQL（mariadb）服务器。我们如何来定义playbook？
第一个play用到第一个主机上，用来构建httpd，第二个play用到第二个主机上，用来构建haproxy。这些个play定义在playbook中比较麻烦，将来也不利于模块化调用，不利于多次调用。比如说后来又加进来一个主机，这第3个主机既是httpd服务器，又是haproxy服务器，我们只能写第3个play，上面写上安装httpd和haproxy。这样playbook中的代码就重复了。
为了避免代码重复，可以定义一个角色叫httpd，第二个角色叫haproxy，并使用roles实现代码重复被调用。

roles角色的作用？
可以把playbook剧本里的各个play看作为一个角色，将各个角色的tasks任务、vars变量、template模板和copy、script模块使用的相关文件等内容放置在指定角色的目录里统一管理，在需要的时候可在playbook中使用roles角色直接调用即可。也就是说roles角色可以在playbook中实现代码的复用。

roles 的目录结构

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 文件，用于定义此角色的元数据信息及其依赖关系。

在一个 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 文件，针对不同主机去调用不同的角色
```
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
```
格式：

roles/ #角色总目录，其每个子目录就是一个角色目录
nginx/ #相当于playbook中的每一个play主题，目录名就是角色名
files/ #存放copy、script模块调用的文件
   templates/ #存放template模块调用的 XXX.j2 模板文件
   tasks/main.yml #定义此角色的tasks普通任务列表
   handlers/main.yml #定义此角色通过notify触发时执行的handlers处理器任务列表
   vars/main.yml #定义此角色用的自定义变量
   defaults/main.yml #定义此角色用的默认变量(一般不用)
   meta/main.yml #定义此角色的元数据信息和依赖关系
mysql/
....
php/
....

vim XXX.yaml
- name:
hosts:
remote_user:
roles:
- nginx
- mysql
- php

ansible-playbook XXX.yaml
相关阅读:
c语言基础：数组的运用以及在内存中的地址的理解
 【尚硅谷React】——React全家桶笔记
 【STL编程】【竞赛常用】【part 3】
JVM工具
 参数调整F-score折线图
 【Springcloud】Seata分布式事务
 骨传导能保护听力吗，骨传导耳机能够进一步减少耳道的损伤
 Nacos入门
 【LEACH协议】无线传感器网络LEACH与DEEC协议【含Matlab源码 2187期】
F - Ginger的GIAO
原文地址：https://blog.csdn.net/weixin_72625764/article/details/136172856

playbook的简介

什么是playbook

playbook组成

应用实例

Templates 模块

tags 模块

Roles 模块