Ansible10：Playbook的角色与包含

32421312

当单个playbook文件越来越大的时候，我们就需要重新来组织Playbooks了。我们可以将一个大的playbook拆成若干个小的playbook文件，然后通过include的方式，在主配置文件中将这些零碎的小文件包含进来，这叫做playbook的包含。我们也可以按照一定的规则将执行的某一类型任务放在一个目录里，并在这个目录中再次对这个playbook按照tasks,handlers，files,templates,vars等类型划分成若干文件，将对应文件存放在对应的目录中，这种组织方式就叫做playbook的roles。

一、Playbook的包含

playbook的包含其实就是使用include关键字

1、tasks包含

示例1：

一个task文件foo.yml示例如下：

# possibly saved as tasks/foo.yml

- name: placeholder foo

  command: /bin/foo

- name: placeholder bar

  command: /bin/bar


在另一个task文件bar.yml中包含foo.yml:

tasks:

  - include: tasks/foo.yml

也可以在include的时候，带入变量：

tasks:

  - include: wordpress.yml user=timmy

  - include: wordpress.yml user=alice

  - include: wordpress.yml user=bob


通过如下方式带入变量：

tasks:

- { include: wordpress.yml, user: timmy, ssh_keys: [ 'keys/one.txt', 'keys/two.txt' ] }

再给一个例子：

tasks:
  - include: wordpress.yml
    vars:
        remote_user: timmy
        some_list_variable:
          - alpha
          - beta
          - gamma

2、handlers包含

handlers包含与tasks的包含大体类似，直接给例子：

handlers1.yml内容如下：

# this might be in a file like handlers/handlers.yml

- name: restart apache

  service: name=apache state=restarted

handlers.yml包含handlers1.yml示例：
handlers:

  - include: handlers/handlers.yml

3、混合包含

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

二、角色（roles）

1、创建role

创建role的步骤如下：

1)创建以roles命令的目录

2)在roles目录中分别创建角色名称命名的目录，如websrvs等

3)在每个角色命名的目录中分别创建files、handlers、meta、tasks、teamplates和vars目录，用不到的目录可以创建为空目录，也可以不创建。

4)在playbook文件中，调用各角色

roles文件组织结构示例：

group_vas/

site.yml

webservers.yml

roles/

   common/

     files/

     templates/

     tasks/

     handlers/

     vars/

     defaults/

     meta/

   webservers/

     files/

     templates/

     tasks/

     handlers/

     vars/

     defaults/

     meta/


roles各目录的作用及可用的文件：

    files：存放由copy或script等模块调用的文件

    tempaltes：Jinja2模板文件

    tasks：至少应该包含一个名为main.yml的文件，其定义了此角色的任务列表，些文件可以使用include包含其它的位于此目录中的task文件

    handlers：至少包含一个main.yml文件，用于定义此角色用到的各handler，在handler中使用include包含的其他handler文件也应该位于此目录

    vars：应当包含一个main.yml文件，用于定义此角色用到的变量

    meta：应当包含一个main.yml文件，用于定义此角色的特殊设定及依赖关系等

    default：为当前角色设定默认变量时使用些目录，包含一个main.yml文件


2、引用roles

基本引用的方法：

- hosts: webservers

  roles:

     - common

     - webserver


也可以通过如下方法引用时带入变量：

- hosts: webservers

  roles:

    - common

    - { role: foo_app_instance, dir: '/opt/a',  port: 5000 }

    - { role: foo_app_instance, dir: '/opt/b',  port: 5001 }


还可以在引用时使用条件语句：

- hosts: webservers

  roles:

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


下面也是一个带入变量的示例：

- hosts: webservers

  roles:

    - role: database

      database_name: {{ db_name }}

      database_user: {{ db_pass }}

    - role: webserver

      live_hostname: web1

      domains:

        - example.com

        - www.example.com

3、pre_tasks和post_tasks

    如果在执行一个role时，需要在其前或其后依然要执行某些任务，我们可以使用pre_tasks及post_tasks来声明。pre_tasks是在role之前执行，而post_tasks则在role之后执行：

- name: deply webservers

  host: webservers

  vars_files:

    - secrets.yml

  pre_tasks:

    - name: update yum cache

      yum: update_cache=yes

  roles:

    - role: apache

      database_host: {{ hostvars.db.ansible_eth0.ipv4.address }}

      domains:

        - exampel.com

        - www.example.com

  post_tasks:

    - name: print something

      shell: echo "The roles have been updated!"


4、role的依赖

如果当前role在执行前需要依赖另一个role，我们可以在roles的meta目录中的main.yml中定义role的依赖关系。

示例1：

#roles/webservers/meta/main.yml

dependencies:

  - { role: common, some_parameter: 3 }

  - { role: apache, port: 80 }

  - { role: postgres, dbname: blarg, other_parameter: 12 }


示例2：

dependencies:

  - {role: ntp, ntp_server=ntp.ubuntu.com}

  - {role: web}

  - {role: memcached}


5、Ansible Galaxy

ansible-galaxy是一个工具，我们可以利用它快速的创建一个标准的roles目录结构，还可以通过它在https:/galaxy.ansible.com上下载别人写好的roles，直接拿来用。

通过ansible-galaxy初始化一个roles的目录结构，方法如下：

    ansible-galaxy init /etc/ansible/roles/websrvs

安装别人写好的roles：

    ansible-galaxy install -p /etc/ansible/roles bennojoy.mysql

列出已安装的roles：

    ansible-galaxy list

查看已安装的roles信息：

    ansible-galaxy info bennojoy.mysql

卸载roles：

    ansible-galaxy remove bennojoy.mysql