python中Ansible模塊的Playbook的具體使用
Playbook
在上一節(jié)中，我們?cè)敿?xì)介紹了Ansible提供的一些常用模塊?？梢钥吹?，Ansible中的每個(gè)模塊專注于某一方面的功能。雖然每個(gè)模塊實(shí)現(xiàn)的功能都比較簡(jiǎn)單，但是，將各個(gè)模塊組合起來(lái)就可以實(shí)現(xiàn)比較復(fù)雜的功能。在Ansible中，將各個(gè)模塊組合起來(lái)的文件是一個(gè)YAML格式的配置文件。這個(gè)配置文件，在Ansible中稱為Playbook。
在這一節(jié)中，我們將循序漸進(jìn)地介紹Ansible中的Playbook，我們將首先介紹Playbook的定義，然后介紹如何使用Playbook完成遠(yuǎn)程服務(wù)器部署，之后詳細(xì)介紹Playbook的基本語(yǔ)法，使用Playbook的基本講法就能夠完成大部分的部署任務(wù)。
在這一節(jié)中，找們將介紹如何使用Playbook的基本語(yǔ)法完成nginx與MongoDB的部署，最后，我們介紹了部分Playbook的高級(jí)語(yǔ)法。
1、Playbook的定義
Playbook不同于其他使用單個(gè)模塊操作遠(yuǎn)程服務(wù)器，Playbook的功能更加強(qiáng)大。如果只使用Playbook的基本功能，那么，Playbook是一個(gè)非常簡(jiǎn)單的配、管理和部署系統(tǒng)。此外，Playbook也可以實(shí)現(xiàn)各種高級(jí)功能，如指定任務(wù)的執(zhí)行順序，委派其他主機(jī)來(lái)執(zhí)行某一個(gè)任務(wù)，與監(jiān)控服務(wù)器和負(fù)載均衡組件進(jìn)行交互等。
有一個(gè)非常恰當(dāng)?shù)谋扔?，Ansible中的模塊類似于Linux下的命令，Ansible中的Playbook類似于Linux下的Shell腳本文件。Shell腳本文件將各個(gè)Linux命令組合起來(lái)，以此實(shí)現(xiàn)復(fù)雜的功能，Playbook將各個(gè)模塊組合起來(lái)也可以實(shí)現(xiàn)復(fù)雜的部署功能。在shell腳本中，除了調(diào)用Linux命令以外，還有一些基本的語(yǔ)法，如變量定義、if語(yǔ)句、for循環(huán)等。在Playbook中，一方面通過(guò)YAML格式進(jìn)行定義提高Playbook的可讀性、可維護(hù)性，降低工程師的學(xué)習(xí)負(fù)擔(dān)；另一方面，Ansible提供了若干可以應(yīng)用在Playbook中的選項(xiàng)，以便工程師實(shí)現(xiàn)更加高級(jí)的功能。
一個(gè)Playbook可以包含一到多個(gè)Play，每一個(gè)Play是一個(gè)完整的部署任務(wù)。在Play中，我們需要指定對(duì)哪些遠(yuǎn)程服務(wù)器執(zhí)行操作，以及對(duì)這些遠(yuǎn)程服務(wù)器執(zhí)行哪些操作。
下面是一個(gè)名為first_playbook.yml的Playbook。在這個(gè)Playbook中，我們定義了兩個(gè)Play，前者用來(lái)在數(shù)據(jù)庫(kù)服務(wù)器上部署MongoDB，后者用來(lái)在web服務(wù)器上部署“應(yīng)用”。這里只是為了對(duì)Playbook進(jìn)行演示，并沒(méi)有真的部署應(yīng)用。
[root@python ~]# vim first_playbook.yml --- - hosts: dbservers become: yes become_method: sudo tasks: - name: install mongodb yum: name=mongodb-server state=present - hosts: webservers tasks: - name: copy file copy: src=/tmp/data.txt dest=/tmp/data.txt - name: change mode file: dest=/tmp/data.txt mode=655 owner=root group=root
這個(gè)Playbook中包含了兩個(gè)Play。一個(gè)Playbook可以包含一到多個(gè)Play，所以即使Playbook中值包含一個(gè)Play，也需要使用列表的形式進(jìn)行定義。在YAML語(yǔ)法中，“- hosts”前面的“-”表示定義列表。
在Ansible中，一個(gè)Play必須包含以下兩項(xiàng)：
1. hosts：需要對(duì)哪些遠(yuǎn)程服務(wù)器執(zhí)行操作
2. tasks：需要在這些服務(wù)器上執(zhí)行的任務(wù)列表
例如，對(duì)web服務(wù)器進(jìn)行部署時(shí)，我們僅僅使用了hosts和tasks兩個(gè)選項(xiàng)。前者表示對(duì)哪些服務(wù)器執(zhí)行操作，后者表示對(duì)服務(wù)器執(zhí)行哪些操作。在部署數(shù)據(jù)庫(kù)服務(wù)器時(shí)需要安裝軟件，因此使用了become與become_method兩個(gè)選項(xiàng)，用來(lái)表示使用管理員的身份去安裝MongoDB數(shù)據(jù)庫(kù)。
一個(gè)Play可以包含一到多個(gè)task，因此task也必須以YAML的列表形式進(jìn)行定義?？梢钥吹?，在這個(gè)例子中，對(duì)數(shù)據(jù)庫(kù)服務(wù)器進(jìn)行操作時(shí)僅包含了一個(gè)task，對(duì)web服務(wù)器進(jìn)行部署時(shí)包含了兩個(gè)task。
在Ansible中，task有兩種定義形式：
1. action：module options
2. module：options
前一種形式是Ansible的舊版本語(yǔ)法，第2種形式是新版本的語(yǔ)法，直接使用模塊的名稱作為鍵，使用模塊的參數(shù)作為值。如下所示：
- name: install httpd yum: name=httpd update_cache=yes state=present
在安裝Apache的例子中，“name=httpd update_cache=yes state=present”是一個(gè)完整的字符串，而不是一個(gè)字典。只是字符串的值是一個(gè)“key=value”形式的參數(shù)。
在參數(shù)較多時(shí)，為了增加Playbook的可讀性，我們也可以像下面這樣定義一個(gè)task：
- name: install httpd yum: > name=httpd update_cache=yes state=present
在Ansible中，當(dāng)參數(shù)較長(zhǎng)時(shí)，除了使用“>”進(jìn)行折疊換行以外，也可以使用縮進(jìn)字塊的形式：
- name: install httpd yum: name: httpd update_cache: yes state: present
雖然從字面來(lái)看，這兩種指定參數(shù)的方式相差不大。但是，從YAML的語(yǔ)法來(lái)說(shuō)，這是完全不同的兩個(gè)方法。前者是一個(gè)比較長(zhǎng)的字符串，后者是一個(gè)字典。
task的定義中，name是可選的。所以，像下面這樣定義task也是完全合法的：
- yum: name=httpd update_cache=yes state=present
name的作用在于，執(zhí)行Playbook時(shí)作為注釋進(jìn)行顯示，以便使用者知道當(dāng)前執(zhí)行到哪一步。因此，在定義task時(shí)，一般都會(huì)定義name字段。
在實(shí)際工作中，雖然一個(gè)Playbook可以包含多個(gè)Play，但是為了Playbook的可讀性和可維護(hù)性，我們一般只會(huì)在Playbook中編寫(xiě)一個(gè)Play。例如，對(duì)于這里的例子，我們可以將first_playbook.yml這個(gè)Playbook拆分成兩個(gè)Playbook，分別名為db.yml與web.yml。其中，db.yml文件包含了與數(shù)據(jù)庫(kù)服務(wù)器相關(guān)的部署任務(wù)，web.yml文件包含了與web服務(wù)器相關(guān)的部署任務(wù)。
當(dāng)我們需要部署數(shù)據(jù)庫(kù)服務(wù)器和web服務(wù)器時(shí)，可以先執(zhí)行db.yml文件，再執(zhí)行web.yml文件。除此之外，Ansible還提供了一種便捷方式來(lái)處理這種情況。例如，我們可以編寫(xiě)一個(gè)名為all.yml的Playbook，它的內(nèi)容如下：
--- - include: db.yml - include: web.yml
include選項(xiàng)是Ansible提供的，用于在一個(gè)Playbook中導(dǎo)入其他Playbook。在Ansible中，只需要使用include選項(xiàng)導(dǎo)入其他Playbook文件，執(zhí)行這個(gè)Playbook時(shí)，被導(dǎo)入的Playbook便會(huì)依次執(zhí)行。
上面詳細(xì)介紹了Ansible的Playbook定義，這個(gè)Playbook定義雖然比較簡(jiǎn)單，但是，是一個(gè)比較完整的Playbook例子。在實(shí)際工作中使用的Playbook也不會(huì)比這個(gè)Playbook復(fù)雜很多。
我們接下來(lái)將介紹如何使用ansible-playbook命令執(zhí)行Playbook，然后再介紹Playbook的其他語(yǔ)法。
2、ansible拆分playbook.yml
查看一下所需文件是否正確
[root@python ~]# cat hosts 127.0.0.1 [webservers] 192.168.1.60 [dbservers] 192.168.1.80 [common:children] dbservers webservers [root@python ~]# cat /etc/ansible/ansible.cfg [defaults] remote_user = root remote_port = 22 inventory = /root/hosts
拆分playbook.yml
[root@python ~]# cat db.yml --- - hosts: dbservers become: yes become_method: sudo tasks: - name: install mongodb yum: name=mongodb-server state=present #mongodb-server 可歡成其他服務(wù)如（git） [root@python ~]# cat web.yml --- - hosts: webservers tasks: - name: copy file copy: src=/tmp/data.txt dest=/opt/data.txt - name: change mode file: dest=/opt/data.txt mode=655 owner=root group=root [root@python ~]# cat all.yml --- - include: db.yml - include: web.yml [root@python ~]# touch /tmp/data.txt [root@python ~]# touch /opt/data.txt
3、使用Ansible-playbook執(zhí)行Playbook
上一小節(jié)中，我們簡(jiǎn)單地介紹了Playbook的定義。那么，當(dāng)我們有了一個(gè)Playbook文件以后，如何執(zhí)行這個(gè)文件完成應(yīng)用部署呢？我們知道，Ansible安裝完成以后存在多個(gè)可執(zhí)行的命令行工具，其中，ansible-playbook便是用于執(zhí)行Playbook的命令行工具。
ansible-playbook的執(zhí)行方式如下:
ansible-playbook first_playbook.yml
ansible-playbook命令也有若干命令行選項(xiàng)，其中,有部分選項(xiàng)與ansible命令相同。Ansible中也存在一些ansible-playbook特有的命令行選項(xiàng)。
ansible-playbook命令與ansible命令相同的命令行選項(xiàng):
-T --timeout：建立SSH連接的超時(shí)時(shí)間
--key-file --private-key：建立SSH連接的私鑰文件
-i --inventory-file：指定Inventory文件，默認(rèn)是/etc/ansible/hosts
-f --forks：并發(fā)執(zhí)行的進(jìn)程數(shù)，默認(rèn)為5
--list-hosts：playbooks匹配的服務(wù)器列表。
ansible-playbook也有一個(gè)名為--list-hosts的選項(xiàng)，該選項(xiàng)的作用是列出匹配的服務(wù)器列表。例如，在我們這個(gè) Playbook的例子中，hosts文件的內(nèi)容如下：
127.0.0.1 [webservers] 192.168.1.60 [dbservers] 192.168.1.80 [common:children] dbservers webservers
我們知道，Ansible中的Play定義了需要對(duì)哪些服務(wù)器執(zhí)行哪些操作，也就是說(shuō)，每一個(gè)Play都可以指定匹配的遠(yuǎn)程服務(wù)器。在我們這個(gè)Playbook的例子中，對(duì)數(shù)據(jù)庫(kù)服務(wù)器安裝MongoDB，對(duì)web服務(wù)器部署“應(yīng)用“。因此，ansible-playbook命令與ansible命令的--list-hosts選項(xiàng)輸出的結(jié)果將會(huì)大不相同。ansible-playbook命令的--list-hosts選項(xiàng)輸出的結(jié)果如下：
[root@python ~]# ansible-playbook all.yml --list-hosts
ansible-playbook命令有一些特有的選項(xiàng)，如下所示：
--list-tasks：列出任務(wù)列表
--step：每執(zhí)行一個(gè)任務(wù)后停止，等待用戶確認(rèn)
--syntax-check：檢查Playbook語(yǔ)法
-C --check：檢查當(dāng)前這個(gè)Playbook是否會(huì)修改遠(yuǎn)程服務(wù)器，相當(dāng)于預(yù)測(cè)Playbook的執(zhí)行結(jié)果。
這里的幾個(gè)選項(xiàng)，除了--step以外，其他幾個(gè)選項(xiàng)都不會(huì)執(zhí)行Playbook中的任務(wù)。這些選項(xiàng)存在主要是為了便于調(diào)試Playbook。例如，--list-tasks選項(xiàng)，該選項(xiàng)用來(lái)顯示當(dāng)前Playbook中的任務(wù)列表。當(dāng)Playbook比較大時(shí)，可以通過(guò)這個(gè)方式快速查看任務(wù)列表。如下所示：
[root@python ~]# ansible-playbook all.yml --list-tasks playbook: all.yml play #1 (dbservers): dbservers TAGS: [] tasks: install mongodb TAGS: [] play #2 (webservers): webservers TAGS: [] tasks: copy file TAGS: [] change mode TAGS: []
當(dāng)我們查看任務(wù)列表時(shí)，任務(wù)的名稱就是task的name字段。因此，name的定義需要具有較好的描述性，讓使用者通過(guò)名字就能知道該任務(wù)需要做什么事情。
--step選項(xiàng)類似于編程語(yǔ)言中的單步調(diào)試。當(dāng)我們使--step選項(xiàng)執(zhí)行Playbook時(shí)，ansible-playbook在每一個(gè)任務(wù)之前都會(huì)停住，等侍用戶輸入yes,、no或continue。如下所示：
[root@python ~]# ansible-playbook all.yml --step [DEPRECATION WARNING]: 'include' for playbook includes. You should use 'import_playbook' instead. This feature will be removed in version 2.12. Deprecation warnings can be disabled by setting deprecation_warnings=False in ansible.cfg. PLAY [dbservers] *************************************************************** Perform task: TASK: Gathering Facts (N)o/(y)es/(c)ontinue: y Perform task: TASK: Gathering Facts (N)o/(y)es/(c)ontinue: ********************* TASK [Gathering Facts] ********************************************************* ok: [192.168.1.80] Perform task: TASK: install mongodb (N)o/(y)es/(c)ontinue: y Perform task: TASK: install mongodb (N)o/(y)es/(c)ontinue: ********************* TASK [install mongodb] ********************************************************* changed: [192.168.1.80] PLAY [webservers] ************************************************************** Perform task: TASK: Gathering Facts (N)o/(y)es/(c)ontinue: y Perform task: TASK: Gathering Facts (N)o/(y)es/(c)ontinue: ********************* TASK [Gathering Facts] ********************************************************* ok: [192.168.1.60] Perform task: TASK: copy file (N)o/(y)es/(c)ontinue: y Perform task: TASK: copy file (N)o/(y)es/(c)ontinue: *************************** TASK [copy file] *************************************************************** changed: [192.168.1.60] Perform task: TASK: change mode (N)o/(y)es/(c)ontinue: y Perform task: TASK: change mode (N)o/(y)es/(c)ontinue: ************************* TASK [change mode] ************************************************************* changed: [192.168.1.60] PLAY RECAP ********************************************************************* 192.168.1.60 : ok=3 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.80 : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
輸入yes以后，任務(wù)將會(huì)繼續(xù)執(zhí)行，并在下一個(gè)任務(wù)時(shí)停止，等待用戶繼續(xù)輸入。當(dāng)我們輸入continue時(shí)，Ansible會(huì)執(zhí)行完當(dāng)前這個(gè)Play，當(dāng)執(zhí)行到下一個(gè)Play時(shí)再停止，并等待用戶輸入。
二、Playbook的詳細(xì)語(yǔ)法
到目前為止，我們已經(jīng)學(xué)習(xí)了如何編寫(xiě)Playbook以及如何運(yùn)行Playbook。但是，我們僅僅介紹了最簡(jiǎn)單的Playbook。在這一節(jié)中，我們將會(huì)介紹Playbook是如何通過(guò)不同的選項(xiàng)提供豐富多樣的功能。靈活使用這些選項(xiàng)，能夠編寫(xiě)出形式各異的Playbook，以此應(yīng)對(duì)自動(dòng)部署中的各種情況。
在定義Play時(shí)，只有hosts與tasks是必選選項(xiàng)，其他選項(xiàng)都是根據(jù)需要添加的。在這一小節(jié)中。我們將介紹Playbook提供的不同功能，以Playbook的功能為線索，介紹Play與task中可以使用的選項(xiàng)。
（1）權(quán)限
在Ansible中，默認(rèn)使用當(dāng)前用戶連接遠(yuǎn)程服務(wù)器執(zhí)行操作。我們也可以在anaible.cfg文件中配置連接遠(yuǎn)程服務(wù)器的默認(rèn)用戶。此外，如果是不同的用戶使用不同類型的遠(yuǎn)程服務(wù)器，那么也可以在Playbook的Play定義中指定連接遠(yuǎn)程服務(wù)器的用戶。例如，我們可以指定執(zhí)行Play的用戶：
--- - hosts: webservers remote_user: root
用戶可以細(xì)分每一個(gè)task，如下所示：
---
- hosts: werbservers
remote_user: root
tasks:
- name: test connection
ping:
remote_user: yourname
很多時(shí)候，我們需要的不是以某個(gè)特定用戶連接遠(yuǎn)程服務(wù)器，而是在需要更高級(jí)別的權(quán)限時(shí)，使用管理員身份去執(zhí)行操作。在ansible中，可以通過(guò)become與become_ method選項(xiàng)實(shí)現(xiàn)：
--- - hosts: werbservers remote_user: root become: yes
與remote_user選項(xiàng)類似，我們也可以為單個(gè)任務(wù)使用管理員權(quán)限，如下所示：
--- - hosts: werbservers remote_user: yourname tasks: - name: installed nginx service: name=nginx state=started become: yes become_method: sudo
實(shí)例
先修改遠(yuǎn)程服務(wù)器中test的權(quán)限為（0:0）
[root@192 ~]# vim /etc/passwd
test:x:0:0::/home/test:/bin/bash
[root@python ~]# chown test:root /etc/ansible/*
[root@python ~]# su test
[test@python root]$ cd
[test@python ~]$ vim hosts
[db]
192.168.1.60
[test@python ~]$ vim db.yml
---
- hosts: db
remote_user: root #遠(yuǎn)程服務(wù)器登陸的用戶
tasks:
- name: installed nginx
become: yes
become_method: sudo
ping:
remote_user: root #遠(yuǎn)程服務(wù)器登陸的用戶
[test@python ~]$ vim /etc/ansible/ansible.cfg
[defaults]
inventory = /home/test/hosts
執(zhí)行一下
[test@python ~]$ sudo ansible-playbook db.yml --step We trust you have received the usual lecture from the local System Administrator. It usually boils down to these three things: #1) Respect the privacy of others. #2) Think before you type. #3) With great power comes great responsibility. [sudo] password for test: PLAY [db] ********************************************************************** Perform task: TASK: Gathering Facts (N)o/(y)es/(c)ontinue: y Perform task: TASK: Gathering Facts (N)o/(y)es/(c)ontinue: ********************* TASK [Gathering Facts] ********************************************************* Enter passphrase for key '/root/.ssh/id_rsa': ok: [192.168.1.60] Perform task: TASK: installed nginx (N)o/(y)es/(c)ontinue: Perform task: TASK: installed nginx (N)o/(y)es/(c)ontinue: ********************* PLAY RECAP ********************************************************************* 192.168.1.60 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
（2）通知
在Ansible中，模塊是冪等的。例如，我們要在遠(yuǎn)程服務(wù)器上創(chuàng)建一個(gè)用戶，如果該用戶已經(jīng)存在，那么Ansible不會(huì)將該用戶刪除以后重新創(chuàng)建，而是直接返回成功，并通過(guò)changed字段表示是否對(duì)遠(yuǎn)程服務(wù)器進(jìn)行了修改。
考慮這樣一種需求：我們要通過(guò)Ansible修改Apache的配置文件，并重啟Apache服務(wù)，使得新的配置文件生效。由于Ansible的模塊是冪等的，當(dāng)我們修改Apache的配置文件時(shí)，如果配置文件的內(nèi)容已經(jīng)與我們想要修改成的內(nèi)容一樣（例如，不小心將Ansible執(zhí)行了兩次的情況），那么，Ansible就什么也不做。既然Apache的配置文件并沒(méi)有真的被修改，那么我們也不應(yīng)該去重啟Apache的服務(wù)器。在Ansible中，通過(guò)notify與handler機(jī)制來(lái)實(shí)現(xiàn)這里的功能。
在下面的例子中，我們首先嘗試安裝Apache，然后修改Apache的配置文件。如果配置文件被修改，則通過(guò)notify選項(xiàng)通知handler進(jìn)行后續(xù)處理。
handler是Ansible提供的條件機(jī)制，與tasks比較類似，都是去執(zhí)行某些操作。但是，handler只有在被notify觸發(fā)以后才會(huì)執(zhí)行，如果沒(méi)有被觸發(fā)則不會(huì)執(zhí)行。在Playbook中，如果task后面存在notify選項(xiàng)，那么，當(dāng)Ansible識(shí)別到task改變了系統(tǒng)的狀態(tài)，就會(huì)通過(guò)notify去觸發(fā)handler。
Ansibie是通過(guò)什么條件判斷notify觸發(fā)的是哪一個(gè)handler呢？很簡(jiǎn)單，在Ansible中，task使用handler的名字作為參數(shù)，以此來(lái)觸發(fā)特定的handler。例如，在我們這里的例子中，notify觸發(fā)的是“restart apache"這個(gè)handler, handlers中也存在一個(gè)名為" restart apache“的handler。
--- - hosts: webservers tasks: - name: ensure apache is at the latest version yum: name=httpd state=latest - name: write the apache config file template: src=/srv/httpd.j2 dest=/etc/httpd.conf notify: - restart apache - name: ensure apache is running service: name=httpd state=started handlers: - name: restart apache service: name=httpd state=restarted
需要注意的是，handler只會(huì)在所有task執(zhí)行完后執(zhí)行。并且，即便一個(gè)handler被觸發(fā)多次，它也只會(huì)執(zhí)行一次。handler并不是在被觸發(fā)時(shí)立即執(zhí)行，而是按照Play中定義的順序執(zhí)行。一般情況下，handler都位于Play的最后，即在所有任務(wù)執(zhí)行完成以后再執(zhí)行。
Ansible官方文檔提到handler的唯一用途，就是重啟服務(wù)與服務(wù)器，正如找們這個(gè)例子所演示的。
在這個(gè)例子中，我們還用到T了template模塊。template模塊用以渲染Jinja模板。
（3）變量
在Inventory管理章節(jié)，我們已經(jīng)介紹了如何定義變量。在Ansible中，還有其他幾種定義變量的方式。對(duì)于簡(jiǎn)單的Playbook，最直接的方式是將變量定義在Playbook的vars選項(xiàng)中。如下所示：
- hosts: dbservers vars: mysql_port: 3307
在Playbook中定義變量，可以在模板渲染時(shí)使用。例如：Ansible官方給出的例子中，MySQL配置文件的部分模板如下：
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
user=mysql
port={{ mysql_port }}
當(dāng)變量較少的時(shí)候，定義在vars選項(xiàng)中完全沒(méi)有問(wèn)題。當(dāng)變量較多時(shí)，可以將變量保存在一個(gè)獨(dú)立的文件中，并通過(guò)vars_files選項(xiàng)引用該文件。如下所示：
--- - hosts: all vars: favcolor: blue vars_files: - /vars/external_vars.yml tasks: - name: this is just a placeholer command: /bin/echo foo
保存變量的文件是一個(gè)簡(jiǎn)單的YAML格式的字典，如下所示：
--- # in th above example, this would be vars/external_vars.yml somevar: somevalue password: magic
在shell腳本中，我們可以通過(guò)獲取上一條命令的返回碼判斷命令是否執(zhí)行成功。在Ansible中，我們也可以獲取任務(wù)的執(zhí)行結(jié)果，將任務(wù)的執(zhí)行結(jié)果保存在一個(gè)變最中，并在之后引用這個(gè)變量。這樣的變量在Ansible中使用register選項(xiàng)獲取，也稱為注冊(cè)變量。
例如，在下面這個(gè)例子中，我們首先執(zhí)行/usr/bin/foo命令，并通過(guò)register選項(xiàng)獲取命令的執(zhí)行結(jié)果，將結(jié)果保存在foo_result中。在之后的task中，使用這個(gè)變量名引用/usr/bin/foo命令的執(zhí)行結(jié)果。
- hosts: web_servers tasks: - shell: /usr/bin/foo register: foo_result ignore_errors: True - shell: /usr/bin/bar when: foo_result == 5
這個(gè)例子還涉及了兩個(gè)新的選項(xiàng)，分別是ignore_errors與when。前者表示忽略當(dāng)前task中的錯(cuò)誤，后者是一個(gè)條件語(yǔ)句，只有條件為真時(shí)才會(huì)執(zhí)行這個(gè)task。
（4）Facts變量
在Ansible中，還有一些特殊的變量，這些變量不需要我們進(jìn)行任何設(shè)置就可以直接使用，這樣的變量稱為Facts變量。Facts變量是Ansible執(zhí)行遠(yuǎn)程部署之前從遠(yuǎn)程服務(wù)器中獲取的系統(tǒng)信息，包括服務(wù)器的名稱、IP地址、操作系統(tǒng)、分區(qū)信息、硬件信息等。Facts變量可以配合Playbook實(shí)現(xiàn)更加個(gè)性化的功能需求。例如，將MongoDB數(shù)據(jù)庫(kù)的數(shù)據(jù)保存在/var/mongo-\<hostname>/目錄下。
我們可以通過(guò)setup模塊查看Facts變量的列表，如下所示：
ansible all -m setup
有了Facts變量以后，如何在Ansible中使用它們呢？答案是直接使用。我們可以在Playbook中直接通過(guò)變量的名字引用變量，也可以在Jinja2模板中通過(guò)變量的名字引用變量。下面是一個(gè)名為test_facts.yml的Playbook。在這個(gè)Playbook中，我們輸出了操作系統(tǒng)的類型，并且只有在操作系統(tǒng)為“RedHat"類操作系統(tǒng)時(shí)才會(huì)執(zhí)行安裝操作。
---
- hosts: dbservers
tasks:
- shell: echo {{ ansible_os_family }}
register: myecho
- debug: var=myecho.stdout_lines
- name: install git on Red Hat Linux
yum: name=git state=installed
when: ansible_os_family == "RedHat"
setup模塊為了輸出結(jié)果的可讀性，對(duì)模塊的輸出進(jìn)行了歸類和整理。因此，當(dāng)我們要訪問(wèn)復(fù)雜變量的子屬性時(shí)，需要使用嵌套結(jié)構(gòu)。例如，我們可以通過(guò)下面兩種方式訪問(wèn)Ansible中的ipv4地址：
ansible_ens33['ipv4']['address'] ansible_ens33.ipv4.address
訪問(wèn)復(fù)雜的變量的Playbook：
---
- hosts: dbservers
gather_facts: yes
tasks:
- shell: echo {{ ansible_ens33['ipv4']['address'] }}
register: myecho
- debug: var=myecho.stdout_lines
- shell: echo {{ ansible_ens33.ipv4.address }}
register: myecho
- debug: var=myecho.stdout_lines
在實(shí)際工作中，我們一般會(huì)在Jinja2模板中引用Facts變量。使用方式與這里的例子一樣，為了節(jié)省篇幅就不再贅述了。
在Playbook中，可以通過(guò)gather_ facts選項(xiàng)控制是否收集遠(yuǎn)程服務(wù)器的信息。該選項(xiàng)默認(rèn)取值為yes，如果確定不需要用到遠(yuǎn)程服務(wù)器的信息，可以將該選項(xiàng)設(shè)置為no，以此提高Ansible部署的效率。如下所示：
--- - hosts: dbservers gather_factes: no tasks:
（5）循環(huán)
- name: Install Mysql package
yum: name={{ item }} state=installed
with_items:
- mysql-server
- MySQL-python
- libselinux-python
- libsemanage-python
（6）條件
有時(shí)候，一個(gè)任務(wù)是否執(zhí)行取決于一個(gè)變量的取值，或者上一個(gè)任務(wù)的執(zhí)行結(jié)果，這個(gè)時(shí)候找們就需要條件語(yǔ)句。再或者說(shuō)，在循環(huán)的時(shí)候想要跳過(guò)一些特定的元素，在服務(wù)器部署時(shí)只對(duì)某些特定的操作系統(tǒng)進(jìn)行操作。所有這些行為都可以使用條件語(yǔ)句解決。Ansible的Playbook不是一門(mén)編程語(yǔ)言，因此沒(méi)有相應(yīng)的條件語(yǔ)句，不過(guò)Ansible提供了一個(gè)類似的選項(xiàng)。
在Playbook中可以通過(guò)when選項(xiàng)執(zhí)行條件語(yǔ)句，when就類似于編程語(yǔ)言中的if語(yǔ)句。
下面是一個(gè)簡(jiǎn)單的when選項(xiàng)使用示例：
# 查看Linux系統(tǒng)版本：cat /etc/redhat-release tasks: - name: "系統(tǒng)關(guān)機(jī)" command: /sbin/shutdown -t now when: ansible_os_family == "RedHat"
when選項(xiàng)也支持多個(gè)條件語(yǔ)句，下面是一個(gè)YAML格式的多條件：
tasks: - name: "shutdown CentOS 7 systems" command: /sbin/shutdown -t now when: - ansible_distribution == "CentOS" - ansible_distribution_major_version == "7"
對(duì)于更復(fù)雜的條件可以使用and、or與括號(hào)進(jìn)行定義：
tasks: - name: "shutdown CentOS 7 and Debian 6 systems" command: /sbin/shutdown -t now when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "7") or (ansible_distribution == "Debian" and ansible_distribution_major_version == "6")
在when選項(xiàng)中可以讀取變量的取值，例如：
vars: epic: true tasks: - shell: echo "This certainly is epic!" when: epic
when選項(xiàng)可以與循環(huán)一起使用，以實(shí)現(xiàn)過(guò)濾的功能：
tasks:
- command: echo {{ item }}
with_items: [0, 2, 4, 6, 8, 10]
when: item > 5
（7）任務(wù)執(zhí)行策略
在Ansible中，Playbook的執(zhí)行是以task為單位進(jìn)行的。Ansible默認(rèn)使用5個(gè)進(jìn)程對(duì)遠(yuǎn)程服務(wù)器執(zhí)行任務(wù)。在默認(rèn)情況的任務(wù)執(zhí)行策略( linear)中，Ansible首先執(zhí)行task1，并且等到所有服務(wù)器執(zhí)行完task1以后再開(kāi)始執(zhí)行task2，以此類推。從Ansible 2.0開(kāi)始，Ansible支持名為free的任務(wù)執(zhí)行策略，允許執(zhí)行較快的遠(yuǎn)程服務(wù)器提前完成Play的部署，不用等待其他遠(yuǎn)程服務(wù)器一起執(zhí)行task。如下所示：
- hosts: all strategy: free tasks: ……
在這一節(jié)中，我們比較詳細(xì)地介紹了Ansible中的Playbook選項(xiàng)。在Ansible中，Play與task都有很多選項(xiàng)，每個(gè)選項(xiàng)可以實(shí)現(xiàn)不同的功能。Ansibie官方并沒(méi)有通過(guò)功能的形式介紹不同的選項(xiàng)給出一個(gè)完整的選項(xiàng)列表。我們也可以參考https://github.com/lorin/ansible-quickref快速了解Play與task中的選項(xiàng)，以及各個(gè)選項(xiàng)的含義。
4、案例：使用Playbook部署nginx
wget -O /etc/yum.repos.d/epel.repo http://mirrors.aliyun.com/repo/epel-7.repo //下載源
在這個(gè)例子中，我們使用Ansible配置一臺(tái)服務(wù)器運(yùn)行nginx進(jìn)程。部署nginx的Playbook如下：
---
- hosts: webservers
become: yes
become_method: sudo
vars:
worker_prosess: 4
worker_connections: 768
max_open_files: 65506
tasks:
- name: install nginx
yum: name=nginx update_cache=yes state=present
- name: copy nginx config file
template: src=/root/test_ansible/nginx.conf.j2 dest=/etc/nginx/nginx.conf
notify: restart nginx
- name: copy index.html
template:
src: /root/test_ansible/index.html.j2
dest: /usr/share/nginx/www/index.html
mode: 0644
notify: restart nginx
handlers:
- name: restart nginx
service: name=nginx state=restarted
在這個(gè)Playbook中，我們首先通過(guò)hosts選項(xiàng)指定了要對(duì)哪些遠(yuǎn)程服務(wù)器執(zhí)行操作。隨后，我們通過(guò)become與become_method選項(xiàng)聲明了部署時(shí)使用sudo權(quán)限。接下來(lái)，我們?cè)趘ars字段中定義了三個(gè)變量，這三個(gè)變量將用在nginx的配置文件中。我們?cè)趖asks選項(xiàng)下定義了部署nginx服務(wù)的任務(wù)列表，包括軟件安裝、模板渲染、定制s首頁(yè)和重啟nginx進(jìn)程。
為了避免配置文件在沒(méi)有任何修改的情況下重啟了nginx進(jìn)程，這里使用了Ansible的handler機(jī)制。在這個(gè)Playbook中，存在兩個(gè)notify選項(xiàng)，以及一個(gè)handler選項(xiàng)。無(wú)論是nginx的配置文件，還是定制首頁(yè)發(fā)生了修改，我們都會(huì)重啟nginx進(jìn)程。由于我們使用了Ansible的handlers機(jī)制，因此，在沒(méi)有任何修改的情況下，Ansible并不會(huì)重啟nginx進(jìn)程。使用handler機(jī)制還有一個(gè)好處，notify多次，handler也只會(huì)執(zhí)行一次，避免了反復(fù)多次重啟nginx進(jìn)程。
在這個(gè)部署nginx服務(wù)的Playbook中，我們用到了nginx.conf.j2這個(gè)配置模板。這個(gè)模板使用的是Jinja2的語(yǔ)法，所以后綴名為j2。模板的內(nèi)容如下：
[root@python ~]# mkdir test_ansible
[root@python ~]# vim /root/test_ansible/nginx.conf.j2
worker_processes {{ worker_prosess }};
worker_rlimit_nofile {{ max_open_files }};
events {
worker_connections {{ worker_connections }};
}
http {
server {
listen 80;
listen 443 ssl;
server_name localhost;
location / {
root /usr/share/nginx/www;
index index.html index.htm;
tr_files $uri $uri/ =404;
}
}
}
Ansible會(huì)使用我們?cè)赑laybook的vars字段中定義的變量，將Jinja2模板渲染成真實(shí)的配置文件。
我們的Playbook還用到了一個(gè)名為index.html.j2的模板，該模板用于渲染網(wǎng)站首頁(yè)。index.html.j2的內(nèi)容如下：
[root@python ~]# vim /root/test_ansible/index.html.j2
<html>
<meta charset="utf-8">
<head>
<title>wellcome to ansible</title>
</head>
<body>
<h1>nginx, configured by ansible</h1>
<p>如果你能看到這個(gè)頁(yè)面，說(shuō)明ansible自動(dòng)部署nginx成功了！</p>
<p>{{ ansible_hostname }}<p>
</body>
</html>
在index.html.j2中，我們用到了一個(gè)名為ansible_hostname的變量。這個(gè)變量是Facts變量，是Ansible在執(zhí)行Playbook之前從遠(yuǎn)程服務(wù)器獲取到的信息。因此，我們不需要定義，直接使用即可。
有了Playbook以后，使用ansible-playbook命令進(jìn)行部署。如下所示：
[root@python ~]# pip install Jinja2 [root@python ~]# vim /etc/ansible/ansible.cfg [defaults] inventory = /root/hosts [root@bogon ~]# ansible-playbook nginx.yml PLAY [webservers] ********************************************************************************************************** TASK [Gathering Facts] ***************************************************************************************************** ok: [127.0.0.1] TASK [install nginx] ******************************************************************************************************* ok: [127.0.0.1] TASK [copy nginx config file] ********************************************************************************************** ok: [127.0.0.1] TASK [copy index.html] ***************************************************************************************************** ok: [127.0.0.1] PLAY RECAP ***************************************************************************************************************** 127.0.0.1 : ok=4 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 [root@bogon ~]#
如果安裝失敗，可能是端口被占用，可以停止使用該端口的服務(wù)，或者更改nginx端口。
[root@bogon ~]# netstat -ntlp Active Internet connections (only servers) Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name tcp 0 0 0.0.0.0:111 0.0.0.0:* LISTEN 1/systemd tcp 0 0 0.0.0.0:6000 0.0.0.0:* LISTEN 7470/X tcp 0 0 192.168.122.1:53 0.0.0.0:* LISTEN 7654/dnsmasq tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 7337/sshd tcp 0 0 127.0.0.1:631 0.0.0.0:* LISTEN 7340/cupsd tcp 0 0 127.0.0.1:6010 0.0.0.0:* LISTEN 31653/sshd: root@pt tcp 0 0 127.0.0.1:6011 0.0.0.0:* LISTEN 31653/sshd: root@pt tcp 0 0 127.0.0.1:6012 0.0.0.0:* LISTEN 31653/sshd: root@pt tcp6 0 0 :::111 :::* LISTEN 1/systemd tcp6 0 0 :::80 :::* LISTEN 17867/httpd tcp6 0 0 :::6000 :::* LISTEN 7470/X tcp6 0 0 :::22 :::* LISTEN 7337/sshd tcp6 0 0 ::1:631 :::* LISTEN 7340/cupsd tcp6 0 0 ::1:6010 :::* LISTEN 31653/sshd: root@pt tcp6 0 0 ::1:6011 :::* LISTEN 31653/sshd: root@pt tcp6 0 0 ::1:6012 :::* LISTEN 31653/sshd: root@pt [root@bogon ~]# systemctl stop httpd.service
第二臺(tái)服務(wù)器啟動(dòng)一下nginx
[root@192 ~]# nginx -t nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful [root@192 ~]# nginx nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use) nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use) nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use) nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use) nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use) nginx: [emerg] still could not bind()
瀏覽器訪問(wèn)一下
到此這篇關(guān)于python中Ansible模塊的Playbook的具體使用的文章就介紹到這了,更多相關(guān)python Ansible Playbook內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了Python字符串和文件操作常用函數(shù),實(shí)例分析了Python中字符串及文件操作的常用技巧,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2015-04-04
Python+OpenCV實(shí)現(xiàn)車牌字符分割和識(shí)別
這篇文章主要為大家詳細(xì)介紹了Python+OpenCV實(shí)現(xiàn)車牌字符分割和識(shí)別，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-03-03
Pandas數(shù)據(jù)集的合并與連接merge()方法
Pandas數(shù)據(jù)集的合并與連接（merge()）是數(shù)據(jù)處理過(guò)程中常用的操作之一,在使用Pandas進(jìn)行數(shù)據(jù)集合并時(shí),可以使用merge()函數(shù)將兩個(gè)或多個(gè)數(shù)據(jù)集按照指定的列進(jìn)行合并,本文就來(lái)介紹一下,感興趣的可以了解一下2023-11-11
python對(duì)指定目錄下文件進(jìn)行批量重命名的方法
這篇文章主要介紹了python對(duì)指定目錄下文件進(jìn)行批量重命名的方法,涉及Python中replace及join方法的使用技巧,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2015-04-04
Python實(shí)現(xiàn)上下文管理器的示例代碼
這篇文章主要為大家詳細(xì)介紹了Python中實(shí)現(xiàn)上下文管理器的具體方法，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以跟隨小編一起了解一下2023-07-07
今天小編就為大家分享一篇關(guān)于Python3字符串encode與decode的講解，小編覺(jué)得內(nèi)容挺不錯(cuò)的，現(xiàn)在分享給大家，具有很好的參考價(jià)值，需要的朋友一起跟隨小編來(lái)看看吧2019-04-04
Python實(shí)現(xiàn)switch/case語(yǔ)句
與Java、C\C++等語(yǔ)言不同，Python中是不提供switch/case語(yǔ)句的，這一點(diǎn)讓我感覺(jué)到很奇怪。我們可以通過(guò)如下幾種方法來(lái)實(shí)現(xiàn)switch/case語(yǔ)句2021-08-08
python數(shù)據(jù)類型_元組、字典常用操作方法(介紹)
下面小編就為大家?guī)?lái)一篇python數(shù)據(jù)類型_元組、字典常用操作方法(介紹)。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-05-05
Python中的map()函數(shù)和reduce()函數(shù)的用法
這篇文章主要介紹了Python中的map()函數(shù)和reduce()函數(shù)的用法,代碼基于Python2.x版本,需要的朋友可以參考下2015-04-04
本文給大家分享的是PyCharm開(kāi)發(fā)工具的快捷鍵大全整理,非常詳細(xì),適合使用PyCharm作為開(kāi)發(fā)工具的開(kāi)發(fā)人員參考使用,能夠幫助提高開(kāi)發(fā)效率和速度2020-02-02