Commit 372e47d9 authored by Pietsch, Martin's avatar Pietsch, Martin

added documentation

parent acd98eb9
Role Name
=========
Description
===========
A brief description of the role goes here.
This role installs and configures the sudo utility.
Requirements
------------
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.
Dependencies
------------
============
Variables
----------
* sudo_defaults:
* description:
* This option is a list of `sudo_defaults_item`. This items contain the default values for all sudo options.
* default:
- name: "env_keep"
parameters: ["+DISPLAY HOME"]
* sudo_defaults_item:
* description:
* This item type is a dictionary and contains the default values for all sudo options.
* The keys are:
* name: The name of the sudo option.
* parameters: This key contains a list of all option parameters. A leading `+` adds a the value to a list option and a leading `-` removes it.
* type: The type key specifies the type that is affected by this option and these parameters. Types are: all (default), hosts, cmnds, users, runas
* assignto: If the type is not set to `all`, a single name or list of names to which the parameters are to be assigned must be set.
* enabled: Specifies if the sudo option is enabled (true) or disabled (false). The default value is true.
* sudo_aliases:
* description:
* This option is a list of `sudo_aliases_item`. This items contain the alias names for lists of users, hosts, commands or runas members.
* default: []
* sudo_aliases_item:
* description:
* This item type is a dictionary and contains a alias name for a list of users, hosts, commands or runas members.
* The keys are:
* name: The name of the alias.
* type: The type key specifies the type of the alias: Possible types are: host, cmnd, user, runas
* members: The key `members` is a list of all alias members.
Processes
=========
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.
main
----
Example Playbook
----------------
1. NOP
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
configure
---------
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
1. NOP
License
-------
=======
BSD
Author Information
------------------
Contributors
============
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
- Martin Pietsch (martin.pietsch@tu-dresden.de)
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