首先簡單說明一下playbook,playbook是什么呢?根本上說playbook和shell腳本沒有任何的區別,playbook就像shell一樣,也是把一堆的命令組合起來,然后加入對應條件判斷等等,在shell腳本中是一條一條的命令,而在playbook中是一個一個的task任務構成,每個task任務可以看做shell中的一條命令;shell腳本一般只是在當前服務器上執行,而playbook則是在不止一個服務器上執行,因此playbook需要在其中指定運行該playbook的服務器名。
playbook的語法結構
playbook使用yml標記語言,這是一種標記語言,這種標記語言在文件的最開始需要使用三個“-”來說明文件開始,然后使用縮進來說明代碼塊的范圍。下面通過一個簡易的實例,來說明playbook的語法。【實例來自官方文檔】
--- #標記文件的開始
- hosts: webservers #指定該playbook在哪個服務器上執行
vars: #表示下面是定義的變量,
http_port: 80 #變量的形式,key: value,這里http_port是變量名,80是值
max_clients: 200
remote_user: root #指定遠程的用戶名,這里縮進和vars保持了一致,說明變量的代碼塊已經結束。
tasks: #下面構成playbook的tasks,每個task都有 - name: 開始,name指定該任務的名稱。
- name: ensure apache is at the latest version #指定該任務的名稱。
yum: pkg=httpd state=latest #yum說明要是用的模板名稱,后面指定對應的參數,這兩行結合起來就相當於一個shell命令。
- name: write the apache config file #每個task之間可以使用空行來做區分。
template: src=/srv/httpd.j2 dest=/etc/httpd.conf
#需要說明的是縮進的意義和python中縮進的意義是一樣,是來區分代碼塊的。
一個簡單的實例: 檢查MySQL的運行狀態
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no #不收集對應主機的信息,這樣運行會快點。 tasks: - name: check the mysql stauts service: name=mysqld state=running
運行結果如下:
[root@test2 playbook]# ansible-playbook test.yml PLAY [all] ******************************************************************** TASK: [check the mysql stauts] ************************************************ ok: [10.0.102.200] ok: [10.0.102.162] ok: [10.0.102.212] PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=0 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=0 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=0 unreachable=0 failed=0
ansible-playbook的使用小技巧
限定主機范圍執行
雖然playbook中定義了執行的主機,但是有時候我們可能僅想在定義的主機中的部分機器上執行,這時候怎么辦?修改playbook中的hosts的范圍,但是每次改變主機就修改一次,比較麻煩,我們可以使用--limit參數,指定該playbook在指定的主機上執行。有以下inventory文件,我們想在dbservers上執行上面測試用的playbook內容。
[all] 10.0.102.212 10.0.102.200 10.0.102.162 [dbservers] 10.0.102.162
上面測試的playbook中hosts定義all,我們想僅在dbservers上執行。
[root@test2 playbook]# ansible-playbook test.yml --limit dbservers PLAY [all] ******************************************************************** TASK: [check the mysql stauts] ************************************************ ok: [10.0.102.162] PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=0 unreachable=0 failed=0 [root@test2 playbook]#
查看當前playbook在哪些主機上執行
[root@test2 playbook]# ansible-playbook test.yml --list-hosts playbook: test.yml play #1 (all): host count=3 10.0.102.162 10.0.102.212 10.0.102.200
ansible-playbook的一些其他技巧
- --inventory=path,指定inventory文件,默認是在/etc/ansible/hosts下面。
- --verbose,顯示詳細的輸出,使用-vvvv顯示精確到每分鍾的輸出。
- --extra-vars=vars:定義在playbook使用的變量。
- --forks:指定並發的線程數,默認是5.
- --connection=type:指定遠程連接主機的方式,默認是ssh,設置為local時,則只在本地執行playbook、
- --check:檢測模式,playbook中定義的所有任務將在每台主機上檢測,但是並不執行。
ansibleplaybook中的handlers
在系統中,我們修改了服務器的配置文件,這時候就需要重啟操作服務,就可以使用到handlers。
handlers: #下面定義了兩個handlers - name: restart memcached service: name=memcached state=restarted - name: restart apache service: name=apache state=restarted - name: template configuration file template: src=template.j2 dest=/etc/foo.conf #修改了配置文件然后依次啟動memcached和apache服務。 notify: #使用notify來聲明引用handlers。 - restart memcached - restart apache
在使用handlers時需要注意以下幾點:
- Handlers只有在其所在的任務被執行時,才會被運行;如果一個任務中定義了notify調用Handlers,但是由於條件判斷等原因,該任務未被執行,那么Handlers同樣不會被執行。
- Handlers只會在每一個play的末尾運行一次;如果想在一個playbook中間運行Handlers,則需要使用meta模塊來實現。例如: -meta: flush_handlers.
- 如果一個play在運行到調用Handlers的語句之前失敗了,那么這個Handlers將不會被執行。我們可以使用meta模塊的--force-handlers選項來強制執行Handlers,即使Handlers所在的play中途運行失敗也能執行。
變量
這個變量我們來說明ansible中變量(不包含role中的變量)用法。
playbook中的變量
在運行playbook的時候使用--extra-vars來指定變量
有如下playbook腳本:
--- - hosts: all remote_user: root gather_facts: no tasks: - name: test playbook variables command: echo {{ test_var }} #打印出變量test_var的值。
運行上面的playbook如下:
[root@test2 playbook]# ansible-playbook test.yml --extra-vars "test_var=test" -v #加上-v選項,會顯示詳細的信息 PLAY [all] ******************************************************************** TASK: [test playbook variables] *********************************************** changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "test"], "delta": "0:00:00.006045", "end": "2019-02-15 23:04:49.789452", "rc": 0, "start": "2019-02-15 23:04:49.783407", "stderr": "", "stdout": "test"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "test"], "delta": "0:00:00.005318", "end": "2019-02-15 23:04:52.976471", "rc": 0, "start": "2019-02-15 23:04:52.971153", "stderr": "", "stdout": "test"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "test"], "delta": "0:00:00.005082", "end": "2019-02-15 23:04:52.424959", "rc": 0, "start": "2019-02-15 23:04:52.419877", "stderr": "", "stdout": "test"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=1 unreachable=0 failed=0
上面詳細信息的標准輸出為test,說明變量的值已經傳遞了。
在playbook中使用vars代碼塊定義變量
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no vars: #在這里使用了vars代碼塊來定義變量 test_var: Hello World tasks: - name: test playbook variables command: echo {{ test_var }} [root@test2 playbook]# ansible-playbook test.yml -v PLAY [all] ******************************************************************** TASK: [test playbook variables] *********************************************** changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.004940", "end": "2019-02-15 23:20:06.541672", "rc": 0, "start": "2019-02-15 23:20:06.536732", "stderr": "", "stdout": "Hello World"} changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.004843", "end": "2019-02-15 23:20:03.957950", "rc": 0, "start": "2019-02-15 23:20:03.953107", "stderr": "", "stdout": "Hello World"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.004219", "end": "2019-02-15 23:20:07.166900", "rc": 0, "start": "2019-02-15 23:20:07.162681", "stderr": "", "stdout": "Hello World"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=1 unreachable=0 failed=0 [root@test2 playbook]#
使用獨立的文件來定義playbook變量
首先來看下playbook的內容:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no vars_files: #這里使用了vars_files來引入變量文件 - vars.yml tasks: - name: test playbook variables command: echo {{ test_var }}
變量文件的定義
[root@test2 playbook]# cat vars.yml --- test_var: Hello World
然后,查看執行的結果:
[root@test2 playbook]# ansible-playbook test.yml -v PLAY [all] ******************************************************************** TASK: [test playbook variables] *********************************************** changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.005198", "end": "2019-02-15 23:23:16.397557", "rc": 0, "start": "2019-02-15 23:23:16.392359", "stderr": "", "stdout": "Hello World"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.004359", "end": "2019-02-15 23:23:19.629804", "rc": 0, "start": "2019-02-15 23:23:19.625445", "stderr": "", "stdout": "Hello World"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:01.006185", "end": "2019-02-15 23:23:20.039320", "rc": 0, "start": "2019-02-15 23:23:19.033135", "stderr": "", "stdout": "Hello World"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=1 unreachable=0 failed=0
inventory文件中的變量
在ansible中,inventory文件通常是指ansible的主機和組定義文件hosts。在hosts文件中,變量會被定義在主機名后面或組名的下方。
為特定的主機定義變量,變量名跟在對應主機的后邊。
inventory文件如下:
[root@test2 playbook]# cat /etc/ansible/hosts [all] 10.0.102.212 test_var=212 10.0.102.200 test_var=200 10.0.102.162 test_var=162
#為三個主機定義了同名的變量,但是變量值卻不一樣。
查看playbook的內容如下:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no tasks: - name: test playbook variables command: echo {{ test_var }} [root@test2 playbook]#
執行一下這個playbook,結果如下:【對應的主機顯示了各自對應的變量值】
[root@test2 playbook]# ansible-playbook test.yml -v PLAY [all] ******************************************************************** TASK: [test playbook variables] *********************************************** changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "212"], "delta": "0:00:00.004399", "end": "2019-02-15 23:31:20.648111", "rc": 0, "start": "2019-02-15 23:31:20.643712", "stderr": "", "stdout": "212"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "200"], "delta": "0:00:00.005932", "end": "2019-02-15 23:31:23.873082", "rc": 0, "start": "2019-02-15 23:31:23.867150", "stderr": "", "stdout": "200"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "162"], "delta": "0:00:00.006723", "end": "2019-02-15 23:31:23.287861", "rc": 0, "start": "2019-02-15 23:31:23.281138", "stderr": "", "stdout": "162"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=1 unreachable=0 failed=0 [root@test2 playbook]#
給主機組定義變量,作用范圍為整個主機組。
[root@test2 playbook]# cat /etc/ansible/hosts [all] 10.0.102.212 10.0.102.200 10.0.102.162 [all:vars] #給主機組定義變量 test_var=Hello World
[root@test2 playbook]# ansible-playbook test.yml -v PLAY [all] ******************************************************************** TASK: [test playbook variables] *********************************************** changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.003923", "end": "2019-02-15 23:37:29.322158", "rc": 0, "start": "2019-02-15 23:37:29.318235", "stderr": "", "stdout": "Hello World"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.004161", "end": "2019-02-15 23:37:32.548947", "rc": 0, "start": "2019-02-15 23:37:32.544786", "stderr": "", "stdout": "Hello World"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "Hello", "World"], "delta": "0:00:00.006090", "end": "2019-02-15 23:37:32.005067", "rc": 0, "start": "2019-02-15 23:37:31.998977", "stderr": "", "stdout": "Hello World"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=1 unreachable=0 failed=0 [root@test2 playbook]#
回想一下,這種方法定義變量雖然簡單直觀,但是若是變量特別多的情況下,會怎么樣?特別是給對應的主機定義變量,若是變量太多,則管理起來會很不方便的,因此引入了主機變量和組變量。
主機變量和組變量
【inventory文件仍然使用上面的文件】
在執行ansbile命令時,ansible默認會從/etc/ansible/host_vars/和/etc/amsible/group_vars/兩個目錄下讀取變量定義,如果/etc/ansible下面沒有這兩個目錄,可以直接手動創建,並且可以在這兩個目錄中創建與hosts(這里是指inventory文件)文件中主機名或組名同名的文件來定義變量。
先來看主機變量
[root@test2 playbook]# cd /etc/ansible/ [root@test2 ansible]# tree . ├── group_vars ├── hosts └── host_vars #定義與主機名同名的文件 ├── 10.0.102.162 ├── 10.0.102.200 └── 10.0.102.212 2 directories, 4 files #文件中的內容如下 [root@test2 ansible]# cat host_vars/10.0.102.162 --- test_var: 162 [root@test2 ansible]# cat host_vars/10.0.102.200 --- test_var: 200 [root@test2 ansible]# cat host_vars/10.0.102.212 --- test_var: 212
playbook的內容如下,執行結果如下:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no tasks: - name: test playbook variables command: echo {{ test_var }}
[root@test2 playbook]# ansible-playbook test.yml -v PLAY [all] ******************************************************************** TASK: [test playbook variables] *********************************************** changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "212"], "delta": "0:00:00.003767", "end": "2019-02-15 23:55:58.595282", "rc": 0, "start": "2019-02-15 23:55:58.591515", "stderr": "", "stdout": "212"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "162"], "delta": "0:00:00.006254", "end": "2019-02-15 23:56:01.235307", "rc": 0, "start": "2019-02-15 23:56:01.229053", "stderr": "", "stdout": "162"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "200"], "delta": "0:00:01.004509", "end": "2019-02-15 23:56:02.775410", "rc": 0, "start": "2019-02-15 23:56:01.770901", "stderr": "", "stdout": "200"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=1 unreachable=0 failed=0
再來說明一下主機組變量
創建與組名同名的文件
[root@test2 ansible]# tree . ├── group_vars │ └── all #創建與組名同名的文件 ├── hosts └── host_vars ├── 10.0.102.162 ├── 10.0.102.200 └── 10.0.102.212 2 directories, 5 files [root@test2 ansible]# cat group_vars/all --- test_group_var: from group
執行結果如下:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no tasks: - name: test the host variables command: echo {{ test_var }} - name: test host group variables #寫入測試組變量的task command: echo {{ test_group_var }} [root@test2 playbook]# ansible-playbook test.yml -v PLAY [all] ******************************************************************** TASK: [test the host variables] *********************************************** changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "212"], "delta": "0:00:00.004613", "end": "2019-02-15 23:59:23.227722", "rc": 0, "start": "2019-02-15 23:59:23.223109", "stderr": "", "stdout": "212"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "200"], "delta": "0:00:00.006490", "end": "2019-02-15 23:59:26.422682", "rc": 0, "start": "2019-02-15 23:59:26.416192", "stderr": "", "stdout": "200"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "162"], "delta": "0:00:00.004709", "end": "2019-02-15 23:59:25.812786", "rc": 0, "start": "2019-02-15 23:59:25.808077", "stderr": "", "stdout": "162"} TASK: [test host group variables] ********************************************* changed: [10.0.102.212] => {"changed": true, "cmd": ["echo", "from", "group"], "delta": "0:00:00.003759", "end": "2019-02-15 23:59:23.519180", "rc": 0, "start": "2019-02-15 23:59:23.515421", "stderr": "", "stdout": "from group"} changed: [10.0.102.162] => {"changed": true, "cmd": ["echo", "from", "group"], "delta": "0:00:00.003748", "end": "2019-02-15 23:59:26.109337", "rc": 0, "start": "2019-02-15 23:59:26.105589", "stderr": "", "stdout": "from group"} changed: [10.0.102.200] => {"changed": true, "cmd": ["echo", "from", "group"], "delta": "0:00:00.004339", "end": "2019-02-15 23:59:26.724525", "rc": 0, "start": "2019-02-15 23:59:26.720186", "stderr": "", "stdout": "from group"} PLAY RECAP ******************************************************************** 10.0.102.162 : ok=2 changed=2 unreachable=0 failed=0 10.0.102.200 : ok=2 changed=2 unreachable=0 failed=0 10.0.102.212 : ok=2 changed=2 unreachable=0 failed=0 [root@test2 playbook]#
巧用主機變量和組變量
有時候在執行ansbile任務時,可能需要從一台遠程主機上獲取另一台遠程主機的變量信息,這時候可以使用hostvars變量,這個變量包含了指定主機上所定義的所有變量。
譬如,若是想獲取host1上變量admin_user的內容,在任意主機上直接上使用下面代碼即可。
{{ hostvars['host1']['admin_user']}}
ansible提供了一些非常有用的內置變量,幾個常用的如下:
- grorps:包含了所有hosts文件里的主機組的一個列表。
- group_names: 包含了當前主機所在的所有主機組名的一個列表。
- inventory_hostname: 通過hosts文件定義的主機名。(與ansible_home意義不同)
- inventory_hostname_short:變量inventory_hostname的第一部分。譬如inventory_hostname的值為books.ansible.com,那么inventory_hostname_short的值就是books。
- play_hosts: 將執行當前任務的所有主機
注冊變量
注冊變量,其實就是將操作結果,包括標准輸出和標准錯誤輸出,保存到變量中,然后再根據這個變量的內容來決定下一步的操作,在這個過程中用來保存操作結果的變量就叫注冊變量。
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no tasks: - name: test the register variables shell: uptime register: results #使用關鍵字register聲明注冊變量,上面uptime命令產生的結果,存入到results中。結果是字典形式。 - name: print the register result debug: msg="{{ results.stdout }}" #使用debug模塊,打印出上面命令的輸出結果。
上面的playbook執行結果如下:
[root@test2 playbook]# ansible-playbook test.yml PLAY [all] ******************************************************************** TASK: [test the register variables] ******************************************* changed: [10.0.102.212] changed: [10.0.102.200] changed: [10.0.102.162] TASK: [print the register result] ********************************************* ok: [10.0.102.212] => { "msg": " 00:18:01 up 3 days, 2:56, 3 users, load average: 0.02, 0.03, 0.05" #msg的結果就是注冊變量的標准輸出 } ok: [10.0.102.200] => { "msg": " 00:18:04 up 4 days, 7:45, 3 users, load average: 0.03, 0.06, 0.05" } ok: [10.0.102.162] => { "msg": " 00:18:04 up 4 days, 7:45, 3 users, load average: 0.01, 0.02, 0.05" } PLAY RECAP ******************************************************************** 10.0.102.162 : ok=2 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=2 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=2 changed=1 unreachable=0 failed=0 [root@test2 playbook]#
一個注冊變量通常會有以下4個屬性:
- changed:任務是否對遠程主機造成的變更。
- delta:任務運行所用的時間。
- stdout:正常的輸出信息。
- stderr:錯誤信息。
高階變量
對於普通變量,在ansible命令行設定的,在hosts文件中定義的,或者在playbook中定義的等,這些都是普通變量,在引用時,可以使用使用{{ variable }}的形式。ansible是用python語言寫的,因此也支持一種叫做列表的變量,形式如下:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root gather_facts: no vars: var_list: #注意形式,定義了var_list列表,取值方法和列表取值一樣,不推薦使用jinja2的方法取值。 - one - two - three tasks: - name: test the list variables shell: echo {{ var_list[0] }} #取列表中的第一個字,也就是one register: results - name: print the register result debug: msg="{{ results.stdout }}"
執行結果如下:
[root@test2 playbook]# ansible-playbook test.yml PLAY [all] ******************************************************************** TASK: [test the list variables] *********************************************** changed: [10.0.102.212] changed: [10.0.102.200] changed: [10.0.102.162] TASK: [print the register result] ********************************************* ok: [10.0.102.212] => { "msg": "one" } ok: [10.0.102.200] => { "msg": "one" } ok: [10.0.102.162] => { "msg": "one" } PLAY RECAP ******************************************************************** 10.0.102.162 : ok=2 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=2 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=2 changed=1 unreachable=0 failed=0
facts變量信息
在上面的測試中,我們的playbook都執行了一條命令叫gater_facts:no,加入了這條命令后,playbook腳本的執行速度會快很多,這是因為默認情況下,ansible是會手機遠程服務器的主機信息,這些信息包含了服務器的一些基本設置。
GATHERING FACTS *************************************************************** ok: [10.0.102.200] ok: [10.0.102.212] ok: [10.0.102.162]
收集的主機信息可以使用setup模塊查看,一個主機的收集信息如下:

