47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
Role Name
|
|
=========
|
|
|
|
A brief description of the role goes here.
|
|
|
|
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
|
|
--------------
|
|
|
|
* burp_folders: list of folders to backup [ /etc, /root, /home ]
|
|
* burp_server_directory: "/srv/Backups/{{ group_name[0] | lower }}/{{ inventory_hostname }}/"
|
|
* burp_server: default guillotine.opendoor.fr
|
|
* burp_packages: name of burp package to install
|
|
* burp_cname: name of burp client - {{ ansible_hostname }}
|
|
* burp_password - group_names[0]}}/{{ inventory_hostname }}_burp_password
|
|
* burp_encryption_password - group_names[0]}}/{{ inventory_hostname }}_burp_encryption_password
|
|
* burp_retention: default [ 7 ]
|
|
* burp_watch - wether we monitor backup status - default true
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
none
|
|
|
|
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
|
|
roles:
|
|
- { role: username.rolename, x: 42 }
|
|
|
|
License
|
|
-------
|
|
|
|
BSD
|
|
|
|
Author Information
|
|
------------------
|
|
|
|
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|