Commit a9559065 authored by Pietsch, Martin's avatar Pietsch, Martin
Browse files

added documentation

parent 406fba32
Role Name
A brief description of the role goes here.
This role is the top level package of all packaging categorised software and does not provide a special software product.
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
Role Variables
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
- development note: Define these variables in the defaults/main.yml file of your sub-role.
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
Example Playbook
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
- hosts: servers
- { role: username.rolename, x: 42 }
1. NOP
Author Information
1. NOP
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment