ansible进阶

发表于 | 阅读次数:
字数统计: 4.2k | 阅读时长 ≈ 18

YAML语言简介

YAML是一个可读性高的用来表达资料序列的格式。
YAML参考了其他多种语言，包括：XML、C语言、Python以及电子邮件格式RFC2822等。
YAML特性：

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

YAML语法简介

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

List：列表，其所有元素均使用”-“开头
示例：

1
2
3
4
5
# A list of tasty fruits
- Apple
- Orange
- Strawberry
- Mango

Dictionary：字典，通常由多个key与value构成
示例：

1
2
3
4
5
---
# An employee record
name: Example Developer
job: Developer
skill: Elite

也可以将key:value放置于{}中进行表示，用,分割多个key:value
例如：

1
2
3
---
# An employee record
{name: Example Developer, job: Developer, skill: Elite}

YAML的语法和其他高阶语言类似，并且可以简单的表达清单、散列表、标量等数据结构。其结构（Structure）通过空格来展示，序列(Sequence)里的项用”-“来代表，Map里的键值对用”:”分割
示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
name: John Smith
age: 41
gender: Male
spouse:
  - name: Jane Smith
    age: 37
    gender: Female
children:
  - name: Jimmy Smith
    age: 17
    gender: Male
  - name: Jenny Smith
    age 13
    gender: Female

playbook

playbook核心元素

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

playbook基础组件

hosts

1
2
3
4
5
6
7
8
9
10
11
Hosts：
	playbook中的每一个play的目的都是为了让特定主机以某个指定的用户身份执行任务。hosts用于指定要执行指定任务的主机，须事先定义在主机清单中
	可以是如下形式：
		one.example.com
		one.example.com:two.example.com
		192.168.1.50
		192.168.1.*
	Websrvs:dbsrvs 或者，两个组的并集
	Websrvs:&dbsrvs 与，两个组的交集
	webservers:!phoenix 在websrvs组，但不在dbsrvs组
 		示例: - hosts: websrvs：dbsrvs

remote_user

1
2
3
4
5
6
7
8
9
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
    sudo_user:wang # sudo为wang

task列表和action

1
2
3
play的主体部分是task list。task list中的各任务按次序逐个在hosts中指定的所有主机上执行，即在所有主机上完成第一个任务后，再开始第二个任务
task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致
每个task都应该有其name，用于playbook的执行结果输出，建议其内容能清晰地描述任务执行步骤。如果未提供name，则action的结果将用于输出

tasks：任务列表

