Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 2.51 KB

role_README.md

File metadata and controls

91 lines (58 loc) · 2.51 KB

Ansible Role: <your role>

Describe the purpose of your role in 1 sentence

To include this role in your ansible repository, add the following to ./requirements.yml in your repository:

- name: <role-name>
  src: <git remote string>
  version: <version>

Description

explain what your role does short and concise

Dependencies

Ansible Roles
  • list any roles your role depends on here, including those specified in ./meta/main.yml
python packages
  • list any python packages your role depends on here, including those specified in .requirements.txt
custom ansible modules
  • list any required costum modules that are not included in ./library here

Requirements

  • list any other requirements here

Usage

explain in detail how and when your role should or should not be used and describe all functions and common use cases.

Role Variables

Specify all variables this role accepts here using the provided example table format. Sub-sections and table columns that are not required may be ommitted.

For complex structured variables, a codeblock outlining the schema and a separate table with variable descriptions should be added:

Schema for example_var:

example_var:
  - a_value:
    a_list:
      -
    a_list_of_dicts:
      - a_value:
        another_value:

feature switches

describe variables which are used to influence the behaviour of the entire role

Variable Type Required Default Description/purpose

group vars

describe variables to be specified per host group here. In a simple use cases, most variables go here

Variable Type Required Default Description/purpose

Host vars

If your role takes variables which are to be specified uniquely for each host in a group as opposed to the entire target host group, describe them here. A typical use case for this would be a role configuring a cluster, where some settings are to be applied to the entire cluster, and others differ per cluster node.

Variable Type Required Default Description/purpose

Example Playbook

provide an example of how to implement this role in a playbook. provide multiple examples if use cases differ largely

- name: execute my role
  hosts: <group of hosts>
  gather_facts: true
  roles:
    - role: my_role

ℹ️ This ansible role adheres to the Coven913 ansible role template.