Ansible-playbook

一.playbook概述

• playbook是ansible用于配置，部署，和管理被节点的剧本。
• 通过playbook的详细描述，执行其中的一些列tasks，可以让远端的主机达到预期的状态。playbook就像ansible控制器给被控节点列出的一系列to-do-list，而且被控节点必须要完成。
• playbook顾名思义，即剧本，现实生活中演员按照剧本表演，在ansible中，这次由被控计算机表演，进行安装，部署应用，提供对外的服务等，以及组织计算机处理各种各样的事情。

1.1playbook使用场景

• 执行一些简单的任务，使用ad-hoc命令可以方便的解决问题，但是有时一个设施过于复杂，需要大量的操作的时候，执行的ad-hoc命令是不合适的，这时候最好使用playbook。
• 就像执行shell命令与写shell脚本一样，也可以理解为批处理任务，不过playbook有自己的语法格式。
• 使用playbook可以方便的重复使用这些代码，可以移植到不同的机器上面，像函数一样，最大化的利用代码。在你使用Ansible的过程中，你也会发现，你所处理的大部分操作都是编写playbook。
• 可以把常见的应用都编写playbook，之后管理服务器会变得很简单。

二.playbook的组成

2.1playbook剧本的组成

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

②Variables：变量

③Templates：模板

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

⑤Roles：角色

2.2playbook剧本组成实例

①实例1：playbook编写，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，从而避免多次重启。

 修改配置文件【webservers端】

vim httpd.conf         #在/opt/目录下放入修改之后的配置文件
  
#42行，指定端口
Listen 8080
#95行，指定域名
ServerName www.suoluo.com:8080　

 

 

 

 

 

 

 运行playbook

##运行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：定义，引用变量

vim test2.yaml

- 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 test1.yaml -e "username=nginx"     //在命令行里定义变量

 

 

 

 

③实例3：指定远程主机sudo

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

④实例4：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.61.101" //when指令中的变量名不需要手动加上 {{}}
    或
    when: inventory_hostname == "<主机名>"
 
ansible-playbook test4.yaml

 

 

 

⑤实例5：迭代

vim test5.yaml
---
- name: play5
  hosts: dbservers
  gather_facts: false
  tasks:
    - name: create directories      //创建目录。目录名使用with_items里的循环
      file:
        path: "{{item}}"              //由于值是{{....}} ,所以为了防止被认为是字典，要加上双引号.
        state: directory
      with_items:                   //等同于 loop:
        - /tmp/test1
        - /tmp/test2
   - name: add users               //使用循环创建用户，并添加附加组
     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 test5.yaml

 

 

 

 

 

 

 

 

三.playbook模块

3.1 Templates 模块

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

①先准备一个以 .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行，修改
<Directory "{{root_dir}}">     //131修改 配置目录访问权限

 

 

 

 

 

 

 

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

 

③编写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

 

 

 

3.2 Tags 模块

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

 

3.3 Roles 模块

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

 

四.Roles在lnmp中的应用

 

 

五.总结

playbook中yaml的要求

• playbook文件的第一行应该以---三个连字符开始，表明YMAL文件的开始
• 在同一行中，#之后的内容表示注释
• 支持数据格式：列表、字典、布尔值、复合形式（数据可以复合使用，注意各自标准即可）
• 列表：列表元素以-开头，然后紧跟着一个空格，同一个列表中的元素应该保持相同的缩进
• 字典：一个字典是由一个简单的 key: value 的形式组成，这个冒号后面必须是一个空格，字典也可以使用缩进形式来表示
• 布尔值：yes|no|ture|fals|True|False|TRUE|FALSE，不区分大小写，均可以表示布尔值
• 复合形式：数据可以复合使用，使用时按照各自标准书写即可
• 可以使用|和>符号来书写文字块，前者其所修饰的所有字符串的换行符均不保留，后者与之相反全部保留（>符号可以看做折叠换行符），注意主要区别在于保留换行符，但是无论哪种情况，缩进都将被忽略。
• 使用''或者""将含有特殊符号的字符串包裹起来使用，不与格式要求的特殊符号发生语法冲突；单引号和双引号之间的区别在于，在双引号中可以使用转义符\0,\t,\n等
• "{{ variable }}"以此格式表示变量，为与字典进行区分所以是双括号+引号