Ansible的高级用法playbook


Ansible入门

playbook工作过程

Ansible的高级用法playbook

YAML特性

?? YAML的可读性好
?? YAML和脚本语言的交互性好
?? YAML使用实现语言的数据类型
?? YAML有一个一致的信息模型
?? YAML易于实现
?? YAML可以基于流来处理
?? YAML表达能力强,扩展性好

YAML语法简介

??1. 在单一档案中,可用连续三个连字号(——)区分多个档案。另外,还有选择性的连续三个点号( ... )用来表示档案结尾
??2. 次行开始正常写Playbook的内容,一般建议写明该Playbook的功能
??3. 使用#号注释代码
??4. 缩进必须是统一的,不能空格和tab混用
??5. 缩进的级别也必须是一致的,同样的缩进代表同样的级别,程序判别配置的级别是通过缩进结合换行来实现的
??6. YAML文件内容是区别大小写的,k/v的值均需大小写敏感
??7. 多个k/v可同行写也可换行写,同行使用,分隔
??8. v可是个字符串,也可是另一个列表
??9. 一个完整的代码块功能需最少元素需包括 name 和 task
??10. 一个name只能包括一个task
??11. YAML文件扩展名通常为yml或yaml

YAML语法简介

List:列表,其所有元素均使用“-” 打头

示例:
    # A list of tasty fruits
    - Apple
    - Orange
    - Strawberry
    - Mango

Dictionary:字典,通常由多个key与value构成

示例:
    ---
    # An employee record
    name: Example Developer
    job: Developer
    skill: Elite

    也可以将key:value放置于{}中进行表示,用","分隔多个key:value

示例:
    ---
    # An employee record
    {name: Example Developer,job: Developer,skill: Elite}

Playbook核心元素

??1. Hosts 执行的远程主机列表
??2. Tasks 任务集
??3. Varniables 内置变量或自定义变量在playbook中调用
??4. Templates 模板,可替换模板文件中的变量并实现一些简单逻辑的文件
??5. Handlers 和 notity 结合使用,由特定条件触发的操作,满足条件方才执行,否则不执行
??6. tags 标签 指定某条任务执行,用于选择运行playbook中的部分代码。 ansible具有幂等性,因此会自动跳过没有变化的部分,即便如此,有些代码为测试其确实没有发生变化的时间依然会非常地长。此时,如果确信其没有变化,就可以通过tags跳过此些代码片断
????ansible-playbook –t tagsname useradd.yml

Playbook基础组件

Hosts

??playbook中的每一个play的目的都是为了让特定主机以某个指定的用户身份执行任务。 hosts用于指定要执行指定任务的主机,须事先定义在主机清单中
??可以标明指定主机IP地址,也可写主机清单组名,或者使用逻辑与、逻辑或等表示特定的主机

remote_user

??可用于Host和task中。也可以通过指定其通过sudo的方式在远程主机上执行任务,其可用于play全局或某任务;此外,甚至可以在sudo时使用sudo_user指定sudo时切换的用户

示例:
    - hosts: websrvs
      remote_user: root
      tasks:
        - name: test connection
          ping: 
          remote_user: magedu
          sudo: yes            # 默认sudo为root
          duso_user: wang       # sudo为wang

task列表和action

??play的主体部分是task list,task list中的各任务按次序逐个在hosts中指定的所有主机上执行,即在所有主机上完成第一个任务后,再开始第二个任务
??task的目的是使用指定的参数执行???,而在??椴问锌梢允褂帽淞?。??橹葱惺敲莸鹊?,这意味着多次执行是安全的,因为其结果均一致
??每个task都应该有其name,用于playbook的执行结果输出,建议其内容能
清晰地描述任务执行步骤。如果未提供name,则action的结果将用于输出

tasks:任务列表

