playbook
ansible命令適合執(zhí)行簡單的操作瓶盛。如果要完成一個復雜的部署函筋,需要很多ansible操作榴啸,寫起來會很亂净响。
所以有了ansible-playbook
把一件事切分成很多任務酵镜,有序的組織起來
目錄結構解讀
官方給的playbook工程的最佳實踐
production # 生產(chǎn)環(huán)境的服務器清單
stage # stage環(huán)境的服務器清單
group_vars/
group1 # 這里我們給特定的組賦值
group2 # ""
host_vars/
hostname1 # 主機變量
hostname2 # ""
library/ # 如果有自定義的模塊,放在這里(可選)
filter_plugins/ # 如果有自定義的過濾插件,放在這里(可選)
site.yml # 主 playbook文件
webservers.yml # Web 服務器的 playbook
dbservers.yml # 數(shù)據(jù)庫服務器的 playbook
roles/
common/ # 這個目錄代表了一個名為common的 "role"
tasks/ #
main.yml # <-- tasks file can include smaller files if wanted
handlers/ #
main.yml # <-- handlers file
templates/ # <-- files for use with the template resource
ntp.conf.j2 # <------- templates end in .j2
files/ #
bar.txt # <-- files for use with the copy resource
foo.sh # <-- script files for use with the script resource
vars/ #
main.yml # <-- variables associated with this role
defaults/ #
main.yml # <-- default lower priority variables for this role
meta/ #
main.yml # <-- role dependencies
webserver/ # 像上面的common一樣馍驯,這個目錄代表了一個名為webserver的 "role"
monitoring/ # ""
fooapp/ # ""
第一眼看起來很亂够挂,不要慌掉分,我們一個一個看就清晰了逐虚∏荻睿看完這幾個文件锯厢,也就初步學會playbook了皮官。
其中重點要看的是roles目錄!J导捺氢!
服務器清單文件
比如這里的production和stage文件。在ansible中常稱為inventory file
可以自己根據(jù)需要創(chuàng)建剪撬。
我這里創(chuàng)建一個redis文件摄乒,內(nèi)容如下
[prod]
redis1 ansible_ssh_host=10.178.151.211
[prod]是組名,用中括號括起
下面是在組內(nèi)的服務器地址残黑。
服務器地址這部分可以使用域名馍佑、主機名、IP地址表示梨水。但是使用域名或主機名時拭荤,需要ansible主機能夠反解析到相應的IP地址,所以一般此類配置中多使用IP地址疫诽;
在這個例子中舅世,redis1是自定義的主機名別名,具體的ip寫在ansible_ssh_host奇徒。
ansible_ssh_host是ansible內(nèi)置的inventory參數(shù)雏亚,下面講。
主機變量
在主機條目上可以加變量摩钙,以便后面的playbook執(zhí)行時使用罢低,比如
[prod]
redis1 ansible_ssh_host=10.178.151.211 password=UYSbdyf
組變量
就是給整個組加變量
[prod]
redis1 ansible_ssh_host=10.178.151.211
[prod:vars]
password=UYSbdyf
inventory參數(shù)
通過參數(shù)指定ssh的交互
有以下參數(shù),
ansible_ssh_host
ansible_ssh_port
ansible_ssh_user
ansible_ssh_pass
ansible_sudo_pass
ansible_connection
ansible_ssh_private_key_file
ansible_shell_type
ansible_python_interpreter
使用方式如下,比如改了ssh的端口
[prod]
redis1 ansible_ssh_host=10.178.151.211 ansible_ssh_port=50022 ansible_ssh_user=root
group_vars
用于存放group相關的變量
在上面的inventory 文件中腺律,我們定義過組變量
如果組變量可以抽取出來多個組公用奕短,就可以放在group_vars下。
比如上面我給名叫prod的組定義過變量≡染現(xiàn)在要抽取出來翎碑,就要在group_vars目錄下創(chuàng)建一個名為prod的文件
把變量放進去。
所以之斯,文件名和組名是對應的日杈。
文件內(nèi)容格式如下:
---
password=UYSbdyf
host_vars
用于存放host相關的變量
和組名同理。主機變量名和這里創(chuàng)建的文件名必須一致佑刷。
playbook主文件
比如這里的site.yml
主playbook文件莉擒,我們開始執(zhí)行一個playbook就是從這個主文件開始
ansible-playbook site.yml
這個主文件不是一定要叫site.yml。隨便起名瘫絮。根據(jù)你自己的業(yè)務來起名即可涨冀。比如后面的webservers.yml和dbservers.yml。
我們這里寫一個redis.yml,用來部署redis
- hosts: redis
remote_user: root
gather_facts: True
roles:
- redis
主文件的內(nèi)容就是指定哪些主機進行什么操作麦萤。用什么用戶等等鹿鳖。
roles
roles是整個playbook的重點扁眯。role可以理解為做一件事的一個角色。
roles目錄下面根據(jù)你自己的業(yè)務翅帜,可以定義多個role子目錄姻檀,對應完成某件工作。
為了做成這件事的一些列操作都寫到這個role子目錄下涝滴。比如這里的common,webserver,monitoring,fooapp等
我這里新建一個redis目錄
tasks
tasks下的文件就是完成工作的一個個具體動作绣版,
至少要包含main.yml,playbook執(zhí)行時默認就找這個main.yml〖叽可以定義其他的yml文件杂抽,在main.yml引入
比如
- name: System Add group {{ redisgroup }}
group: gid={{ usergid }} name={{ redisgroup }} state=present system=yes
- name: System Add user {{ redisuser }}
user:
name: '{{ redisuser }}'
...省略
- name: create redis database directory
file: path='/data/redis_data' state=directory mode='0755' owner={{ redisuser }} group={{ redisgroup }}
- name: create logs directory
file: path='/data/logs/redis' state=directory mode='0755' owner={{ redisuser }} group={{ redisgroup }}
- name: yum install {{ pkgname }}
yum: name={{ pkgname }} state=present
- name: Template Set {{ pkgname }} Config Files
template: src='redis.conf.j2' dest='/etc/redis.conf' owner={{ redisuser }} group={{ redisgroup }} mode='0755'
notify:
- restart redis service
通過-name來說明這個動作的作用
可以看到里面使用了變量。用{{xx}}包圍的腋妙。這些變量放在vars文件夾下默怨。
其中的動作Action讯榕,group骤素,user,file愚屁,yum等就是我們上一篇中說的ansible的內(nèi)置模塊
playbook對task的執(zhí)行時從上到下按順序一個一個執(zhí)行的济竹。執(zhí)行的結果是冪等的。這個特性非常使用霎槐。
對一臺客戶機多次執(zhí)行playbook是安全的送浊。
為什么是冪等的呢?
仔細觀察task的動作丘跌,會發(fā)現(xiàn)其對動作的描述都是聲明式的袭景。
比如 yum: name={{ pkgname }} state=present
有一個state值是present,表明我們期望達到的效果是安裝了這個包闭树。所以ansible會采取的操作是先檢查有沒有安裝耸棒,沒有安裝才進行安裝。
在這個例子中报辱,還用到了template模塊与殃。它會去找templates目錄下的模板文件,進行變量替換后碍现,放到客戶機指定的目錄下幅疼。
還有一個notify,這個特性和下面要講到的handler有關
handlers
應當包含一個main.yml文件昼接,用于定義此角色用到的各handlers爽篷,
在handler中可以使用inclnude引入其它的handlers文件;
handler是干嘛的慢睡?
handler是用來描述當關注的資源的狀態(tài)發(fā)生變化時要采取的操作逐工。
比如main.yml中這樣寫
- name: restart redis service
service: name={{ pkgname }} state=restarted
這里的name要注意膨疏,它的值必須和上面task文件中norify的值一致!钻弄!佃却,不是隨便寫的。
也就是說窘俺,當task中的redis.conf文件修改了之后饲帅,會觸發(fā)notify這個名叫restart redis service的handler
這個handler執(zhí)行的操作就是調用service模塊,對某個service進行restart
templates
存放模板文件瘤泪。
playbook使用jinja2模板文件灶泵。
比如我們講redis.conf作為一個模板配置文件redis.conf.j2
bind {{ bindip }}
protected-mode yes
port 6379
tcp-backlog 511
timeout 0
tcp-keepalive 300
daemonize {{ mode }}
...
模板文件中的變量從vars目錄下取
files
用來存放會用到的文件。
比如script模塊用到的sh腳本文件对途。需要copy到目標主機的安裝包等赦邻。
vars
存在自定義的變量。
應當包含一個main.yml文件
defaults
應當包含一個main.yml文件,也是用于為當前role定義變量实檀。只不過設定的時默認值惶洲。優(yōu)先級低于vars。
meta
應當包含一個main.yml文件膳犹,用于定義此角色的特殊設定及其依賴關系恬吕;ansible1.3及其以后的版本才支持;
我還沒用過~
library 和 filter_plugins
ansible支持自定義擴展功能须床,新手先不用管這個
執(zhí)行
執(zhí)行就簡單了铐料,通過ansible-playbook redis.yaml
命令運行即可
# ansible-playbook -h
#ansible-playbook常用選項:
--check or -C #只檢測可能會發(fā)生的改變,但不真正執(zhí)行操作
--list-hosts #列出運行任務的主機
--list-tags #列出playbook文件中定義所有的tags
--list-tasks #列出playbook文件中定義的所以任務集
--limit #主機列表 只針對主機列表中的某個主機或者某個組執(zhí)行
-f #指定并發(fā)數(shù)豺旬,默認為5個
-t #指定tags運行钠惩,運行某一個或者多個tags。(前提playbook中有定義tags)
-v #顯示過程 -vv -vvv更詳細