[root@test2 playbook]# ansible 10.0.102.162 -m setup 10.0.102.162 | success >> { "ansible_facts": { "ansible_all_ipv4_addresses": [ "10.0.102.162" ], "ansible_all_ipv6_addresses": [ "fe80::1392:ecd3:5adf:c3ae" ], "ansible_architecture": "x86_64", "ansible_bios_date": "04/01/2014", "ansible_bios_version": "1.9.1-5.el7.centos", "ansible_cmdline": { "BOOT_IMAGE": "/vmlinuz-3.10.0-514.el7.x86_64", "LANG": "en_US.UTF-8", "crashkernel": "auto", "quiet": true, "rd.lvm.lv": "cl/swap", "rhgb": true, "ro": true, "root": "/dev/mapper/cl-root" }, "ansible_date_time": { "date": "2019-02-16", "day": "16", "epoch": "1550248590", "hour": "00", "iso8601": "2019-02-15T16:36:30Z", "iso8601_micro": "2019-02-15T16:36:30.311222Z", "minute": "36", "month": "02", "second": "30", "time": "00:36:30", "tz": "CST", "tz_offset": "+0800", "weekday": "Saturday", "year": "2019" }, "ansible_default_ipv4": { "address": "10.0.102.162", "alias": "eth0", "gateway": "10.0.100.1", "interface": "eth0", "macaddress": "fa:0a:e3:54:a6:00", "mtu": 1500, "netmask": "255.255.252.0", "network": "10.0.100.0", "type": "ether" }, "ansible_default_ipv6": {}, "ansible_devices": { "sr0": { "holders": [], "host": "IDE interface: Intel Corporation 82371SB PIIX3 IDE [Natoma/Triton II]", "model": "QEMU DVD-ROM", "partitions": {}, "removable": "1", "rotational": "1", "scheduler_mode": "cfq", "sectors": "2097151", "sectorsize": "512", "size": "1024.00 MB", "support_discard": "0", "vendor": "QEMU" }, "vda": { "holders": [], "host": "SCSI storage controller: Red Hat, Inc Virtio block device", "model": null, "partitions": { "vda1": { "sectors": "2097152", "sectorsize": 512, "size": "1.00 GB", "start": "2048" }, "vda2": { "sectors": "81786880", "sectorsize": 512, "size": "39.00 GB", "start": "2099200" } }, "removable": "0", "rotational": "1", "scheduler_mode": "", "sectors": "83886080", "sectorsize": "512", "size": "40.00 GB", "support_discard": "0", "vendor": "0x1af4" } }, "ansible_distribution": "CentOS", "ansible_distribution_major_version": "7", "ansible_distribution_release": "Core", "ansible_distribution_version": "7.3.1611", "ansible_domain": "", "ansible_env": { "HOME": "/root", "LANG": "en_US.UTF-8", "LC_CTYPE": "en_US.UTF-8", "LESSOPEN": "||/usr/bin/lesspipe.sh %s", "LOGNAME": "root", "LS_COLORS": "rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:mi=01;05;37;41:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:*.tar=01;31:*.tgz=01;31:*.arc=01;31:*.arj=01;31:*.taz=01;31:*.lha=01;31:*.lz4=01;31:*.lzh=01;31:*.lzma=01;31:*.tlz=01;31:*.txz=01;31:*.tzo=01;31:*.t7z=01;31:*.zip=01;31:*.z=01;31:*.Z=01;31:*.dz=01;31:*.gz=01;31:*.lrz=01;31:*.lz=01;31:*.lzo=01;31:*.xz=01;31:*.bz2=01;31:*.bz=01;31:*.tbz=01;31:*.tbz2=01;31:*.tz=01;31:*.deb=01;31:*.rpm=01;31:*.jar=01;31:*.war=01;31:*.ear=01;31:*.sar=01;31:*.rar=01;31:*.alz=01;31:*.ace=01;31:*.zoo=01;31:*.cpio=01;31:*.7z=01;31:*.rz=01;31:*.cab=01;31:*.jpg=01;35:*.jpeg=01;35:*.gif=01;35:*.bmp=01;35:*.pbm=01;35:*.pgm=01;35:*.ppm=01;35:*.tga=01;35:*.xbm=01;35:*.xpm=01;35:*.tif=01;35:*.tiff=01;35:*.png=01;35:*.svg=01;35:*.svgz=01;35:*.mng=01;35:*.pcx=01;35:*.mov=01;35:*.mpg=01;35:*.mpeg=01;35:*.m2v=01;35:*.mkv=01;35:*.webm=01;35:*.ogm=01;35:*.mp4=01;35:*.m4v=01;35:*.mp4v=01;35:*.vob=01;35:*.qt=01;35:*.nuv=01;35:*.wmv=01;35:*.asf=01;35:*.rm=01;35:*.rmvb=01;35:*.flc=01;35:*.avi=01;35:*.fli=01;35:*.flv=01;35:*.gl=01;35:*.dl=01;35:*.xcf=01;35:*.xwd=01;35:*.yuv=01;35:*.cgm=01;35:*.emf=01;35:*.axv=01;35:*.anx=01;35:*.ogv=01;35:*.ogx=01;35:*.aac=01;36:*.au=01;36:*.flac=01;36:*.mid=01;36:*.midi=01;36:*.mka=01;36:*.mp3=01;36:*.mpc=01;36:*.ogg=01;36:*.ra=01;36:*.wav=01;36:*.axa=01;36:*.oga=01;36:*.spx=01;36:*.xspf=01;36:", "MAIL": "/var/mail/root", "PATH": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin", "PWD": "/root", "SELINUX_LEVEL_REQUESTED": "", "SELINUX_ROLE_REQUESTED": "", "SELINUX_USE_CURRENT_RANGE": "", "SHELL": "/bin/bash", "SHLVL": "2", "SSH_CLIENT": "10.0.102.204 4242 22", "SSH_CONNECTION": "10.0.102.204 4242 10.0.102.162 22", "SSH_TTY": "/dev/pts/1", "TERM": "xterm", "USER": "root", "XDG_RUNTIME_DIR": "/run/user/0", "XDG_SESSION_ID": "168", "_": "/usr/bin/python" }, "ansible_eth0": { "active": true, "device": "eth0", "ipv4": { "address": "10.0.102.162", "netmask": "255.255.252.0", "network": "10.0.100.0" }, "ipv6": [ { "address": "fe80::1392:ecd3:5adf:c3ae", "prefix": "64", "scope": "link" } ], "macaddress": "fa:0a:e3:54:a6:00", "module": "virtio_net", "mtu": 1500, "promisc": false, "type": "ether" }, "ansible_form_factor": "Other", "ansible_fqdn": "docker4", "ansible_hostname": "docker4", "ansible_interfaces": [ "lo", "eth0" ], "ansible_kernel": "3.10.0-514.el7.x86_64", "ansible_lo": { "active": true, "device": "lo", "ipv4": { "address": "127.0.0.1", "netmask": "255.0.0.0", "network": "127.0.0.0" }, "ipv6": [ { "address": "::1", "prefix": "128", "scope": "host" } ], "mtu": 65536, "promisc": false, "type": "loopback" }, "ansible_machine": "x86_64", "ansible_memfree_mb": 881, "ansible_memtotal_mb": 1839, "ansible_mounts": [ { "device": "/dev/mapper/cl-root", "fstype": "xfs", "mount": "/", "options": "rw,seclabel,relatime,attr2,inode64,noquota", "size_available": 34615087104, "size_total": 39700664320 }, { "device": "/dev/vda1", "fstype": "xfs", "mount": "/boot", "options": "rw,seclabel,relatime,attr2,inode64,noquota", "size_available": 918556672, "size_total": 1063256064 } ], "ansible_nodename": "docker4", "ansible_os_family": "RedHat", "ansible_pkg_mgr": "yum", "ansible_processor": [ "QEMU Virtual CPU version 2.5+", "QEMU Virtual CPU version 2.5+" ], "ansible_processor_cores": 2, "ansible_processor_count": 1, "ansible_processor_threads_per_core": 1, "ansible_processor_vcpus": 2, "ansible_product_name": "KVM", "ansible_product_serial": "NA", "ansible_product_uuid": "E5E1D5E6-1A4D-4E0D-98C3-B8AD422B10CC", "ansible_product_version": "RHEL 7.3.0 PC (i440FX + PIIX, 1996)", "ansible_python_version": "2.7.5", "ansible_selinux": { "config_mode": "enforcing", "mode": "enforcing", "policyvers": 28, "status": "enabled", "type": "targeted" }, "ansible_ssh_host_key_ecdsa_public": "AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEp5iF/lAqB9Q9FNKfnsi3mLJSVvvooVhRRcuGTBHEJs+TaM36oBaIr764IX1zdn2sWFLdYgmcuaAeiPu3fK+UU=", "ansible_ssh_host_key_rsa_public": "AAAAB3NzaC1yc2EAAAADAQABAAABAQC6yHI2+V64EMW3jDISBrzKmWurP7uF4IqemJgowpqC3mVlFsPOSqerDoJN9hE34fViXcbLUj9wIi0kc3QzxxNwTefwJCdPSL17ns9eIEDKJqrHswts7OXYC1948bdyhyGnaW57BEfVUJ+Vt8OI1JSKkKsi3aCumaZDz9tNGCVYiqW4PMUQFaT/yEnPqKhSp8mDX/SL/unpVsctB0w37o38ZVApKPaNkHW25uiwroStLGqY4VgoZHTqHUdvqk4EZQOD0+JmBcYKVj2ABBl1sMiH8mmrc2W2Gi0gJx31Ky/t5SWQtXTdMRB3D7N9yRd1pPcnh0zebS/OPnX4G5UWX/aP", "ansible_swapfree_mb": 0, "ansible_swaptotal_mb": 0, "ansible_system": "Linux", "ansible_system_vendor": "Red Hat", "ansible_user_id": "root", "ansible_userspace_architecture": "x86_64", "ansible_userspace_bits": "64", "ansible_virtualization_role": "guest", "ansible_virtualization_type": "kvm", "module_setup": true }, "changed": false } [root@test2 playbook]#
在實際應用中,運用的比較多的facts變量有ansible_os_family,ansible_hostname等,這些變量通常會被拿來作為when條件語句的判斷條件,來決定下一步的操作。一個簡單的實例:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root tasks: - name: test the list variables shell: echo {{ ansible_os_family }} register: results - name: print the register result debug: msg="{{ results.stdout }}" [root@test2 playbook]#
執行結果如下:
[root@test2 playbook]# ansible-playbook test.yml PLAY [all] ******************************************************************** GATHERING FACTS *************************************************************** ok: [10.0.102.162] ok: [10.0.102.212] ok: [10.0.102.200] TASK: [test the list variables] *********************************************** changed: [10.0.102.162] changed: [10.0.102.212] changed: [10.0.102.200] TASK: [print the register result] ********************************************* ok: [10.0.102.212] => { "msg": "RedHat" #對應變量的結果 } ok: [10.0.102.200] => { "msg": "RedHat" } ok: [10.0.102.162] => { "msg": "RedHat" } PLAY RECAP ******************************************************************** 10.0.102.162 : ok=3 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=3 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=3 changed=1 unreachable=0 failed=0
本地facts變量
我們可以自己定義facts變量,把這個變量寫入一個以.fact結尾的文件中,這個文件可以是json文件或ini文件,或者是一個可以返回json代碼的可執行文件。然后將其放在遠程主機的/etc/ansible/facts.d文件夾中,ansible在執行的任務時會自動到這個文件夾中讀取變量的信息。
在遠程主機上做如下操作:
#自定義fact信息
[root@docker4 ~]# mkdir -p /etc/ansible/facts.d [root@docker4 ~]# cd !$ cd /etc/ansible/facts.d [root@docker4 facts.d]# vim test.fact [root@docker4 facts.d]# cat test.fact [test_fact] admin=hongkong
然后再ansible主機上獲取自定義的信息。
[root@test2 playbook]# ansible 10.0.102.162 -m setup -a "filter=ansible_local" 10.0.102.162 | success >> { "ansible_facts": { "ansible_local": { "test": { "test_fact": { "admin": "hongkong" } } } }, "changed": false }
if/then/while流控制語句
條件判斷在ansible任務中的使用頻率非常高。我們可以根據一些條件的不一樣執行不同的task。
when條件判斷
很多任務只有在特定條件下才能執行,這就是when語句發揮作用的地方。
一個簡單的實例,關閉掉ip地址為10.0.102.162服務器上的mysql服務,如下:
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root tasks: - name: shut down the db server service: name=mysqld state=stopped when: ansible_eth0.ipv4.address == "10.0.102.162" #這里使用了when條件語句 [root@test2 playbook]#
執行的結果如下:
[root@test2 playbook]# ansible-playbook test.yml PLAY [all] ******************************************************************** GATHERING FACTS *************************************************************** ok: [10.0.102.212] ok: [10.0.102.200] ok: [10.0.102.162] TASK: [shut down the db server] *********************************************** skipping: [10.0.102.200] skipping: [10.0.102.212] changed: [10.0.102.162] #162的服務狀態已經改變 PLAY RECAP ******************************************************************** 10.0.102.162 : ok=2 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=1 changed=0 unreachable=0 failed=0 10.0.102.212 : ok=1 changed=0 unreachable=0 failed=0
這個就是when條件語句的用法很簡單。需要注意when語句的作用於paly的作用時間,當when的條件滿足時,然后才會執行play中的任務。ansible還提供了另外兩個與when相關的語句changed_when和failed_when條件判斷。
changed_when和failed_when條件判斷
暫空
任務間的流程控制
任務委托
默認情況下,ansible所有任務都是在我們指定的機器上面運行的,當在一個獨立的集群環境配置時,這並沒有什么問題。而在有些情況下,比如給某台服務器發送通知或者向監控服務器中添加被監控的主機,這個時候任務就需要在特定的主機上運行,而非一開始指定的所有主機,此時就需要ansible的委托任務。
使用delegate_to關鍵字可以配置任務在指定的服務器上執行,而其他任務還是在hosts關鍵字配置的所有機器上執行,當到了這個關鍵字所在的任務時,就使用委托的機器運行。
查看MySQL是否在運行狀態,因此在檢查之前首先關掉162上的mysql服務。【為了方便查看狀態】
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root tasks: - name: stop the db server service: name=mysqld state=stopped delegate_to: 10.0.102.162 #這里使用了委托,僅關閉162這台服務器上,這個play僅在162這台服務器上執行。 - name: check mysql status service: name=mysqld state=running
這里委托是在指定的機器上執行,若是想在本地服務器上執行,可以把ip地址換為127.0.0.1即可。也可以使用local_action方法。
[root@test2 playbook]# cat test.yml --- - hosts: all remote_user: root tasks: - name: create the test file local_action: shell touch test1111 #在本地創建一個測試文件 - name: check mysql status service: name=mysqld state=running
結果如下:
[root@test2 playbook]# ansible-playbook test.yml PLAY [all] ******************************************************************** GATHERING FACTS *************************************************************** ok: [10.0.102.212] ok: [10.0.102.200] ok: [10.0.102.162] TASK: [create the test file] ************************************************** changed: [10.0.102.212 -> 127.0.0.1] changed: [10.0.102.200 -> 127.0.0.1] changed: [10.0.102.162 -> 127.0.0.1] TASK: [check mysql status] **************************************************** ok: [10.0.102.200] ok: [10.0.102.212] ok: [10.0.102.162] PLAY RECAP ******************************************************************** 10.0.102.162 : ok=3 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=3 changed=1 unreachable=0 failed=0 10.0.102.212 : ok=3 changed=1 unreachable=0 failed=0 [root@test2 playbook]# ls #默認會在當前目錄創建對應的文件 test1111 test.yml vars.yml
任務暫停
有些情況下,一些任務的運行需要等待一些狀態的恢復,比如某一台主機或者應用剛剛重啟,我們需要等待它上面的某個端口開啟,此時我們就不得不將正在運行的任務暫停,直到其狀態滿足我們的需求。下一個實例【摘抄】
- name: wait for webserver to start
local_action:
module: wait_for
host: webserver1
port: 80
delay: 10
timeout: 300
state: startted
#這個實例中,這個任務將會每10s檢查一次主機webserver1上面的80端口是否開啟,如果超過了300s,80端口仍未開啟,將會返回失敗信息。
交互式提示
在少數情況下,ansible任務運行的過程中需要用戶輸入一些數據,這些數據要么比較秘密不方便,或者數據是動態的,不同的用戶有不同的需求,比如輸入用戶自己的賬戶和密碼或者輸入不同的版本號會觸發不同的后續操作等。ansible的vars_prompt關鍵字就是用來處理上述這種與用戶交互的情況的。下面是一個簡單的實例。
--- - hosts: all remote_user: root vars_prompt: - name: share_user prompt: "what is your network username?" private: no - name: share_pass prompt: "what is your network password" private: no
然后執行上面的playbook,因為我們只是測試,只需要在一台機器上執行,因此加入了--limit參數。
[root@test2 playbook]# ansible-playbook test.yml --limit 10.0.102.162 what is your network username?: test #需要手動交互輸入 what is your network password: 123456 #手動輸入 PLAY [all] ******************************************************************** GATHERING FACTS *************************************************************** ok: [10.0.102.162] PLAY RECAP ******************************************************************** 10.0.102.162 : ok=1 changed=0 unreachable=0 failed=0
手動輸入的變量值,在后面的play中仍然可以用{{ var_name }}的形式調用。
關鍵字vars_prompt幾個常用的選項總結如下:
- private: 默認值為yes,表示用戶輸入的值在命令行不可見;將值設為no時,用戶輸入可見。
- default:為變量設置默認值,以節省用戶輸入時間。
- confirm:特別適合輸入密碼的情況,如果將其設置為yes,則會要求用戶輸入兩次,以增加輸入的安全性。
Tags標簽
默認情況下,ansible在執行一個playbook時,會執行playbook中定義的所有任務。ansible的標簽功能可以給角色,文件,單獨的任務甚至整個playbook打上標簽,然后利用這些標簽來指定要運行playbook中的個別任務,或不執行指定的任務,並且它的語法非常簡單。
通過一段代碼來說明tags的用法,代碼摘自《ansible權威指南》
---
# 可以給整個playbook的所有任務打一個標簽。
- hosts: all
tags: deploy
roles:
# 給角色打的標簽將會應用與角色下所有的任務。
- {role: tomcat, tags : ["tomcat", "app"]} #一個對象添加多個tag的寫法之一
tasks:
- name: Notify on completion
local_action:
module: osx_say
msg: "{{inventory_hostname}} is finished"
voice: Zarvox
tags: #一個對象添加多個tag寫法之二
- notifications
- say
- include: foo.yml
tags: foo
#縮進可能不太對
將上述代碼保存,可以通過以下命令來只執行“Notify on completion”任務。
ansible-playbook test.yml --tags "say"
如果想忽略掉某個任務,可以使用--skip-tags關鍵字指定。
Block塊
ansible從2.0.0版本開始引入了塊功能。塊功能可以將任務進行分組,並且可以在塊級別上應用任務變量。同時,塊功能還可以使用類似於其他編程語言處理異常那樣的方法,來處理塊內部的任務異常。
[root@docker5 ~]# cat test.yml --- - hosts: all remote_user: root tasks: - block: - yum: name=httpd state=present - service: name=httpd state=started enabled=no when: ansible_eth0.ipv4.address == "10.0.102.162" - block: - yum: name=nginx state=present - service: name=nginx state=started enabled=no when: ansible_eth0.ipv4.address == "10.0.102.200"
運行結果如下:
[root@docker5 ~]# ansible-playbook -i hosts test.yml PLAY [all] ************************************************************************************************************************************************************************************** TASK [Gathering Facts] ************************************************************************************************************************************************************************** ok: [10.0.102.162] ok: [10.0.102.200] TASK [yum] ************************************************************************************************************************************************************************************** skipping: [10.0.102.200] #因為在inventory文件中注釋了這一台服務器,因此這里忽略了。 ok: [10.0.102.162] TASK [service] ********************************************************************************************************************************************************************************** skipping: [10.0.102.200] changed: [10.0.102.162] TASK [yum] ************************************************************************************************************************************************************************************** skipping: [10.0.102.162] ok: [10.0.102.200] TASK [service] ********************************************************************************************************************************************************************************** skipping: [10.0.102.162] changed: [10.0.102.200] PLAY RECAP ************************************************************************************************************************************************************************************** 10.0.102.162 : ok=3 changed=1 unreachable=0 failed=0 10.0.102.200 : ok=3 changed=1 unreachable=0 failed=0
上面的playbooj和之前的並沒有什么不同,只是假如了block之后,代碼更容易查看。
塊功能可以用來處理任務的異常。比如一個ansible任務時監控一個並不太重要的應用,這個應用的正常運行與否對后續的任務並不產生影響,這時候我們就可以通過塊功能來處理這個應用的報錯。如下代碼:
tasks:
- block:
- name: shell script to connect the app ti a mointoring service.
script: mointoring-connect.sh
rescue:
- name:只有腳本報錯時才執行
debug: msg="There was an error in the block"
always:
- name: 無論結果如何都執行
debug: msg="This always executes"
當塊中任意任務出錯時,rescue關鍵字對應的代碼塊就會被執行,而always關鍵字對應的代碼塊無論如何都會被執行。