Ansible 的脚本 --- playbooks剧本

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

ansible playbook（.yaml 文件）	192.168.190.80
webservers	192.168.190.60
dbservers	192.168.190.70

1、tasks 任务列表

vim test01.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 复制到远程主机的 /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，从而避免多次重启。

//运行playbook

ansible-playbook test01.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开始运行

2、vars 定义、引用变量

vim test02.yaml

- name: play02                   #定义playbook名称为play02
  hosts: dbservers              #针对dbservers主机组
  remote_user: root            #连接到主机时，用户名为root
  vars:                 #定义变量groupname、username
   - groupname: mysql   #变量groupname，赋值为mysql  #格式为 键值 key: value   
   - username: nginx      #变量username赋值为nginx
  tasks:       #任务列表
   - name: create group     
     group: name={{groupname}} system=yes gid=306     ##用 group 模块创建一个名为 {{groupname}}（即 mysql）的组，GID 为 306。
   - name: create user         
     user: name={{username}} uid=306 group={{groupname}}    #用 user 模块创建一个名为 {{username}}（即 nginx）的用户，UID 为 306，并将其添加到之前创建的组。
   - name: copy file
     copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt      #用 copy 模块将目标主机的默认 IPv4 地址写入 /opt/vars.txt 文件

------------------------------------------------------------------------------------------------------------------------
ansible-playbook test02.yaml -e "username=nginx"     #在命令行里定义变量

3、远程主机 sudo 切换用户

- hosts: dbservers
  remote_user: zhangsan            
  become: yes                     #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_user: root              #指定sudo用户为root

--------------------------------------------------------------------------------------------------------------------------

[root@dbservers ~]# vim /etc/sudoers            #切换到目标主机，配置SSH密钥认证
            yss ALL=(root) NOPASSWD: ALL        #G到行尾，添加
 

执行playbook时：ansible-playbook test1.yml -K -k

 

4、when 条件判断

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

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

vim test2.yaml
---
- hosts: all             #这个playbook应该在所有匹配的主机上运行
  remote_user: root         #指定 root 用户来执行任务
  tasks:                  #任务列表
   - name: shutdown host 
     command: /sbin/shutdown -r now     #shut down -r now重启主机
     when: ansible_default_ipv4.address == "192.168.190.60"      #当ipv4为192.168.190.60时执行
或 
     when: inventory_hostname == "<主机名>"
    
ansible-playbook test2.yaml       

#192.168.190.60应该重启才正确

5、with_items 迭代

迭代：通常指持续的playbook剧本（一种使用YAML编写自动化的任务脚本）进行修改、更新、改进的过程

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

vim test05.yaml
---
- name: play1
  hosts: dbservers
  gather_facts: false
  tasks:         #任务列表
    - name: create directories             #用file模块创建目录
      file:
        path: "{{item}}"
        state: directory
      with_items:          #等同于 loop:
        - /tmp/test1
        - /tmp/test2
    - name: add users                #用user模块添加用户
      user: name={{item.name}} state=present groups={{item.groups}}
      with_items:
        - name: test1
          groups: wheel
        - name: test2
          groups: root
或
      with_items:
        - {name:'test1', groups:'wheel'}
        - {name:'test2', groups:'root'}

--------------------------------------------------------------------------------------------------------------------------

ansible-playbook test3.yaml

6、Templates 模块

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

template：动态生成配置文件。会有数据经常动态改变，如IP地址、主机名（服务名）、端口、用户名等

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.190.60 http_port=192.168.190.60:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs

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

3.编写 playbook 

vim apache.yaml
---
- hosts: all                      #在所有主机（all）上执行
  remote_user: root        #使用 root 用户连接远程主机
  vars:                 #定义变量
    - package: httpd         #定义了一个变量 package，其值为 httpd
    - service: httpd           #定义了一个变量 service，其值也为 httpd
  tasks:              #任务列表
    - name: install httpd package           #安装httpd包
      yum: name={{package}} state=latest
    - name: install configure file             #安装配置文件
      template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf     #使用template模板安装一个模板文件 httpd.conf 到 /etc/httpd/conf/httpd.conf
      notify:       #如果这个任务改变了文件状态，那么将会触发名为 restart httpd 的 handler
        - restart httpd
    - name: create root dir            #用 file 模块来创建目录 /etc/httpd/htdocs
      file: path=/etc/httpd/htdocs state=directory               #directory目录
    - name: start httpd server       #用 service 模块来启动 httpd 服务，并设为开机自启
      service: name={{service}} enabled=true state=started
  handlers:          #特殊的 task，它们不会自动执行，而是由 notify 关键字触发
    - name: restart httpd              #定义了一个处理程序，用于重新启动 httpd 服务
      service: name={{service}} state=restarted

----------------------------------------------------------------------------------------------------------------------

ansible-playbook apache.yaml

7、tags 模块

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

vim webhosts.yaml
---
- hosts: webservers           #在webservers主机组上执行
  remote_user: root            #用户root执行
  tasks:           #任务列表
    - name: Copy hosts file       #使用copy模块，复制hosts文件
      copy: src=/etc/hosts dest=/opt/hosts      #源地址：/etc/hosts，目标地址/opt/hosts
      tags:
      - only            #标签为 only，任务只有在指定 --tags="only" 参数时才会执行
    - name: touch file        #使用 file 模块，创建或更新 /opt/testhost 文件
      file: path=/opt/testhost state=touch
      tags:
      - always    #标签为always，始终要运行的代码，无论是否指定标签ansible-playbook

-----------------------------------------------------------------------------------------------------------------------

webhosts.yaml --tags="only" 

#webservers主机组上的主机，创建了hosts和testhost

vim dbhosts.yaml
---
- hosts: dbservers                #在dbservers主机组上执行
  remote_user: root              #用户root执行
  tasks:               #任务列表
    - name: Copy hosts file            #用copy模块，复制文件
      copy: src=/etc/hosts dest=/opt/hosts      #源地址：/etc/hosts，目标地址：/opt/hosts 
      tags:              #标签为 only，任务只有在指定 --tags="only" 参数时才会执行
        - only
    - name: touch file                    #使用file模块，创建或更新文件
      file: path=/opt/testhost state=touch

----------------------------------------------------------------------------------------------------------------------
ansible-playbook dbhosts.yaml --tags="only"
#dbservers主机组上的主机只生成了 hosts，没生成 testhost

给 touch file 任务也加上 only 标签，才会生成 testhost

8、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 内各目录含义解释

1、任务（tasks）：执行具体的操作步骤

2、变量（vars）：角色中使用的变量

3、文件（files）：需要复制到远程主机的文件

4、模版（templates）：动态生成配置文件

5、处理器（handlers）：任务完成后触发的操作，如重启服务等

6、默认变量（defaults）：角色中的默认变量

7、依赖（meta）：依赖其他角色

//ansible 角色的好处：

1、简化剧本的管理：将剧本分解成一个个小模块，每个角色处理特定的功能，管理更加清晰

2、模块化和重要性：不同的场景可以反复使用，减少编写任务

3、易于维护和扩展***：当某个部分的角色需要修改时，只需要修改对应角色，不用修改整个playbook剧本

//在一个 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

查看webservers主机组httpd安装情况，dbservers主机组mysql安装情况

示例：

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

------编写httpd（80）模块------

写一个简单的tasks/main.yml

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

-------编写mysql（3306）模块-------

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

-------编写php（9000）模块-----

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

-----编写roles示例-----

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

cd /etc/ansible
ansible-playbook site.yml

查看webservers主机组的apache、mysql、php安装情况