??两种格式
????(1) action: module arguments
????(2) module: arguments 建议使用
???注意:shell和command??楹竺娓?,而非key=value
??某任务的状态在运行后为changed时,可通过“notify” 通知给相应的handlers
??任务可以通过"tags“打标签,可在ansible-playbook命令上使用-t指定进行调用

示例:
    tasks:
      - name: disable selinux
        command: /sbin/setenforce 0

??如果命令或脚本的退出码部位零,可以使用如下方式进行替换

示例:
    tasks:
      - name: run this command and ignore the result
        shell: /usr/bin/somecommand || /bin/true

??或者使用ignore_errors来忽略错误信息

示例:
    tasks:
      - name: run this command and ignore the result
        shell: /usr/bin/somecommand
        ignore_errors: True

运行Playbook

playbook的运行方式

    ansible-playbook <filename.yml> ... [options]

常见选项

??--check -C 只检测可能会发生的改变,但不真正执行操作
??--list-hosts 列出运行任务的主机
??--list-tags 列出tag
??--list-tasks 列出task
??--limit 主机列表 只针对主机列表中的主机执行
??-v -vv -vvv 显示过程

Playbook VS ShellScripts

SHELL脚本安装Apache并启动

#!/bin/bash
# 安装Apache
yum install --quiet -y httpd
# 复制配置文件
cp /tmp/httpd.conf /etc/httpd/conf/httpd.conf
cp/tmp/vhosts.conf /etc/httpd/conf.d/
# 启动Apache,并设置开机启动
service httpd start
chkconfig httpd on

Playbook定义安装并启动Apache

---
- hosts: all
tasks:
- name: "安装Apache"
yum: name=httpd
- name: "复制配置文件"
copy: src=/tmp/httpd.conf dest=/etc/httpd/conf/
- name: "复制配置文件"
copy: src=/tmp/vhosts.conf dest=/etc/httpd/conf.cd/
- name: "启动Apache,并设置开机启动"
service: name=httpd state=started enabled=yes

handlers和notify结合使用触发条件

Handlers

??是task列表,这些task与前述的task并没有本质上的不同,用于当关注的资源发生变化时,才会采取一定的操作

Notify

??此action可用于在每个play的最后被触发,这样可避免多次有改变发生时每次都执行指定的操作,仅在所有的变化发生完成后一次性地执行指定操作。

??在notify中列出的操作称为handler,也即notify中调用handler中定义的操作

Playbook中handlers使用

示例:
- hosts: websrvs
  remote_user: root
  tasks:
    - name: Install httpd
      yum: name=httpd state=present
    - name: Install configure file
      copy: src=files/httpd.conf dest=/etc/httpd/conf/
      notify: restart httpd
    - name: ensure apache is running
      service: name=httpd state=started enabled=yes
  handlers:
    - name: restart httpd
      service: name=httpd status=restarted

Playbook中tags使用

示例:httpd.yml
- hosts: websrvs
  remote_user: root
  tasks:
    - name: Install httpd
      yum: name=httpd state=present
    - name: Install configure file
      copy: src=files/httpd.conf dest=/etc/httpd/conf/
      tags: conf
    - name: start httpd service
      tags: service
      service: name=httpd state=started enabled=yes

[root@Ansible ~]# ansible-playbook –t conf httpd.yml

Playbook中变量的使用

变量命令

??变量名仅能由字母、数字和下划线组成,且只能以字母开头

变量调用方法

??1. 通过{{ variable_name }} 调用变量,且变量名前后必须有空格,有时用"{{ variable_name }}"才生效
??2. ansible-playbook –e 选项指定
???ansible-playbook test.yml -e "hosts=www user=magedu"

[root@Ansible ~]#ansible 192.168.36.37 -m setup | grep ansible_fqdn
        "ansible_fqdn": "test.magedu.com",
示例:var.yml
- hosts: srvs
  remote_user: root

  tasks:
    - name: create log file
      file: name=/var/log/{{ansible_fqdn}} state=touch

