Ansible的脚本---playbook剧本

目录

playbooks 的组成

playbooks 本身由以下各部分组成

示例

定义、引用变量

指定远程主机sudo切换用户

when条件判断

迭代

Templates 模块

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

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

编写 playbook

tags 模块

Roles 模块

roles 的目录结构：

roles 内各目录含义解释

在一个 playbook 中使用 roles 的步骤：

案例：编写nginx模块

编写mysql模块

编写php模块

编写roles示例

---

playbooks 的组成

playbooks 本身由以下各部分组成

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

（2）Variables：变量

（3）Templates：模板

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

（5）Roles：角色

示例

vim demo1.yaml
---     #yaml文件以---开头，以表明这是一个yaml文件，可省略
- name: first play     #定义一个play的名称，可省略
  gather_facts: false    #设置不进行facts信息收集，这可以加快执行速度，可省略
  hosts: dbservers    #指定要执行任务的被管理主机组，如多个主机组用冒号分隔
  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: create apache http dir
     file: path=/opt/html state=directory
   - 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，从而避免多次重启。


//运行playbook
ansible-playbook demo1.yaml

补充参数：

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

定义、引用变量

vim demo2.yaml
- name: second play
  hosts: webservers
  remote_user: root
  vars:                 #定义变量
   - groupname: huo     #格式为 key:value
   - username: hh
  tasks:
   - name: create group
     group: name={{groupname}} gid=1314    #使用 {{key}} 引用变量的值
   - name: create user join to huo group
     user: name={{username}} uid=9521 group={{groupname}} 
   - name: copy local ip to remote
     copy: content="{{ansible_default_ipv4.address}}" dest=/opt/ipaddr.txt    #在setup模块中可以获取facts变量信息


ansible-playbook demo2.yaml      #运行playbook

指定远程主机sudo切换用户

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

when条件判断

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

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

vim demo3.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: create hah user 217.110
     user: name=hah uid=9526
     when: ansible_default_ipv4.address == "192.168.217.110"  
     when指令中的变量名不需要手动加上 {{}}
或
     when: inventory_hostname == "<主机名>"
     
   - name: create haha user 217.120
     user: name=hah uid=9527
     when: inventory_hostname == "192.168.217.120"  
   - name: create hf user on centos7
     user: name=hf uid=9528
     when: 
     - ansible_distribution == "Centos"
     - ansible_distribution_major_version == "7"
	
ansible-playbook demo3.yaml

迭代

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

vim demo4.yaml
---
- name: play1
  hosts: webservers
  remote_user: root
  tasks:
  - name: add users and groups
    #循环取值列表的横向写法
    with_items:
    - {name: 'yi', group: 'dayi'}
    - {name: 'er', group: 'daer'}
    - {name: 'san', group: 'dasan'}
    #模块的横向写法
    group: name={{item.group}}

  - name: add user to group
    #循环取值列表的纵向写法
    with_items:
    - name: yi
      group: dayi
    - name: er
      group: daer
    - name: san
      group: dasan
    #任务模块的纵向写法
    user:
      name: "{{item.name}}"
      groups: "{{item.group}}"

  - name: check users id
    loop:
    - yi
    - er
    - san
    command: 'id {{item}}'

ansible-playbook demo4.yaml

Templates 模块

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

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

cd /etc/ansible/
cd /templatem
cp /etc/httpd/conf/httpd.conf ./httpd.conf.j2

vim httpd.conf.j2
Listen {{http_port}}				#42行，修改
ServerName {{server_name}}			#95行，修改
DocumentRoot "{{root_dir}}"          #119行，修改

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

vim /etc/ansible/hosts       
[webservers]
192.168.217.110 http_port=192.168.217.110:81 server_name=www.accp.com:81 root_dir=/opt/html

[dbservers]
192.168.217.120 http_port=192.168.217.120:82 server_name=www.benet.com:82 root_dir=/opt/html

编写 playbook

vim demo5.yaml
---
- name: play2
  hosts: dbservers
  vars:
  - pkg: httpd
  - svc: httpd
  - dir_path: /opt/html
  tasks:
  - name: disable selinux
    command: '/sbin/setenforce 0'
    ignore_errors: True

  - name: disable firewalld
    service: name=firewalld state=stopped enabled=no
  - name: install apache
    yum: name={{pkg}} state=latest
  - name: create web root dir
    file: path={{dir_path}} state=directory

  - name: add configuration file to remote host
    template: src=/etc/ansible/template/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
    notify:
    - restart apache

  - name: start apache
    service: name={{svc}} enabled=yes state=started

  handlers:
  - name: restart apache
    service: name={{svc}} state=restarted

ansible-playbook demo5.yaml

查看执行任务的被管理主机组
vim /etc/httpd/conf/httpd.conf

tags 模块

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

vim demo6.yaml
---
- name: play3
  hosts: webservers
  remote_user: root
  tasks:
    - name: copy hosts to remote host
      copy: src=/etc/hosts dest=/opt/hosts.bak
      tags:
      - one     #可自定义
    - name: copy fstab file to remote host
      copy: src=/etc/fstab dest=/opt/fstab.bak
      tags:
      - two    
    - name: copy passwd file to remote host
      copy: src=/etc/passwd dest=/opt/passwd.bak
      tags:
      - always    #表示始终要运行的代码
      
ansible-playbook demo6.yaml --tags="one"

//去被管理主机上去查看文件创建情况

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/hnginx
mkdir /etc/ansible/roles/mysql

（4）在每个角色命令的目录中分别创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建
mkdir /etc/ansible/roles/nginx/{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/nginx/{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


示例：
mkdir /etc/ansible/roles/nginx/{files,templates,tasks,handlers,vars,defaults,meta}
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta}
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta}

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模块

cd /etc/ansible/roles/nginx/files
把在线源拉进去

vim /etc/ansible/roles/nginx/tasks/main.yml

- name: copy repo file to remote host
  copy: src=nginx.repo dest=/etc/yum.repos.d

- name: install nginx
  yum: name={{pkg}} state=latest
- name: start nginx
  service: enabled=yes name={{svc}} state=started
 
//定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
vim /etc/ansible/roles/nginx/vars/main.yml

pkg: nginx
svc: nginx

编写mysql模块

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
  
vim /etc/ansible/roles/mysql/vars/main.yml

pkg:
- mariadb
- mariadb-server

svc: mariadb

编写php模块

vim /etc/ansible/roles/php/tasks/main.yml

- name: install php
  yum: name={{pkg}} state=latest

- name: start php-fpm
  service: enabled=yes name={{svc}} state=started

vim /etc/ansible/roles/php/vars/main.yml

pkg:
- php
- php-fpm
svc: php-fpm

编写roles示例

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

- hosts: webservers
  remote_user: root
  roles:
   - nginx

- hosts: dbservers
  remote_user: root
  roles:
   - mysql

- hosts: phpservers
  remote_user: root
  roles:
   - php


ansible-playbook lnmp.yml