diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 35d30d8d19343334b5befe558fb2a86b345c67c2..c3c17634ae99496ddb1a35bdb3935f4d8ee26e99 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -10,6 +10,15 @@ Common parameters A number of common parameters are used by all of the roles during deployment. This section lists such parameters. +**enable_backup** (boolean, optional, ``False``) + If set to ``True``, and the role supports backups, server will be configured + for back-up of role's data. See role description for more details on what is + backed-up and if the option is available. Just keep in mind that if you enable + this globally, all the roles will be running backup-specific tasks. If the + option has been enabled, the ``backup_client`` role will be included + automatically (see the role reference for details on parameters that need to + be provided in the case). + **tls_private_key_dir** (string, optional if paths to private keys for all roles are explicitly specified) Path to directory on Ansible host that contains the private keys used by services deployed by various roles. When TLS key path is not explicitly @@ -439,6 +448,17 @@ The role implements the following: * Sets the LDAP server administrator's password. +Backups +~~~~~~~ + +If the backup for this role has been enabled, the following paths are backed-up: + +**/srv/backup/slapd.bak** + Dump of the LDAP database. LDAP database dump is created every day at 01:45 in + the morning. This does *not* include the dump of the config database + (``cn=config``). + + Parameters ~~~~~~~~~~