[root@Ansible ~]#ansible-playbook var.yml   # 执行yml脚本

[root@Ansible ~]#ansible srvs -a "ls -l /var/log/|grep test*"   # 检查生成
192.168.36.37 | CHANGED | rc=0 >>
-rw-r--r--. 1 root root      0 Apr 25 22:11 test.magedu.com

192.168.36.47 | CHANGED | rc=0 >>
-rw-r--r--. 1 root root      0 Apr 25 22:11 test.magedu.com
自定义变量示例:var.yml

---
- hosts: srvs
  remote_user: root

  tasks:
  - name: install
    yum: name={{pkname}} state=present

[root@Ansible ~]#ansible-playbook -e pkname=lrzsz var.yml

Ansible的高级用法playbook

Ansible的高级用法playbook

YAML文件中定义变量

示例:var.yml
---
- hosts: websrvs
  remote_user: root
  vars:
    - username: user1
    - groupname: group1
  tasks:
    - name: create group
      group: name={{ groupname }} state=present
    - name: create user
      user: name={{ username }} state=present

[root@Ansible ~]#ansible-playbook var.yml

主机变量

??可以在inventory中定义主机时为其添加主机变量以便于在playbook中使用

[websrvs]
192.168.99.101 http_port=8080 hname=www1
192.168.99.102 http_port=80 hname=www2

组变量

??组变量是指赋予给指定组内所有主机上的在playbook中可用的变量

[websrvs]
www1.magedu.com
www2.magedu.com
[websrvs:vars]
ntp_server=ntp.magedu.com
nfs_server=nfs.magedu.com

变量文件定义

cat vars.yml
var1: httpd
var2: nginx
cat var.yml
---
- hosts: web
  remote_user: root
  vars_files:
    - vars.yml

  tasks:
    - name: create httpd log
      file: name=/app/{{ var1 }}.log state=touch
    - name: create nginx log
      file: name=/app/{{ var2 }}.log state=touch

模板template

??文本文件,嵌套有脚本(使用模板编程语言编写)
??Jinja2语言,使用字面量,有下面形式
????字符串:使用单引号或双引号
????数字:整数,浮点数
????列表:[item1, item2, ...]
????元组:(item1, item2, ...)
????字典:{key1:value1, key2:value2, ...}
????布尔型:true/false
??算术运算:+, -, *, /, //, %, **
??比较操作:==, !=, >, >=, <, <=
??逻辑运算:and,or,not
??流表达式:For,If,When

template功能

??根据??槲募啥杂Φ呐渲梦募?
??1. template文件必须存放于templates目录下,且命名为 .j2 结尾
??2. yaml/yml 文件需和templates目录平级,目录结构如下:
???./
????├── temnginx.yml
????└── templates
????????└── nginx.conf.j2

template示例

??利用tempplate同步nginx配置文件

准备templates/nginx.conf.j2文件
vim temnginx.yml
---
- hosts: websrvs
  remote_user: root

  tasks:
    - name: template config to remote hosts
      template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf

[root@Ansible ~]#ansible-playbook temnginx.yml

Playbook中template变更替换

??修改文件nginx.conf.j2 下面行为

worker_processes {{ ansible_processor_vcpus }};
cat temnginx2.yml
---
- hosts: websrvs
  remote_user: root

  tasks:
    - name: template config to remote hosts
      template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf

[root@Ansible ~]#ansible-playbook temnginx2.yml

Playbook中template算数运算

示例:
vim nginx.conf.j2
worker_processes {{ ansible_processor_vcpus**2 }};
worker_processes {{ ansible_processor_vcpus+2 }};

when条件判断

条件测试

??如果需要根据变量、 facts或此前任务的执行结果来做为某task执行与否的前提时要用到条件测试,通过when语句实现,在task中使用,jinja2的语法格式

when语句

??在task后添加when子句即可使用条件测试;when语句支持Jinja2表达式语法

示例