1
2
3
4
5
6
7
8
9
10
两种格式：
	(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

是某些返回值不为0的任务不报错的方法
方法一：

1
2
3
tasks:
  - name: run this command and ignore the result
    shell: /usr/bin/somecommand || /bin/true

方法二：

1
2
3
4
tasks:
  - name: run this command and ignore the result
    shell: /usr/bin/somecommand
    ignore_errors: True

运行playbook

运行playbook的方式

1
ansible-playbook filename.yml ... [options]

常见option

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

示例

1
2
3
ansible-playbook file.yml --check 只检测
ansible-playbook file.yml
ansible-playbook file.yml --limit websrvs

handlers和notify结合使用触发条件

1
2
3
4
Handlers
	是task列表，这些task与前述的task并没有本质上的不同,用于当关注的资源发生变化时，才会采取一定的操作
Notify此action可用于在每个play的最后被触发，这样可避免多次有改变发生时每次都执行指定的操作，仅在所有的变化发生完成后一次性地执行指定操作。
在notify中列出的操作称为handler，也即notify中调用handler中定义的操作

在playbook中使用标签

Ansible 允许给playbook里面的资源通过自定义的关键字打上标签，然后只运行与关键字一致的部分代码
多个动作可以使用同一个标签
只执行特定tags

1
ansible-playbook -t tags file.yml

使用示例：playbook实现安装配置运行httpd服务，并且当配置发生更改时重启服务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
[root@ansible ~/playbook]#cat httpd_install.yml 
---
- hosts: appsrvs
  remote_user: root
  
  tasks:
    - name: groupadd
      group: name=apache gid=80 system=yes
    - name: useradd
      user: name=apache uid=80 group=apache comment=apache 
            shell=/sbin/nologin system=yes home=/usr/share/apache
            password='$1$Z6yqJ4Ea$Ti0QkIPmPWwaFrWbkPwzy1'
    - name: install app
      tags: install
      yum: name=httpd
    - name: conf
      copy: src=/root/httpd.conf dest=/etc/httpd/conf/httpd.conf 
            backup=yes
      tags: config
      notify: 
        - restart
        - check httpd
    - name: service
      tags: service
      service: name=httpd state=started enabled=yes
  handlers:
    - name: restart
      service: name=httpd state=restarted
    - name: check httpd
      shell: /usr/bin/killall -0 httpd &> /tmp/httpd.log

playbook中的变量

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

变量来源

1
2
3
4
5
6
7
8
9
10
11
12
1、ansible setup facts远程主机的所有变量都可直接调用
2、在/etc/ansible/hosts中定义
  普通变量：主机组中主机单独定义，优先级个哦与公共变量
  公共（组）变量：针对主机组中所有主机定义同一变量
3、通过命令行指定变量，优先级最高
  ansible-playbook -e varname=balue
4、在playbook中定义变量
  vars:
    - var1: value1
    - var2: value2
5、在独立的变量YAML文件中定义
6、在role中定义

变量的生效顺序：

变量使用

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

变量使用示例

使用ansible命令定义变量
在playbook中调用变量

1
2
3
4
5
6
7
8
9
10
[root@ansible ~]#cat /root/playbook/vars_test.yml 
---
- hosts: appsrvs
  remote_user: root
  
  tasks:
    - name: install app
      yum: name={{ app_name }}
    - name: start app
      service: name={{ app_name }} state=started

在执行playbook时定义给变量赋值

1
[root@ansible ~]#ansible-playbook /root/playbook/vars_test.yml -e app_name=vsftpd

在playbook中直接定义变量，并调用变量

1
2
3
4
5
6
7
8
9
10
11
12
[root@ansible ~/playbook]#cat vars_test.yml 
---
- hosts: appsrvs
  remote_user: root
  vars:
    - name1: samba
    - name2: smbd
  tasks:
    - name: install app
      yum: name={{ name1 }} 
    - name: start app
      service: name={{ name2 }} state=started

使用专门的文件存放变量
将变量存放在专门的文件中

1
2
3
[root@ansible ~/playbook]#cat vars.yml 
name1: samba
nsme2: smbd

在playbook中调用存放变量的文件

1
2
3
4
5
6
7
8
9
10
11
[root@ansible ~/playbook]#cat vars_test.yml 
---
- hosts: appsrvs
  remote_user: root
  vars_files:
    - vars.yml
  tasks:
    - name: install app
      yum: name={{ name1 }} 
    - name: start app
      service: name={{ name2 }} state=started

在主机清单中定义变量

1
2
3
4
5
6
7
[root@ansible ~/playbook]#cat /etc/ansible/hosts
[appsrvs]
192.168.34.106 nodename=centos7_1
192.168.34.101 nodename=centod7_2 #主机变量

[appsrvs:vars] #组变量
suffix=msq

在playbook中调用变量

1
2
3
4
5
6
7
8
[root@ansible ~]#cat /root/playbook/changename.yml 
---
- hosts: appsrvs
  remote_user: root

  tasks:
    - name: changename
      hostname: name={{ nodename }}.{{ suffix }}

模板templates

1
2
3
4
5
6
7
8
9
10
11
12
文本文件，嵌套有脚本（使用模板编程语言编写）
Jinja2语言，使用字面量，有下面形式
  字符串：使用单引号或双引号
  数字：整数，浮点数
  列表：[item1, item2, ...]
  元组：(item1, item2, ...)
  字典：{key1:value1, key2:value2, ...}
  布尔型：true/false
算术运算：+, -, *, /, //(整除；与取模正好相反), %, **
比较操作：==, !=, >, >=, <, <=
逻辑运算：and, or, not
流表达式：For If When
1
2
3
4
5
6
7
templates功能：根据模块文件动态生成对应的配置文件
  templates文件必须存放于templates目录下，且命名为 .j2 结尾
  yaml/yml 文件需和templates目录平级，目录结构如下：
    ./
    ├── temnginx.yml
    └── templates
        └── nginx.conf.j2

模板使用示例
以安装nginx为例
模板文件必须放在templates文件夹下，templates文件夹与调用该模板的playbook需要是平级的关系。
将NGINX配置文件作为模板放入templates中

1
[root@ansible ~]#cp /etc/nginx/nginx.conf /root/playbook/templates/nginc.conf.j2

在playbook中使用模板

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[root@ansible ~/playbook]#cat nginx_install.yml 
- hosts: appsrvs
  remote_user: root

  tasks:
    - name: install
      yum: name=nginx
    - name: template
      template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
      notify: restart
    - name: service
      service: name=nginx state=started
  handlers:
    - name: restart
      service: name=nginx state=restarted

此时的目录结构如下

1
2
3
4
5
[root@ansible ~/playbook]#tree
.
├── nginx_install.yml
├── templates
│   └── nginx.conf.j2

此例即为使用模板批量配置多台主机，模板文件中可以使用变量。

plabook中的template for if语句的用法示例

变量示例
写一个测试用playbook

1
2
3
4
5
6
7
8
9
10
11
12
[root@ansible ~/playbook]#cat for_test3.yml 
---
- hosts: appsrvs
  remote_user: root
  vars:
    ports:
      - 81
      - 82
      - 83
  tasks:
    - name: template
      template: src=test_for3.conf.j2 dest=/data/test_for3.conf

增加一个对应的模板文件

1
2
3
4
5
6
[root@ansible ~/playbook]#cat templates/test_for3.conf.j2 
{% for i in ports %}
server {
  listen {{i}}
}
{% endfor %}

执行该playbook

1
[root@ansible ~/playbook]#ansible-playbook  for_test3.yml

查看效果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[root@ansible ~/playbook]#ansible appsrvs -a 'cat /data/test_for3.conf'
192.168.34.106 | CHANGED | rc=0 >>
server {
  listen 81
}
server {
  listen 82
}
server {
  listen 83
}

192.168.34.101 | CHANGED | rc=0 >>
server {
  listen 81
}
server {
  listen 82
}
server {
  listen 83
}

字典示例
写一个测试用paybook

1
2
3
4
5
6
7
8
9
10
11
12
[root@ansible ~/playbook]#cat for_test2.yml 
---
- hosts: appsrvs
  remote_user: root
  vars:
    ports:
      - listen_port: 81
      - listen_port: 82
      - listen_port: 83
  tasks:
    - name: template
      template: src=test_for2.conf.j2 dest=/data/test_for2.conf

增加一个对应的模板文件

1
2
3
4
5
6
7
      template: src=test_for2.conf.j2 dest=/data/test_for2.conf
[root@ansible ~/playbook]#cat templates/test_for2.conf.j2 
{% for i in ports %}
server {
  listen {{i.listen_port}}
}
{% endfor %}

执行该playbook

1
[root@ansible ~/playbook]#ansible-playbook  for_test2.yml

到客户端查看执行效果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[root@ansible ~/playbook]#ansible appsrvs -a 'cat /data/test_for2.conf'
192.168.34.106 | CHANGED | rc=0 >>
server {
  listen 81
}
server {
  listen 82
}
server {
  listen 83
}

192.168.34.101 | CHANGED | rc=0 >>
server {
  listen 81
}
server {
  listen 82
}
server {
  listen 83
}

列表示例
写一个测试用playbook

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[root@ansible ~/playbook]#cat for_test.yml 
---
- hosts: appsrvs
  remote_user: root
  vars:
    vhosts:
      - host1:
        listen_port: 81
        host_name: www.a.com
        dirname: /data/www1
      - host2:
        listen_port: 82
        #host_name: www.b.com
        dirname: /data/www2
      - host3:
        listen_port: 83
        host_name: www.c.com
        dirname: /data/www3
  
  tasks:
    - name: template
      template: src=test_for.conf.j2 dest=/data/test_for.conf

增加一个模板

1
2
3
4
5
6
7
8
9
10
11
[root@ansible ~/playbook]#cat templates/test_for.conf.j2 

{% for p in ports %} 
 server{
        listen {{p.listen_port}}
{% if p.host_name is defined %}
        server_name {{p.hostname}}
{% endif %}
        dirname {{p.dirname}}
}
{% endfor %}

执行playbook

1
[root@ansible ~/playbook]#ansible-playbook for_test.yml

取被控端主机检查执行效果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
[root@ansible ~/playbook]#ansible appsrvs -a 'cat /data/tes*'
192.168.34.106 | CHANGED | rc=0 >>

 
server {
  listen 81
  host_name www.a.com
  dirname /data/www1
}
 
server {
  listen 82
  #host_name www.b.com
  dirname /data/www2
}
 
server {
  listen 83
  host_name www.c.com
  dirname /data/www3
}

192.168.34.101 | CHANGED | rc=0 >>

 
server {
  listen 81
  host_name www.a.com
  dirname /data/www1
}
 
server {
  listen 82
  #host_name www.b.com
  dirname /data/www2
}
 
server {
  listen 83
  host_name www.c.com
  dirname /data/www3
}

在playbook中使用when判断

1
2
3
条件测试：如果需要根据变量、facts或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试，通过when语句实现，在task中使用，jinja2的语法格式
when语句
  在task后添加when子语句即可使用条件测试；when语句支持jinja2表达式语法

when条件测试使用示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[root@ansible ~/playbook]#cat nginx_install.yml 
- hosts: websrvs
  remote_user: root

  tasks:
    - name: install
      yum: name=nginx
    - name: template
      template: src=nginx6.conf.j2 dest=/etc/nginx/nginx.conf
      notify: restart
      when: ansible_distribution_major_version=="6"
    - name: template
      template: src=nginx7.conf.j2 dest=/etc/nginx/nginx.conf
      when: ansible_distribution_major_version=="7"
      notify: restart
    - name: service
      service: name=nginx state=started
  handlers:
    - name: restart
      service: name=nginx state=restarted

在playbook文件夹下的templates文件夹中，存放了nginx6.conf.j2、nginx7.conf.j2两个配置文件。其目录结构如下

1
2
3
4
5
6
[root@ansible ~/playbook]#tree
.
├── nginx_install.yml
├── templates
│   ├── nginx6.conf.j2
│   └── nginx7.conf.j2

playbook中的迭代

with_items：当有需要重复执行的任务时，可以使用迭代机制

1
2
3
4
5
对迭代选项的引用，固定变量名为"item"
要在task中使用with_items给定要迭代的元素列表
列表格式：
  字符串
  字典

with_items使用示例
字符串

1
2
3
4
5
6
7
8
9
10
11
[root@ansible ~/playbook]#cat with_items.yml 
---
- hosts: websrvs
  remote_user: root

  tasks:
    - name: useradd
      user: name={{ item }}
      with_items:
        - testuser1
        - testuser2

字典

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[root@ansible ~/playbook]#cat with_items.yml 
---
- hosts: websrvs
  remote_user: root

  tasks:
    - name: groupadd
      group: name={{item}}
      with_items:
        - g1
        - g2
    - name: useradd
      user: name={{ item.name }} group={{ item.group }}
      with_items:
        - {name: 'user1',group: 'g1'}
        - {name: 'user2',group: 'g2'}

roles

ansible自1.2版本引入的新特性，用于层次性、结构化地组织playbook。roles能够根据层次型结构自动装载变量文件、tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。简单来讲，roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中，并可以便捷地include它们的一种机制。角色一般用于基于主机构建服务的场景中，但也可以是用于构建守护进程等场景中

复杂场景：建议使用roles，代码复用度高

1
2
3
变更指定主机或主机组
如命名不规范维护和传承成本太大
某些功能需要多个playbook，通过includes即可实现

roles的文件结构
需要执行的yml文件和roles文件夹是同级的关系，在roles问价下有实现各种不同功能的子目录如httpd等，在httpd下又有子目录如tasks、files、vars等目录。如下所示

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
[root@ansible ~/playbook]#tree
.
├── httpd_install.yml
├── nginx_install.yml
├── ping.yml
├── roles
│   ├── httpd
│   │   ├── files
│   │   ├── handlers
│   │   ├── tasks
│   │   ├── templates
│   │   └── vars
│   ├── memcached
│   │   ├── files
│   │   ├── handlers
│   │   ├── tasks
│   │   ├── templates
│   │   └── vars
│   ├── mysql
│   │   ├── files
│   │   ├── handlers
│   │   ├── tasks
│   │   ├── templates
│   │   └── vars
│   └── nginx
│       ├── files
│       ├── handlers
│       ├── tasks
│       ├── templates
│       └── vars

示例：用角色的方式实现httpd的安装

将各个task分别写成文件放入tasks文件夹下，将模板文件放到files文件夹下，tasks文件夹中的main.yml文件内写入各个task的执行次序

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[root@ansible httpd]#tree
.
├── files
│   └── httpd.conf
├── handlers
├── tasks
│   ├── config.yml
│   ├── group.yml
│   ├── install.yml
│   ├── main.yml
│   ├── service.yml
│   └── user.yml
├── templates
└── vars
1
2
3
4
5
6
root@ansible httpd]#cat tasks/main.yml 
- include: group.yml
- include: user.yml
- include: install.yml
- include: config.yml
- include: service.yml

