天天看点

ansible小技巧

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

ansible-doc的使用

<code>localhost</code><code># ansible-doc -h</code>

<code>Usage: ansible-doc [options] [module...]</code>

<code>Options:</code>

<code>  </code><code>-h, --help            show this help message and </code><code>exit</code>

<code>  </code><code>-l, --list            List available modules</code>

<code>  </code><code>-M MODULE_PATH, --module-path=MODULE_PATH</code>

<code>                        </code><code>specify path(s) to module library (default=None)</code>

<code>  </code><code>-s, --snippet         Show playbook snippet </code><code>for</code> <code>specified module(s)</code>

<code>  </code><code>-</code><code>v</code><code>, --verbose         verbose mode (-vvv </code><code>for</code> <code>more</code><code>, -vvvv to </code><code>enable</code>

<code>                        </code><code>connection debugging)</code>

<code>  </code><code>--version             show program's version number and </code><code>exit</code>

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

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

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

2.学会使用roles

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

<a href="http://s5.51cto.com/wyfs02/M02/86/D0/wKioL1fL5rfzP3eWAAAkfDaFpiI766.png-wh_500x0-wm_3-wmp_4-s_466107824.png" target="_blank"></a>

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

<code>root@localhost:</code><code>/home/xujpxm/ansible/vspc_snmp</code><code># cat sysctlconf.yml </code>

<code># This playbook is used to replace sysctl.conf file </code>

<code>- name: copy sysctlconf to vspc servers</code>

<code>  </code><code>hosts: TestGroup</code>

<code>  </code><code>remote_user: root</code>

<code>  </code><code>gather_facts: no</code>

<code>  </code><code>roles:</code>

<code>    </code><code>- sysctlconf</code>

3.Host Inventory的写法

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

<code>[TestGroup]</code>

<code>'测试1:192.168.1.1'</code>    <code>ansible_host=192.168.1.1</code>

<code>'测试2:192.168.1.2'</code>    <code>ansible_host=192.168.1.2</code>

<code>'测试3:192.168.1.3'</code>    <code>ansible_host=192.168.1.3</code>

<code>'运维1:192.168.1.4'</code>    <code>ansible_host=192.168.1.4</code>

<code>'运维1:192.168.1.5'</code>    <code>ansible_host=192.168.1.5 </code>

<code>'运维1:192.168.1.6'</code>    <code>ansible_host=192.168.1.6</code>

<code>'研发1:192.168.1.7'</code>    <code>ansible_host=192.168.1.7 </code>

<code>'研发1:192.168.1.8'</code>    <code>ansible_host=192.168.1.8</code>

<code>'研发1:192.168.1.9'</code>    <code>ansible_host=192.168.1.9</code>

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

<a href="http://docs.ansible.com/ansible/intro_inventory.html" target="_blank">http://docs.ansible.com/ansible/intro_inventory.html</a>

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”即可,如下:

<code> </code><code>--- </code>

<code> </code><code>- hosts: 192.168.1.10</code>

<code>   </code><code>gather_facts: no </code>

<code>   </code><code>remote_user: xujpxm</code>

<code>   </code><code>sudo</code><code>: </code><code>yes</code> 

<code>   </code><code>roles: </code>

<code>     </code><code>- {role: profile_test}</code>

6.delegate_to:任务委派

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

<code> </code><code>- name: run </code><code>'ls'</code> <code>command</code> <code>on host 10</code>

<code>   </code><code>shell: </code><code>ls</code>

<code>   </code><code>delegate_to: 192.168.1.10</code>

7.循环:with_items

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

添加多个用户:

<code>- name: add several </code><code>users</code>

<code>  </code><code>user: name={{ item }} state=present </code><code>groups</code><code>=wheel</code>

<code>  </code><code>with_items:</code>

<code>     </code><code>- testuser1</code>

<code>     </code><code>- testuser2</code>

8.条件判断:when

比如判断操作系统类型:

<code>tasks:</code>

<code>  </code><code>- name: </code><code>"shut down Debian flavored systems"</code>

<code>    </code><code>command</code><code>: </code><code>/sbin/shutdown</code> <code>-t now</code>

<code>    </code><code>when: ansible_os_family == </code><code>"Debian"</code>

<code>    </code><code># note that Ansible facts and vars like ansible_os_family can be used</code>

<code>    </code><code># directly in conditionals without double curly braces</code>

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

9.ansible-lint

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

安装:

<code>$ pip </code><code>install</code> <code>ansible-lint</code>

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

<code>$ ansible-lint setup_galera_cluster.yml</code>

<code>Syntax Error </code><code>while</code> <code>loading YAML.</code>

<code>The error appears to have been </code><code>in</code> <code>'/Users/junxian/script/ansible/ubuntu_galera_cluster/roles/galera_cluster_install/tasks/secure.yml'</code><code>: line 24, column 2, but may</code>

<code>be elsewhere </code><code>in</code> <code>the </code><code>file</code> <code>depending on the exact syntax problem.</code>

<code>The offending line appears to be:</code>

<code>- name: change password </code><code>for</code> <code>mysql root user</code>

<code> </code><code>mysql_user:</code>

<code> </code><code>^ here</code>

      本文转自Jx战壕  51CTO博客,原文链接:http://blog.51cto.com/xujpxm/1846163,如需转载请自行联系原作者