示例一:
tasks:
  - name: install conf file to centos7
    template: src=nginx.conf.c7.j2 dest=/etc/nginx/nginx.conf
    when: ansible_distribution_major_version == "7"
  - name: install conf file to centos6
    template: src=nginx.conf.c6.j2 dest=/etc/nginx/nginx.conf
    when: ansible_distribution_major_version == "6"
示例二:
- hosts: websrvs
  remote_user: root

  tasks:
    - name: add group nginx
      tags: user
      user: name=nginx state=present
    - name: add user nginx
      user: name=nginx state=present group=nginx
    - name: Install Nginx
      yum: name=nginx state=present
    - name: restart Nginx
      service: name=nginx state=restarted
      when: ansible_distribution_major_version == “6”

迭代:with_items

??当有需要重复性执行的任务时,可以使用迭代机制
????☆ 对迭代项的引用,固定变量名为"item"
????☆ 要在task中使用with_items给定要迭代的元素列表
????☆ 列表格式:
??????字符串
??????字典

示例

- name: add several users
  user: name={{ item }} state=present groups=wheel
  with_items:
    - testuser1
    - testuser2

上面语句的功能等同于下面的语句:
- name: add user testuser1
  user: name=testuser1 state=present groups=wheel
- name: add user testuser2
  user: name=testuser2 state=present groups=wheel

迭代嵌套子变量

---
- hosts:websrvs
  remote_user: root

  tasks:
  - name: add some groups
    group: name={{ item }} state=present
    with_items:
      - group1
      - group2
      - group3
  - name: add some users
    user: name={{ item.name }} group={{ item.group }} state=present
    with_items:
      - { name: 'user1', group: 'group1' }
      - { name: 'user2', group: 'group2' }
      - { name: 'user3', group: 'group3' }

Playbook中template for if

