【Ansible】Ansible自动化运维工具之playbook剧本

一、playbook 的概述

1. playbook 的概念

  简单来说，playbooks是一种简单的配置管理系统与多机器部署系统的基础。与现有的其他系统有不同之处，且非常适合复杂应用的部署。

  Playbooks 可用于声明配置，更强大的地方在于，playbooks可以编排有序的去执行过程，甚至做到多组机器间来回有序的执行特别指定的步骤，并且可以同步或异步的发起任务。

2. playbook 的构成

  playbooks 本身由以下各部分组成:

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

二、playbook 的应用

1. 安装 httpd 并启动

#创建一个目录用来存放 playbooks 的文件
cd /etc/ansible/
mkdir playbooks

#编写 playbooks 文件
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，从而避免多次重启。

#运行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开始运行

2. 定义、引用变量

- name: second play
  hosts: dbservers
  remote_user: root
  vars:                 #定义变量
   - groupname: mysql   #格式为 key: value
   - username: nginx
  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}}" dest=/opt/vars.txt    #在setup模块中可以获取facts变量信息

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

3. 指定远程主机 sudo 切换用户

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

#目标主机添加用户并提权
vim /etc/sudoers
nginx   ALL=ALL

#运行playbook
ansible-playbook test3.yml -k -K 

4. when条件判断

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

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

vim test4.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: shutdown host 
     command: /sbin/shutdown -r now
     when: ansible_default_ipv4.address == "192.168.145.30"      #when指令中的变量名不需要手动加上 {{}}
或 
     when: inventory_hostname == "<主机名>

#运行playbook
ansible-playbook test4.yaml

5. 迭代

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

vim test5.yaml
---
- name: play1
  hosts: dbservers
  gather_facts: false
  tasks: 
    - name: create file
      file:
        path: "{{item}}"
        state: touch
      with_items: [ /opt/a, /opt/b, /opt/c, /opt/d ]

#运行playbook
ansible-playbook test5.yaml

- name: play2
  hosts: dbservers
  gather_facts: false		
  vars:
    test:
    - /tmp/test1
    - /tmp/test2
    - /tmp/test3
    - /tmp/test4
  tasks: 
    - name: create directories
      file:
        path: "{{item}}"
        state: directory
      with_items: "{{test}}"

#运行playbook
ansible-playbook test5.yaml

6. Templates 模块

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

6.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行，修改

6.2 修改主机清单文件

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

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

6.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

#运行playbook
ansible-playbook apache.yaml

7. 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    #表示始终要运行的代码

#运行playbook
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

#运行playbook
ansible-playbook dbhosts.yaml --tags="only"

#分别去两台被管理主机上去查看文件创建情况

总结

1. playbook 剧本

vim xxx.ymal
- name: 					#指定play名称
  hosts: 					#指定主机组
  remote_user:				#执行用户
  gather_facts: treu/false	#是否收集远程主机facts信息
  vars:						#定义变量
  tasks:					#定义任务列表
  - name:					#定义任务名称
    模块:					   #定义任务使用的模块和参数
    with_items:				#定义循环
    when:					#定义判断条件(== != >= <= <)，true则执行任务，否则不执行任务
    ignore_errors: true		#忽略任务失败
    notify:					#定义task任务changed状态时触发的任务名
    tags: 					#指定标签，ansible-playbook --tags 仅执行拥有指定tags标签的任务（always标签总会执行）
  handlers:					#定义notify触发的任务列表

task任务 模块语法格式：

#横向格式：
模块名：参数选项1=值 参数选项2={{变量名}}  ...

#纵向格式
模块名：
  参数选项1: 值
  参数选项2: "{{变量名}}"
  ...

with_items 和 变量 的语法格式
#横向格式：
with_items: ["值1","值2","值3"]
#纵向格式:
with_items:
- 值1
- 值2
- 值3
----------------------------------------------
值为对象（键值对字段)时:
#横向格式：
with_items :
- { key1 : value1, key2 : value2, ... }
- { key1 : value3, key2 : value4, ... }
#纵向格式:
with_items:
- key1: value1
  key2: value2
- key1: value3
  key2: value4