sebclem/ansible-role-borgbackup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: configuration sections are deprecated
Some checks failed
Test / test (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Simon LEONARD 2024-02-09 18:16:01 +01:00 committed by SebClem
parent 84b0030581
commit b623f24c43
Signed by: sebclem
GPG Key ID: 5A4308F6A359EA50
1 changed files with 100 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

188
templates/config.yaml.j2
View File

@ -3,62 +3,77 @@
# Managed by Ansible, please don't edit manually # Managed by Ansible, please don't edit manually
# Full config: https://torsion.org/borgmatic/docs/reference/config.yaml # Full config: https://torsion.org/borgmatic/docs/reference/config.yaml
location:
{% if borg_source_directories is not defined or borg_source_directories | length == 0 %} {% if borg_source_directories is not defined or borg_source_directories | length == 0 %}
source_directories: source_directories:
- /etc/hostname # prevent empty backupconfig - /etc/hostname # prevent empty backupconfig
{% else %} {% else %}
source_directories: source_directories:
{% for dir in borg_source_directories %} {% for dir in borg_source_directories %}
- {{ dir }} - {{ dir }}
{% endfor %} {% endfor %}
{% endif %} {% endif %}
# Stay in same file system (do not cross mount points). # Stay in same file system (do not cross mount points).
one_file_system: {{ borg_one_file_system }} one_file_system: {{ borg_one_file_system }}
repositories:
{# List of... #}
repositories:
{% if borg_repository is iterable and (borg_repository is not string and borg_repository is not mapping) %} {% if borg_repository is iterable and (borg_repository is not string and borg_repository is not mapping) %}
{% for repo in borg_repository %} {% for repo in borg_repository %}
- {{ repo }} {# ...mappings #}
{% if repo is mapping and "path" in repo and "label" in repo %}
{{ [repo] | to_nice_yaml(indent=2) | trim | indent(4) }}
{# ...strings (legacy) #}
{% elif repo is string %}
- path: {{ repo }}
label: {{ repo }}
{% endif %}
{% endfor %} {% endfor %}
{# Mapping with path and label key #}
{% elif borg_repository is defined and borg_repository is mapping and "path" in borg_repository and "label" in borg_repository %}
- path: {{ borg_repository.path }}
label: {{ borg_repository.label }}
{# String (legacy) #}
{% elif borg_repository is defined and borg_repository is string %} {% elif borg_repository is defined and borg_repository is string %}
- {{ borg_repository }} - path: {{ borg_repository }}
label: {{ borg_repository }}
{% endif %} {% endif %}
# Store atime into archive. # Store atime into archive.
atime: {{ borgmatic_store_atime }} atime: {{ borgmatic_store_atime }}
# Store ctime into archive. # Store ctime into archive.
ctime: {{ borgmatic_store_ctime }} ctime: {{ borgmatic_store_ctime }}
{% if borg_exclude_patterns %} {% if borg_exclude_patterns %}
# Any paths matching these patterns are excluded from backups. Globs and tildes # Any paths matching these patterns are excluded from backups. Globs and tildes
# are expanded. See the output of "borg help patterns" for more details. # are expanded. See the output of "borg help patterns" for more details.
exclude_patterns: exclude_patterns:
{% for dir in borg_exclude_patterns %} {% for dir in borg_exclude_patterns %}
- '{{ dir }}' - '{{ dir }}'
{% endfor %} {% endfor %}
{% endif %} {% endif %}
{% if borg_exclude_from %} {% if borg_exclude_from %}
# Read exclude patterns from one or more separate named files, one pattern per # Read exclude patterns from one or more separate named files, one pattern per
# line. See the output of "borg help patterns" for more details. # line. See the output of "borg help patterns" for more details.
exclude_from: exclude_from:
{% for dir in borg_exclude_from %} {% for dir in borg_exclude_from %}
- {{ dir }} - {{ dir }}
{% endfor %} {% endfor %}
{% endif %} {% endif %}
# Exclude directories that contain a CACHEDIR.TAG file. See # Exclude directories that contain a CACHEDIR.TAG file. See
# http://www.brynosaurus.com/cachedir/spec.html for details. # http://www.brynosaurus.com/cachedir/spec.html for details.
exclude_caches: true exclude_caches: true
# Exclude directories that contain a file with the given filename. # Exclude directories that contain a file with the given filename.
exclude_if_present: .nobackup exclude_if_present:
- .nobackup
# Alternate Borg remote executable. Defaults to "borg". # Alternate Borg remote executable. Defaults to "borg".
# remote_path: borg1 # remote_path: borg1
{% if borg_remote_path %} {% if borg_remote_path %}
remote_path: {{ borg_remote_path }} remote_path: {{ borg_remote_path }}
{% endif %} {% endif %}
# Repository storage options. See # Repository storage options. See
@ -76,107 +91,104 @@ storage:
# then encryption_passphrase takes precedence. # then encryption_passphrase takes precedence.
# encryption_passcommand: secret-tool lookup borg-repository repo-name # encryption_passcommand: secret-tool lookup borg-repository repo-name
{% if borg_encryption_passcommand %} {% if borg_encryption_passcommand %}
encryption_passcommand: {{ borg_encryption_passcommand }} encryption_passcommand: {{ borg_encryption_passcommand }}
{% endif %} {% endif %}
# Type of compression to use when creating archives. See # Type of compression to use when creating archives. See
# https://borgbackup.readthedocs.org/en/stable/usage.html#borg-create for details. # https://borgbackup.readthedocs.org/en/stable/usage.html#borg-create for details.
# Defaults to no compression. # Defaults to no compression.
compression: auto,zstd compression: auto,zstd
# Remote network upload rate limit in kiBytes/second. # Remote network upload rate limit in kiBytes/second.
{% if borg_remote_rate_limit %} {% if borg_remote_rate_limit %}
remote_rate_limit: {{ borg_remote_rate_limit }} remote_rate_limit: {{ borg_remote_rate_limit }}
{% endif %} {% endif %}
# Command to use instead of just "ssh". This can be used to specify ssh options. # Command to use instead of just "ssh". This can be used to specify ssh options.
# ssh_command: ssh -i ~/.ssh/id_ed25519 # ssh_command: ssh -i ~/.ssh/id_ed25519
{% if borg_ssh_command %} {% if borg_ssh_command %}
ssh_command: {{ borg_ssh_command }} ssh_command: {{ borg_ssh_command }}
{% endif %} {% endif %}
# Umask to be used for borg create. # Umask to be used for borg create.
umask: 0077 umask: 0077
# Maximum seconds to wait for acquiring a repository/cache lock. # Maximum seconds to wait for acquiring a repository/cache lock.
lock_wait: {{ borg_lock_wait_time }} lock_wait: {{ borg_lock_wait_time }}
# Name of the archive. Borg placeholders can be used. See the output of # Name of the archive. Borg placeholders can be used. See the output of
# "borg help placeholders" for details. Default is # "borg help placeholders" for details. Default is
# "{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this option, you must # "{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this option, you must
# also specify a prefix in the retention section to avoid accidental pruning of # also specify a prefix in the retention section to avoid accidental pruning of
# archives with a different archive name format. And you should also specify a # archives with a different archive name format. And you should also specify a
# prefix in the consistency section as well. # prefix in the consistency section as well.
archive_name_format: '{hostname}-{now:%Y-%m-%d-%H%M%S}' archive_name_format: '{hostname}-{now:%Y-%m-%d-%H%M%S}'
# Bypass Borg error about a repository that has been moved. # Bypass Borg error about a repository that has been moved.
relocated_repo_access_is_ok: {{ borgmatic_relocated_repo_access_is_ok }} relocated_repo_access_is_ok: {{ borgmatic_relocated_repo_access_is_ok }}
# Retention policy for how many backups to keep in each category. See # Retention policy for how many backups to keep in each category. See
# https://borgbackup.readthedocs.org/en/stable/usage.html#borg-prune for details. # https://borgbackup.readthedocs.org/en/stable/usage.html#borg-prune for details.
# At least one of the "keep" options is required for pruning to work. # At least one of the "keep" options is required for pruning to work.
retention:
{% if borg_retention_policy.keep_secondly is defined %} {% if borg_retention_policy.keep_secondly is defined %}
# Number of secondly archives to keep. # Number of secondly archives to keep.
keep_secondly: {{ borg_retention_policy.keep_secondly }} keep_secondly: {{ borg_retention_policy.keep_secondly }}
{% endif %} {% endif %}
{% if borg_retention_policy.keep_minutely is defined %} {% if borg_retention_policy.keep_minutely is defined %}
# Number of minutely archives to keep. # Number of minutely archives to keep.
keep_minutely: {{ borg_retention_policy.keep_minutely }} keep_minutely: {{ borg_retention_policy.keep_minutely }}
{% endif %} {% endif %}
{% if borg_retention_policy.keep_hourly is defined %} {% if borg_retention_policy.keep_hourly is defined %}
# Number of hourly archives to keep. # Number of hourly archives to keep.
keep_hourly: {{ borg_retention_policy.keep_hourly }} keep_hourly: {{ borg_retention_policy.keep_hourly }}
{% endif %} {% endif %}
{% if borg_retention_policy.keep_daily is defined %} {% if borg_retention_policy.keep_daily is defined %}
# Number of daily archives to keep. # Number of daily archives to keep.
keep_daily: {{ borg_retention_policy.keep_daily }} keep_daily: {{ borg_retention_policy.keep_daily }}
{% endif %} {% endif %}
{% if borg_retention_policy.keep_weekly is defined %} {% if borg_retention_policy.keep_weekly is defined %}
# Number of weekly archives to keep. # Number of weekly archives to keep.
keep_weekly: {{ borg_retention_policy.keep_weekly }} keep_weekly: {{ borg_retention_policy.keep_weekly }}
{% endif %} {% endif %}
{% if borg_retention_policy.keep_monthly is defined %} {% if borg_retention_policy.keep_monthly is defined %}
# Number of monthly archives to keep. # Number of monthly archives to keep.
keep_monthly: {{ borg_retention_policy.keep_monthly }} keep_monthly: {{ borg_retention_policy.keep_monthly }}
{% endif %} {% endif %}
{% if borg_retention_policy.keep_yearly is defined %} {% if borg_retention_policy.keep_yearly is defined %}
# Number of yearly archives to keep. # Number of yearly archives to keep.
keep_yearly: {{ borg_retention_policy.keep_yearly }} keep_yearly: {{ borg_retention_policy.keep_yearly }}
{% endif %} {% endif %}
# Consistency checks to run after backups. See # Consistency checks to run after backups. See
# https://borgbackup.readthedocs.org/en/stable/usage.html#borg-check and # https://borgbackup.readthedocs.org/en/stable/usage.html#borg-check and
# https://borgbackup.readthedocs.org/en/stable/usage.html#borg-extract for details. # https://borgbackup.readthedocs.org/en/stable/usage.html#borg-extract for details.
consistency: # List of one or more consistency checks to run: "repository",
# List of one or more consistency checks to run: "repository", # "archives", "data", and/or "extract". Defaults to
# "archives", "data", and/or "extract". Defaults to # "repository" and "archives". Set to "disabled" to disable
# "repository" and "archives". Set to "disabled" to disable # all consistency checks. "repository" checks the consistency
# all consistency checks. "repository" checks the consistency # of the repository, "archives" checks all of the archives,
# of the repository, "archives" checks all of the archives, # "data" verifies the integrity of the data within the
# "data" verifies the integrity of the data within the # archives, and "extract" does an extraction dry-run of the
# archives, and "extract" does an extraction dry-run of the # most recent archive. Note that "data" implies "archives".
# most recent archive. Note that "data" implies "archives". checks:
checks: {% for checks in borgmatic_checks %}
{% for checks in borgmatic_checks %} - {{ checks }}
- {{ checks }} {% endfor %}
{% endfor %}
# Restrict the number of checked archives to the last n. Applies only to the "archives" check. # Restrict the number of checked archives to the last n. Applies only to the "archives" check.
check_last: {{ borgmatic_check_last }} check_last: {{ borgmatic_check_last }}
# Shell commands or scripts to execute before and after a backup or if an error has occurred. # Shell commands or scripts to execute before and after a backup or if an error has occurred.
# IMPORTANT: All provided commands and scripts are executed with user permissions of borgmatic. # IMPORTANT: All provided commands and scripts are executed with user permissions of borgmatic.
# Do not forget to set secure permissions on this file as well as on any script listed (chmod 0700) to # Do not forget to set secure permissions on this file as well as on any script listed (chmod 0700) to
# prevent potential shell injection or privilege escalation. # prevent potential shell injection or privilege escalation.
hooks:
{% for hook in borgmatic_hooks %} {% for hook in borgmatic_hooks %}
{{ hook }}: {{ hook }}:
{{ borgmatic_hooks[hook] | to_nice_yaml(indent=2) | trim | indent(8) }} {{ borgmatic_hooks[hook] | to_nice_yaml(indent=2) | trim | indent(8) }}
{% endfor %} {% endfor %}