Ansible 的脚本 --- playbook 剧本

Ansible 的脚本 --- playbook 剧本

目录

• Ansible 的脚本 --- playbook 剧本
  • playbooks 的组成
    • playbooks 本身由以下各部分组成
    • 示例
      • 补充参数
    • 定义、引用变量
    • when条件判断
    • 迭代
  • Templates 模块
  • tags 模块
  • Roles 模块
    • roles 的目录结构：
      • roles 内各目录含义解释
      • 示例：使用roles模块搭建分布式lnmp
        • 编写nginx模块
        • 编写mysql模块
        • 编写php模块
        • 添加主机清单
        • 编写roles模板文件

playbooks 的组成

playbooks 本身由以下各部分组成

• Tasks：任务，即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行

• Variables：变量

• Templates：模板

• Handlers：处理器，当changed状态条件满足时，（notify）触发执行的操作

• Roles：角色

示例

服务器类型	系统和IP地址	需要安装的组件
Ansible管理服务器	CentOS7.4(64 位) 192.168.239.10	Ansible
被管理客户端	CentOS7.4(64 位) 192.168.239.20	————
被管理客户端	CentOS7.4(64 位) 192.168.239.30	————

1.将修改后的httpd.conf配置文件拉入opt目录修改端口站点目录

vim apache.yaml        #编写apache剧本文件
---                    #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 mode=644
     #这里需要一个事先准备好的/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，从而避免多次重启。


#运行playbook
ansible-playbook apache.yaml

验证服务是否开启

被控制端查看端口

补充参数

-k（–ask-pass）：用来交互输入ssh密码
-K（-ask-become-pass）：用来交互输入sudo密码
-u：指定用户
ansible-playbook apache.yaml --syntax-check #检查yaml文件的语法是否正确
ansible-playbook apache.yaml --list-task #检查tasks任务
ansible-playbook apache.yaml --list-hosts #检查生效的主机
ansible-playbook apache.yaml --start-at-task=‘install httpd’ #指定从某个task开始运行

定义、引用变量

vim dome1.yaml
- name: second play
  hosts: dbservers
  remote_user: 
  vars:                 #定义变量
   - groupname: geng   #格式为 key: value
   - username: bo
  tasks:
   - name: create group
     group: name={{groupname}} system=yes gid=306    #使用 {{key}} 引用变量的值
   - name: create user
     user: name={{username}} uid=306 group={{groupname}} 
   - name: copy file
     copy: content="{{ansible_default_ipv4.ipaddress}}" dest=/opt/vars.txt    #在setup模块中可以获取facts变量信息


ansible-playbook dome1.yaml     #在命令行里定义变量
ansible dbservers -a 'id bo'    #验证

指定远程主机sudo切换用户

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

when条件判断

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

when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

vim dome2.yaml
- hosts: all
  remote_user: root
  tasks:
  - name: create gb user on 239.20
    user: name=gb111
    when: ansible_default_ipv4.address == "192.168.239.20"  #判断IP为20才回去创建用户
  - name: create xiuer user on centos7
    user: name=bo111
#判断的两种方法
#- ansible_distribution == "CentoS"
#- ansible_distribution_major_version =="7"
    when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "7") or (ansible_default_ipv4.address == "192.168.239.30")
#判断为centos7或者ip为30就去创建用户只需要满足一个条件即可 
	
ansible-playbook dome2.yaml

验证

迭代

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

vim demo4.yaml
---
- name: play
  hosts: webservers
  remote_user: root
  tasks:
  - name: add users and groups
    #循环取值列表的横向写法
    with_items:
    - {name: 'geng', group: 'lu'}
    - {name: 'bo', group: 'han'}
    - {name: 'gengbo', group: 'qing'}
    #模块的横向写法
    group: name={{item.group}}
  - name: add user to group
    #循环取值列表的纵向写法
    with_items:
    - name: geng
      group: lu
    - name: bo
      group: han
    - name: gengbo
      group: qing
    #任务模块的纵向写法
    user:
      name: "{{item.name}}"
      groups: "{{item.group}}"

  - name: check users id
    loop:
    - geng
    - bo
    - gengbo
    command: 'id {{item}}'

ansible-playbook demo4.yaml

验证

Templates 模块

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

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

#在ansible控制端安装apache服务将配置文件复制到并添加后缀名.j2
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行，修改
 <Directory "{{root_dir}}">
     AllowOverride None
     # Allow open access:
     Require all granted
 </Directory>

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

vim /etc/ansible/hosts       
[webservers]
[webservers]
192.168.239.20 http_port=192.168.239.20:80 server_name=www.kgc.com:80 root_dir=/etc/httpd/htdocs

[dbservers]
192.168.239.30 http_port=192.168.239.30:80 server_name=www.yjs.com:80 root_dir=/etc/httpd/htdocs

3.编写 playbook

vim apache.yaml
- name: play
  hosts: all                                #所有主机
  vars:
  - pkg: httpd                              #定义服务变量
  - svc: httpd
  - A_path: /opt/kgc/html                   #定义站点目录
  - B_path: /opt/yjs/html
  tasks: 
  - name: disable selinux                   #关闭selinux
    command: '/sbin/setenforce 0'
    ignore_errors: True                     #如果返回值不是0则忽略失败的任务
  - name: disable firewalld                 #关闭防火墙
    service: name=firewalld state=stopped enabled=no
  - name: install apache
    yum: name={{pkg}} state=latest          #安装最新版本服务
  - name: create web kgc root dir           #创建目录通过when判断主机ip分别创建不同的目录
    when: inventory_hostname == "192.168.239.20"
    file: path={{A_path}} state=directory
  - name: create web kgc root dir
    when: inventory_hostname == "192.168.239.30"
    file: path={{B_path}} state=directory
  - name: install configure file            #将本机修改后的配置文件远程复制到其他被控制服务器
    template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
    notify:       #如以上操作后为changed的状态时，会通过notify指定的名称触发对应名称的handlers操作
    - restart apache
  - name: start apache server   #开启服务
    service: name={{svc}} enabled=true state=started
  handlers:
  - name: restart apache        #重启服务
    service: name={{svc}} state=restarted


ansible-playbook apache.yaml

验证

被控制服务器查看端口是否开启或在自己定义的站点目录写入网页文档并访问进行验证

tags 模块

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

vim tags.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  #表示始终要运行的代码
    - name: touch file   #创建文件夹
      file: path=/opt/geng state=touch
      tags:
      - gb  #表示始终要运行的代码

ansible-playbook tags.yaml --tags="only"
#验证去dbservers组主机查看opt目录

Roles 模块

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

roles 的目录结构：

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

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模块搭建分布式lnmp

环境准备工作：

服务器类型	系统和IP地址	需要安装的组件
Ansible管理服务器	CentOS7.4(64 位) 192.168.239.10	Ansible
被管理客户端	CentOS7.4(64 位) 192.168.239.20	————
被管理客户端	CentOS7.4(64 位) 192.168.239.30	————
被管理客户端	CentOS7.4(64 位) 192.168.239.40	————

1.创建角色目录及文件

mkdir /etc/ansible/roles/nginx/{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/nginx/{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

编写nginx模块

#定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
vim /etc/ansible/roles/nginx/vars/main.yml

pkg: nginx
svc: nginx


#因为这里时域名安装mginx所以要把nginx在线源拉入files目录
nginx.repo
# nginx.repo

[nginx]
name=nginx repo
baseurl=http://nginx.org/packages/centos/7/$basearch/
gpgcheck=0
enabled=1

vim /etc/ansible/roles/nginx/tasks/main.yml
#编写角色的任务列表文件
- name: copy repo file to remote host
  copy: src=nginx.repo dest=/etc/yum.repos.d
#将本地的files目录内的nginx在线源复制到远程主机yum源目录
- name: install nginx
#安装nginx服务调用vars目录文件内变量
  yum: name={{pkg}} state=latest
- name: start nginx   
#启动服务
  service: enabled=yes name={{svc}} state=started

编写mysql模块

vim /etc/ansible/roles/mysql/vars/main.yml
#定义角色变量

pkg:  
#yum安装mysql所需要的依赖包
- mariadb
- mariadb-server
#服务名
svc: mariadb

vim /etc/ansible/roles/mysql/tasks/main.yml
#编写角色的任务列表文件

- name: install mysql
  yum: name={{pkg}} state=latest  
#安装相关依赖包

- name: start mysql
  service: enabled=yes name={{svc}} state=started
#开启服务

编写php模块

vim /etc/ansible/roles/php/vars/main.yml
#定义变量
pkg:
#所需依赖包
- php
- php-fpm
#服务名
svc: php-fpm

vim /etc/ansible/roles/php/tasks/main.yml
#安装php
- name: install php
  yum: name={{pkg}} state=latest

- name: start php-fpm 
#开启服务
  service: enabled=yes name={{svc}} state=started

添加主机清单

cd /etc/ansible/
vim hosts

[nginxservers]
192.168.239.20
[nginxservers:vars]
ansible_user=root
ansible_password=1999612

[mysqlservers]
192.168.239.30
[mysqlservers:vars]
ansible_user=root
ansible_password=1999612

[phpservers]
192.168.239.40
[phpservers:vars]
ansible_user=root
ansible_password=1999612

编写roles模板文件

cd /etc/ansible
mkdir play
cd play
vim lnmp.yml

- hosts: nginxservers
  remote_user: root
  roles:
   - nginx

- hosts: mysqlservers
  remote_user: root
  roles:
   - mysql

- hosts: phpservers
  remote_user: root
  roles:
   - php


ansible-playbook lnmp.yml

各服务器验证