patrick/zfs_autobackup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tried to clear up thinner documetion and output

Browse Source
This commit is contained in:
Edwin Eefting
2020-03-31 19:06:46 +02:00
parent bcf73c6e5c
commit 3a4062c983
2 changed files with 26 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -192,16 +192,16 @@ Run the script on the backup server and pull the data from the server specfied b
#### Settings summary #### Settings summary
[Source] Datasets on: pve.server.com [Source] Datasets on: pve.server.com
[Source] Keep the last 10 snapshots. [Source] Keep the last 10 snapshots.
[Source] Keep oldest of 1 day, delete after 1 week. [Source] Keep every 1 day, delete after 1 week.
[Source] Keep oldest of 1 week, delete after 1 month. [Source] Keep every 1 week, delete after 1 month.
[Source] Keep oldest of 1 month, delete after 1 year. [Source] Keep every 1 month, delete after 1 year.
[Source] Send all datasets that have 'autobackup:offsite1=true' or 'autobackup:offsite1=child' [Source] Send all datasets that have 'autobackup:offsite1=true' or 'autobackup:offsite1=child'
[Target] Datasets are local [Target] Datasets are local
[Target] Keep the last 10 snapshots. [Target] Keep the last 10 snapshots.
[Target] Keep oldest of 1 day, delete after 1 week. [Target] Keep every 1 day, delete after 1 week.
[Target] Keep oldest of 1 week, delete after 1 month. [Target] Keep every 1 week, delete after 1 month.
[Target] Keep oldest of 1 month, delete after 1 year. [Target] Keep every 1 month, delete after 1 year.
[Target] Receive datasets under: backup/pve [Target] Receive datasets under: backup/pve
#### Selecting #### Selecting
@ -253,21 +253,17 @@ Note that the thinner will ONLY destroy snapshots that are matching the naming p
#### Thinning schedule #### Thinning schedule
The thinner is specified by a comma separated string. The default thinning schedule is: `10,1d1w,1w1m,1m1y`. The default thinning schedule is: `10,1d1w,1w1m,1m1y`.
If you run zfs-autobackup with the `--verbose` option it will show you what this means: The schedule consists of multiple rules separated by a `,`
```console A plain number specifies how many snapshots you want to always keep, regardless of time or interval.
[Source] Keep the last 10 snapshots.
[Source] Keep oldest of 1 day, delete after 1 week.
[Source] Keep oldest of 1 week, delete after 1 month.
[Source] Keep oldest of 1 month, delete after 1 year.
```
* The plain number 10 means: keep at least the 10 most recent snapshots, regardless how old they are. The format of the other rules is: `<Interval><TTL>`.
* 1d1w means: Keep a daily snapshot, for one week.
* 1w1m means: Keep a weekly snapshot, for a month etc. * Interval: The minimum interval between the snapshots. Snapshots with intervals smaller than this will be destroyed.
* These are the time units you can use: * TTL: The maximum time to life time of a snapshot, after that they will be destroyed.
* These are the time units you can use for interval and TTL:
* `y`: Years * `y`: Years
* `m`: Months * `m`: Months
* `d`: Days * `d`: Days
@ -275,6 +271,17 @@ If you run zfs-autobackup with the `--verbose` option it will show you what this
* `min`: Minutes * `min`: Minutes
* `s`: Seconds * `s`: Seconds
Since this might sound very complicated, the `--verbose` option will show you what it all means:
```console
[Source] Keep the last 10 snapshots.
[Source] Keep every 1 day, delete after 1 week.
[Source] Keep every 1 week, delete after 1 month.
[Source] Keep every 1 month, delete after 1 year.
```
A snapshot will only be destroyed if it not needed anymore by ANY of the rules.
You can specify as many rules as you need. The order of the rules doesn't matter. You can specify as many rules as you need. The order of the rules doesn't matter.
Keep in mind its up to you to actually run zfs-autobackup often enough: If you want to keep hourly snapshots, you have to make sure you at least run it every hour. Keep in mind its up to you to actually run zfs-autobackup often enough: If you want to keep hourly snapshots, you have to make sure you at least run it every hour.

2
bin/zfs-autobackup
View File

@ -117,7 +117,7 @@ class ThinnerRule:
self.rule_str=rule_str self.rule_str=rule_str
self.human_str="Keep oldest of {} {}{}, delete after {} {}{}.".format( self.human_str="Keep every {} {}{}, delete after {} {}{}.".format(
period_amount, self.TIME_DESC[period_unit], period_amount!=1 and "s" or "", ttl_amount, self.TIME_DESC[ttl_unit], ttl_amount!=1 and "s" or "" ) period_amount, self.TIME_DESC[period_unit], period_amount!=1 and "s" or "", ttl_amount, self.TIME_DESC[ttl_unit], ttl_amount!=1 and "s" or "" )