ansible—playbook劇本相關概念及示例！

一、playbook前置知識點

1、主機清單

ansible默認的主機清單是/etc/ansible/hosts檔案
主機清單可以手動設定，也可以通過Dynamic Inventory動態生成

vi /etc/ansible/hosts
[webserver]              #使用方括號設定組名
www1.example.org         #定義被監控主機，這邊可以是主機名也可以是IP地址
www2.example.org:2222    #冒號后定義遠程連接埠，默認是ssh的22埠

如果是名稱類似的主機，可以使用串列的方式標識各個主機

[webserver]
//[01:50]表示匹配從01到50，后面跟著內置變數，這里定義了ssh的訪問的用戶名和密碼，用于免互動登錄
www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=abc123

[dbbservers]
//[a:f]表示支持匹配a到f
db-[a:f].example.org

Inventory中的變數

主機變數

[webserver]
//定義變數http_port（開放的埠資訊）和maxRequestsChild（最大行程數）
www1.magedu.com http_port=80 maxRequestsChild=808
www2.magedu.com http_port=8080 maxRequestsChild=909

組變數

[servers:vars]
ntp_server=ntp.example.org
nfs_server=nfs.example.org

組嵌套

[apache]
http1.example.org
http2.example.org

[nginx]
ngx1.example.org
ngx2.example.org

//定義一個組名，將剛才定義的兩個組名放入，即webservers組包含apache組和nginx組的主機
[webservers]
apache
nginx

inventory變數引數

ansible_ssh_host #將要連接的遠程主機名，與你想要設定的主機的別名不同的話，可以通過此變數設定，
ansible_ssh_port #ssh 埠號.如果不是默認的埠號,通過此變數設定，
ansible_ssh_user #默認的 ssh 用戶名，
ansible_ssh_pass #ssh 密碼（這種方式并不安全,強烈建議使用 --ask-pass 或SSH密鑰），
ansible_ssh_private_key_file #ssh使用的私鑰檔案，適用于有多個密鑰，但你不想使用 SSH 代理的情況，
ansible_ssh_common_args #此設定附加到 sftp ， scp 和ssh的預設命令列，
ansible_sftp_extra_args #此設定附加到默認 sftp 命令列，
ansible_scp_extra_args #此設定附加到默認 scp 命令列，
ansible_ssh_extra_args #此設定附加到默認 ssh 命令列，
ansible_ssh_pipelining #確定是否使用SSH管道，這可以覆 ansible.cfg 中的設定，
ansible_shell_type #目標系統的shell型別，默認情況下,命令的執行使用 ’ sh ’ 語法,可設定為 ’ csh ’ 或 ’ fish '，
ansible_python_interpreter #目標主機的 python路徑.適用于的情況: 系統中有多個 Python , 或者命令路徑不是"/usr/bin/python",比如 *BSD, 或者 /usr/bin/python
ansible_*_interpreter #這里的" * "可以是 ruby 或 perl 或其他語言的解釋器，作用和ansible_python_interpreter 類似，
ansible_shell_executable #這將設定 ansibie 控制器將在目標機器上使用的 shell ，覆寫 ansible.cfg 中的配置，默認為 /bin/sh，

2、YAML

YAML：另一種標記語言，是用來寫組態檔的語言，非常簡潔和強大，
YAML語法和其他語言類似，也可以表達散串列、標量等資料結構，
結構通過 空格 來展示；序列里配置項通過-來代表;Map里鍵值用:來分隔;YAML的擴展名為yaml

（1）基本語法規則

大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tab鍵，只允許使用空格，
縮進的空格數目不重要，只要相同層級的元素左側對齊即可

（2）YAML支持的資料結構

物件
鍵值對的集合，又稱為映射（mapping）/哈希（hashes）/字典（dictionary）

例如: name (鍵): Example(值)

類class：（物品）
  物件1：（桌子）
    屬性（名稱，長、寬、高等）
    方法（動詞，放東西）
    ...
  物件2
  物件3

陣列
一組按次序排列的值，又稱為序列（sequence）/串列（list）

例如：-Apple
     -Orange

純量
單個的、不可再分的值

例如：number: 12.30
     sure: true

二、Ansible的劇本playbook

通過task呼叫ansible的模板將多個play組織在一個playbook中運行，

1、playbooks的組成部分

