aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJulien Dessaux2021-05-02 18:42:01 +0200
committerJulien Dessaux2021-05-02 18:42:01 +0200
commit5d9a22501476b3384451b98eeb6b1dee65fed21d (patch)
tree51bcbd1914beda62ea450fb14bba3ee13670e52a /README
parentFixed stupid ansible python sucks silent name collision (diff)
downloadborg-ansible-role-5d9a22501476b3384451b98eeb6b1dee65fed21d.tar.gz
borg-ansible-role-5d9a22501476b3384451b98eeb6b1dee65fed21d.tar.bz2
borg-ansible-role-5d9a22501476b3384451b98eeb6b1dee65fed21d.zip
Reworked and improved borg role
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 0 insertions, 22 deletions
diff --git a/README b/README
deleted file mode 100644
index 45a64d3..0000000
--- a/README
+++ /dev/null
@@ -1,22 +0,0 @@
-There are several variables you can define to configure a machines response to the borg role :
-- borg_server: a string that contains a borg servers hostname
-- borg_jobs: a list of dict, one item per job with the following keys:
- - name: the name of the borg job
- - path: an optional path containing the files to backup
- - command_to_pipe: an optional command to pipe the backup data from
- - pre_command: an optional command to run before a job
- - post_command: an optional command to run after a job
- - exclude: an optional list of paths containing locations to exclude
-
-To be valid, a borg job entry needs to have exactly one of the path or command_to_pipe keys.
-
-Here are some job examples :
-- { name: etc, path: "/etc", exclude: [ "/etc/firmware" ] }
-- { name: mysqldump, command_to_pipe: "/usr/bin/mysqldump -h {{ mysql_server }} -u{{ ansible_hostname }} -p{{ ansible_local.mysql_client.password }} --single-transaction --add-drop-database -B {{ ansible_hostname }}" }
-- { name: gitea, path: "/tmp/gitea.zip", pre_command: "echo '/usr/local/sbin/gitea -C /etc/gitea -c /etc/gitea/app.ini dump -f /tmp/gitea.zip' | su -l _gitea", post_command: "rm -f /tmp/gitea.zip" }
-
-There is an action plugin that parses the borg_server entries from all host_vars and set the borg.is_server fact to True for any machine specified as a backup target
-
-Usefull commands:
-=================
-ansible all -i hosts -m shell -a "/usr/local/bin/adyxax_backup.sh"