{% for vhost in nginx_vhosts %}
server {
listen {{ vhost.listen | default('80 default_server') }};

{% if vhost.server_name is defined %}
server_name {{ vhost.server_name }};
{% endif %}

{% if vhost.root is defined %}
root {{ vhost.root }};
{% endif %}

{% endfor %}

示例:

// temnginx.yml
---
- hosts: mageduweb
  remote_user: root
  vars:
    nginx_vhosts:
      - web1
      - web2
      - web3

    tasks:
      - name: template config
        template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf

// templates/nginx.conf.j2
{% for vhost in nginx_vhosts %}
server {
listen {{ vhost }}
}
{% endfor %}

生成的结果:
server {
listen web1
}
server {
listen web2
}
server {
listen web3
}

Ansible中的roles

关于roles的介绍

??roles能够根据层次型结构自动装在变量文件、tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。简单来讲,roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中,并可以便捷地include它们的一种机制。角色一般用于基于主机构建服务的场景中,但也可以是用于构建守护进程等场景中。
??在某些复杂的场景中建议使用roles,代码复用度高:
????1. 变更指定主机或主机组
????2. 如 命名不规范维护和传承成本大
????3. 某些功能需多个Playbook,通过includes即可实现

Ansible Roles目录编排

Ansible的高级用法playbook

roles目录结构及其作用

??每个角色,以特定的层级目录结构进行组织

roles/project/             # 项目名称,有以下子目录
            tasks/         # 定义task,role的基本元素,至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含
            files/         # 存放由copy或script??榈鹊饔玫奈募?            vars/          # 定义变量,至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含
            templates/     # template??椴檎宜枰0逦募哪柯?            handlers/      # 至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含
            default/       # 设定默认变量时使用此目录中的main.yml文件
            meta/          # 定义当前角色的特殊设定及其依赖关系,至少应该包含一个名为main.yml的文件,其它文件需在此文件中通过include进行包含

创建role的步骤

??(1) 创建以roles命名的目录
??(2) 在roles目录中分别创建以各角色名称命名的目录,如webserver等
??(3) 在每个角色命名的目录中分别创建files、handlers、meta、tasks、templates和vars目录;用不到的目录可以创建为空目录,也可以不创建
??(4) 在playbook文件中,调用各角色

针对nginx项目使用Roles进行编排

示例:
nginx-role.yml
roles/
└── nginx
    ├── files
    │   └── main.yml
    ├── tasks
    │   ├── groupadd.yml
    │   ├── install.yml
    │   ├── main.yml
    │   ├── restart.yml
    │   └── useradd.yml
    └── vars
        └── main.yml

playbook调用角色

调用角色方法1:

- hosts: websrvs
  remote_user: root

  roles:
    - mysql
    - memcached
    - nginx

调用角色方法2:

- hosts:
  remote_user: root

  roles:
    - mysql
    - { role: nginx, username: nginx }
        >-- 键role用于指定角色名称
        >-- 后续的k/v用于传递变量给角色 

###调用角色方法3:还可基于条件测试实现角色调用

roles:
  - { role: nginx, username: nginx, when: ansible_distribution_maior_version == '7' }

示例

创建目录
[root@centos ansible]#mkdir roles/httpd/{files,tasks} -pv
mkdir: created directory ‘roles/httpd’
mkdir: created directory ‘roles/httpd/files’
mkdir: created directory ‘roles/httpd/tasks’
创建任务文件,编辑任务
[root@centos ansible]#touch roles/httpd/tasks/{install.yml,conf.yml,service.yml,main.yml,copy.yml}

[root@centos httpd]#cat tasks/install.yml
- name: install httpd
  yum: name=httpd

[root@centos httpd]#cat tasks/conf.yml
- name: config
  copy: src=httpd.conf dest=/etc/httpd/conf/httpd.conf

[root@centos httpd]#cat tasks/copy.yml
- name: HTML
  copy: src=index.html dest=/var/www/html

[root@centos httpd]#cat tasks/service.yml
- name: service httpd
  service: name=httpd state=started enabled=yes

主yml文件,对yml文件进行顺序执行
[root@centos httpd]#cat tasks/main.yml
- include: install.yml
- include: conf.yml
- include: copy.yml
- include: service.yml
准备需要用到的文件
[root@centos httpd]#echo www.magedu.com > files/index.html
[root@centos httpd]#scp 192.168.36.37:/etc/httpd/conf/httpd.conf files/
httpd.conf                                                           100%   18KB   7.3MB/s   00:00
创建yml文件的主文件,调用之前创建的yml文件
[root@centos httpd]#cat role_httpd.yml
- hosts: srvs
  roles:
    - role: httpd
目录结构树
[root@centos httpd]#tree
.
├── files
│?? ├── httpd.conf
│?? └── index.html
├── role_httpd.yml
└── tasks
    ├── conf.yml
    ├── copy.yml
    ├── install.yml
    ├── main.yml
    └── service.yml

2 directories, 8 files
执行YAML文件,自动部署
[root@centos httpd]#ansible-playbook role_httpd.yml

PLAY [srvs] *******************************************************************************************

TASK [Gathering Facts] ********************************************************************************
ok: [192.168.36.37]
ok: [192.168.36.47]

TASK [httpd : install httpd] **************************************************************************
changed: [192.168.36.47]
changed: [192.168.36.37]

TASK [httpd : config] *********************************************************************************
ok: [192.168.36.37]
ok: [192.168.36.47]

TASK [httpd : HTML] ***********************************************************************************
ok: [192.168.36.37]
ok: [192.168.36.47]

TASK [httpd : service httpd] **************************************************************************
changed: [192.168.36.47]
changed: [192.168.36.37]

PLAY RECAP ********************************************************************************************
192.168.36.37              : ok=5    changed=2    unreachable=0    failed=0
192.168.36.47              : ok=5    changed=2    unreachable=0    failed=0

这里附上一个由Ansible-playbook编写的剧本,欢迎进入指导^_^