自動化運維Ansible之Playbook劇本
Playbook是由一個或多個play組成的列表,主要功能是將task定義好的角色並為一組進行統一管理,也就是通過task調用Ansible的模板將多個play組織在一個Playbook中運行
Playbook本身由以下各部分組成:
- Tasks:任務,調用模塊完成的某操作
- Variables:變量
- Templates:模板
- Handlers:處理器 ,當某條件滿足時,觸發執行的操作
- Roles:角色
執行一個playbook
ansible-playbook [yaml文件名]
例如:ansible-playbook ping.yaml
參數:-k(–ask-pass) 用來交互輸入ssh密碼 -K(-ask-become-pass) 用來交互輸入sudo密碼 -u 指定用戶
補充命令:
ansible-playbook nginx.yaml --syntax-check #檢查yaml文件的語法是否正確
ansible-playbook nginx.yaml --list-task #檢查tasks任務
ansible-playbook nginx.yaml --list-hosts #檢查生效的主機
ansible-playbook nginx.yaml --start-at-task=‘Copy Nginx.conf‘ #指定從某個task開始運行
hosts和users介紹
Playbook的設計目的是為了讓某個或某些主機以某個用戶的身份去執行相應的任務。其中用於指定要執行指定任務的主機用hosts定義,可以是一個主機也可以是由冒號分隔的多個主機組;用於指定被管理主機上執行任務的用戶用remote_ser來定義。
- hosts: xxy //指定主機組,可以是一個或多個組。
remote_user: root //指定遠程主機執行的用戶名
還可以為每個任務定義遠程執行用戶:
- hosts: xxy
remote_user: root
tasks:
- name: test connection
ping:
remote_user: zhangsan //指定遠程主機執行tasks的運行用戶為zhangsan
指定遠程主機sudo切換用戶:
vim sudo.yaml - hosts: xxy remote_user: root become: yes //2.6版本以後的參數,之前是sudo,意思為切換用戶運行 become_user: zhangsan //指定sudo用戶為zhangsan 執行:ansible-playbook sudo.yaml -K
tasks列表和action
- Play的主體部分是task列表,task列表中的各任務按次序逐個在hosts中指定的主機上執行,即在所有主機上完成第一個任務後再開始第二個任務。在運行playbook時(從上到下執行),如果一個host執行task失敗,整個tasks都會回滾,請修正playbook中的錯誤,然後重新執行即可。Task的目的是使用指定的參數執行模塊,而在模塊參數中可以使用變量,模塊執行時冪等的,這意味著多次執行是安全的,因為其結果一致。
- 每一個task必須有一個名稱name,這樣在運行playbook時,從其輸出的任務執行信息中可以很好的辨別出是屬於哪一個task的。如果沒有定義name,‘action’的值將會用作輸出信息中標記特定的task。
- 定義一個task,常見的格式:”module: options” 例如:yum: name=httpd
- ansible的自帶模塊中,command模塊和shell模塊無需使用key=value格式
小示例:
vim http.yaml
- hosts: 192.168.1.25
remote_user: root
tasks:
- name: disable selinux
command: ‘/sbin/setenforce 0‘
- name: make sure apache is running
service: name=httpd state=started
ansible-playbook http.yaml
正常執行
修改如下
- hosts:192.168.1.25
remote_user: root
tasks:
- name: disable selinux
command: ‘/sbin/setenforc 0‘ //故意寫錯setenforc
ignore_errors: True //忽略錯誤,強制返回成功
- name: make sure apache is running
service: name=httpd state=started
執行結束,沒有中途停止
Handlers介紹
Handlers也是一些task的列表,和一般的task並沒有什麽區別。是由通知者進行的notify,如果沒有被notify,則Handlers不會執行,假如被notify了,則Handlers被執行,不管有多少個通知者進行了notify,等到play中的所有task執行完成之後,handlers也只會被執行一次
示例
vim http.yaml
- hosts: xxy
remote_user: root
tasks:
- name: install httpd package
yum: name=httpd state=latest
- name: install configuration file for httpd
copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
-restart httpd
- name: start httpd service
service: enabled=true name=httpd state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
ansible-playbook http.yaml
也可以引入變量
- hosts: xxy
remote_user: root
vars:
- package: httpd //變量
- service: httpd //變量
tasks:
- name: install httpd package
yum: name={{package}} state=latest
- name: install configuration file for httpd
copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
-restart httpd
- name: start httpd service
service: enabled=true name={{service}} state=started
handlers:
- name: restart httpd
service: name={{service}} state=restarted
playbook使用變量的方法
1.通過ansible命令傳遞
vi user.yaml
- hosts: xxy
remote_user: root
vars:
- user: //此處先不指定
tasks:
- name: add new user
user: name={{user}}
執行:ansible-playbook user.yml -e "user=wangwu"
可以執行命令查看:ansible xxy -m command -a ‘tail /etc/passwd‘
2.直接在yaml中定義變量,如上handlers示例
3.直接引用一些變量
如:引用ansible的固定變量
vi test.yaml
- hosts: xxy
remote_user: root
tasks:
- name: copy file
copy: content="{{ansible_all_ipv4_addresses}}," dest=/opt/vars.txt
執行:ansible-playbook test.yaml
執行:ansible xxy -a ‘cat /opt/vars.txt‘ //查看文件內容
4.引用主機變量
vi /etc/ansible/hosts //在xxy組的主機後面添加如下
[xxy]
192.168.1.25 testvar="haha" //定義testvar變量的值為haha
vi test.yml //添加{{testvar}}主機變量
- hosts: xxy
remote_user: root
tasks:
- name: copy file
copy: content="{{ansible_all_ipv4_addresses}},{{testvar}}" dest=/opt/vars.txt
執行:ansible-playbook test.yml
執行:ansible xxy -a ‘cat /opt/vars.txt‘ //查看文件內容
條件測試
如果需要根據變量、facts(setup)或此前任務的執行結果來作為某task執行與否的前提時要用到條件測試,在Playbook中條件測試使用when子句。
在task後添加when子句即可使用條件測試:when子句支持jinjia2表達式或語法,例如:
vi when.yaml
- hosts: xxy
remote_user: root
tasks:
- name: "shutdown CentOS"
command: /sbin/shutdown -h now
when: ansible_distribution == "CentOS"
//如果被控制端是CentOS系統,則立即關閉
多條件判斷
vi when.yaml
- hosts: xxy
remote_user: root
tasks:
- name: "shut down CentOS 7 systems"
command: /sbin/shutdown -r now
when:
- ansible_distribution == "CentOS"
- ansible_distribution_major_version == "7"
//如果被控制端是CentOS系統,版本是7,則立即關閉
組條件判斷
vi when.yaml
- hosts: xxy
remote_user: root
tasks:
- name: "shut down CentOS 6 and Debian 7 systems"
command: /sbin/shutdown -t now
when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "6") or
(ansible_distribution == "Debian" and ansible_distribution_major_version == "7")
//如果被控制端是CentOS 6 系統,Debian 7 系統,則立即關閉
自定義變量進行條件測試
vi when.yaml
- hosts: all
vars:
exist: "True" //定義變量
tasks:
- name: creaet file
command: touch /tmp/test.txt
when: exist | match("True") //True則創建文件
- name: delete file
command: rm -rf /tmp/test.txt
when: exist | match("False") //False則刪除文件
叠代
當有需要重復性執行的任務時,可以使用叠代機制。其使用格式為將需要叠代的內容定義為item變量引用,並通過with_items語句指明叠代的元素列表即可。
- hosts: xxy
remote_user: root
tasks:
- name: "Install Packages"
yum: name={{ item }} state=latest
with_items:
- httpd
- mysql-server
- php //依次安裝這三個包
Templates介紹
Jinja是基於Python的模板引擎。template類是Jinja的另一個重要組件,可以看作一個編譯過的模塊文件,用來生產目標文本,傳遞Python的變量給模板去替換模板中的標記。
編輯好模板
管理端:
mkdir templates
cp conf/httpd.conf templates/httpd.conf
vi templates/httpd.conf
Listen {{http_port}}
ServerName {{server_name}}
MaxClients {{access_num}}
編輯主機變量
vi /etc/ansible/hosts
[xxy]
192.168.1.25 http_port=192.168.1.25:80 access_num=100 server_name="www.xxy.com:80"
編輯yaml文件
vi apache.yaml
- hosts: xxy
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd package
yum: name={{package}} state=latest
- name: install configure file
template: src=/templates/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
- restart httpd
- name: start httpd server
service: name={{service}} enabled=true state=started
handlers:
- name: restart httpd
service: name={{service}} state=restarted
執行:ansible-playbook apache.yaml
可以去被控制端主機上查看是否已修改好配置文件
grep -i listen /etc/httpd/conf/httpd.conf
grep -i MaxClients /etc/httpd/conf/httpd.conf
grep -i ServerName /etc/httpd/conf/httpd.conf
tags模塊
在一個playbook中,我們一般會定義很多個task,如果我們只想執行其中的某一個task或多個task時就可以使用tags標簽功能了,格式如下:
vi hosts.yaml
- hosts: xxy
remote_user: root
tasks:
- name: Copy hosts file
copy: src=/etc/hosts dest=/etc/hosts
tags:
- only //定義標簽
- name: touch file
file: path=/opt/hosts state=touch
執行:ansible-playbook hosts.yml --tags="only"
#只執行標簽部分內容
事實上,不光可以為單個或多個task指定同一個tags。playbook還提供了一個特殊的tags為always。作用就是當使用always當tags的task時,無論執行哪一個tags時,定義有always的tags都會執行。
vi hosts.yaml
---
- hosts: xxy
remote_user: root
tasks:
- name: Copy hosts file
copy: src=/etc/hosts dest=/etc/hosts
tags:
- only
- name: touch file
file: path=/opt/hosts state=touch
tags:
- always
執行:ansible-playbook hosts.yml --tags="only"
#雖然指定執行only標簽內容,但是由於下面定義了always標簽,所以任然執行了
自動化運維Ansible之Playbook劇本