ansible-playbook

ansible-playbook介紹


1、playbook簡介

    playbook是ansible用於配置、部署和管理被控節點的劇本,通過playbook的詳細描述,執行其中的一系列tasks,可以讓遠程主機達到預期的狀態,playbook就像Ansible控制器給被控節點列出的一系列to-do-list,而被控節點必須要完成。

     也可以這樣理解,playbook字面意思,即劇本,現實中由演員按照劇本表演,在ansible中,這次是由計算機進行表演,由計算機安裝,部署應用,提供對外服務,以及組織計算機處理各種各樣的事情。


2、playbook使用場景

    執行一些簡單的任務,使用ad-hoc命令可以方便的解決問題,但是有時一個設施太過於複製,需要大量的操作時,執行ad-hoc命令就不太合適,這時最好使用playbook,就像執行shell命令與寫shell腳本一樣,也可以理解爲批處理任務,不過playbook有自己的語法格式,具體可以看下面介紹。

    使用playbook你可以方便的重用這些代碼,可以移值到不同的機器上面,像函數一樣,最大化的利用代碼。在使用ansible的過程中,所處理的大部分操作都是需要編寫playbook的。


3、YAML語法

    playbook由YMAL語言編寫,YMAL參考了其他多種語言,包括:XML、C語言、python、perl以及電子郵件格式RFC2822,Clark Evans在2001年5月在首次發表了這種語言,另外Ingy dot Net與Oren Ben-Kiki也是這種語言的共同設計者。

    YAML介紹:yaml是一個可讀性高的用來表達資料序列的格式。YAML Ain't Markup Language,即YAML不是XML。不過,在開發的這種語言時,YAML的意思其實是:“Yet Another Markup Language"(仍是一種標記語言)。其特性:    

   YAML的可讀性好。
   YAML和腳本語言的交互性好
   YAML使用實現語言的數據類型
   YAML有一個一致的信息模型
   YAML易於實現
   YAML可以基於流來處理
   YAML表達能力強

更多的規範參見:http://www.yaml.org。

    YAML的語法和其他高階語言類似,並且可以簡單表達清單、散列表、標量等數據結構。其結構(Structure)通過空格來展示,序列(Sequence)裏的項用"-"來代表,Map裏的鍵值對用":"分隔。下面是一個示例:

name: John Smith
age: 41
gender: Male
spouse:
    name: Jane Smith
    age: 37
    gender: Female
children:
    -   name: Jimmy Smith
        age: 17
        gender: Male
    -   name: Jenny Smith
        age 13
        gender: Female

YAML文件擴展名通常爲.yaml,如example.yaml。


4、ansible-playbook語法

   playbook是又一個或多個"play"組成的列表。play的主要功能在於將事先歸併爲一組的主機裝扮成事先通過ansible中的task定義好的角色。從根本上來講,所謂task無非是調用ansible的一個module。將多個play組織在一個playbook中,即可以讓他們聯同起來按事先編排的機制同唱一臺大戲。下面是一個簡單示例:

    

        - hosts: webnodes
	  vars:
	    http_port: 80
	    max_clients: 256
	  remote_user: root
	  tasks:
	  - name: ensure apache is at the latest version
	    yum: name=httpd state=latest
	  - name: ensure apache is running
	    service: name=httpd state=started
	  handlers:
	    - name: restart apache
	      service: name=httpd state=restarted


5、playbook基礎組件

hosts:playbook中的每一個play的目的都是爲了讓某個或某些以某個指定用戶的身份執行任務。
       hosts用於指定要執行指定任務的主機,其可以是一個或多個由冒號分隔主機組。

user:remote_user則用於指定遠程主機上的執行任務的用戶。

任務列表:play的主體部分是task list. task list中的各任務按次序逐個在hosts中指定的所有主機
          上執行,即在所有主機上完成第一個任務後再開始第二個。

action:任務執行過程

handlers:用於當前關注的資源發生變化時採取一定指定的操作


實例:

