Ansible-playbook 快速入門到放棄
隔岸紅塵忙似火,當軒青嶂冷如冰。
1-簡介
playbook 相當於可以把模塊命令都寫入到配置文件裏面,這樣就可以直接執行配置文件了,類似腳本。
2-playbook 初體驗
編寫test.yml 文件,在serviceA 主機機器上的/opt/tjt 路徑下創建test.txt 文件。
1 --- 2 - hosts: serviceA 3 remote_user: root 4 tasks: 5 - name: "使用touch 命令創建test.txt文件" 6 shell: touch /opt/tjt/test.txt
文件格式說明
- 第一行需要有三個槓,hosts 參數指定了對哪些主機進行參作,如果是多臺機器可以用逗號作爲分隔,也可以使用主機組,在/etc/ansible/hosts裏定義;
- user 參數指定了使用什麼用戶登錄遠程主機操作;
- tasks 指定了一個任務,其下面的name 參數同樣是對任務的描述,在執行過程中會打印出來,shell 是ansible 模塊名字。
編輯完成之後,使用ansible-playbook 命令執行test.yml 文件。
[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/test.yml
然後到客戶端上看看是否有創建test.txt 文件。
[root@localhost ~]# ls -l /opt/tjt/test.txt
3-playbook 變量
通過創建用戶體驗playbook 的變量使用方式。
--- - name: "創建test用戶" hosts: 192.168.8.136 user: root gather_facts: false vars: - user: "test" tasks: - name: "---playbook變量----創建test用戶---" user: name="{{ user }}"
說明:
- name:對該playbook 實現的功能做一個概述,後面執行過程中,會打印 name 變量的值 ,可以省略;
- gather_facts:指定了在以下任務部分執行前,是否先執行setup 模塊獲取主機相關信息,如果需要在後面的tasks裏獲取setup收集到的信息,就需要把這個參數設置爲True;
- vars:指定了變量,這裏聲明瞭一個user 變量,其值爲test ,需要注意的是,變量值一定要用引號引住;
- user:提定了調用user 模塊,name是user 模塊裏的一個參數,而增加的用戶名字調用了上面user 變量的值。
執行該文件:
[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/create_user.yml
到客戶端上看看用戶是否已創建:
[root@localhost ~]# id test
4-playbook 循環
--- - hosts: 192.168.8.136 user: root tasks: - name: "playbook---循環" file: path=/opt/tjt/{{ item }} state=touch mode=600 with_items: - 1.txt - 2.txt - 3.txt
參數說明
- file 模塊可以對文件進行相關的操作,例如創建文件或者更改文件權限等,具體可以查看該模塊的文檔。
- with_items 爲循環的對象,相當於是一個數組或集合,寫在下面的1.txt、2.txt 以及3.txt 是該集合的元素。而item 則表示的是遍歷出來的元素,也就是說item 指代的是1.txt、2.txt 以及3.txt。
- state 的值設置爲touch 表示如果該文件不存在就進行創建。
- path 表示文件的路徑。
- mode 設置權限。
執行該文件:
[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/while.yml
到客戶端上看看文件是否已創建:
[root@localhost ~]# ll /opt/tjt/*.txt
5-playbook 條件判斷
一般以setup 模塊收集到的主機信息,來作爲判斷條件。所以在編寫代碼之前,我們需要先獲取相應的信息,例如我要以ip 地址來作爲判斷條件,那麼我就得先從setup 裏獲取主機ip的相關信息。執行以下命令可以查看到setup 收集到的所有的facter 信息,輸出的信息是JSON格式的:
[root@localhost tjt]# ansible serviceA -m setup
通過一個簡單的創建文件的例子體驗playbook 條件判斷語句的使用方式,編寫 when.yml 文件內容如下:
--- - hosts: serviceA user: root gather_facts: True tasks: - name: "playbook---條件判斷" shell: touch /opt/tjt/when.txt when: ansible_virbr0.ipv4.address == "192.168.122.1"
參數說明
- ansible_virbr0 是一個數組存儲着網卡相關信息,ipv4 屬於該數組的子元素,但是ipv4也是一個數組,而address 則是ipv4 數組的子元素,我們需要使用address 來作爲判斷條件,所以要訪問address 就需要使用這樣的格式:ansible_virbr0.ipv4.address,address 表示的是鍵,而"192.168.122.1"則是值,when 爲判斷語句相當於if,所以其判斷條件爲:該鍵的值爲"192.168.122.1"時就執行shell 模塊裏定義的語句。
- gather_facts: True ,在遠程主機運行setup 模塊,並將收集的信息記錄起來(等於命令ansible all -m setup #查看系統信息),可以通過系統信息來判斷是否執行。
- gather_facts: no ,在不需要獲取機器信息時,根據信息做判斷時,將其關閉,避免影響執行速度。
執行該文件:
[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/when.yml
到客戶端上看看文件是否已創建:
[root@localhost ~]# ll /opt/tjt/when.txt -rw-r--r--. 1 root root 0 2月 21 21:51 /opt/tjt/when.txt [root@localhost ~]#
6-playbook 的handlers
- 有一種情況就是執行了tasks裏面的內容之後,服務器發生了變化,這時我們可能需要執行一些相關的操作。
- 例如我們修改了某個服務的配置文件後,則需要重啓一下服務,而handlers 就是完成這樣的事情的,它相當於編程中的回調函數,當tasks 裏的內容執行成功後,就會執行handlers 裏定義的內容。
- 類似於shell 腳本中的 && 符號,例如 cat 1.txt && rm -f 1.txt ,當 cat 1.txt 命令執行成功之後就會執行 rm -f 1.txt 命令,否則不執行。
--- - name: "playbook中的handlers" hosts: serviceA user: root tasks: - name: copy file copy: src=/opt/tjt/handlers dest=/opt/tjt/handlers.txt notify: test handlers handlers: - name: test handlers shell: echo "This is a test string" >> /opt/tjt/ansible/handlers.txt
參數說明
- 只有copy 模塊執行成功後,纔會去調用下面的handlers 裏定義的內容,去執行handlers 裏面的shell 相關命令,這種比較適合配置文件發生更改後,重啓服務的操作。
- notify 用於指定handlers 的name 參數的值,因爲handlers 可以定義多個,所以需要使用notify 來進行指定調用哪一個。
執行該文件:
[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/handlers.yml
到客戶端上查看文件末尾一行是否爲ansible 執行的echo 寫進的那一行內容。
[root@localhost ~]# tail -n1 /opt/tjt/ansible/handlers.txt
7-Ansible 的roles
role是task文件、變量文件、handlers文件的集合體,這個集合體的顯著特點是:可移植性和可重複執行性。
在實際項目中,通常我們以部署某個服務爲單元作爲一個role ,然後將這些服務單元(role)放在一個roles 目錄下,主playbook 文件通過調用roles目錄下的role,來實現各種靈活多變的部署需求。
roles創建
創建一個role 的方法有兩種:
-
命令mkdir 和touch 行手動創建,即需要哪個目錄和文件就用「mkdir」和「touch」命令創建出來。
-
使用ansible-galaxy 自動初始化一個role,創建完後再刪除不需要的目錄。
使用「ansible-galaxy init」命令創建一個名字爲role_D 的role。
[root@localhost roles]# ansible-galaxy init role_D - Role role_D was created successfully
role 目錄結構
- tasks : 用於存放role_D 的主要任務,也可以添加其他task 文件,供main.yml 調用,從而實現更加複雜的部署功能。
- handlers : 用於存放觸發執行( hanlders )的任務。
- defaults : 用於存放默認變量,優先級最低。
- vars : 用於存放變量文件,role_D 中任務和模版裏用到的變量可以在這裏定義。
- files :用於存放需要拷貝到目的主機的文件,例如,作爲「copy」模塊src 參數的默認根目錄。
- template : 用於存放模版文件,格式爲.j2,文件內容要符合Jinja2 語法規則,通常使用「template」模塊部署服務的配置文件。
- meta : 用於存放role 依賴列表,這個知識點後面會詳細闡述。
- tests : 用於存放測試role 本身功能的playbook 和主機定義文件,在開發測試階段比較常用。
role 中各個目錄下的main.yml 文件很重要,這是ansible 默認加載的YAML 文件。
roles 的引用&執行
可以使用「roles:」語句引用role ,根據需要在主playbook 中引用不同的role,ansible 會把role 所包含的任務、變量、handlers、依賴等加載到playbook中,按照順序執行。
編寫主playbook 文件test_role.yml:
--- - name: "主playbook文件通過調用roles目錄下的role" hosts: serviceA user: root gather_facts: false roles: - roleB - roleA
roleA 和roleB 目錄結構如下:
/opt/tjt/ansible/roles/roleA/tasks/main.yml
--- - name: "調用-roles目錄下的roleA" debug: msg: "msg: roleA被執行"
/opt/tjt/ansible/roles/roleB/tasks/main.yml
--- - name: "調用-roles目錄下的roleB" debug: msg: "age:: roleB被執行"
執行主playbook 文件test_role.yml:
[root@localhost roles]# ansible-playbook /opt/tjt/ansible/test_role.ym
如上,可以看到roleB 和roleA 分別有序執行。
檢索路徑
ansible 如何查找要執行的role,在不使用絕對路徑的情況下(可以這麼配role - role: /opt/tjt/ansible/roles/roleB),ansible 檢索role 的默認路徑有:
- 執行ansible-playbook 命令時所在的當前目錄
- playbook 文件所在的目錄及playbook 文件所在目錄的roles 目錄
- 當前系統用戶下的~/.ansible/roles 目錄
- /usr/share/ansible/roles 目錄
- ansible.cfg 中「roles_path」指定的目錄,默認值爲/etc/ansible/roles 目錄
8-playbook 的chdir
chdir:進入指定目錄,如下chdir,執行ls 命令前,先進入指定目錄/opt/tjt。
[root@localhost roles]# ansible serviceA -m command -a 'chdir=/opt/tjt ls'
9-playbook 的with_items
ansible 中的循環模塊有很多,with_items 最爲簡單常用。
--- - name: "with_items循環遍歷" shell: "echo {{ item }}" register: "with_items_output" with_items: [a,b,c,d]
如上,with_items 可以用於迭代一個列表或字典,通過 {{ item }} 獲取每次迭代的值。