天天看點

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,如需轉載請自行聯系原作者