Edit

Ansible Playbook Roles 和 Include 聲明

• Ansible Playbook Roles 和 Include 聲明

• 1. Introduction

• 2. Task Include Files And Encouraging Reuse

• 3. Roles

• 4. Role Default Variables

• 5. Role Dependencies

• 6. Embedding Modules In Roles

• 7. Ansible Galaxy

1. Introduction

工作中我們有可能會寫一個很長的playbook，最后發現playbook中很多功能是可以復用。

客觀來講，include允許我們把playbook寫成很多小文件，然后通過一定的策略include組織在一起，提高利用性。task可以使用include, handlers同樣也屬于task，所以handlers也可以使用include

playbook同樣也可以被include.當你有這方面的考慮時，你已經不再止步于普通應用者，如何更好的使和組織架構是你更高的追求。這期間我們要有封裝的思想，所謂的封裝，你可以簡單的理解為”我們會開汽車但必需要發動機如何工作“

roles的概念在Ansible中比較抽象，不太形象有比喻可以理解為 class 類。roles具備include的功能，將比較長的playbook功能分拆通過include的將增加代碼復用性。roles站在更高一層看問題，其基于 include, playbook之上把整合的更為干凈，復用性更高。

我們首先要理解 roles, 因為 roles 功能是如此強大，以至于我們在用到playbook功能后，一定會使用到roles功能。

2. Task Include Files And Encouraging Reuse

include可以上我們有效提高代碼復用性，請參考如下案例。

tasks/foo.yml

---
# possibly saved as tasks/foo.yml

- name: placeholder foo
  command: /bin/foo

- name: placeholder bar
  command: /bin/bar

如果我們希望在task中引用，如下方式可實現：

tasks:

  - include: tasks/foo.yml

Include支持變量引用，我們稱之為parameterized include。舉個例子，如果分發多個 wordpress 實例，我可以將 wordpress 任務排版到一個 wordprss.yml 文件，通過變量傳參實現。

tasks:
  - include: wordpress.yml wp_user=timmy
  - include: wordpress.yml wp_user=alice
  - include: wordpress.yml wp_user=bob

從1.0版本開始，ansible 同樣也支持如下格式的傳參：

tasks:

  - include: wordpress.yml
    vars:
        wp_user: timmy
        ssh_keys:
          - keys/one.txt
          - keys/two.txt

變量的引用方式如下：

{{ wp_user }}

如前面所介紹includes同時適用于 handlers。比如，我們定義了如何重啟 apache, 但希望所有 playbook 執行前只執行一次，那么我們可以使用如下的方式進行，定義 handlers.yml:

---
# this might be in a file like handlers/handlers.yml
- name: restart apache
  service: name=apache state=restarted

然后在playbook中引用

handlers:
  - include: handlers/handlers.yml

include 也支持從一個playbook 導入到另外一個 playbook,同時支持層級定義。如下例：

- name: this is a play at the top level of a file
  hosts: all
  remote_user: root

  tasks:

  - name: say hi
    tags: foo
    shell: echo "hi..."

- include: load_balancers.yml
- include: webservers.yml
- include: dbservers.yml

這里需要留意的是，include時變量不隨之生效

3. Roles

組織playbook的最好辦法是什么？ 使用 roles!。 roles 可以有效的把 vars_files, tasks, handlers組織起來，按角色分組可以非常容易的和其它用戶分享。rles 只是自動化 include 如上的這些指令，其本身并沒有魔法效果，不管如此，這是一項大工程。因為我們要合理的規劃其目錄結構。

site.yml
webservers.yml
fooservers.yml
roles/
   common/
     files/
     templates/
     tasks/
     handlers/
     vars/
     defaults/
     meta/
   webservers/
     files/
     templates/
     tasks/
     handlers/
     vars/
     defaults/
     meta/

寫到playbook中，它長成這個樣子：

---
- hosts: webservers
  roles:
     - common
     - webservers

其中每項均有其功能介紹：

• roles/x/tasks/main.yml
  主函數，包括在其中的所有任務將被執行

• roles/x/handlers/main.yml
  所有包括中其中的 handlers 將被執行

• roles/x/vars/main.yml
  所有包括在其中的變量將在roles中生效

• roles/x/meta/main.yml
  roles所有依賴將被正常登入

• roles/x/{files,templates,tasks}/ (dir depends on task)
  所有文件，模板都將可存放在這里，放在這里最大的好處是不用指定絕對路徑

---

- hosts: webservers
  roles:
    - common
    - { role: foo_app_instance, dir: '/opt/a',  app_port: 5000 }
    - { role: foo_app_instance, dir: '/opt/b',  app_port: 5001 }

也可以加入一定的條件：

---

- hosts: webservers
  roles:
    - { role: some_role, when: "ansible_os_family == 'RedHat'" }

同時，我們有可能希望為我們的角色分配 tags, tags的功能是我使用 ansible 下來體驗最為深刻的功能，沒有之一，實在是太靈活方便了。在考慮組織嚴密的同時，又不忘其靈活性。

---

- hosts: webservers
  roles:
    - { role: foo, tags: ["bar", "baz"] }

雖說tags 是好東西，但如果你發現你制訂的roles中具有很多tags而且經常性的會被使用，則要考慮下再次切分roles為多個roles.

同時，在一個playbook中我們可以定義多層級的任務。如下案例：

---

- hosts: webservers

  pre_tasks:
    - shell: echo 'hello'

  roles:
    - { role: some_role }

  tasks:
    - shell: echo 'still busy'

  post_tasks:
    - shell: echo 'goodbye'

4. Role Default Variables

defaults/main.yml 定義最低優化級的 roles 變量，我們可以通過很多其它方式定義的變量，均會覆蓋這里的變量值

5. Role Dependencies

meta/mainl.yml默認定義role的依賴，

---
dependencies:
  - { role: common, some_parameter: 3 }
  - { role: apache, appache_port: 80 }
  - { role: postgres, dbname: blarg, other_parameter: 12 }

Role 依賴也可以是全路徑，如：

---
dependencies:
   - { role: '/path/to/common/roles/foo', x: 1 }

Roles dependencies 總是在roles最開始的時候執行，而且默認只執行一次，即使其它其它roles重復引用。
通過設置 meta/main.yml 中 allow_duplicates: yes 可以多次執行。如下例：

---
dependencies:
- { role: wheel, n: 1 }
- { role: wheel, n: 2 }
- { role: wheel, n: 3 }
- { role: wheel, n: 4 }

---
allow_duplicates: yes
dependencies:
- { role: tire }
- { role: brake }

6. Embedding Modules In Roles

這個高級話題和大部分用戶無關，這里暫不做介紹

7. Ansible Galaxy