在与roles同级别目录下写一个playbook，调用该role

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[root@ansible playbook]#tree
.
├── httpd_role.yml
├── roles
│   ├── httpd
│   │   ├── files
│   │   │   └── httpd.conf
│   │   ├── handlers
│   │   ├── tasks
│   │   │   ├── config.yml
│   │   │   ├── group.yml
│   │   │   ├── install.yml
│   │   │   ├── main.yml
│   │   │   ├── service.yml
│   │   │   └── user.yml
│   │   ├── templates
│   │   └── vars
1
2
3
4
5
6
7
[root@ansible playbook]#cat httpd_role.yml 
---
- hosts: appsrvs
  remote_user: root
  
  roles:
    - role: httpd

示例：用角色的方式定制memcached的缓存大小

1
2


roles之间的相互调用

以安装NGINX为例示范roles之间的相互调用

文件结构如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[root@ansible nginx]#pwd
/root/playbook/roles/nginx
[root@ansible nginx]#tree
.
├── files
├── handlers
│   └── main.yml
├── tasks
│   ├── config.yml
│   ├── data.yml
│   ├── install.yml
│   ├── main.yml
│   └── service.yml
├── templates
│   └── nginx.conf.j2
└── vars

其中data.yml文件调用httpd角色中的文件

1
2
3
[root@ansible nginx]#cat tasks/data.yml 
- name: copy
  copy: src=roles/httpd/files/index.html dest=/usr/share/nginx/html/index.html

在config.yml中使用notify-handler组合

1
2
3
4
[root@ansible nginx]#cat tasks/config.yml 
- name: config file
  template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
  notify: restart
1
2
3
[root@ansible nginx]#cat handlers/main.yml 
- name: restart
  service: name=nginx state=restarted

注意 ：handlers文件夹下必须以main.yml为文件名，不然会报错，因为找不到执行handler的入口

分享到： 收藏夹 复制网址 邮件 微信 QQ空间 腾讯微博 豆瓣 一键分享 更多