[root@mail ~]# cat web.yml
- hosts: webservers  ##主機組,在/etc/ansible/hosts中定義
  remote_user: root  ##遠程執行任務的用戶
  tasks:   ##任務
  - name: install httpd   ##任務描述
    command: yum -y install httpd  ##調用ansible的command模塊安裝httpd
  - name: provide httpd.conf   ##任務描述
    copy: src="/root/httpd.conf" dest="/etc/httpd/conf/httpd.conf"  ##調用ansible的copy模塊,httpd安裝完成後將事先準備好的httpd.conf文件複製到目標主機的/etc/httpd/conf/目錄下
    tags: conf  ##給此任務打標記,可單獨執行標記的任務,使用ansible-playbook -C 命令執行
    notify:  ##文件內容變更通知
    - server restart  ##通知到指定的任務
  - name: server start  ##任務描述
    service: name=httpd state=started enabled=true  ##調用ansible的service模塊的屬性定義安裝完成httpd以後httpd服務的管理
  handlers:  ##定義接受關注的資源變化後執行的動作
  - name: server restart  ##任務描述
    service: name=httpd state=restarted  ##當關注的資源發生變化後調用service模塊,採取相應的動作
 
##執行過程如下:
[root@mail ~]# ansible-playbook web.yml

PLAY [webservers] ************************************************************* 

GATHERING FACTS *************************************************************** 
ok: [node2]
ok: [node1]

TASK: [install httpd] ********************************************************* 
changed: [node2]
changed: [node1]

TASK: [provide httpd.conf] **************************************************** 
changed: [node2]
changed: [node1]

TASK: [server start] ********************************************************** 
changed: [node2]
changed: [node1]

NOTIFIED: [server restart] **************************************************** 
changed: [node2]
changed: [node1]

PLAY RECAP ******************************************************************** 
node1                      : ok=5    changed=4    unreachable=0    failed=0   
node2                      : ok=5    changed=4    unreachable=0    failed=0


6、ansible的roles介紹

    ansible的roles用於層次性、結構化的組織playbook。roles能夠根據層次型結構自動裝載變量文件、tasks及handlers等。要使用roles只需要playbook中使用include指令即可。

1)、創建roles的步驟
   (1)、創建以roles命名的目錄;
   (2)、在roles目錄中分別創建以各角色名稱命名的目錄,如webservers等;
   (3)、在每個角色命名的目錄中分別創建files、handlers、meta、tasks、templates、和vars
          目錄;用不到的目錄可以創建爲空目錄,也可以不創建。
   (4)、在playbook文件中,調用各角色;
2)、roles內各目錄可用的文件
    tasks目錄:至少應該包括一個名爲main.yml的文件,其定義了此角色的任務列表;此文件可以使
               用include包含其它的位於此目錄中的task文件。
    files目錄:存放由copy或script等模塊調用的文件;
    templates目錄:template模塊會自動在此目錄中尋找jinja2模版文件;
    handlers目錄:此目錄中應當包含一個main.yml文件,用於定義此角色用到的各handler;在handl
                  er中使用include包含的其它的handler文件也應該位於此目錄中;
    vars目錄:應當包含一個main.yml文件,用於定義此角色用到的變量;
    meta目錄:應當包含一個main.yml文件,用於定義此角色的特殊設定及其依賴關係;
    default目錄:爲當前角色設定默認變量時使用此目錄;應當包含一個main.yml文件;
3)、舉例說明
root@mail playbook]# tree  roles/
    roles/ \\ansible所有的信息都放到此目錄下面對應的目錄中
    └── nginx  \\角色名稱
        ├── default  \\爲當前角色設定默認變量時使用此目錄,應當包含一個main.yml文件;
        ├── files  \\存放有copy或script等模塊調用的文件
        ├── handlers \\此目錄總應當包含一個main.yml文件,用於定義各角色用到的各handler
        ├── meta \\應當包含一個main.yml,用於定義角色的特殊設定及其依賴關係;1.3及以後
                      版本支持
        ├── tasks \\至少包含一個名爲main.yml的文件,定義了此角色的任務列表,可使用incl
                       ude指令
        ├── templates \\template模塊會自動在此目錄中尋找Jinja2模板文件
        └── vars  \\應當包含一個main.yml文件,用於定義此角色用到的變量

ansible的roles配置nginx

