ansible入門四（Ansible playbook基礎組件介紹）

本節內容：

• ansible playbook介紹
• ansible playbook基礎組件
• playbook中使用變量

 

一、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

其中，tasks是一個一個任務。

 

二、ansible playbook基礎組件

Playbooks結構：

• Tasks：任務，即調用模塊完成的某操作。
• Variables：變量
• Templates：模板
• Handlers：處理器，指的是在某條件滿足時能夠觸發完成的功能，或者說是由某事件觸發執行的操作
• Roles：角色。

 

1. Hosts和Users

playbook中的每一個play的目的都是為了讓某個或某些主機以某個指定的用戶身份執行任務。hosts用於指定要執行指定任務的主機，其可以是一個或多個由冒號分隔主機組；remote_user則用於指定遠程主機上的執行任務的用戶。如上面示例中的

- hosts: webnodes
  remote_user: root

不過，remote_user也可用於各task中。也可以通過指定其通過sudo的方式在遠程主機上執行任務，其可用於play全局或某任務；此外，甚至可以在sudo時使用sudo_user指定sudo時切換的用戶。

- hosts: webnodes
  remote_user: mageedu
  tasks:
  - name: test connection
    ping:
    remote_user: mageedu
    sudo: yes

比如寫一個最簡單的playbook，里面寫了兩個play，一個play是在nginx組的主機上都創建一個nginx組，nginx用戶，另一個play是復制一個文件到mysql組的主機上：

[root@node1 ~]# vim nginx.yml
- hosts: nginx                                                                                                                                
  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 hosts
    copy: src=/etc/inittab dest=/tmp/inittab.ans

 

查看ansible-playbook的使用方法：

[root@node1 ~]# man ansible-playbook

運行playbook：

[root@node1 ~]# ansible-playbook nginx.yml

 

2. 任務列表(Tasks)和action

play的主體部分是task list。task list中的各任務按次序逐個在hosts中指定的所有主機上執行，即在所有主機上完成第一個任務后再開始第二個。在運行自下而下某playbook時，如果中途發生錯誤，所有已執行任務都可能回滾，因此，在更正playbook后重新執行一次即可。(因為具有冪等性)

task的目的是使用指定的參數執行模塊，而在模塊參數中可以使用變量。模塊執行是冪等的，這意味着多次執行是安全的，因為其結果均一致。

每個task都應該有其name，用於playbook的執行結果輸出，建議其內容盡可能清晰地描述任務執行步驟。如果未提供name，則action的結果將用於輸出。

定義task的可以使用“action: module options”(這個在較新版本上才能執行)或“module: options”的格式，推薦使用后者以實現向后兼容。如果action一行的內容過多，也可以使用在行首使用幾個空白字符進行換行。

tasks:
- name: make sure apache is running
  service: name=httpd state=running

 

在眾多模塊中，只有command和shell模塊僅需要給定一個列表而無需使用“key=value”格式，例如：

tasks:
- name: disable selinux
  command: /sbin/setenforce 0

 

如果命令或腳本的退出碼不為零，可能會阻止playbook繼續往下執行可以使用如下方式替代：

tasks:
- name: run this command and ignore the result
  shell: /usr/bin/somecommand || /bin/true

也就是說這個命令失敗也是要繼續往下走的，就是失敗了但不要影響下面的操作。或者使用ignore_errors來忽略錯誤信息：

tasks:
- name: run this command and ignore the result
  shell: /usr/bin/somecommand
  ignore_errors: True

 

3. handlers

用於當關注的資源發生變化時采取一定的操作。

“notify”這個action可用於在每個play的最后被觸發，這樣可以避免多次有改變發生時每次都執行指定的操作，取而代之，僅在所有的變化發生完成后一次性地執行指定操作。在notify中列出的操作稱為handler，也即notify中調用handler中定義的操作。

- name: template configuration file
  template: src=template.j2 dest=/etc/foo.conf
  notify:
  - restart memcached
  - restart apache    

handler是task列表，這些task與前述的task並沒有本質上的不同。

handlers:
- name: restart memcached
  service:  name=memcached state=restarted
- name: restart apache
  service: name=apache state=restarted

 

【舉例】：比如有個配置apache的playbook，然后利用這個來說明handlers。

1.先創建一個apache.yml，里面定義play安裝啟動apache

[root@node1 ~]# vim apache.yml
- hosts: mysql
  remote_user: root
  tasks:
  - name: install httpd package
    yum: name=httpd state=latest
  - name: install configuration file for httpd
    copy: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf 
  - name: start httpd service 
    service: enabled=true name=httpd state=started
[root@node1 ~]# ansible-playbook apache.yml

2.假如說某個時刻httpd.conf發生改變了，比如說不再監聽在80，而是監聽在8080端口，其他沒變。修改/root/conf/httpd.conf，把端口改成8080，再執行這個playbook：

[root@node1 ~]# ansible-playbook apache.yml

到mysql組所在的主機172.16.7.153上查看端口，發現監聽端口仍然是80：

[root@node3 ~]# ss -tnlp

3.一個程序的配置文件發生了改變，那么程序應該重讀配置文件才對。然而默認情況下，你多次唱同一個劇本，如果那個task此前執行過，為了保證冪等性，它是不會再被執行。handlers就是為了解決這種問題而生的。Handlers也是任務，但它不是上來就執行的，只有某個條件滿足時才會執行。所以我們去修改apache.yml：

- hosts: mysql
  remote_user: root
  tasks:
  - name: install httpd package
    yum: name=httpd state=latest
  - name: install configuration file for httpd
    copy: src=/root/conf/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

修改/root/conf/httpd.conf，把端口改成8090，再執行這個playbook：

[root@node1 ~]# ansible-playbook apache.yml

到mysql組所在的主機172.16.7.153上查看端口，發現監聽端口改變了，變成了8090：

 

三、playbook中使用變量

- hosts: mysql
  remote_user: root
  vars:
  - package: httpd
  tasks:
  - name: install httpd package
    yum: name={{ package }} state=latest                                                                                                      
  - name: install configuration file for httpd
    copy: src=/root/conf/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

【注意】：playbook中能使用的變量不僅僅是這里定義的變量，而是可以使用ansible中定義的所有變量。例如：

[root@node1 ~]# ansible 172.16.7.152 -m setup

 

另外，在inventory中定義的變量也可以在playbook中調用。例如：

[root@node1 ~]# vim /etc/ansible/hosts