Tasks：任務，即呼叫模塊完成的某操作；原理和事務一樣，要么一起執行，要么一起不執行，
Variables：變數；宣告變數的三個場景：hosts檔案中定義、劇本中定義、在命令中加上-e定義，
Templates：模板；定義模板同一格式，解決每個服務可能因格式不一樣而不兼容的問題，
Handlers：處理器，當某條件滿足時，觸發執行的操作，
Roles：角色；將任務分類執行，彼此之間互不干擾，
我們先看一個playbook的示例簡單了解一下

vim httpd.yaml
- hosts: webserver
  vars:
    http_port: 80
    max_clients: 200
  user: root
  tasks:
   - name: ensure apache is at the latest version
     yum: pkg=httpd state=latest
   - name: write the apache config file
     template: src=/root/test/httpd.j2 dest=/etc/httpd/conf/httpd.conf
     notify:
     - restart apache
   - name: ensure apache is running
     service: name=httpd state=started
  handlers:
   - name: restart apache
     service: name=httpd state=restarted
      
      
#---------------------playbook解釋------------------------
- hosts: webserver      //定義的主機組，即應用的主機
  vars:                 //定義變數
    http_port: 80
    max_clients: 200
  user: root            //指定用戶執行任務
  tasks:                //執行的任務
   - name: ensure apache is at the latest version   //自定義輸出內容，任務名稱
     yum: pkg=httpd state=latest        //yum模塊:指定軟體包和版本引數；即使用yum安裝最新版的httpd
   - name: write the apache config file
     template: src=/srv/httpd.j2 dest=/etc/httpd.conf  //定義一個httpd的模板（在管理端自己創建）
     notify:     //呼叫下面的操作
      - restart apache    //操作的名字，在handlers下定義
   - name: ensure apache is running
     service: name=httpd state=started  //輸出httpd狀態
  handlers:               //處理器
   - name: restart apache          //被呼叫的操作名字
     service: name=httpd state=restarted  //重啟httpd服務

2、執行playbook

格式：
ansible-playbook [yaml檔案名]
例如：ansible-playbook ping.yml
引數：-k(–ask-pass) 用來互動輸入ssh密碼
     -K(-ask-become-pass) 用來互動輸入sudo密碼
     -u 指定用戶

補充命令：
ansible-playbook XXXX.yaml --syntax-check   #檢查yaml檔案的語法是否正確
ansible-playbook XXXX.yaml --list-task      #檢查tasks任務
ansible-playbook XXXX.yaml --list-hosts     #檢查生效的主機
ansible-playbook XXXX.yaml --start-at-task='ensure apache is at the latest version'  #指定從某個task開始運行

3、hosts 和 users 介紹

 - hosts: webserver   #指定主機組，可以是一個或多個組
   remote_user: root  #指定遠程主機執行的用戶名

還可以為每個任務定義遠程執行用戶:

 - hosts: mysql
   remote_user: root
   tasks:
   - name: test connection
     ping:
     remote_user: mysql   #指定遠程主機執行tasks的運行用戶為mysql

執行playbook時:  ansible-playbook ping.yml -k

4、指定遠程主機 sudo 切換用戶

 - hosts: mysql
   remote_user: root
   become: yes         #2.6版本以后的引數，之前是sudo,意思為切換用戶運行
   become_user: mysql   #指定sudo用戶為mysql
   tasks:
   - name: copy text
     copy: src=/etc/fstab dest=/home/mysql/fstab.bak

執行playbook時: ansible-playbook ping.yml -K

在mysql主機上查看復制的檔案

ls /home/mysql

一個yaml檔案中可以寫多個hosts，定義多個主機組

vim hosts.yaml
- hosts: webserver
  remote_user: root
  tasks:
   - name: create nginx group
     group: name=nginx system=yes gid=208
   - name: create nginx user
     user: name=nginx uid=208 group=nginx system=yes
- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file to mysql
     copy: src=/etc/inittab dest=/opt/inittab.back

5、tasks串列和action

1、Play的主體部分是task列表，task串列中的各任務按次序逐個在hosts中指定的主機上執行，即在所有主機上完成第一個任務后再開始，在運行playbook時 (從上到下執行)，如果一個host執行task失敗， 整個tasks都會回滾，請修正playbook中的錯誤，然后重新執行，即Task的目的是使用指定的引數執行模塊，而在模塊引數中可以使用變數，模塊執行時冪等的，這意味著多次執行是安全的，因為其結果一定的，
2、每一個task必須有一個名稱 name，這樣在運行playbook時，從其輸出的任務執行資訊中可以很好的辨別出是屬于哪一個task的，
3、定義一個task，常見的格式: ”module: options" 例如: yum: name =httpd
4、ansible的自帶模塊中，command模塊和shell模塊無需使用key=value格式
示例：

