/docs/MyDocs

Roles

=====

 We also can include files with tasks: conditionally or unconditionally or even in the loop (variables are propogated)

  - name: task group

    include: <name>.yml

    [when|with_*|...]

    

 Or we can define a complete role, which may define the tasks, handlers, variables, etc. The roles are included from top

 level only like:

  - hosts: nodes

    roles:

        - role1

        - role2 param1=5000                                     - parametrizing

        - role2 param1=5001

 

 Including role from other roles.

    - include_role: 

        name: subrole

        *_from: filename.yml                                    - overrides the file to load vars/tasks/defaults from. I.e. instead main.yml the specified YaML description will be used

    vars:

        param1: value1

 

 It is also possible to icnlude a file with variables as a new variable with the specified name:

  - include_vars: file=vars.yml name=var_name                   - if name is ommited, the top level vars are loaded

    dir=<path> [extensions=list] [depth=l] [files_matching=re]  - if dir is specified, all files matching 're' in the directory and its subdirectoris until level 'l' are loaded. 

                                                                BEWARE: main.yml for some reason may be not included!

 

Directory Layout 

================

 meta/                                                          - information about the role

    main.yml

 defaults/                                                      - define default (least priority) facts for the role

    main.yml                                                    - variables from here are not propogated to next roles by default, but should be passed using 'set_fact'

 vars/                                                          

    main.yml                                                    - includede by default

    vars1.yml                                                   - variables included with 'vars_files'

 templates/                                                     - various templates used in tasks

    something.conf.j2

 files/                                                         - various files used in tasks and possibly distributed to the configured nodes

    ...

 tasks/                                                         - task lists

    main.yml                                                    - this task list is executed when roles in included, and may include more files from this folder

    action1.yml                                                 - this is not executed by default, but can be included from main.yml

 handlers/                                                      - define hanlders for the role

    main.yml

 library/                                                       - custom modules

 *_plugins/                                                     - various python plugins

 

 

Meta

====

dependencies:                                                   - ensures that listed roles are executed before this one 

 - { role: common, param1: val1, ... }

allow_duplicates: yes                                           - enforces all dependencies to be run before the role (even if they have been already executed in this playbook)