Update documentation about configuring multiple consistency checks or multiple databases (#559).

This commit is contained in:
Dan Helfman 2022-07-03 22:24:25 -07:00
parent 673ed1a2d3
commit 6005426684
4 changed files with 15 additions and 7 deletions

3
NEWS
View file

@ -1,3 +1,6 @@
1.6.6.dev0
* #559: Update documentation about configuring multiple consistency checks or multiple databases.
1.6.5 1.6.5
* #553: Fix logging to include the full traceback when Borg experiences an internal error, not just * #553: Fix logging to include the full traceback when Borg experiences an internal error, not just
the first few lines. the first few lines.

View file

@ -52,6 +52,8 @@ hooks:
postgresql_databases: postgresql_databases:
- name: users - name: users
hostname: database1.example.org hostname: database1.example.org
- name: orders
hostname: database2.example.org
port: 5433 port: 5433
username: postgres username: postgres
password: trustsome1 password: trustsome1
@ -59,14 +61,14 @@ hooks:
options: "--role=someone" options: "--role=someone"
mysql_databases: mysql_databases:
- name: posts - name: posts
hostname: database2.example.org hostname: database3.example.org
port: 3307 port: 3307
username: root username: root
password: trustsome1 password: trustsome1
options: "--skip-comments" options: "--skip-comments"
mongodb_databases: mongodb_databases:
- name: messages - name: messages
hostname: database3.example.org hostname: database4.example.org
port: 27018 port: 27018
username: dbuser username: dbuser
password: trustsome1 password: trustsome1

View file

@ -83,12 +83,15 @@ consistency:
checks: checks:
- name: repository - name: repository
frequency: 2 weeks frequency: 2 weeks
- name: archives
frequency: 1 month
``` ```
This tells borgmatic to run this consistency check at most once every two This tells borgmatic to run the `repository` consistency check at most once
weeks for a given repository. The `frequency` value is a number followed by a every two weeks for a given repository and the `archives` check at most once a
unit of time, e.g. "3 days", "1 week", "2 months", etc. The `frequency` month. The `frequency` value is a number followed by a unit of time, e.g. "3
defaults to "always", which means run this check every time checks run. days", "1 week", "2 months", etc. The `frequency` defaults to `always`, which
means run this check every time checks run.
Unlike a real scheduler like cron, borgmatic only makes a best effort to run Unlike a real scheduler like cron, borgmatic only makes a best effort to run
checks on the configured frequency. It compares that frequency with how long checks on the configured frequency. It compares that frequency with how long

View file

@ -1,6 +1,6 @@
from setuptools import find_packages, setup from setuptools import find_packages, setup
VERSION = '1.6.5' VERSION = '1.6.6.dev0'
setup( setup(