1、準備目錄
# mkdir -pv playbook/roles/nginx/{default,files,handlers,meta,tasks,templates,vars}
2、準備nginx的配置文件
# cd roles/nginx/templates
# ansible all -m setup |grep ansible_processor_cores
        "ansible_processor_cores": 1,  \\獲取ansible的要調用的相關函數
        "ansible_processor_cores": 1,  \\獲取ansible的要調用的相關函數
# vim nginx.conf
worker_processes {{ ansible_processor_cores }}; \\調用獲取到的函數
3、準備Nginx的default.conf文件及rpm包
# ll nginx/files/
-rw-r--r-- 1 root root   2685 Jan 18 15:51 default.conf
-rw-r--r-- 1 root root 319456 Jan 18 15:52 nginx-1.4.7-1.el6.ngx.x86_64.rpm
4、在tasks目錄中配置任務列表
# cd nginx/tasks/
# vim main.yml
 - name: copy nginx.rpm
    copy: src=nginx-1.4.7-1.el6.ngx.x86_64.rpm  dest=/tmp/nginx-1.4.7-1.el6.ngx.x86_64.rpm
  - name: install nginx
    shell: yum -y  install /tmp/nginx-1.4.7-1.el6.ngx.x86_64.rpm
  - name: provides nginx.conf
    template: src=nginx.conf  dest=/etc/nginx/nginx.conf
    tags: nginxconf
    
    notify:
    - server restart
  - name: provides default.conf
    copy: src=default.conf dest=/etc/nginx/conf.d/default.conf 
    tags: nginxconf
  - name: server start
    service: name=nginx enabled=true state=started
5、在handlers目錄中配置定義handler信息
# cd nginx/handlers/
# vim main.yml
- name: server restart
  service: name=nginx  state=restarted
6、在roles同一級目錄中創建site.yml文件
- hosts: webservers
  remote_user: root
  roles:
  - nginx
7、應用配置
# ansible-playbook site.yml 

PLAY [webservers] ************************************************************* 

GATHERING FACTS *************************************************************** 
ok: [node2]
ok: [node1]

TASK: [nginx | copy nginx.rpm] ************************************************ 
ok: [node1]
ok: [node2]

TASK: [nginx | install nginx] ************************************************* 
changed: [node1]
changed: [node2]

TASK: [nginx | provides nginx.conf] ******************************************* 
changed: [node2]
changed: [node1]

TASK: [nginx | provides default.conf] ***************************************** 
changed: [node2]
changed: [node1]

TASK: [nginx | server start] ************************************************** 
changed: [node2]
changed: [node1]

NOTIFIED: [nginx | server restart] ******************************************** 
changed: [node1]
changed: [node2]

PLAY RECAP ******************************************************************** 
node1                      : ok=7    changed=5    unreachable=0    failed=0   
node2                      : ok=7    changed=5    unreachable=0    failed=0   
8、查看webservers主機上是否已經啓動nginx
# ansible webservers -m shell -a 'netstat -tnlp'
node2 | success | rc=0 >>
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:80                  0.0.0.0:*                   LISTEN      5497/nginx          
tcp        0      0 0.0.0.0:22                  0.0.0.0:*                   LISTEN      1174/sshd           
tcp        0      0 :::22                       :::*                        LISTEN      1174/sshd           

node1 | success | rc=0 >>
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:80                  0.0.0.0:*                   LISTEN      5513/nginx          
tcp        0      0 0.0.0.0:22                  0.0.0.0:*                   LISTEN      1174/sshd           
tcp        0      0 :::22                       :::*                        LISTEN      1174/sshd     
9、查看playbook目錄總體結構:
# tree playbook/
playbook/
├── roles
│   └── nginx
│       ├── default
│       ├── files
│       │   ├── default.conf
│       │   └── nginx-1.4.7-1.el6.ngx.x86_64.rpm
│       ├── handlers
│       │   └── main.yml
│       ├── meta
│       ├── tasks
│       │   └── main.yml
│       ├── templates
│       │   └── nginx.conf
│       └── vars
└── site.yml

到此,ansible-playbook已總計完畢,僅個人總結學習。如有疑問,請查官方文檔。也可交流,主要個人技術暫時還不強悍。。。大神吾噴。。。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章