vim error.yaml
- hosts: webserver
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/sbin/setenforce 0'
   - name: make sure apache is running
     service: name=httpd state=started

只要執行命令的回傳值不為0，就會報錯，tasks停止
修改如下:

- hosts: webserver
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/sbin/setenforce 0'
     ignore_errors: True #忽略錯誤，強制回傳成功
   - name: make sure apache is running
     service: name=httpd state=started

6、Handlers介紹：

Handlers也是一些task的串列， 和一般的task并沒有什么區別，
是由通知者進行的notify，如果沒有被notify，則Handlers不會執行，假如被notify了 ，則Handlers被執行不管有多少個通知者進行了notify，等到play中的所有task執行完成之后，handlers也只會被執行一次

示例

 - hosts: webserver
   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

也可以引入變數

 - hosts: webserver
   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

7、playbook使用變數

1）通過ansible命令傳遞

例如：編輯如下yamI

vi a.yaml
 - hosts: mysql
   remote_user: root
   vars:
   - user:
   tasks:
   - name: add new user 
     user: name={{user}}

然后執行命令: ansible-playbook a.yml -e "user=testvar"

可以執行命令查看: ansible mysql -m command -a 'tail /etc/passwd'

2）直接在yamI中定義變數，如上handlers示例

vi b.yaml
 - hosts: mysql
   remote_user: root
   vars:
   - user: gcc01
   tasks:
   - name: add new user 
     user: name={{user}}

然后執行命令: ansible-playbook b.yml

3）直接參考一些變數

如: 參考ansible 的固定變數

vi test.yaml
 - hosts: mysql
   remote_user: root
   tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}}" dest=/opt/vars.txt

執行命令: ansible-playbook test.yaml

4）參考主機變數

vi  /etc/ansible/hosts
#在mysq|組的主機后面添加如下
[mysql]
192.168.2.5 testvar="2.15"
#定義testvar變數的值為2.15

vi test.yaml     #添加{{testvar}}主機變數
 - hosts: mysql
   remote_user: root
   tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}},{{testvar}}" dest=/opt/vars.txt

執行命令: ansible-playbook test.yaml

8、條件測驗

如果需要根據變數、facts (setup) 或此前任務的執行結果來作為某task執行與否的前提時要用到條件測驗，在Playbook中條件測驗使用，在task后添加when子句即可使用條件測驗: when子句支持 jinjia2 運算式或語法，例如：

1）單條件判斷

vi when.yml
 - hosts: mysql
   remote_user: root
   tasks:
     - name: "shutdown CentOS"
       command: /sbin/shutdown -h now
       when: ansible_distribution == "CentOS"

2）多條件判斷

vi when.yml
 - hosts: mysql
   remote_user: root
   tasks:
   - name: "shut down CentOS 7 systems"
     command: /sbin/shutdown -r now
     when:
     - ansible_distribution == "CentOS"
     - ansible_distribution_major_version == "7"

3）組條件判斷

vi when.yml
 - hosts: mysql
   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")

4）自定義變數進行條件測驗 (version2.9版本后被移出，無法使用)

vi when.yml
 - hosts: all 
   vars:
    exist: "True" 
   tasks:
   - name: creaet file
     command: touch /tmp/test.txt
     when: exist | match("True")
     
   - name: delete file
     command: rm -rf /tmp/test.txt
     when: exist | match("False")

5）迭代

當有需要重復性執行的任務時，可以使用迭代機制，其使用格式為將需要迭代的內容定義為item變數參考，并通過with_items陳述句指明迭代，

 - hosts: webserver
   remote_user: root
   tasks:
   - name: "Install Packages"
     yum: name={{ item }} state=latest
     with_items:
     - httpd
     - mysql-server
     - php

也可以自己定義

 - hosts: webserver
   remote_user: root
   tasks:
   - name: "Add users"
     user: name={{ item.name }} state=present groups={{ item.groups }}
     with_items:
      - { name: 'test1', groups: 'wheel'}
      - { name: 'test2', groups: 'root'}

其中：
name表示要操作的軟體包的名字；
state標識要做什么操作；
present:默認的，表示為安裝；
lastest:安裝為最新的版本；
absent：表示洗掉，