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