使用ansible有段时间了,写几个ansible进阶的小技巧。

  1. ansible-doc的使用

1
2
3
4
5
6
7
8
9
10
11
12
localhost# ansible-doc -h
Usage: ansible-doc [options] [module...]
 
Options:
  -h, --help            show this help message and exit
  -l, --list            List available modules
  -M MODULE_PATH, --module-path=MODULE_PATH
                        specify path(s) to module library (default=None)
  -s, --snippet         Show playbook snippet for specified module(s)
  -v, --verbose         verbose mode (-vvv for more, -vvvv to enable
                        connection debugging)
  --version             show program's version number and exit

ansible-doc -l 列出所有ansible的模板;

ansible-doc +模块名称 查看ansible模块的用法,例如:

ansible-doc template  #查看template模块的用法

2.学会使用roles

我的习惯性写法,无论定义多小的playbook都会创建这几个文件夹:roles,common,+自定义的role;然后再在每个role下面写ymal文件。格式如下,也推荐大家使用这种排版。

wKioL1fL5rfzP3eWAAAkfDaFpiI766.png-wh_50

roles可以实现“代码复用”。只是把任务给分离出去了。只要在playbook文件中调用此role就可执行这些任务,常用的task一般放到common下。例如下面的playbook:

1
2
3
4
5
6
7
8
9
10
root@localhost:/home/xujpxm/ansible/vspc_snmp# cat sysctlconf.yml 
# This playbook is used to replace sysctl.conf file 
 
- name: copy sysctlconf to vspc servers
  hosts: TestGroup
  remote_user: root
  gather_facts: no
 
  roles:
    - sysctlconf

3.Host Inventory的写法

host文件有好多种写法,比如可以定义组,定义远程主机的ssh端口号。这里说下,自定义远程主机的hostname。管理的主机多了之后,主机的ip地址比较难于记忆,可以在自定义hostname方便查看playbook的输出结果,格式类似如下,第一列是自定制的hostname,第二列是对应的实际IP地址:

1
2
3
4
5
6
7
8
9
10
[TestGroup]
'测试1:192.168.1.1'    ansible_host=192.168.1.1
'测试2:192.168.1.2'    ansible_host=192.168.1.2
'测试3:192.168.1.3'    ansible_host=192.168.1.3
'运维1:192.168.1.4'    ansible_host=192.168.1.4
'运维1:192.168.1.5'    ansible_host=192.168.1.5 
'运维1:192.168.1.6'    ansible_host=192.168.1.6
'研发1:192.168.1.7'    ansible_host=192.168.1.7 
'研发1:192.168.1.8'    ansible_host=192.168.1.8
'研发1:192.168.1.9'    ansible_host=192.168.1.9

更多格式请查看官方文档:

http://docs.ansible.com/ansible/intro_inventory.html

4.查看整个任务执行时间

编辑ansible的配置文件(ansible.cfg)

开启 callback_whitelist = timer

ansible-playbook +yml文件 执行之后会返回类似如下信息:

Playbook run took 0 days, 0 hours, 0 minutes, 6 seconds

5.关闭 gathering facts

ansible默认是开启gathering facts的,如果你不需要获取被控机器的 fact 数据的话,你可以关闭获取 fact 数据功能。关闭之后,可以加快 ansible-playbook 的执行效率,尤其是你管理很大量的机器时,这非常明显。关闭获取 facts 很简单,只需要在 playbook 文件中加上“gather_facts: no”即可,如下:

1
2
3
4
5
6
7
 --- 
 - hosts: 192.168.1.10
   gather_facts: no 
   remote_user: xujpxm
   sudoyes 
   roles: 
     - {role: profile_test}

6.delegate_to:任务委派

在对一组服务器的执行操作过程中,需要在其中一台机器上执行一个操作,这个操作可以写在一个playbook中,就需要用到ansible的任务委派功能(delegate_to)。使用 delegate_to 关键字可以委派任务到指定的机器上运行。EG:

1
2
3
 - name: run 'ls' command on host 10
   shell: ls
   delegate_to: 192.168.1.10

7.循环:with_items

为了保持简洁,重复的任务可以用以下简写的方式:

添加多个用户:

1
2
3
4
5
- name: add several users
  user: name={{ item }} state=present groups=wheel
  with_items:
     - testuser1
     - testuser2

8.条件判断:when

比如判断操作系统类型:

1
2
3
4
5
6
tasks:
  - name: "shut down Debian flavored systems"
    command/sbin/shutdown -t now
    when: ansible_os_family == "Debian"
    # note that Ansible facts and vars like ansible_os_family can be used
    # directly in conditionals without double curly braces

这里引用ansible_os_family需要注意一点是,ansible开启gather_facts参数,默认是开启的。

9.ansible-lint

ansible-lint是对playbook的语法进行检查的一个工具。用法是ansible-lint playbook.yml 

安装:

1
$ pip install ansible-lint

用法示例,监测语法错误:

1
2
3
4
5
6
7
8
9
10
11
12
$ ansible-lint setup_galera_cluster.yml
Syntax Error while loading YAML.
 
 
The error appears to have been in '/Users/junxian/script/ansible/ubuntu_galera_cluster/roles/galera_cluster_install/tasks/secure.yml': line 24, column 2, but may
be elsewhere in the file depending on the exact syntax problem.
 
The offending line appears to be:
 
- name: change password for mysql root user
 mysql_user:
 ^ here