forked from borgmatic-collective/borgmatic
Compare commits
762 Commits
Author | SHA1 | Date | |
---|---|---|---|
08843d51d9 | |||
ea9213cb03 | |||
1ea4433aa9 | |||
4c0e2cab78 | |||
31a2ac914a | |||
d6ef0df50d | |||
cc60a71210 | |||
4cd7556a34 | |||
b4b1fa939d | |||
16d7131fb7 | |||
091d60c226 | |||
0fbdf8d860 | |||
192bfe46a9 | |||
080c3afa0d | |||
a9a65ebe54 | |||
616eb6b6da | |||
00d1dea94e | |||
127ad1dd1f | |||
fc58ba5763 | |||
7e6bee84b0 | |||
01811e03ba | |||
9712d00680 | |||
275e99d0b9 | |||
b9328e6d42 | |||
2934d0902c | |||
1ad43ad4b5 | |||
32ab17fa46 | |||
6054ced931 | |||
1412038ed3 | |||
|
fa8bc285c8 | ||
f256908b27 | |||
3f78ac4085 | |||
5f595f7ac3 | |||
b27e625a77 | |||
fc2c181b74 | |||
010b82d6d8 | |||
aaf3462d17 | |||
f709125110 | |||
3512191f3e | |||
06b5d81baa | |||
9d71bf916e | |||
59fe01b56d | |||
08e358e27f | |||
ce22d2d302 | |||
2d08a63e60 | |||
d96f2239c1 | |||
67a349ae44 | |||
dcefded0fa | |||
1bcdebd1cc | |||
7a8e0e89dd | |||
489ae080e5 | |||
0e3da7be63 | |||
c5ffb76dfa | |||
61c7b8f13c | |||
3e8e38011b | |||
d0d3a39833 | |||
8bef1c698b | |||
acbbd6670a | |||
b336b9bedf | |||
ec9def4e71 | |||
a136fda92d | |||
b511e679ae | |||
f56fdab7a9 | |||
8c0eea7229 | |||
19e95628c3 | |||
4d01e53414 | |||
a082cb87cb | |||
1c51a8e229 | |||
d14a8df71a | |||
739a58fe47 | |||
af3431d6ae | |||
9851abc2e1 | |||
61ce6f0473 | |||
78e8bb6c8c | |||
af95134cd2 | |||
d6dfb8753a | |||
1bc003560a | |||
aeaf69f49e | |||
e83ad9e1e4 | |||
f42890430c | |||
6f300b0079 | |||
9bec029b4f | |||
08afad5d81 | |||
a01dc62468 | |||
8b61225b13 | |||
66d2f49f18 | |||
0a72c67c6c | |||
ab64b7ef67 | |||
1e3a3bf1e7 | |||
7a2f287918 | |||
8a63c49498 | |||
3b5ede8044 | |||
bd235f0426 | |||
09183464cd | |||
ca6fd6b061 | |||
dd9a64f4b6 | |||
23e7f27ee4 | |||
f9ef52f9a5 | |||
3f17c355ca | |||
c83fae5e5b | |||
39ad8f64c4 | |||
e86d223bbf | |||
86587ab2dc | |||
58c95d8015 | |||
6351747da5 | |||
55c153409e | |||
b115fb2fbe | |||
31d04d9ee3 | |||
f803836416 | |||
997f60b3e6 | |||
c84b26499b | |||
214ae81cbb | |||
d17b2c74db | |||
fb9677230b | |||
0db137efdf | |||
e6605c868d | |||
bdfe4b61eb | |||
ca4461820d | |||
7605838bfe | |||
7a784b8eba | |||
|
3e22414613 | ||
|
5f87ea3ec5 | ||
|
a8aeace5b5 | ||
|
480addd7ce | ||
|
ce0ce4cd1c | ||
|
7de9260b0d | ||
|
cdbe6cdf3a | ||
95dcc20d5f | |||
49e0494924 | |||
|
5fad2bd408 | ||
c6829782a3 | |||
8cec7c74d8 | |||
d3086788eb | |||
8d860ea02c | |||
b343363bb8 | |||
9db31bd1e9 | |||
d88bcc8be9 | |||
332f7c4bb6 | |||
5d19d86e4a | |||
044ae7869a | |||
62ae82f2c0 | |||
66194b7304 | |||
98e429594e | |||
4fcfddbe08 | |||
f442aeae9c | |||
e211863cba | |||
45256ae33f | |||
1573d68fe2 | |||
69f6695253 | |||
a7c055264d | |||
db18364a73 | |||
22498ebd4c | |||
e1f02d9fa5 | |||
9ec220c600 | |||
cf0275a3ed | |||
c71eb60cd2 | |||
675e54ba9f | |||
1793ad74bd | |||
767a7d900b | |||
903507bd03 | |||
b6cf7d2adc | |||
a071e02d20 | |||
3aa88085ed | |||
af1cc27988 | |||
dbf8301c19 | |||
2a306bef12 | |||
2a36a2a312 | |||
d7a07f0428 | |||
da321e180d | |||
c6582e1171 | |||
9b83afe491 | |||
2814ac3642 | |||
8a9d5d93f5 | |||
783a6d3b45 | |||
95575c3450 | |||
9b071ff92f | |||
d80e716822 | |||
418ebc8843 | |||
f5a448c7c2 | |||
37ac542b31 | |||
|
8c7d7e3e41 | ||
b811f125b2 | |||
061f3e7917 | |||
6055918907 | |||
4a90e090ad | |||
301b29ee11 | |||
c1eb210253 | |||
30cca62d09 | |||
113c0e7616 | |||
0e6b2c6773 | |||
22c750b949 | |||
504cce39a1 | |||
6c4abb6803 | |||
|
fd7ad86daa | ||
6f3b23c79d | |||
4838f5e810 | |||
116f1ab989 | |||
5e15c9f2bc | |||
442641f9f6 | |||
f67c544be6 | |||
437fd4dbae | |||
36873252d6 | |||
1ef82a27fa | |||
6837dcbf42 | |||
c657764367 | |||
f79286fc91 | |||
694d376d15 | |||
ab4c08019c | |||
fd39f54df7 | |||
ca7e18bb29 | |||
6975a5b155 | |||
b627d00595 | |||
9bd8f1a6df | |||
|
faf682ca35 | ||
6aeb74550d | |||
89500df429 | |||
82b072d0b7 | |||
018c0296fd | |||
9c42e7e817 | |||
953277a066 | |||
e2002b5488 | |||
c9742e1d04 | |||
906da838ef | |||
d7f1c10c8c | |||
e8e4d17168 | |||
a31ce337e9 | |||
902730df46 | |||
c969c822ee | |||
c31702d092 | |||
ba8fbe7a44 | |||
2774c2e4c0 | |||
ae036aebd7 | |||
|
2e9f70d496 | ||
90be5b84b1 | |||
80e95f20a3 | |||
ac7c7d4036 | |||
858b0b9fbe | |||
9cc043f60e | |||
276a27d485 | |||
679bb839d7 | |||
9e64d847ef | |||
61fb275896 | |||
ca0c79c93c | |||
87c97b7568 | |||
80b8c25bba | |||
d1837cd1d3 | |||
c46f2b8508 | |||
a274c0dbf7 | |||
ef7e95e22a | |||
3be99de5b1 | |||
e7b7560477 | |||
317dc7fbce | |||
97fad15009 | |||
462326406e | |||
bbdf4893d1 | |||
ef6617cfe6 | |||
dbef0a440f | |||
22628ba5d4 | |||
8576ac86b9 | |||
540f9f6b72 | |||
f9d7faf884 | |||
7dee6194a2 | |||
68f9c1b950 | |||
43d711463c | |||
00255a2437 | |||
b40e9b7da2 | |||
89d201c8ff | |||
f47c98c4a5 | |||
3b6ed06686 | |||
57009e22b5 | |||
3ab7a3b64a | |||
596dd49cf5 | |||
28d847b8b1 | |||
2a1c6b1477 | |||
30abd0e3de | |||
f36e38ec20 | |||
d807ce095e | |||
7626fe1189 | |||
cc04bf57df | |||
cce6d56661 | |||
a05d0f378e | |||
94321aec7a | |||
4a55749bd2 | |||
2898e63166 | |||
c7176bd00a | |||
647ecdac29 | |||
e7a8acfb96 | |||
622caa0c21 | |||
22149c6401 | |||
9aece3936a | |||
c7e4e6f6c9 | |||
bcad0de1a4 | |||
|
5c6407047f | ||
6ddae20fa1 | |||
23feac2f4c | |||
16066942e3 | |||
|
3720f22234 | ||
|
f7c8e89a9f | ||
|
ba377952fd | ||
|
1fdec480d6 | ||
e85d551eac | |||
2b23a63a08 | |||
c0f48e1071 | |||
6005426684 | |||
673ed1a2d3 | |||
992f62edd2 | |||
f1ffa1da1d | |||
457ed80744 | |||
1fc028ffae | |||
10723efc68 | |||
2e0b2a308f | |||
bd4d109009 | |||
ae25386336 | |||
d929313d45 | |||
d372a86fe6 | |||
e306f03e1d | |||
8336165f23 | |||
c664c6b17b | |||
b63c854509 | |||
aa013af25e | |||
cc32f0018b | |||
dfc4db1860 | |||
35706604ea | |||
6d76e8e5cb | |||
aecb6fcd74 | |||
ea45f6c4c8 | |||
97b5cd089d | |||
f2c2f3139e | |||
dc4e7093e5 | |||
b6f1025ecb | |||
65b2fe86c6 | |||
0e90a80680 | |||
7648bcff39 | |||
a8b8d507b6 | |||
3561c93d74 | |||
331a503a25 | |||
9aefb5179f | |||
d14f22e121 | |||
b6893f6455 | |||
80ec3e7d97 | |||
cd834311eb | |||
d751cceeb0 | |||
ce78b07e4b | |||
87f3c50931 | |||
8e9e06afe6 | |||
2bc91ac3d2 | |||
5b615d51a4 | |||
c7f5d5fd0b | |||
6ef7538eb0 | |||
8fa90053cf | |||
b3682b61d1 | |||
ad0e2e0d7c | |||
6629f40cab | |||
e76bfa555f | |||
8ddb7268eb | |||
cb5fe02ebd | |||
77b84f8a48 | |||
691ec96909 | |||
29b4666205 | |||
316a22701f | |||
be59a3e574 | |||
37327379bc | |||
22c2f13611 | |||
8708ca07f4 | |||
634d9e4946 | |||
54933ebef5 | |||
157e59ac88 | |||
666f0dd751 | |||
8b179e4647 | |||
865eff7d98 | |||
b9741f4d0b | |||
02781662f8 | |||
32a1043468 | |||
3e4aeec649 | |||
b98b827594 | |||
255cc6ec23 | |||
51fc37d57a | |||
1921f55a9d | |||
fbd381fcc1 | |||
cd88f9f2ea | |||
788281cfb9 | |||
cd234b689d | |||
92354a77ee | |||
48ff3e70d1 | |||
7e9adfb899 | |||
e238e256f7 | |||
|
3ecb92a8d2 | ||
d58d450628 | |||
dee9c6e293 | |||
897c4487de | |||
48b50b5209 | |||
13bae8c23b | |||
4a48e6aa04 | |||
525266ede6 | |||
d045eb55ac | |||
0e6b425ac5 | |||
bdc26f2117 | |||
ed7fe5c6d0 | |||
cbce6707f4 | |||
e40e726687 | |||
0c027a3050 | |||
9f44bbad65 | |||
413a079f51 | |||
6f3accf691 | |||
5b3cfc542d | |||
c838c1d11b | |||
4d1d8d7409 | |||
db7499db82 | |||
6b500c2a8b | |||
95c518e59b | |||
976516d0e1 | |||
574eb91921 | |||
28fef3264b | |||
9161dbcb7d | |||
4b3027e4fc | |||
0eb2634f9b | |||
7c5b68c98f | |||
9317cbaaf0 | |||
1b5f04b79f | |||
948c86f62c | |||
7e7209322a | |||
00a57fd947 | |||
6bf6ac310b | |||
4b5af2770d | |||
b525e70e1c | |||
4498671233 | |||
9997aa9a92 | |||
cbf7284f64 | |||
ee466f870d | |||
e3f4bf0293 | |||
46688f10b1 | |||
48f44d2f3d | |||
bff1347ba3 | |||
9582324c88 | |||
bb0716421d | |||
bec73245e9 | |||
dcead12e86 | |||
0119514c11 | |||
b39f08694d | |||
80bdf1430b | |||
2ee75546f5 | |||
07d7ae60d5 | |||
87001337b4 | |||
2e9964c200 | |||
3ec3d8d045 | |||
96384d5ee1 | |||
8ed5467435 | |||
7c6ce9399c | |||
6b7653484b | |||
|
85e0334826 | ||
|
2a80e48a92 | ||
|
5821c6782e | ||
|
f15498f6d9 | ||
a1673d1fa1 | |||
2e99a1898c | |||
7a086d8430 | |||
0e8e9ced64 | |||
f34951c088 | |||
c6f47d4d56 | |||
c3e76585fc | |||
0014b149f8 | |||
091c07bbe2 | |||
240547102f | |||
2bbd53e25a | |||
58f2f63977 | |||
7df6a78c30 | |||
c646edf2c7 | |||
bcc820d646 | |||
3729ba5ca3 | |||
9c19591768 | |||
38ebfd2969 | |||
180018fd81 | |||
794ae94ac4 | |||
4eb6359ed3 | |||
|
976a877a25 | ||
|
b4117916b8 | ||
|
19cad89978 | ||
6b182c9d2d | |||
4d6ed27f73 | |||
745a8f9b8a | |||
6299d8115d | |||
717cfd2d37 | |||
7881327004 | |||
549aa9a25f | |||
1c6890492b | |||
a7c8e7c823 | |||
c8fcf6b336 | |||
449896f661 | |||
1004500d65 | |||
0a8d4e5dfb | |||
38e35bdb12 | |||
65503e38b6 | |||
d0c5bf6f6f | |||
f129e4c301 | |||
fbbb096cec | |||
77980511c6 | |||
4ba206f8f4 | |||
ecc849dd07 | |||
7ff6066d47 | |||
2bb1fc9826 | |||
|
6df6176f3a | ||
acb2ca79d9 | |||
c9211320e1 | |||
760286abe1 | |||
5890a1cb48 | |||
b3f5a9d18f | |||
80b33fbf8a | |||
5389ff6160 | |||
|
e8b8d86592 | ||
92d729a9dd | |||
c63219936e | |||
0aff497430 | |||
1f3907a6a5 | |||
2a8692c64f | |||
1709f57ff0 | |||
|
89baf757cf | ||
|
4f36fe2b9f | ||
|
510449ce65 | ||
|
4cc4b8d484 | ||
9c972cb0e5 | |||
9b1779065e | |||
057ec3e59b | |||
bc2e611a74 | |||
b6d3a1e02f | |||
54d57e1349 | |||
af0b3da8ed | |||
27d37b606b | |||
77a860cc62 | |||
7bd6374751 | |||
cf8882f2bc | |||
b37dd1a79e | |||
fd59776f91 | |||
9fd28d2eed | |||
f5c61c8013 | |||
88cb49dcc4 | |||
73235e59be | |||
7076a7ff86 | |||
d6e376d32d | |||
9016f4be43 | |||
d1c403999f | |||
d543109ef4 | |||
7085a45649 | |||
cf4c603f1d | |||
d2533313bc | |||
c43b50b6e6 | |||
c072678936 | |||
631da1465e | |||
f29519a5cd | |||
|
5d82b42ab8 | ||
4897a78fd3 | |||
a1d986d952 | |||
717c90a7d0 | |||
8fde19a7dc | |||
ad7198ba66 | |||
eb4b4cc92b | |||
41bf520585 | |||
c0ae01f5d5 | |||
8b8f92d717 | |||
ccd1627175 | |||
b8a7e23f46 | |||
1f4f28b4dc | |||
ea6cd53067 | |||
267138776d | |||
604b3d5e17 | |||
667e1e5b15 | |||
9b819f32f8 | |||
b619bde037 | |||
97af16bd86 | |||
fa75f89acc | |||
222b61b577 | |||
e77757f0fd | |||
ebac02f118 | |||
1c9ae81987 | |||
7b1fb68c18 | |||
8aa7830f0d | |||
79bee755ee | |||
|
cde0ee96ff | ||
1ea04aedf0 | |||
446a2bc15a | |||
|
2d10e758e0 | ||
0e978299cf | |||
d06c1f2943 | |||
d768b50b97 | |||
034ade48f2 | |||
d1e9f74087 | |||
f262f77dbd | |||
a3387953a9 | |||
|
7cad5a8608 | ||
9b83fcbf06 | |||
32a93ce8a2 | |||
e428329c03 | |||
e844bbee15 | |||
631c3068a9 | |||
79d4888e22 | |||
de61fdef48 | |||
93caeba200 | |||
3c723e8d99 | |||
c5776447b9 | |||
5356f487a5 | |||
72bd96c656 | |||
f611fe7be3 | |||
dd6ea40a36 | |||
ea1274d1c6 | |||
8526468975 | |||
|
95c415f416 | ||
06dc336481 | |||
893fca2816 | |||
99590cb6b6 | |||
b3fd1be5f6 | |||
a23083f737 | |||
8306b758e8 | |||
218cbd5289 | |||
2ac58670d5 | |||
6f82c9979b | |||
0a659a397f | |||
2781873faf | |||
3aaa89fb08 | |||
35d542a676 | |||
d0b9c436b1 | |||
37cc229749 | |||
17c2d109e5 | |||
c8d5de2179 | |||
32e15dc905 | |||
f5ebca4907 | |||
01db676d68 | |||
d2d92b1f1a | |||
27cbe9dfc0 | |||
8fb830099f | |||
463a133a63 | |||
a16fed8887 | |||
33113890f5 | |||
abd47fc14e | |||
7fb4061759 | |||
b320e74ad5 | |||
0ed8f67b9d | |||
a12a1121b6 | |||
795e18773b | |||
aa14449857 | |||
ed7b1cd3d7 | |||
a155eefa23 | |||
398665be9e | |||
6db232d4ac | |||
d7277893fb | |||
00033bf0a8 | |||
adda33dc4e | |||
097a09578a | |||
65472c8de2 | |||
602ad9e7ee | |||
96df52ec50 | |||
244dc35bae | |||
d9c9d7d2ee | |||
89cb5eb76d | |||
6d3802335e | |||
c1d6232b79 | |||
048a9ebb52 | |||
de478f6ff7 | |||
3e5a19d95a | |||
2ddf38f99c | |||
d88f321cef | |||
74adac6c70 | |||
15ea70a71b | |||
8b91c01a4c | |||
3bcef72050 | |||
695c764a01 | |||
f7c93ea2e8 | |||
1ea047dd94 | |||
4b523f9e2c | |||
6a61070d85 | |||
f36082938e | |||
1ba996ad93 | |||
a23fdf946d | |||
12cf6913ef | |||
a4eef383c3 | |||
ac124612ad | |||
95a479a86e | |||
e4eff0e3dc | |||
dce1928dc4 | |||
|
3c8dc4929f | ||
e511014a28 | |||
bae5f88824 | |||
41ad98653a | |||
6a138aeb6e | |||
f0ce37801b | |||
35f6aba365 | |||
|
f6407bafcb | ||
|
d5e9f67cec | ||
|
b14f371c05 | ||
31a5d1b9c4 | |||
fb4305a953 | |||
eab872823c | |||
3332750243 | |||
4942b7ce4d | |||
a2af77f363 | |||
a7490b56d1 | |||
66eb18d5ea | |||
46486138b6 | |||
d6562c4b1e | |||
1ddde0910c | |||
79f3b84ca2 | |||
55141bda67 | |||
bc02c123e6 | |||
e76d5ad988 | |||
8ad8a9c422 | |||
b15c9b7dab | |||
2405e97c38 | |||
fdbb2ee905 | |||
94b9ef56be | |||
952168ce25 | |||
5273037a94 | |||
53e6ff9524 | |||
f66fd1caaa | |||
d93fdbc5ad | |||
58e0439daf | |||
|
75b5e7254e | ||
39550a7fe9 | |||
|
5f0c084bee | ||
88f06f7921 | |||
8d12079386 | |||
7824a034ca | |||
8ef0ba2fae | |||
cc384f4324 | |||
8a91c79fb0 | |||
ac1d63bb0d | |||
|
83632448be | ||
|
e108526bab | ||
|
e27ba0d08a | ||
5afe0e3d63 | |||
c52f82f9ce | |||
d0c533555e | |||
1995c80e60 | |||
24e1516ec5 | |||
5b1beda82b | |||
e4f1094569 | |||
911668f0c8 | |||
6bfa0783b9 | |||
d64bcd5e83 | |||
ed2ca9f476 | |||
f787dfe809 | |||
afaabd14a8 | |||
e009bfeaa2 | |||
f1358d52aa | |||
b04b333466 | |||
|
dd16504329 | ||
c6cb21a748 | |||
78aa4626fa | |||
d2df224da8 | |||
464ff2fe96 | |||
0cc711173a | |||
14e5cfc8f8 | |||
b8b888090d | |||
68281339b7 | |||
2e5be3d3f1 | |||
abd31a94fb | |||
01e2cf08d1 | |||
9f821862b7 | |||
8660af745e | |||
826e4352d1 | |||
b94999bba4 | |||
65cc4c9429 | |||
df2be9620b | |||
2ab9daaa0f | |||
0c6c61a272 |
87
.drone.yml
87
.drone.yml
|
@ -1,57 +1,41 @@
|
||||||
---
|
|
||||||
kind: pipeline
|
kind: pipeline
|
||||||
name: python-3-5-alpine-3-10
|
name: python-3-8-alpine-3-13
|
||||||
|
|
||||||
|
services:
|
||||||
|
- name: postgresql
|
||||||
|
image: postgres:13.1-alpine
|
||||||
|
environment:
|
||||||
|
POSTGRES_PASSWORD: test
|
||||||
|
POSTGRES_DB: test
|
||||||
|
- name: mysql
|
||||||
|
image: mariadb:10.5
|
||||||
|
environment:
|
||||||
|
MYSQL_ROOT_PASSWORD: test
|
||||||
|
MYSQL_DATABASE: test
|
||||||
|
- name: mongodb
|
||||||
|
image: mongo:5.0.5
|
||||||
|
environment:
|
||||||
|
MONGO_INITDB_ROOT_USERNAME: root
|
||||||
|
MONGO_INITDB_ROOT_PASSWORD: test
|
||||||
|
|
||||||
|
clone:
|
||||||
|
skip_verify: true
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: build
|
- name: build
|
||||||
image: python:3.5-alpine3.10
|
image: alpine:3.13
|
||||||
|
environment:
|
||||||
|
TEST_CONTAINER: true
|
||||||
pull: always
|
pull: always
|
||||||
commands:
|
commands:
|
||||||
- scripts/run-tests
|
- scripts/run-full-tests
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: python-3-6-alpine-3-10
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: python:3.6-alpine3.10
|
|
||||||
pull: always
|
|
||||||
commands:
|
|
||||||
- scripts/run-tests
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: python-3-7-alpine-3-10
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: python:3.7-alpine3.10
|
|
||||||
pull: always
|
|
||||||
commands:
|
|
||||||
- scripts/run-tests
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: python-3-7-alpine-3-7
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: python:3.7-alpine3.7
|
|
||||||
pull: always
|
|
||||||
commands:
|
|
||||||
- scripts/run-tests
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: python-3-8-alpine-3-10
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: python:3.8-alpine3.10
|
|
||||||
pull: always
|
|
||||||
commands:
|
|
||||||
- scripts/run-tests
|
|
||||||
---
|
---
|
||||||
kind: pipeline
|
kind: pipeline
|
||||||
name: documentation
|
name: documentation
|
||||||
|
|
||||||
|
clone:
|
||||||
|
skip_verify: true
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: build
|
- name: build
|
||||||
image: plugins/docker
|
image: plugins/docker
|
||||||
|
@ -60,8 +44,15 @@ steps:
|
||||||
from_secret: docker_username
|
from_secret: docker_username
|
||||||
password:
|
password:
|
||||||
from_secret: docker_password
|
from_secret: docker_password
|
||||||
repo: witten/borgmatic-docs
|
registry: projects.torsion.org
|
||||||
|
repo: projects.torsion.org/borgmatic-collective/borgmatic
|
||||||
|
tags: docs
|
||||||
dockerfile: docs/Dockerfile
|
dockerfile: docs/Dockerfile
|
||||||
when:
|
|
||||||
branch:
|
trigger:
|
||||||
- master
|
repo:
|
||||||
|
- borgmatic-collective/borgmatic
|
||||||
|
branch:
|
||||||
|
- master
|
||||||
|
event:
|
||||||
|
- push
|
||||||
|
|
10
.eleventy.js
10
.eleventy.js
|
@ -1,9 +1,13 @@
|
||||||
const pluginSyntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
|
const pluginSyntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
|
||||||
|
const codeClipboard = require("eleventy-plugin-code-clipboard");
|
||||||
const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");
|
const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");
|
||||||
|
const navigationPlugin = require("@11ty/eleventy-navigation");
|
||||||
|
|
||||||
module.exports = function(eleventyConfig) {
|
module.exports = function(eleventyConfig) {
|
||||||
eleventyConfig.addPlugin(pluginSyntaxHighlight);
|
eleventyConfig.addPlugin(pluginSyntaxHighlight);
|
||||||
eleventyConfig.addPlugin(inclusiveLangPlugin);
|
eleventyConfig.addPlugin(inclusiveLangPlugin);
|
||||||
|
eleventyConfig.addPlugin(navigationPlugin);
|
||||||
|
eleventyConfig.addPlugin(codeClipboard);
|
||||||
|
|
||||||
let markdownIt = require("markdown-it");
|
let markdownIt = require("markdown-it");
|
||||||
let markdownItAnchor = require("markdown-it-anchor");
|
let markdownItAnchor = require("markdown-it-anchor");
|
||||||
|
@ -21,8 +25,7 @@ module.exports = function(eleventyConfig) {
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
let markdownItAnchorOptions = {
|
let markdownItAnchorOptions = {
|
||||||
permalink: true,
|
permalink: markdownItAnchor.permalink.headerLink()
|
||||||
permalinkClass: "direct-link"
|
|
||||||
};
|
};
|
||||||
|
|
||||||
eleventyConfig.setLibrary(
|
eleventyConfig.setLibrary(
|
||||||
|
@ -30,10 +33,13 @@ module.exports = function(eleventyConfig) {
|
||||||
markdownIt(markdownItOptions)
|
markdownIt(markdownItOptions)
|
||||||
.use(markdownItAnchor, markdownItAnchorOptions)
|
.use(markdownItAnchor, markdownItAnchorOptions)
|
||||||
.use(markdownItReplaceLink)
|
.use(markdownItReplaceLink)
|
||||||
|
.use(codeClipboard.markdownItCopyButton)
|
||||||
);
|
);
|
||||||
|
|
||||||
eleventyConfig.addPassthroughCopy({"docs/static": "static"});
|
eleventyConfig.addPassthroughCopy({"docs/static": "static"});
|
||||||
|
|
||||||
|
eleventyConfig.setLiquidOptions({dynamicPartials: false});
|
||||||
|
|
||||||
return {
|
return {
|
||||||
templateFormats: [
|
templateFormats: [
|
||||||
"md",
|
"md",
|
||||||
|
|
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -2,7 +2,7 @@
|
||||||
*.pyc
|
*.pyc
|
||||||
*.swp
|
*.swp
|
||||||
.cache
|
.cache
|
||||||
.coverage
|
.coverage*
|
||||||
.pytest_cache
|
.pytest_cache
|
||||||
.tox
|
.tox
|
||||||
__pycache__
|
__pycache__
|
||||||
|
|
538
NEWS
538
NEWS
|
@ -1,3 +1,537 @@
|
||||||
|
1.7.12.dev0
|
||||||
|
* #413: Add "log_file" context to command hooks so your scripts can consume the borgmatic log file.
|
||||||
|
See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
|
||||||
|
* #666, #670: Fix error when running the "info" action with the "--match-archives" or "--archive"
|
||||||
|
flags. Also fix the "--match-archives"/"--archive" flags to correctly override the
|
||||||
|
"match_archives" configuration option for the "transfer", "list", "rlist", and "info" actions.
|
||||||
|
* #668: Fix error when running the "prune" action with both "archive_name_format" and "prefix"
|
||||||
|
options set.
|
||||||
|
* #672: Selectively shallow merge certain mappings or sequences when including configuration files.
|
||||||
|
See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#shallow-merge
|
||||||
|
* #673: View the results of configuration file merging via "validate-borgmatic-config --show" flag.
|
||||||
|
See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#debugging-includes
|
||||||
|
* Add optional support for running end-to-end tests and building documentation with rootless Podman
|
||||||
|
instead of Docker.
|
||||||
|
|
||||||
|
1.7.11
|
||||||
|
* #479, #588: BREAKING: Automatically use the "archive_name_format" option to filter which archives
|
||||||
|
get used for borgmatic actions that operate on multiple archives. Override this behavior with the
|
||||||
|
new "match_archives" option in the storage section. This change is "breaking" in that it silently
|
||||||
|
changes which archives get considered for "rlist", "prune", "check", etc. See the documentation
|
||||||
|
for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#archive-naming
|
||||||
|
* #479, #588: The "prefix" options have been deprecated in favor of the new "archive_name_format"
|
||||||
|
auto-matching behavior and the "match_archives" option.
|
||||||
|
* #658: Add "--log-file-format" flag for customizing the log message format. See the documentation
|
||||||
|
for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#logging-to-file
|
||||||
|
* #662: Fix regression in which the "check_repositories" option failed to match repositories.
|
||||||
|
* #663: Fix regression in which the "transfer" action produced a traceback.
|
||||||
|
* Add spellchecking of source code during test runs.
|
||||||
|
|
||||||
|
1.7.10
|
||||||
|
* #396: When a database command errors, display and log the error message instead of swallowing it.
|
||||||
|
* #501: Optionally error if a source directory does not exist via "source_directories_must_exist"
|
||||||
|
option in borgmatic's location configuration.
|
||||||
|
* #576: Add support for "file://" paths within "repositories" option.
|
||||||
|
* #612: Define and use custom constants in borgmatic configuration files. See the documentation for
|
||||||
|
more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#constant-interpolation
|
||||||
|
* #618: Add support for BORG_FILES_CACHE_TTL environment variable via "borg_files_cache_ttl" option
|
||||||
|
in borgmatic's storage configuration.
|
||||||
|
* #623: Fix confusing message when an error occurs running actions for a configuration file.
|
||||||
|
* #635: Add optional repository labels so you can select a repository via "--repository yourlabel"
|
||||||
|
at the command-line. See the configuration reference for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/reference/configuration/
|
||||||
|
* #649: Add documentation on backing up a database running in a container:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
|
||||||
|
* #655: Fix error when databases are configured and a source directory doesn't exist.
|
||||||
|
* Add code style plugins to enforce use of Python f-strings and prevent single-letter variables.
|
||||||
|
To join in the pedantry, refresh your test environment with "tox --recreate".
|
||||||
|
* Rename scripts/run-full-dev-tests to scripts/run-end-to-end-dev-tests and make it run end-to-end
|
||||||
|
tests only. Continue using tox to run unit and integration tests.
|
||||||
|
|
||||||
|
1.7.9
|
||||||
|
* #295: Add a SQLite database dump/restore hook.
|
||||||
|
* #304: Change the default action order when no actions are specified on the command-line to:
|
||||||
|
"create", "prune", "compact", "check". If you'd like to retain the old ordering ("prune" and
|
||||||
|
"compact" first), then specify actions explicitly on the command-line.
|
||||||
|
* #304: Run any command-line actions in the order specified instead of using a fixed ordering.
|
||||||
|
* #564: Add "--repository" flag to all actions where it makes sense, so you can run borgmatic on
|
||||||
|
a single configured repository instead of all of them.
|
||||||
|
* #628: Add a Healthchecks "log" state to send borgmatic logs to Healthchecks without signalling
|
||||||
|
success or failure.
|
||||||
|
* #647: Add "--strip-components all" feature on the "extract" action to remove leading path
|
||||||
|
components of files you extract. Must be used with the "--path" flag.
|
||||||
|
* Add support for Python 3.11.
|
||||||
|
|
||||||
|
1.7.8
|
||||||
|
* #620: With the "create" action and the "--list" ("--files") flag, only show excluded files at
|
||||||
|
verbosity 2.
|
||||||
|
* #621: Add optional authentication to the ntfy monitoring hook.
|
||||||
|
* With the "create" action, only one of "--list" ("--files") and "--progress" flags can be used.
|
||||||
|
This lines up with the new behavior in Borg 2.0.0b5.
|
||||||
|
* Internally support new Borg 2.0.0b5 "--filter" status characters / item flags for the "create"
|
||||||
|
action.
|
||||||
|
* Fix the "create" action with the "--dry-run" flag querying for databases when a PostgreSQL/MySQL
|
||||||
|
"all" database is configured. Now, these queries are skipped due to the dry run.
|
||||||
|
* Add "--repository" flag to the "rcreate" action to optionally select one configured repository to
|
||||||
|
create.
|
||||||
|
* Add "--progress" flag to the "transfer" action, new in Borg 2.0.0b5.
|
||||||
|
* Add "checkpoint_volume" configuration option to creates checkpoints every specified number of
|
||||||
|
bytes during a long-running backup, new in Borg 2.0.0b5.
|
||||||
|
|
||||||
|
1.7.7
|
||||||
|
* #642: Add MySQL database hook "add_drop_database" configuration option to control whether dumped
|
||||||
|
MySQL databases get dropped right before restore.
|
||||||
|
* #643: Fix for potential data loss (data not getting backed up) when dumping large "directory"
|
||||||
|
format PostgreSQL/MongoDB databases. Prior to the fix, these dumps would not finish writing to
|
||||||
|
disk before Borg consumed them. Now, the dumping process completes before Borg starts. This only
|
||||||
|
applies to "directory" format databases; other formats still stream to Borg without using
|
||||||
|
temporary disk space.
|
||||||
|
* Fix MongoDB "directory" format to work with mongodump/mongorestore without error. Prior to this
|
||||||
|
fix, only the "archive" format worked.
|
||||||
|
|
||||||
|
1.7.6
|
||||||
|
* #393, #438, #560: Optionally dump "all" PostgreSQL/MySQL databases to separate files instead of
|
||||||
|
one combined dump file, allowing more convenient restores of individual databases. You can enable
|
||||||
|
this by specifying the database dump "format" option when the database is named "all".
|
||||||
|
* #602: Fix logs that interfere with JSON output by making warnings go to stderr instead of stdout.
|
||||||
|
* #622: Fix traceback when include merging configuration files on ARM64.
|
||||||
|
* #629: Skip warning about excluded special files when no special files have been excluded.
|
||||||
|
* #630: Add configuration options for database command customization: "list_options",
|
||||||
|
"restore_options", and "analyze_options" for PostgreSQL, "restore_options" for MySQL, and
|
||||||
|
"restore_options" for MongoDB.
|
||||||
|
|
||||||
|
1.7.5
|
||||||
|
* #311: Override PostgreSQL dump/restore commands via configuration options.
|
||||||
|
* #604: Fix traceback when a configuration section is present but lacking any options.
|
||||||
|
* #607: Clarify documentation examples for include merging and deep merging.
|
||||||
|
* #611: Fix "data" consistency check to support "check_last" and consistency "prefix" options.
|
||||||
|
* #613: Clarify documentation about multiple repositories and separate configuration files.
|
||||||
|
|
||||||
|
1.7.4
|
||||||
|
* #596: Fix special file detection erroring when broken symlinks are encountered.
|
||||||
|
* #597, #598: Fix regression in which "check" action errored on certain systems ("Cannot determine
|
||||||
|
Borg repository ID").
|
||||||
|
|
||||||
|
1.7.3
|
||||||
|
* #357: Add "break-lock" action for removing any repository and cache locks leftover from Borg
|
||||||
|
aborting.
|
||||||
|
* #360: To prevent Borg hangs, unconditionally delete stale named pipes before dumping databases.
|
||||||
|
* #587: When database hooks are enabled, auto-exclude special files from a "create" action to
|
||||||
|
prevent Borg from hanging. You can override/prevent this behavior by explicitly setting the
|
||||||
|
"read_special" option to true.
|
||||||
|
* #587: Warn when ignoring a configured "read_special" value of false, as true is needed when
|
||||||
|
database hooks are enabled.
|
||||||
|
* #589: Update sample systemd service file to allow system "idle" (e.g. a video monitor turning
|
||||||
|
off) while borgmatic is running.
|
||||||
|
* #590: Fix for potential data loss (data not getting backed up) when the "patterns_from" option
|
||||||
|
was used with "source_directories" (or the "~/.borgmatic" path existed, which got injected into
|
||||||
|
"source_directories" implicitly). The fix is for borgmatic to convert "source_directories" into
|
||||||
|
patterns whenever "patterns_from" is used, working around a Borg bug:
|
||||||
|
https://github.com/borgbackup/borg/issues/6994
|
||||||
|
* #590: In "borgmatic create --list" output, display which files get excluded from the backup due
|
||||||
|
to patterns or excludes.
|
||||||
|
* #591: Add support for Borg 2's "--match-archives" flag. This replaces "--glob-archives", which
|
||||||
|
borgmatic now treats as an alias for "--match-archives". But note that the two flags have
|
||||||
|
slightly different syntax. See the Borg 2 changelog for more information:
|
||||||
|
https://borgbackup.readthedocs.io/en/2.0.0b3/changes.html#version-2-0-0b3-2022-10-02
|
||||||
|
* Fix for "borgmatic --archive latest" not finding the latest archive when a verbosity is set.
|
||||||
|
|
||||||
|
1.7.2
|
||||||
|
* #577: Fix regression in which "borgmatic info --archive ..." showed repository info instead of
|
||||||
|
archive info with Borg 1.
|
||||||
|
* #582: Fix hang when database hooks are enabled and "patterns" contains a parent directory of
|
||||||
|
"~/.borgmatic".
|
||||||
|
|
||||||
|
1.7.1
|
||||||
|
* #542: Make the "source_directories" option optional. This is useful for "check"-only setups or
|
||||||
|
using "patterns" exclusively.
|
||||||
|
* #574: Fix for potential data loss (data not getting backed up) when the "patterns" option was
|
||||||
|
used with "source_directories" (or the "~/.borgmatic" path existed, which got injected into
|
||||||
|
"source_directories" implicitly). The fix is for borgmatic to convert "source_directories" into
|
||||||
|
patterns whenever "patterns" is used, working around a Borg bug:
|
||||||
|
https://github.com/borgbackup/borg/issues/6994
|
||||||
|
|
||||||
|
1.7.0
|
||||||
|
* #463: Add "before_actions" and "after_actions" command hooks that run before/after all the
|
||||||
|
actions for each repository. These new hooks are a good place to run per-repository steps like
|
||||||
|
mounting/unmounting a remote filesystem.
|
||||||
|
* #463: Update documentation to cover per-repository configurations:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/
|
||||||
|
* #557: Support for Borg 2 while still working with Borg 1. This includes new borgmatic actions
|
||||||
|
like "rcreate" (replaces "init"), "rlist" (list archives in repository), "rinfo" (show repository
|
||||||
|
info), and "transfer" (for upgrading Borg repositories). For the most part, borgmatic tries to
|
||||||
|
smooth over differences between Borg 1 and 2 to make your upgrade process easier. However, there
|
||||||
|
are still a few cases where Borg made breaking changes. See the Borg 2.0 changelog for more
|
||||||
|
information: https://www.borgbackup.org/releases/borg-2.0.html
|
||||||
|
* #557: If you install Borg 2, you'll need to manually upgrade your existing Borg 1 repositories
|
||||||
|
before use. Note that Borg 2 stable is not yet released as of this borgmatic release, so don't
|
||||||
|
use Borg 2 for production until it is! See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-borg
|
||||||
|
* #557: Rename several configuration options to match Borg 2: "remote_rate_limit" is now
|
||||||
|
"upload_rate_limit", "numeric_owner" is "numeric_ids", and "bsd_flags" is "flags". borgmatic
|
||||||
|
still works with the old options.
|
||||||
|
* #557: Remote repository paths without the "ssh://" syntax are deprecated but still supported for
|
||||||
|
now. Remote repository paths containing "~" are deprecated in borgmatic and no longer work in
|
||||||
|
Borg 2.
|
||||||
|
* #557: Omitting the "--archive" flag on the "list" action is deprecated when using Borg 2. Use
|
||||||
|
the new "rlist" action instead.
|
||||||
|
* #557: The "--dry-run" flag can now be used with the "rcreate"/"init" action.
|
||||||
|
* #565: Fix handling of "repository" and "data" consistency checks to prevent invalid Borg flags.
|
||||||
|
* #566: Modify "mount" and "extract" actions to require the "--repository" flag when multiple
|
||||||
|
repositories are configured.
|
||||||
|
* #571: BREAKING: Remove old-style command-line action flags like "--create, "--list", etc. If
|
||||||
|
you're already using actions like "create" and "list" instead, this change should not affect you.
|
||||||
|
* #571: BREAKING: Rename "--files" flag on "prune" action to "--list", as it lists archives, not
|
||||||
|
files.
|
||||||
|
* #571: Add "--list" as alias for "--files" flag on "create" and "export-tar" actions.
|
||||||
|
* Add support for disabling TLS verification in Healthchecks monitoring hook with "verify_tls"
|
||||||
|
option.
|
||||||
|
|
||||||
|
1.6.6
|
||||||
|
* #559: Update documentation about configuring multiple consistency checks or multiple databases.
|
||||||
|
* #560: Fix all database hooks to error when the requested database to restore isn't present in the
|
||||||
|
Borg archive.
|
||||||
|
* #561: Fix command-line "--override" flag to continue supporting old configuration file formats.
|
||||||
|
* #563: Fix traceback with "create" action and "--json" flag when a database hook is configured.
|
||||||
|
|
||||||
|
1.6.5
|
||||||
|
* #553: Fix logging to include the full traceback when Borg experiences an internal error, not just
|
||||||
|
the first few lines.
|
||||||
|
* #554: Fix all monitoring hooks to warn if the server returns an HTTP 4xx error. This can happen
|
||||||
|
with Healthchecks, for instance, when using an invalid ping URL.
|
||||||
|
* #555: Fix environment variable plumbing so options like "encryption_passphrase" and
|
||||||
|
"encryption_passcommand" in one configuration file aren't used for other configuration files.
|
||||||
|
|
||||||
|
1.6.4
|
||||||
|
* #546, #382: Keep your repository passphrases and database passwords outside of borgmatic's
|
||||||
|
configuration file with environment variable interpolation. See the documentation for more
|
||||||
|
information: https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/
|
||||||
|
|
||||||
|
1.6.3
|
||||||
|
* #541: Add "borgmatic list --find" flag for searching for files across multiple archives, useful
|
||||||
|
for hunting down that file you accidentally deleted so you can extract it. See the documentation
|
||||||
|
for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#searching-for-a-file
|
||||||
|
* #543: Add a monitoring hook for sending push notifications via ntfy. See the documentation for
|
||||||
|
more information: https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#ntfy-hook
|
||||||
|
* Fix Bash completion script to no longer alter your shell's settings (complain about unset
|
||||||
|
variables or error on pipe failures).
|
||||||
|
* Deprecate "borgmatic list --successful" flag, as listing only non-checkpoint (successful)
|
||||||
|
archives is now the default in newer versions of Borg.
|
||||||
|
|
||||||
|
1.6.2
|
||||||
|
* #523: Reduce the default consistency check frequency and support configuring the frequency
|
||||||
|
independently for each check. Also add "borgmatic check --force" flag to ignore configured
|
||||||
|
frequencies. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#check-frequency
|
||||||
|
* #536: Fix generate-borgmatic-config to support more complex schema changes like the new
|
||||||
|
Healthchecks configuration options when the "--source" flag is used.
|
||||||
|
* #538: Add support for "borgmatic borg debug" command.
|
||||||
|
* #539: Add "generate-borgmatic-config --overwrite" flag to replace an existing destination file.
|
||||||
|
* Add Bash completion script so you can tab-complete the borgmatic command-line. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#shell-completion
|
||||||
|
|
||||||
|
1.6.1
|
||||||
|
* #294: Add Healthchecks monitoring hook "ping_body_limit" option to configure how many bytes of
|
||||||
|
logs to send to the Healthchecks server.
|
||||||
|
* #402: Remove the error when "archive_name_format" is specified but a retention prefix isn't.
|
||||||
|
* #420: Warn when an unsupported variable is used in a hook command.
|
||||||
|
* #439: Change connection failures for monitoring hooks (Healthchecks, Cronitor, PagerDuty, and
|
||||||
|
Cronhub) to be warnings instead of errors. This way, the monitoring system failing does not block
|
||||||
|
backups.
|
||||||
|
* #460: Add Healthchecks monitoring hook "send_logs" option to enable/disable sending borgmatic
|
||||||
|
logs to the Healthchecks server.
|
||||||
|
* #525: Add Healthchecks monitoring hook "states" option to only enable pinging for particular
|
||||||
|
monitoring states (start, finish, fail).
|
||||||
|
* #528: Improve the error message when a configuration override contains an invalid value.
|
||||||
|
* #531: BREAKING: When deep merging common configuration, merge colliding list values by appending
|
||||||
|
them. Previously, one list replaced the other.
|
||||||
|
* #532: When a configuration include is a relative path, load it from either the current working
|
||||||
|
directory or from the directory containing the file doing the including. Previously, only the
|
||||||
|
working directory was used.
|
||||||
|
* Add a randomized delay to the sample systemd timer to spread out the load on a server.
|
||||||
|
* Change the configuration format for borgmatic monitoring hooks (Healthchecks, Cronitor,
|
||||||
|
PagerDuty, and Cronhub) to specify the ping URL / integration key as a named option. The intent
|
||||||
|
is to support additional options (some in this release). This change is backwards-compatible.
|
||||||
|
* Add emojis to documentation table of contents to make it easier to find particular how-to and
|
||||||
|
reference guides at a glance.
|
||||||
|
|
||||||
|
1.6.0
|
||||||
|
* #381: BREAKING: Greatly simplify configuration file reuse by deep merging when including common
|
||||||
|
configuration. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#include-merging
|
||||||
|
* #473: BREAKING: Instead of executing "before" command hooks before all borgmatic actions run (and
|
||||||
|
"after" hooks after), execute these hooks right before/after the corresponding action. E.g.,
|
||||||
|
"before_check" now runs immediately before the "check" action. This better supports running
|
||||||
|
timing-sensitive tasks like pausing containers. Side effect: before/after command hooks now run
|
||||||
|
once for each configured repository instead of once per configuration file. Additionally, the
|
||||||
|
"repositories" interpolated variable has been changed to "repository", containing the path to the
|
||||||
|
current repository for the hook. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
|
||||||
|
* #513: Add mention of sudo's "secure_path" option to borgmatic installation documentation.
|
||||||
|
* #515: Fix "borgmatic borg key ..." to pass parameters to Borg in the correct order.
|
||||||
|
* #516: Fix handling of TERM signal to exit borgmatic, not just forward the signal to Borg.
|
||||||
|
* #517: Fix borgmatic exit code (so it's zero) when initial Borg calls fail but later retries
|
||||||
|
succeed.
|
||||||
|
* Change Healthchecks logs truncation size from 10k bytes to 100k bytes, corresponding to that
|
||||||
|
same change on Healthchecks.io.
|
||||||
|
|
||||||
|
1.5.24
|
||||||
|
* #431: Add "working_directory" option to support source directories with relative paths.
|
||||||
|
* #444: When loading a configuration file that is unreadable due to file permissions, warn instead
|
||||||
|
of erroring. This supports running borgmatic as a non-root user with configuration in ~/.config
|
||||||
|
even if there is an unreadable global configuration file in /etc.
|
||||||
|
* #469: Add "repositories" context to "before_*" and "after_*" command action hooks. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
|
||||||
|
* #486: Fix handling of "patterns_from" and "exclude_from" options to error instead of warning when
|
||||||
|
referencing unreadable files and "create" action is run.
|
||||||
|
* #507: Fix Borg usage error in the "compact" action when running "borgmatic --dry-run". Now, skip
|
||||||
|
"compact" entirely during a dry run.
|
||||||
|
|
||||||
|
1.5.23
|
||||||
|
* #394: Compact repository segments and free space with new "borgmatic compact" action. Borg 1.2+
|
||||||
|
only. Also run "compact" by default when no actions are specified, as "prune" in Borg 1.2 no
|
||||||
|
longer frees up space unless "compact" is run.
|
||||||
|
* #394: When using the "atime", "bsd_flags", "numeric_owner", or "remote_rate_limit" options,
|
||||||
|
tailor the flags passed to Borg depending on the Borg version.
|
||||||
|
* #480, #482: Fix traceback when a YAML validation error occurs.
|
||||||
|
|
||||||
|
1.5.22
|
||||||
|
* #288: Add database dump hook for MongoDB.
|
||||||
|
* #470: Move mysqldump options to the beginning of the command due to MySQL bug 30994.
|
||||||
|
* #471: When command-line configuration override produces a parse error, error cleanly instead of
|
||||||
|
tracebacking.
|
||||||
|
* #476: Fix unicode error when restoring particular MySQL databases.
|
||||||
|
* Drop support for Python 3.6, which has been end-of-lifed.
|
||||||
|
* Add support for Python 3.10.
|
||||||
|
|
||||||
|
1.5.21
|
||||||
|
* #28: Optionally retry failing backups via "retries" and "retry_wait" configuration options.
|
||||||
|
* #306: Add "list_options" MySQL configuration option for passing additional arguments to MySQL
|
||||||
|
list command.
|
||||||
|
* #459: Add support for old version (2.x) of jsonschema library.
|
||||||
|
|
||||||
|
1.5.20
|
||||||
|
* Re-release with correct version without dev0 tag.
|
||||||
|
|
||||||
|
1.5.19
|
||||||
|
* #387: Fix error when configured source directories are not present on the filesystem at the time
|
||||||
|
of backup. Now, Borg will complain, but the backup will still continue.
|
||||||
|
* #455: Mention changing borgmatic path in cron documentation.
|
||||||
|
* Update sample systemd service file with more granular read-only filesystem settings.
|
||||||
|
* Move Gitea and GitHub hosting from a personal namespace to an organization for better
|
||||||
|
collaboration with related projects.
|
||||||
|
* 1k ★s on GitHub!
|
||||||
|
|
||||||
|
1.5.18
|
||||||
|
* #389: Fix "message too long" error when logging to rsyslog.
|
||||||
|
* #440: Fix traceback that can occur when dumping a database.
|
||||||
|
|
||||||
|
1.5.17
|
||||||
|
* #437: Fix error when configuration file contains "umask" option.
|
||||||
|
* Remove test dependency on vim and /dev/urandom.
|
||||||
|
|
||||||
|
1.5.16
|
||||||
|
* #379: Suppress console output in sample crontab and systemd service files.
|
||||||
|
* #407: Fix syslog logging on FreeBSD.
|
||||||
|
* #430: Fix hang when restoring a PostgreSQL "tar" format database dump.
|
||||||
|
* Better error messages! Switch the library used for validating configuration files (from pykwalify
|
||||||
|
to jsonschema).
|
||||||
|
* Link borgmatic Ansible role from installation documentation:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#other-ways-to-install
|
||||||
|
|
||||||
|
1.5.15
|
||||||
|
* #419: Document use case of running backups conditionally based on laptop power level:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server/
|
||||||
|
* #425: Run arbitrary Borg commands with new "borgmatic borg" action. See the documentation for
|
||||||
|
more information: https://torsion.org/borgmatic/docs/how-to/run-arbitrary-borg-commands/
|
||||||
|
|
||||||
|
1.5.14
|
||||||
|
* #390: Add link to Hetzner storage offering from the documentation.
|
||||||
|
* #398: Clarify canonical home of borgmatic in documentation.
|
||||||
|
* #406: Clarify that spaces in path names should not be backslashed in path names.
|
||||||
|
* #423: Fix error handling to error loudly when Borg gets killed due to running out of memory!
|
||||||
|
* Fix build so as not to attempt to build and push documentation for a non-master branch.
|
||||||
|
* "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13.
|
||||||
|
* Move #borgmatic IRC channel from Freenode to Libera Chat due to Freenode takeover drama.
|
||||||
|
IRC connection info: https://torsion.org/borgmatic/#issues
|
||||||
|
|
||||||
|
1.5.13
|
||||||
|
* #373: Document that passphrase is used for Borg keyfile encryption, not just repokey encryption.
|
||||||
|
* #404: Add support for ruamel.yaml 0.17.x YAML parsing library.
|
||||||
|
* Update systemd service example to return a permission error when a system call isn't permitted
|
||||||
|
(instead of terminating borgmatic outright).
|
||||||
|
* Drop support for Python 3.5, which has been end-of-lifed.
|
||||||
|
* Add support for Python 3.9.
|
||||||
|
* Update versions of test dependencies (test_requirements.txt and test containers).
|
||||||
|
* Only support black code formatter on Python 3.8+. New black dependencies make installation
|
||||||
|
difficult on older versions of Python.
|
||||||
|
* Replace "improve this documentation" form with link to support and ticket tracker.
|
||||||
|
|
||||||
|
1.5.12
|
||||||
|
* Fix for previous release with incorrect version suffix in setup.py. No other changes.
|
||||||
|
|
||||||
|
1.5.11
|
||||||
|
* #341: Add "temporary_directory" option for changing Borg's temporary directory.
|
||||||
|
* #352: Lock down systemd security settings in sample systemd service file.
|
||||||
|
* #355: Fix traceback when a database hook value is null in a configuration file.
|
||||||
|
* #361: Merge override values when specifying the "--override" flag multiple times. The previous
|
||||||
|
behavior was to take the value of the last "--override" flag only.
|
||||||
|
* #367: Fix traceback when upgrading old INI-style configuration with upgrade-borgmatic-config.
|
||||||
|
* #368: Fix signal forwarding from borgmatic to Borg resulting in recursion traceback.
|
||||||
|
* #369: Document support for Borg placeholders in repository names.
|
||||||
|
|
||||||
|
1.5.10
|
||||||
|
* #347: Add hooks that run for the "extract" action: "before_extract" and "after_extract".
|
||||||
|
* #350: Fix traceback when a configuration directory is non-readable due to directory permissions.
|
||||||
|
* Add documentation navigation links on left side of all documentation pages.
|
||||||
|
* Clarify documentation on configuration overrides, specifically the portion about list syntax:
|
||||||
|
http://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#configuration-overrides
|
||||||
|
* Clarify documentation overview of monitoring options:
|
||||||
|
http://torsion.org/borgmatic/docs/how-to/monitor-your-backups/
|
||||||
|
|
||||||
|
1.5.9
|
||||||
|
* #300: Add "borgmatic export-tar" action to export an archive to a tar-formatted file or stream.
|
||||||
|
* #339: Fix for intermittent timing-related test failure of logging function.
|
||||||
|
* Clarify database documentation about excluding named pipes and character/block devices to prevent
|
||||||
|
hangs.
|
||||||
|
* Add documentation on how to make backups redundant with multiple repositories:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-backups-redundant/
|
||||||
|
|
||||||
|
1.5.8
|
||||||
|
* #336: Fix for traceback when running Cronitor, Cronhub, and PagerDuty monitor hooks.
|
||||||
|
|
||||||
|
1.5.7
|
||||||
|
* #327: Fix broken pass-through of BORG_* environment variables to Borg.
|
||||||
|
* #328: Fix duplicate logging to Healthchecks and send "after_*" hooks output to Healthchecks.
|
||||||
|
* #331: Add SSL support to PostgreSQL database configuration.
|
||||||
|
* #333: Fix for potential data loss (data not getting backed up) when borgmatic omitted configured
|
||||||
|
source directories in certain situations. Specifically, this occurred when two source directories
|
||||||
|
on different filesystems were related by parentage (e.g. "/foo" and "/foo/bar/baz") and the
|
||||||
|
one_file_system option was enabled.
|
||||||
|
* Update documentation code fragments theme to better match the rest of the page.
|
||||||
|
* Improve configuration reference documentation readability via more aggressive word-wrapping in
|
||||||
|
configuration schema descriptions.
|
||||||
|
|
||||||
|
1.5.6
|
||||||
|
* #292: Allow before_backup and similar hooks to exit with a soft failure without altering the
|
||||||
|
monitoring status on Healthchecks or other providers. Support this by waiting to ping monitoring
|
||||||
|
services with a "start" status until after before_* hooks finish. Failures in before_* hooks
|
||||||
|
still trigger a monitoring "fail" status.
|
||||||
|
* #316: Fix hang when a stale database dump named pipe from an aborted borgmatic run remains on
|
||||||
|
disk.
|
||||||
|
* #323: Fix for certain configuration options like ssh_command impacting Borg invocations for
|
||||||
|
separate configuration files.
|
||||||
|
* #324: Add "borgmatic extract --strip-components" flag to remove leading path components when
|
||||||
|
extracting an archive.
|
||||||
|
* Tweak comment indentation in generated configuration file for clarity.
|
||||||
|
* Link to Borgmacator GNOME AppIndicator from monitoring documentation.
|
||||||
|
|
||||||
|
1.5.5
|
||||||
|
* #314: Fix regression in support for PostgreSQL's "directory" dump format. Unlike other dump
|
||||||
|
formats, the "directory" dump format does not stream directly to/from Borg.
|
||||||
|
* #315: Fix enabled database hooks to implicitly set one_file_system configuration option to true.
|
||||||
|
This prevents Borg from reading devices like /dev/zero and hanging.
|
||||||
|
* #316: Fix hang when streaming a database dump to Borg with implicit duplicate source directories
|
||||||
|
by deduplicating them first.
|
||||||
|
* #319: Fix error message when there are no MySQL databases to dump for "all" databases.
|
||||||
|
* Improve documentation around the installation process. Specifically, making borgmatic commands
|
||||||
|
runnable via the system PATH and offering a global install option.
|
||||||
|
|
||||||
|
1.5.4
|
||||||
|
* #310: Fix legitimate database dump command errors (exit code 1) not being treated as errors by
|
||||||
|
borgmatic.
|
||||||
|
* For database dumps, replace the named pipe on every borgmatic run. This prevent hangs on stale
|
||||||
|
pipes left over from previous runs.
|
||||||
|
* Fix error handling to handle more edge cases when executing commands.
|
||||||
|
|
||||||
|
1.5.3
|
||||||
|
* #258: Stream database dumps and restores directly to/from Borg without using any additional
|
||||||
|
filesystem space. This feature is automatic, and works even on restores from archives made with
|
||||||
|
previous versions of borgmatic.
|
||||||
|
* #293: Documentation on macOS launchd permissions issues with work-around for Full Disk Access.
|
||||||
|
* Remove "borgmatic restore --progress" flag, as it now conflicts with streaming database restores.
|
||||||
|
|
||||||
|
1.5.2
|
||||||
|
* #301: Fix MySQL restore error on "all" database dump by excluding system tables.
|
||||||
|
* Fix PostgreSQL restore error on "all" database dump by using "psql" for the restore instead of
|
||||||
|
"pg_restore".
|
||||||
|
|
||||||
|
1.5.1
|
||||||
|
* #289: Tired of looking up the latest successful archive name in order to pass it to borgmatic
|
||||||
|
actions? Me too. Now you can specify "--archive latest" to all actions that accept an archive
|
||||||
|
flag.
|
||||||
|
* #290: Fix the "--stats" and "--files" flags so that they yield output at verbosity 0.
|
||||||
|
* Reduce the default verbosity of borgmatic logs sent to Healthchecks monitoring hook. Now, it's
|
||||||
|
warnings and errors only. You can increase the verbosity via the "--monitoring-verbosity" flag.
|
||||||
|
* Add security policy documentation in SECURITY.md.
|
||||||
|
|
||||||
|
1.5.0
|
||||||
|
* #245: Monitor backups with PagerDuty hook integration. See the documentation for more
|
||||||
|
information: https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#pagerduty-hook
|
||||||
|
* #255: Add per-action hooks: "before_prune", "after_prune", "before_check", and "after_check".
|
||||||
|
* #274: Add ~/.config/borgmatic.d as another configuration directory default.
|
||||||
|
* #277: Customize Healthchecks log level via borgmatic "--monitoring-verbosity" flag.
|
||||||
|
* #280: Change "exclude_if_present" option to support multiple filenames that indicate a directory
|
||||||
|
should be excluded from backups, rather than just a single filename.
|
||||||
|
* #284: Backup to a removable drive or intermittent server via "soft failure" feature. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server/
|
||||||
|
* #287: View consistency check progress via "--progress" flag for "check" action.
|
||||||
|
* For "create" and "prune" actions, no longer list files or show detailed stats at any verbosities
|
||||||
|
by default. You can opt back in with "--files" or "--stats" flags.
|
||||||
|
* For "list" and "info" actions, show repository names even at verbosity 0.
|
||||||
|
|
||||||
|
1.4.22
|
||||||
|
* #276, #285: Disable colored output when "--json" flag is used, so as to produce valid JSON output.
|
||||||
|
* After a backup of a database dump in directory format, properly remove the dump directory.
|
||||||
|
* In "borgmatic --help", don't expand $HOME in listing of default "--config" paths.
|
||||||
|
|
||||||
|
1.4.21
|
||||||
|
* #268: Override particular configuration options from the command-line via "--override" flag. See
|
||||||
|
the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#configuration-overrides
|
||||||
|
* #270: Only trigger "on_error" hooks and monitoring failures for "prune", "create", and "check"
|
||||||
|
actions, and not for other actions.
|
||||||
|
* When pruning with verbosity level 1, list pruned and kept archives. Previously, this information
|
||||||
|
was only shown at verbosity level 2.
|
||||||
|
|
||||||
|
1.4.20
|
||||||
|
* Fix repository probing during "borgmatic init" to respect verbosity flag and remote_path option.
|
||||||
|
* #249: Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and
|
||||||
|
"prune" actions, not just "create".
|
||||||
|
|
||||||
|
1.4.19
|
||||||
|
* #259: Optionally change the internal database dump path via "borgmatic_source_directory" option
|
||||||
|
in location configuration section.
|
||||||
|
* #271: Support piping "borgmatic list" output to grep by logging certain log levels to console
|
||||||
|
stdout and others to stderr.
|
||||||
|
* Retain colored output when piping or redirecting in an interactive terminal.
|
||||||
|
* Add end-to-end tests for database dump and restore. These are run on developer machines with
|
||||||
|
Docker Compose for approximate parity with continuous integration tests.
|
||||||
|
|
||||||
|
1.4.18
|
||||||
|
* Fix "--repository" flag to accept relative paths.
|
||||||
|
* Fix "borgmatic umount" so it only runs Borg once instead of once per repository / configuration
|
||||||
|
file.
|
||||||
|
* #253: Mount whole repositories via "borgmatic mount" without any "--archive" flag.
|
||||||
|
* #269: Filter listed paths via "borgmatic list --path" flag.
|
||||||
|
|
||||||
|
1.4.17
|
||||||
|
* #235: Pass extra options directly to particular Borg commands, handy for Borg options that
|
||||||
|
borgmatic does not yet support natively. Use "extra_borg_options" in the storage configuration
|
||||||
|
section.
|
||||||
|
* #266: Attempt to repair any inconsistencies found during a consistency check via
|
||||||
|
"borgmatic check --repair" flag.
|
||||||
|
|
||||||
1.4.16
|
1.4.16
|
||||||
* #256: Fix for "before_backup" hook not triggering an error when the command contains "borg" and
|
* #256: Fix for "before_backup" hook not triggering an error when the command contains "borg" and
|
||||||
has an exit code of 1.
|
has an exit code of 1.
|
||||||
|
@ -329,7 +863,7 @@
|
||||||
* #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
|
* #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
|
||||||
editor swap files, etc.
|
editor swap files, etc.
|
||||||
* #81: Document user-defined hooks run before/after backup, or on error.
|
* #81: Document user-defined hooks run before/after backup, or on error.
|
||||||
* Add code style guidelines to the documention.
|
* Add code style guidelines to the documentation.
|
||||||
|
|
||||||
1.2.0
|
1.2.0
|
||||||
* #61: Support for Borg --list option via borgmatic command-line to list all archives.
|
* #61: Support for Borg --list option via borgmatic command-line to list all archives.
|
||||||
|
@ -367,7 +901,7 @@
|
||||||
* #49: Support for Borg experimental --patterns-from and --patterns options for specifying mixed
|
* #49: Support for Borg experimental --patterns-from and --patterns options for specifying mixed
|
||||||
includes/excludes.
|
includes/excludes.
|
||||||
* Moved issue tracker from Taiga to integrated Gitea tracker at
|
* Moved issue tracker from Taiga to integrated Gitea tracker at
|
||||||
https://projects.torsion.org/witten/borgmatic/issues
|
https://projects.torsion.org/borgmatic-collective/borgmatic/issues
|
||||||
|
|
||||||
1.1.12
|
1.1.12
|
||||||
* #46: Declare dependency on pykwalify 1.6 or above, as older versions yield "Unknown key: version"
|
* #46: Declare dependency on pykwalify 1.6 or above, as older versions yield "Unknown key: version"
|
||||||
|
|
123
README.md
123
README.md
|
@ -11,6 +11,8 @@ borgmatic is simple, configuration-driven backup software for servers and
|
||||||
workstations. Protect your files with client-side encryption. Backup your
|
workstations. Protect your files with client-side encryption. Backup your
|
||||||
databases too. Monitor it all with integrated third-party services.
|
databases too. Monitor it all with integrated third-party services.
|
||||||
|
|
||||||
|
The canonical home of borgmatic is at <a href="https://torsion.org/borgmatic">https://torsion.org/borgmatic</a>.
|
||||||
|
|
||||||
Here's an example configuration file:
|
Here's an example configuration file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -20,9 +22,12 @@ location:
|
||||||
- /home
|
- /home
|
||||||
- /etc
|
- /etc
|
||||||
|
|
||||||
# Paths to local or remote repositories.
|
# Paths of local or remote repositories to backup to.
|
||||||
repositories:
|
repositories:
|
||||||
- user@backupserver:sourcehostname.borg
|
- path: ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
|
||||||
|
label: borgbase
|
||||||
|
- path: /var/lib/backups/local.borg
|
||||||
|
label: local
|
||||||
|
|
||||||
retention:
|
retention:
|
||||||
# Retention policy for how many backups to keep.
|
# Retention policy for how many backups to keep.
|
||||||
|
@ -33,8 +38,9 @@ retention:
|
||||||
consistency:
|
consistency:
|
||||||
# List of checks to run to validate your backups.
|
# List of checks to run to validate your backups.
|
||||||
checks:
|
checks:
|
||||||
- repository
|
- name: repository
|
||||||
- archives
|
- name: archives
|
||||||
|
frequency: 2 weeks
|
||||||
|
|
||||||
hooks:
|
hooks:
|
||||||
# Custom preparation scripts to run.
|
# Custom preparation scripts to run.
|
||||||
|
@ -50,9 +56,9 @@ hooks:
|
||||||
```
|
```
|
||||||
|
|
||||||
Want to see borgmatic in action? Check out the <a
|
Want to see borgmatic in action? Check out the <a
|
||||||
href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
|
href="https://asciinema.org/a/203761?autoplay=1" target="_blank">screencast</a>.
|
||||||
|
|
||||||
<script src="https://asciinema.org/a/203761.js" id="asciicast-203761" async></script>
|
<a href="https://asciinema.org/a/203761?autoplay=1" target="_blank"><img src="https://asciinema.org/a/203761.png" width="480"></a>
|
||||||
|
|
||||||
borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
||||||
|
|
||||||
|
@ -61,78 +67,103 @@ borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
||||||
<a href="https://www.postgresql.org/"><img src="docs/static/postgresql.png" alt="PostgreSQL" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.postgresql.org/"><img src="docs/static/postgresql.png" alt="PostgreSQL" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://www.mysql.com/"><img src="docs/static/mysql.png" alt="MySQL" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.mysql.com/"><img src="docs/static/mysql.png" alt="MySQL" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://mariadb.com/"><img src="docs/static/mariadb.png" alt="MariaDB" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://mariadb.com/"><img src="docs/static/mariadb.png" alt="MariaDB" height="60px" style="margin-bottom:20px;"></a>
|
||||||
|
<a href="https://www.mongodb.com/"><img src="docs/static/mongodb.png" alt="MongoDB" height="60px" style="margin-bottom:20px;"></a>
|
||||||
|
<a href="https://sqlite.org/"><img src="docs/static/sqlite.png" alt="SQLite" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://healthchecks.io/"><img src="docs/static/healthchecks.png" alt="Healthchecks" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://healthchecks.io/"><img src="docs/static/healthchecks.png" alt="Healthchecks" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://www.rsync.net/cgi-bin/borg.cgi?campaign=borg&adgroup=borgmatic"><img src="docs/static/rsyncnet.png" alt="rsync.net" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>
|
||||||
|
<a href="https://ntfy.sh/"><img src="docs/static/ntfy.png" alt="ntfy" height="60px" style="margin-bottom:20px;"></a>
|
||||||
<a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>
|
||||||
|
|
||||||
|
|
||||||
## How-to guides
|
## Getting started
|
||||||
|
|
||||||
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/) ⬅ *Start here!*
|
Your first step is to [install and configure
|
||||||
* [Make per-application backups](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/)
|
borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).
|
||||||
* [Deal with very large backups](https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/)
|
|
||||||
* [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)
|
|
||||||
* [Monitor your backups](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
|
|
||||||
* [Extract a backup](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/)
|
|
||||||
* [Backup your databases](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
|
||||||
* [Add preparation and cleanup steps to backups](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/)
|
|
||||||
* [Upgrade borgmatic](https://torsion.org/borgmatic/docs/how-to/upgrade/)
|
|
||||||
* [Develop on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/)
|
|
||||||
|
|
||||||
|
For additional documentation, check out the links above (left panel on wide screens)
|
||||||
## Reference guides
|
for <a href="https://torsion.org/borgmatic/#documentation">borgmatic how-to and
|
||||||
|
reference guides</a>.
|
||||||
* [borgmatic configuration reference](https://torsion.org/borgmatic/docs/reference/configuration/)
|
|
||||||
* [borgmatic command-line reference](https://torsion.org/borgmatic/docs/reference/command-line/)
|
|
||||||
|
|
||||||
|
|
||||||
## Hosting providers
|
## Hosting providers
|
||||||
|
|
||||||
Need somewhere to store your encrypted offsite backups? The following hosting
|
Need somewhere to store your encrypted off-site backups? The following hosting
|
||||||
providers include specific support for Borg/borgmatic. Using these links and
|
providers include specific support for Borg/borgmatic—and fund borgmatic
|
||||||
services helps support borgmatic development and hosting. (These are referral
|
development and hosting when you use these links to sign up. (These are
|
||||||
links, but without any tracking scripts or cookies.)
|
referral links, but without any tracking scripts or cookies.)
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li class="referral"><a href="https://www.rsync.net/cgi-bin/borg.cgi?campaign=borg&adgroup=borgmatic">rsync.net</a>: Cloud Storage provider with full support for borg and any other SSH/SFTP tool</li>
|
|
||||||
<li class="referral"><a href="https://www.borgbase.com/?utm_source=borgmatic">BorgBase</a>: Borg hosting service with support for monitoring, 2FA, and append-only repos</li>
|
<li class="referral"><a href="https://www.borgbase.com/?utm_source=borgmatic">BorgBase</a>: Borg hosting service with support for monitoring, 2FA, and append-only repos</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
Additionally, [rsync.net](https://www.rsync.net/products/borg.html) and
|
||||||
|
[Hetzner](https://www.hetzner.com/storage/storage-box) have compatible storage
|
||||||
|
offerings, but do not currently fund borgmatic development or hosting.
|
||||||
|
|
||||||
## Support and contributing
|
## Support and contributing
|
||||||
|
|
||||||
### Issues
|
### Issues
|
||||||
|
|
||||||
You've got issues? Or an idea for a feature enhancement? We've got an [issue
|
Are you experiencing an issue with borgmatic? Or do you have an idea for a
|
||||||
tracker](https://projects.torsion.org/witten/borgmatic/issues). In order to
|
feature enhancement? Head on over to our [issue
|
||||||
create a new issue or comment on an issue, you'll need to [login
|
tracker](https://projects.torsion.org/borgmatic-collective/borgmatic/issues).
|
||||||
first](https://projects.torsion.org/user/login). Note that you can login with
|
In order to create a new issue or add a comment, you'll need to
|
||||||
an existing GitHub account if you prefer.
|
[register](https://projects.torsion.org/user/sign_up?invite_code=borgmatic)
|
||||||
|
first. If you prefer to use an existing GitHub account, you can skip account
|
||||||
|
creation and [login directly](https://projects.torsion.org/user/login).
|
||||||
|
|
||||||
If you'd like to chat with borgmatic developers or users, head on over to the
|
Also see the [security
|
||||||
`#borgmatic` IRC channel on Freenode, either via <a
|
policy](https://torsion.org/borgmatic/docs/security-policy/) for any security
|
||||||
href="https://webchat.freenode.net/?channels=borgmatic">web chat</a> or a
|
issues.
|
||||||
native <a href="irc://chat.freenode.net:6697">IRC client</a>.
|
|
||||||
|
|
||||||
Other questions or comments? Contact <mailto:witten@torsion.org>.
|
|
||||||
|
### Social
|
||||||
|
|
||||||
|
Check out the [Borg subreddit](https://www.reddit.com/r/BorgBackup/) for
|
||||||
|
general Borg and borgmatic discussion and support.
|
||||||
|
|
||||||
|
Also follow [borgmatic on Mastodon](https://fosstodon.org/@borgmatic).
|
||||||
|
|
||||||
|
|
||||||
|
### Chat
|
||||||
|
|
||||||
|
To chat with borgmatic developers or users, check out the `#borgmatic`
|
||||||
|
IRC channel on Libera Chat, either via <a
|
||||||
|
href="https://web.libera.chat/#borgmatic">web chat</a> or a native <a
|
||||||
|
href="ircs://irc.libera.chat:6697">IRC client</a>. If you don't get a response
|
||||||
|
right away, please hang around a while—or file a ticket instead.
|
||||||
|
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
Other questions or comments? Contact
|
||||||
|
[witten@torsion.org](mailto:witten@torsion.org).
|
||||||
|
|
||||||
|
|
||||||
### Contributing
|
### Contributing
|
||||||
|
|
||||||
borgmatic is hosted at <https://torsion.org/borgmatic> with [source code
|
borgmatic [source code is
|
||||||
available](https://projects.torsion.org/witten/borgmatic). It's also mirrored
|
available](https://projects.torsion.org/borgmatic-collective/borgmatic) and is also mirrored
|
||||||
on [GitHub](https://github.com/witten/borgmatic) for convenience.
|
on [GitHub](https://github.com/borgmatic-collective/borgmatic) for convenience.
|
||||||
|
|
||||||
|
borgmatic is licensed under the GNU General Public License version 3 or any
|
||||||
|
later version.
|
||||||
|
|
||||||
If you'd like to contribute to borgmatic development, please feel free to
|
If you'd like to contribute to borgmatic development, please feel free to
|
||||||
submit a [Pull Request](https://projects.torsion.org/witten/borgmatic/pulls)
|
submit a [Pull
|
||||||
or open an [issue](https://projects.torsion.org/witten/borgmatic/issues) first
|
Request](https://projects.torsion.org/borgmatic-collective/borgmatic/pulls) or
|
||||||
to discuss your idea. We also accept Pull Requests on GitHub, if that's more
|
open an
|
||||||
your thing. In general, contributions are very welcome. We don't bite!
|
[issue](https://projects.torsion.org/borgmatic-collective/borgmatic/issues) to
|
||||||
|
discuss your idea. Note that you'll need to
|
||||||
|
[register](https://projects.torsion.org/user/sign_up?invite_code=borgmatic)
|
||||||
|
first. We also accept Pull Requests on GitHub, if that's more your thing. In
|
||||||
|
general, contributions are very welcome. We don't bite!
|
||||||
|
|
||||||
Also, please check out the [borgmatic development
|
Also, please check out the [borgmatic development
|
||||||
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
||||||
info on cloning source code, running tests, etc.
|
info on cloning source code, running tests, etc.
|
||||||
|
|
||||||
<a href="https://build.torsion.org/witten/borgmatic" alt="build status">![Build Status](https://build.torsion.org/api/badges/witten/borgmatic/status.svg?ref=refs/heads/master)</a>
|
<a href="https://build.torsion.org/borgmatic-collective/borgmatic" alt="build status">![Build Status](https://build.torsion.org/api/badges/borgmatic-collective/borgmatic/status.svg?ref=refs/heads/master)</a>
|
||||||
|
|
||||||
|
|
18
SECURITY.md
Normal file
18
SECURITY.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
title: Security policy
|
||||||
|
permalink: security-policy/index.html
|
||||||
|
---
|
||||||
|
|
||||||
|
## Supported versions
|
||||||
|
|
||||||
|
While we want to hear about security vulnerabilities in all versions of
|
||||||
|
borgmatic, security fixes are only made to the most recently released version.
|
||||||
|
It's simply not practical for our small volunteer effort to maintain multiple
|
||||||
|
release branches and put out separate security patches for each.
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
If you find a security vulnerability, please [file a
|
||||||
|
ticket](https://torsion.org/borgmatic/#issues) or [send email
|
||||||
|
directly](mailto:witten@torsion.org) as appropriate. You should expect to hear
|
||||||
|
back within a few days at most and generally sooner.
|
0
borgmatic/actions/__init__.py
Normal file
0
borgmatic/actions/__init__.py
Normal file
36
borgmatic/actions/borg.py
Normal file
36
borgmatic/actions/borg.py
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.borg
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_borg(
|
||||||
|
repository, storage, local_borg_version, borg_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "borg" action for the given repository.
|
||||||
|
'''
|
||||||
|
if borg_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, borg_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(f'{repository["path"]}: Running arbitrary Borg command')
|
||||||
|
archive_name = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
borg_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
borgmatic.borg.borg.run_arbitrary_borg(
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
options=borg_arguments.options,
|
||||||
|
archive=archive_name,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
25
borgmatic/actions/break_lock.py
Normal file
25
borgmatic/actions/break_lock.py
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.break_lock
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_break_lock(
|
||||||
|
repository, storage, local_borg_version, break_lock_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "break-lock" action for the given repository.
|
||||||
|
'''
|
||||||
|
if break_lock_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, break_lock_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(f'{repository["path"]}: Breaking repository and cache locks')
|
||||||
|
borgmatic.borg.break_lock.break_lock(
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
61
borgmatic/actions/check.py
Normal file
61
borgmatic/actions/check.py
Normal file
|
@ -0,0 +1,61 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.check
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_check(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
consistency,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
check_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "check" action for the given repository.
|
||||||
|
'''
|
||||||
|
if check_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, check_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('before_check'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-check',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
logger.info(f'{repository["path"]}: Running consistency checks')
|
||||||
|
borgmatic.borg.check.check_archives(
|
||||||
|
repository['path'],
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
consistency,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
progress=check_arguments.progress,
|
||||||
|
repair=check_arguments.repair,
|
||||||
|
only_checks=check_arguments.only,
|
||||||
|
force=check_arguments.force,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('after_check'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-check',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
63
borgmatic/actions/compact.py
Normal file
63
borgmatic/actions/compact.py
Normal file
|
@ -0,0 +1,63 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.compact
|
||||||
|
import borgmatic.borg.feature
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_compact(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
retention,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
compact_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "compact" action for the given repository.
|
||||||
|
'''
|
||||||
|
if compact_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, compact_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('before_compact'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-compact',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
if borgmatic.borg.feature.available(borgmatic.borg.feature.Feature.COMPACT, local_borg_version):
|
||||||
|
logger.info(f'{repository["path"]}: Compacting segments{dry_run_label}')
|
||||||
|
borgmatic.borg.compact.compact_segments(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
progress=compact_arguments.progress,
|
||||||
|
cleanup_commits=compact_arguments.cleanup_commits,
|
||||||
|
threshold=compact_arguments.threshold,
|
||||||
|
)
|
||||||
|
else: # pragma: nocover
|
||||||
|
logger.info(f'{repository["path"]}: Skipping compact (only available/needed in Borg 1.2+)')
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('after_compact'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-compact',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
96
borgmatic/actions/create.py
Normal file
96
borgmatic/actions/create.py
Normal file
|
@ -0,0 +1,96 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.create
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
import borgmatic.hooks.dispatch
|
||||||
|
import borgmatic.hooks.dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_create(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
create_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "create" action for the given repository.
|
||||||
|
|
||||||
|
If create_arguments.json is True, yield the JSON output from creating the archive.
|
||||||
|
'''
|
||||||
|
if create_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, create_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('before_backup'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-backup',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
logger.info(f'{repository["path"]}: Creating archive{dry_run_label}')
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_database_dumps',
|
||||||
|
hooks,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
active_dumps = borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'dump_databases',
|
||||||
|
hooks,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
stream_processes = [process for processes in active_dumps.values() for process in processes]
|
||||||
|
|
||||||
|
json_output = borgmatic.borg.create.create_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
progress=create_arguments.progress,
|
||||||
|
stats=create_arguments.stats,
|
||||||
|
json=create_arguments.json,
|
||||||
|
list_files=create_arguments.list_files,
|
||||||
|
stream_processes=stream_processes,
|
||||||
|
)
|
||||||
|
if json_output: # pragma: nocover
|
||||||
|
yield json.loads(json_output)
|
||||||
|
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_database_dumps',
|
||||||
|
hooks,
|
||||||
|
config_filename,
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('after_backup'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-backup',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
48
borgmatic/actions/export_tar.py
Normal file
48
borgmatic/actions/export_tar.py
Normal file
|
@ -0,0 +1,48 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.export_tar
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_export_tar(
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
export_tar_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "export-tar" action for the given repository.
|
||||||
|
'''
|
||||||
|
if export_tar_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, export_tar_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(
|
||||||
|
f'{repository["path"]}: Exporting archive {export_tar_arguments.archive} as tar file'
|
||||||
|
)
|
||||||
|
borgmatic.borg.export_tar.export_tar_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
export_tar_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
export_tar_arguments.paths,
|
||||||
|
export_tar_arguments.destination,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
tar_filter=export_tar_arguments.tar_filter,
|
||||||
|
list_files=export_tar_arguments.list_files,
|
||||||
|
strip_components=export_tar_arguments.strip_components,
|
||||||
|
)
|
67
borgmatic/actions/extract.py
Normal file
67
borgmatic/actions/extract.py
Normal file
|
@ -0,0 +1,67 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_extract(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
extract_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "extract" action for the given repository.
|
||||||
|
'''
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('before_extract'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-extract',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
if extract_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, extract_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(f'{repository["path"]}: Extracting archive {extract_arguments.archive}')
|
||||||
|
borgmatic.borg.extract.extract_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
extract_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
extract_arguments.paths,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
destination_path=extract_arguments.destination,
|
||||||
|
strip_components=extract_arguments.strip_components,
|
||||||
|
progress=extract_arguments.progress,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('after_extract'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-extract',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
41
borgmatic/actions/info.py
Normal file
41
borgmatic/actions/info.py
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.info
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_info(
|
||||||
|
repository, storage, local_borg_version, info_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "info" action for the given repository and archive.
|
||||||
|
|
||||||
|
If info_arguments.json is True, yield the JSON output from the info for the archive.
|
||||||
|
'''
|
||||||
|
if info_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, info_arguments.repository
|
||||||
|
):
|
||||||
|
if not info_arguments.json: # pragma: nocover
|
||||||
|
logger.answer(f'{repository["path"]}: Displaying archive summary information')
|
||||||
|
info_arguments.archive = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
info_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
json_output = borgmatic.borg.info.display_archives_info(
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
info_arguments=info_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if json_output: # pragma: nocover
|
||||||
|
yield json.loads(json_output)
|
43
borgmatic/actions/list.py
Normal file
43
borgmatic/actions/list.py
Normal file
|
@ -0,0 +1,43 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.list
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_list(
|
||||||
|
repository, storage, local_borg_version, list_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "list" action for the given repository and archive.
|
||||||
|
|
||||||
|
If list_arguments.json is True, yield the JSON output from listing the archive.
|
||||||
|
'''
|
||||||
|
if list_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, list_arguments.repository
|
||||||
|
):
|
||||||
|
if not list_arguments.json: # pragma: nocover
|
||||||
|
if list_arguments.find_paths:
|
||||||
|
logger.answer(f'{repository["path"]}: Searching archives')
|
||||||
|
elif not list_arguments.archive:
|
||||||
|
logger.answer(f'{repository["path"]}: Listing archives')
|
||||||
|
list_arguments.archive = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
list_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
json_output = borgmatic.borg.list.list_archive(
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
list_arguments=list_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if json_output: # pragma: nocover
|
||||||
|
yield json.loads(json_output)
|
42
borgmatic/actions/mount.py
Normal file
42
borgmatic/actions/mount.py
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.mount
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_mount(
|
||||||
|
repository, storage, local_borg_version, mount_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "mount" action for the given repository.
|
||||||
|
'''
|
||||||
|
if mount_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, mount_arguments.repository
|
||||||
|
):
|
||||||
|
if mount_arguments.archive:
|
||||||
|
logger.info(f'{repository["path"]}: Mounting archive {mount_arguments.archive}')
|
||||||
|
else: # pragma: nocover
|
||||||
|
logger.info(f'{repository["path"]}: Mounting repository')
|
||||||
|
|
||||||
|
borgmatic.borg.mount.mount_archive(
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
mount_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
mount_arguments.mount_point,
|
||||||
|
mount_arguments.paths,
|
||||||
|
mount_arguments.foreground,
|
||||||
|
mount_arguments.options,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
59
borgmatic/actions/prune.py
Normal file
59
borgmatic/actions/prune.py
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.prune
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_prune(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
retention,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
prune_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "prune" action for the given repository.
|
||||||
|
'''
|
||||||
|
if prune_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, prune_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('before_prune'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-prune',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
logger.info(f'{repository["path"]}: Pruning archives{dry_run_label}')
|
||||||
|
borgmatic.borg.prune.prune_archives(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
retention,
|
||||||
|
local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
stats=prune_arguments.stats,
|
||||||
|
list_archives=prune_arguments.list_archives,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
hooks.get('after_prune'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-prune',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
40
borgmatic/actions/rcreate.py
Normal file
40
borgmatic/actions/rcreate.py
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.rcreate
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_rcreate(
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
rcreate_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "rcreate" action for the given repository.
|
||||||
|
'''
|
||||||
|
if rcreate_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, rcreate_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
logger.info(f'{repository["path"]}: Creating repository')
|
||||||
|
borgmatic.borg.rcreate.create_repository(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
rcreate_arguments.encryption_mode,
|
||||||
|
rcreate_arguments.source_repository,
|
||||||
|
rcreate_arguments.copy_crypt_key,
|
||||||
|
rcreate_arguments.append_only,
|
||||||
|
rcreate_arguments.storage_quota,
|
||||||
|
rcreate_arguments.make_parent_dirs,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
357
borgmatic/actions/restore.py
Normal file
357
borgmatic/actions/restore.py
Normal file
|
@ -0,0 +1,357 @@
|
||||||
|
import copy
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.list
|
||||||
|
import borgmatic.borg.mount
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.borg.state
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.dispatch
|
||||||
|
import borgmatic.hooks.dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
UNSPECIFIED_HOOK = object()
|
||||||
|
|
||||||
|
|
||||||
|
def get_configured_database(
|
||||||
|
hooks, archive_database_names, hook_name, database_name, configuration_database_name=None
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Find the first database with the given hook name and database name in the configured hooks
|
||||||
|
dict and the given archive database names dict (from hook name to database names contained in
|
||||||
|
a particular backup archive). If UNSPECIFIED_HOOK is given as the hook name, search all database
|
||||||
|
hooks for the named database. If a configuration database name is given, use that instead of the
|
||||||
|
database name to lookup the database in the given hooks configuration.
|
||||||
|
|
||||||
|
Return the found database as a tuple of (found hook name, database configuration dict).
|
||||||
|
'''
|
||||||
|
if not configuration_database_name:
|
||||||
|
configuration_database_name = database_name
|
||||||
|
|
||||||
|
if hook_name == UNSPECIFIED_HOOK:
|
||||||
|
hooks_to_search = hooks
|
||||||
|
else:
|
||||||
|
hooks_to_search = {hook_name: hooks[hook_name]}
|
||||||
|
|
||||||
|
return next(
|
||||||
|
(
|
||||||
|
(name, hook_database)
|
||||||
|
for (name, hook) in hooks_to_search.items()
|
||||||
|
for hook_database in hook
|
||||||
|
if hook_database['name'] == configuration_database_name
|
||||||
|
and database_name in archive_database_names.get(name, [])
|
||||||
|
),
|
||||||
|
(None, None),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_configured_hook_name_and_database(hooks, database_name):
|
||||||
|
'''
|
||||||
|
Find the hook name and first database dict with the given database name in the configured hooks
|
||||||
|
dict. This searches across all database hooks.
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
def restore_single_database(
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
archive_name,
|
||||||
|
hook_name,
|
||||||
|
database,
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Given (among other things) an archive name, a database hook name, and a configured database
|
||||||
|
configuration dict, restore that database from the archive.
|
||||||
|
'''
|
||||||
|
logger.info(f'{repository}: Restoring database {database["name"]}')
|
||||||
|
|
||||||
|
dump_pattern = borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'make_database_dump_pattern',
|
||||||
|
hooks,
|
||||||
|
repository,
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
database['name'],
|
||||||
|
)[hook_name]
|
||||||
|
|
||||||
|
# Kick off a single database extract to stdout.
|
||||||
|
extract_process = borgmatic.borg.extract.extract_archive(
|
||||||
|
dry_run=global_arguments.dry_run,
|
||||||
|
repository=repository,
|
||||||
|
archive=archive_name,
|
||||||
|
paths=borgmatic.hooks.dump.convert_glob_patterns_to_borg_patterns([dump_pattern]),
|
||||||
|
location_config=location,
|
||||||
|
storage_config=storage,
|
||||||
|
local_borg_version=local_borg_version,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
destination_path='/',
|
||||||
|
# A directory format dump isn't a single file, and therefore can't extract
|
||||||
|
# to stdout. In this case, the extract_process return value is None.
|
||||||
|
extract_to_stdout=bool(database.get('format') != 'directory'),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Run a single database restore, consuming the extract stdout (if any).
|
||||||
|
borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'restore_database_dump',
|
||||||
|
{hook_name: [database]},
|
||||||
|
repository,
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
extract_process,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def collect_archive_database_names(
|
||||||
|
repository, archive, location, storage, local_borg_version, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a resolved archive name, a location configuration dict,
|
||||||
|
a storage configuration dict, the local Borg version, and local and remote Borg paths, query the
|
||||||
|
archive for the names of databases it contains and return them as a dict from hook name to a
|
||||||
|
sequence of database names.
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = os.path.expanduser(
|
||||||
|
location.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
).lstrip('/')
|
||||||
|
parent_dump_path = os.path.expanduser(
|
||||||
|
borgmatic.hooks.dump.make_database_dump_path(borgmatic_source_directory, '*_databases/*/*')
|
||||||
|
)
|
||||||
|
dump_paths = borgmatic.borg.list.capture_archive_listing(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
list_path=parent_dump_path,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Determine the database names corresponding to the dumps found in the archive and
|
||||||
|
# add them to restore_names.
|
||||||
|
archive_database_names = {}
|
||||||
|
|
||||||
|
for dump_path in dump_paths:
|
||||||
|
try:
|
||||||
|
(hook_name, _, database_name) = dump_path.split(
|
||||||
|
borgmatic_source_directory + os.path.sep, 1
|
||||||
|
)[1].split(os.path.sep)[0:3]
|
||||||
|
except (ValueError, IndexError):
|
||||||
|
logger.warning(
|
||||||
|
f'{repository}: Ignoring invalid database dump path "{dump_path}" in archive {archive}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
if database_name not in archive_database_names.get(hook_name, []):
|
||||||
|
archive_database_names.setdefault(hook_name, []).extend([database_name])
|
||||||
|
|
||||||
|
return archive_database_names
|
||||||
|
|
||||||
|
|
||||||
|
def find_databases_to_restore(requested_database_names, archive_database_names):
|
||||||
|
'''
|
||||||
|
Given a sequence of requested database names to restore and a dict of hook name to the names of
|
||||||
|
databases found in an archive, return an expanded sequence of database names to restore,
|
||||||
|
replacing "all" with actual database names as appropriate.
|
||||||
|
|
||||||
|
Raise ValueError if any of the requested database names cannot be found in the archive.
|
||||||
|
'''
|
||||||
|
# A map from database hook name to the database names to restore for that hook.
|
||||||
|
restore_names = (
|
||||||
|
{UNSPECIFIED_HOOK: requested_database_names}
|
||||||
|
if requested_database_names
|
||||||
|
else {UNSPECIFIED_HOOK: ['all']}
|
||||||
|
)
|
||||||
|
|
||||||
|
# If "all" is in restore_names, then replace it with the names of dumps found within the
|
||||||
|
# archive.
|
||||||
|
if 'all' in restore_names[UNSPECIFIED_HOOK]:
|
||||||
|
restore_names[UNSPECIFIED_HOOK].remove('all')
|
||||||
|
|
||||||
|
for (hook_name, database_names) in archive_database_names.items():
|
||||||
|
restore_names.setdefault(hook_name, []).extend(database_names)
|
||||||
|
|
||||||
|
# If a database is to be restored as part of "all", then remove it from restore names so
|
||||||
|
# it doesn't get restored twice.
|
||||||
|
for database_name in database_names:
|
||||||
|
if database_name in restore_names[UNSPECIFIED_HOOK]:
|
||||||
|
restore_names[UNSPECIFIED_HOOK].remove(database_name)
|
||||||
|
|
||||||
|
if not restore_names[UNSPECIFIED_HOOK]:
|
||||||
|
restore_names.pop(UNSPECIFIED_HOOK)
|
||||||
|
|
||||||
|
combined_restore_names = set(
|
||||||
|
name for database_names in restore_names.values() for name in database_names
|
||||||
|
)
|
||||||
|
combined_archive_database_names = set(
|
||||||
|
name for database_names in archive_database_names.values() for name in database_names
|
||||||
|
)
|
||||||
|
|
||||||
|
missing_names = sorted(set(combined_restore_names) - combined_archive_database_names)
|
||||||
|
if missing_names:
|
||||||
|
joined_names = ', '.join(f'"{name}"' for name in missing_names)
|
||||||
|
raise ValueError(
|
||||||
|
f"Cannot restore database{'s' if len(missing_names) > 1 else ''} {joined_names} missing from archive"
|
||||||
|
)
|
||||||
|
|
||||||
|
return restore_names
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_databases_found(restore_names, remaining_restore_names, found_names):
|
||||||
|
'''
|
||||||
|
Given a dict from hook name to database names to restore, a dict from hook name to remaining
|
||||||
|
database names to restore, and a sequence of found (actually restored) database names, raise
|
||||||
|
ValueError if requested databases to restore were missing from the archive and/or configuration.
|
||||||
|
'''
|
||||||
|
combined_restore_names = set(
|
||||||
|
name
|
||||||
|
for database_names in tuple(restore_names.values())
|
||||||
|
+ tuple(remaining_restore_names.values())
|
||||||
|
for name in database_names
|
||||||
|
)
|
||||||
|
|
||||||
|
if not combined_restore_names and not found_names:
|
||||||
|
raise ValueError('No databases were found to restore')
|
||||||
|
|
||||||
|
missing_names = sorted(set(combined_restore_names) - set(found_names))
|
||||||
|
if missing_names:
|
||||||
|
joined_names = ', '.join(f'"{name}"' for name in missing_names)
|
||||||
|
raise ValueError(
|
||||||
|
f"Cannot restore database{'s' if len(missing_names) > 1 else ''} {joined_names} missing from borgmatic's configuration"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_restore(
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
local_borg_version,
|
||||||
|
restore_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "restore" action for the given repository, but only if the repository matches the
|
||||||
|
requested repository in restore arguments.
|
||||||
|
|
||||||
|
Raise ValueError if a configured database could not be found to restore.
|
||||||
|
'''
|
||||||
|
if restore_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, restore_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
f'{repository["path"]}: Restoring databases from archive {restore_arguments.archive}'
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_database_dumps',
|
||||||
|
hooks,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
|
||||||
|
archive_name = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
restore_arguments.archive,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
archive_database_names = collect_archive_database_names(
|
||||||
|
repository['path'],
|
||||||
|
archive_name,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
restore_names = find_databases_to_restore(restore_arguments.databases, archive_database_names)
|
||||||
|
found_names = set()
|
||||||
|
remaining_restore_names = {}
|
||||||
|
|
||||||
|
for hook_name, database_names in restore_names.items():
|
||||||
|
for database_name in database_names:
|
||||||
|
found_hook_name, found_database = get_configured_database(
|
||||||
|
hooks, archive_database_names, hook_name, database_name
|
||||||
|
)
|
||||||
|
|
||||||
|
if not found_database:
|
||||||
|
remaining_restore_names.setdefault(found_hook_name or hook_name, []).append(
|
||||||
|
database_name
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
found_names.add(database_name)
|
||||||
|
restore_single_database(
|
||||||
|
repository['path'],
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
archive_name,
|
||||||
|
found_hook_name or hook_name,
|
||||||
|
found_database,
|
||||||
|
)
|
||||||
|
|
||||||
|
# For any database that weren't found via exact matches in the hooks configuration, try to
|
||||||
|
# fallback to "all" entries.
|
||||||
|
for hook_name, database_names in remaining_restore_names.items():
|
||||||
|
for database_name in database_names:
|
||||||
|
found_hook_name, found_database = get_configured_database(
|
||||||
|
hooks, archive_database_names, hook_name, database_name, 'all'
|
||||||
|
)
|
||||||
|
|
||||||
|
if not found_database:
|
||||||
|
continue
|
||||||
|
|
||||||
|
found_names.add(database_name)
|
||||||
|
database = copy.copy(found_database)
|
||||||
|
database['name'] = database_name
|
||||||
|
|
||||||
|
restore_single_database(
|
||||||
|
repository['path'],
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
archive_name,
|
||||||
|
found_hook_name or hook_name,
|
||||||
|
database,
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_database_dumps',
|
||||||
|
hooks,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
|
||||||
|
ensure_databases_found(restore_names, remaining_restore_names, found_names)
|
33
borgmatic/actions/rinfo.py
Normal file
33
borgmatic/actions/rinfo.py
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.rinfo
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_rinfo(
|
||||||
|
repository, storage, local_borg_version, rinfo_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "rinfo" action for the given repository.
|
||||||
|
|
||||||
|
If rinfo_arguments.json is True, yield the JSON output from the info for the repository.
|
||||||
|
'''
|
||||||
|
if rinfo_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, rinfo_arguments.repository
|
||||||
|
):
|
||||||
|
if not rinfo_arguments.json: # pragma: nocover
|
||||||
|
logger.answer(f'{repository["path"]}: Displaying repository summary information')
|
||||||
|
|
||||||
|
json_output = borgmatic.borg.rinfo.display_repository_info(
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
rinfo_arguments=rinfo_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if json_output: # pragma: nocover
|
||||||
|
yield json.loads(json_output)
|
33
borgmatic/actions/rlist.py
Normal file
33
borgmatic/actions/rlist.py
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_rlist(
|
||||||
|
repository, storage, local_borg_version, rlist_arguments, local_path, remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "rlist" action for the given repository.
|
||||||
|
|
||||||
|
If rlist_arguments.json is True, yield the JSON output from listing the repository.
|
||||||
|
'''
|
||||||
|
if rlist_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, rlist_arguments.repository
|
||||||
|
):
|
||||||
|
if not rlist_arguments.json: # pragma: nocover
|
||||||
|
logger.answer(f'{repository["path"]}: Listing repository')
|
||||||
|
|
||||||
|
json_output = borgmatic.borg.rlist.list_repository(
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments=rlist_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if json_output: # pragma: nocover
|
||||||
|
yield json.loads(json_output)
|
29
borgmatic/actions/transfer.py
Normal file
29
borgmatic/actions/transfer.py
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.transfer
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_transfer(
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
transfer_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "transfer" action for the given repository.
|
||||||
|
'''
|
||||||
|
logger.info(f'{repository["path"]}: Transferring archives to repository')
|
||||||
|
borgmatic.borg.transfer.transfer_archives(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
transfer_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
68
borgmatic/borg/borg.py
Normal file
68
borgmatic/borg/borg.py
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, flags
|
||||||
|
from borgmatic.execute import execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
REPOSITORYLESS_BORG_COMMANDS = {'serve', None}
|
||||||
|
BORG_SUBCOMMANDS_WITH_SUBCOMMANDS = {'key', 'debug'}
|
||||||
|
BORG_SUBCOMMANDS_WITHOUT_REPOSITORY = (('debug', 'info'), ('debug', 'convert-profile'), ())
|
||||||
|
|
||||||
|
|
||||||
|
def run_arbitrary_borg(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
options,
|
||||||
|
archive=None,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage config dict, the local Borg version, a
|
||||||
|
sequence of arbitrary command-line Borg options, and an optional archive name, run an arbitrary
|
||||||
|
Borg command on the given repository/archive.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
try:
|
||||||
|
options = options[1:] if options[0] == '--' else options
|
||||||
|
|
||||||
|
# Borg commands like "key" have a sub-command ("export", etc.) that must follow it.
|
||||||
|
command_options_start_index = 2 if options[0] in BORG_SUBCOMMANDS_WITH_SUBCOMMANDS else 1
|
||||||
|
borg_command = tuple(options[:command_options_start_index])
|
||||||
|
command_options = tuple(options[command_options_start_index:])
|
||||||
|
except IndexError:
|
||||||
|
borg_command = ()
|
||||||
|
command_options = ()
|
||||||
|
|
||||||
|
if borg_command in BORG_SUBCOMMANDS_WITHOUT_REPOSITORY:
|
||||||
|
repository_archive_flags = ()
|
||||||
|
elif archive:
|
||||||
|
repository_archive_flags = flags.make_repository_archive_flags(
|
||||||
|
repository_path, archive, local_borg_version
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
repository_archive_flags = flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path,)
|
||||||
|
+ borg_command
|
||||||
|
+ repository_archive_flags
|
||||||
|
+ command_options
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
|
)
|
||||||
|
|
||||||
|
return execute_command(
|
||||||
|
full_command,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
31
borgmatic/borg/break_lock.py
Normal file
31
borgmatic/borg/break_lock.py
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from borgmatic.borg import environment, flags
|
||||||
|
from borgmatic.execute import execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def break_lock(
|
||||||
|
repository_path, storage_config, local_borg_version, local_path='borg', remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage configuration dict, the local Borg version,
|
||||||
|
and optional local and remote Borg paths, break any repository and cache locks leftover from Borg
|
||||||
|
aborting.
|
||||||
|
'''
|
||||||
|
umask = storage_config.get('umask', None)
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'break-lock')
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
execute_command(full_command, borg_local_path=local_path, extra_environment=borg_environment)
|
|
@ -1,48 +1,155 @@
|
||||||
|
import argparse
|
||||||
|
import datetime
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
import pathlib
|
||||||
|
|
||||||
from borgmatic.borg import extract
|
from borgmatic.borg import environment, extract, feature, flags, rinfo, state
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
DEFAULT_CHECKS = ('repository', 'archives')
|
DEFAULT_CHECKS = (
|
||||||
DEFAULT_PREFIX = '{hostname}-'
|
{'name': 'repository', 'frequency': '1 month'},
|
||||||
|
{'name': 'archives', 'frequency': '1 month'},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _parse_checks(consistency_config, only_checks=None):
|
def parse_checks(consistency_config, only_checks=None):
|
||||||
'''
|
'''
|
||||||
Given a consistency config with a "checks" list, and an optional list of override checks,
|
Given a consistency config with a "checks" sequence of dicts and an optional list of override
|
||||||
transform them a tuple of named checks to run.
|
checks, return a tuple of named checks to run.
|
||||||
|
|
||||||
For example, given a retention config of:
|
For example, given a retention config of:
|
||||||
|
|
||||||
{'checks': ['repository', 'archives']}
|
{'checks': ({'name': 'repository'}, {'name': 'archives'})}
|
||||||
|
|
||||||
This will be returned as:
|
This will be returned as:
|
||||||
|
|
||||||
('repository', 'archives')
|
('repository', 'archives')
|
||||||
|
|
||||||
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If the checks value
|
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If a checks value
|
||||||
is the string "disabled", return an empty tuple, meaning that no checks should be run.
|
has a name of "disabled", return an empty tuple, meaning that no checks should be run.
|
||||||
|
|
||||||
If the "data" option is present, then make sure the "archives" option is included as well.
|
|
||||||
'''
|
'''
|
||||||
checks = [
|
checks = only_checks or tuple(
|
||||||
check.lower() for check in (only_checks or consistency_config.get('checks', []) or [])
|
check_config['name']
|
||||||
]
|
for check_config in (consistency_config.get('checks', None) or DEFAULT_CHECKS)
|
||||||
if checks == ['disabled']:
|
)
|
||||||
|
checks = tuple(check.lower() for check in checks)
|
||||||
|
if 'disabled' in checks:
|
||||||
|
if len(checks) > 1:
|
||||||
|
logger.warning(
|
||||||
|
'Multiple checks are configured, but one of them is "disabled"; not running any checks'
|
||||||
|
)
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
if 'data' in checks and 'archives' not in checks:
|
return checks
|
||||||
checks.append('archives')
|
|
||||||
|
|
||||||
return tuple(check for check in checks if check not in ('disabled', '')) or DEFAULT_CHECKS
|
|
||||||
|
|
||||||
|
|
||||||
def _make_check_flags(checks, check_last=None, prefix=None):
|
def parse_frequency(frequency):
|
||||||
'''
|
'''
|
||||||
Given a parsed sequence of checks, transform it into tuple of command-line flags.
|
Given a frequency string with a number and a unit of time, return a corresponding
|
||||||
|
datetime.timedelta instance or None if the frequency is None or "always".
|
||||||
|
|
||||||
|
For instance, given "3 weeks", return datetime.timedelta(weeks=3)
|
||||||
|
|
||||||
|
Raise ValueError if the given frequency cannot be parsed.
|
||||||
|
'''
|
||||||
|
if not frequency:
|
||||||
|
return None
|
||||||
|
|
||||||
|
frequency = frequency.strip().lower()
|
||||||
|
|
||||||
|
if frequency == 'always':
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
number, time_unit = frequency.split(' ')
|
||||||
|
number = int(number)
|
||||||
|
except ValueError:
|
||||||
|
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
||||||
|
|
||||||
|
if not time_unit.endswith('s'):
|
||||||
|
time_unit += 's'
|
||||||
|
|
||||||
|
if time_unit == 'months':
|
||||||
|
number *= 30
|
||||||
|
time_unit = 'days'
|
||||||
|
elif time_unit == 'years':
|
||||||
|
number *= 365
|
||||||
|
time_unit = 'days'
|
||||||
|
|
||||||
|
try:
|
||||||
|
return datetime.timedelta(**{time_unit: number})
|
||||||
|
except TypeError:
|
||||||
|
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
||||||
|
|
||||||
|
|
||||||
|
def filter_checks_on_frequency(
|
||||||
|
location_config, consistency_config, borg_repository_id, checks, force
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a location config, a consistency config with a "checks" sequence of dicts, a Borg
|
||||||
|
repository ID, a sequence of checks, and whether to force checks to run, filter down those
|
||||||
|
checks based on the configured "frequency" for each check as compared to its check time file.
|
||||||
|
|
||||||
|
In other words, a check whose check time file's timestamp is too new (based on the configured
|
||||||
|
frequency) will get cut from the returned sequence of checks. Example:
|
||||||
|
|
||||||
|
consistency_config = {
|
||||||
|
'checks': [
|
||||||
|
{
|
||||||
|
'name': 'archives',
|
||||||
|
'frequency': '2 weeks',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
When this function is called with that consistency_config and "archives" in checks, "archives"
|
||||||
|
will get filtered out of the returned result if its check time file is newer than 2 weeks old,
|
||||||
|
indicating that it's not yet time to run that check again.
|
||||||
|
|
||||||
|
Raise ValueError if a frequency cannot be parsed.
|
||||||
|
'''
|
||||||
|
filtered_checks = list(checks)
|
||||||
|
|
||||||
|
if force:
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
for check_config in consistency_config.get('checks', DEFAULT_CHECKS):
|
||||||
|
check = check_config['name']
|
||||||
|
if checks and check not in checks:
|
||||||
|
continue
|
||||||
|
|
||||||
|
frequency_delta = parse_frequency(check_config.get('frequency'))
|
||||||
|
if not frequency_delta:
|
||||||
|
continue
|
||||||
|
|
||||||
|
check_time = read_check_time(
|
||||||
|
make_check_time_path(location_config, borg_repository_id, check)
|
||||||
|
)
|
||||||
|
if not check_time:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# If we've not yet reached the time when the frequency dictates we're ready for another
|
||||||
|
# check, skip this check.
|
||||||
|
if datetime.datetime.now() < check_time + frequency_delta:
|
||||||
|
remaining = check_time + frequency_delta - datetime.datetime.now()
|
||||||
|
logger.info(
|
||||||
|
f'Skipping {check} check due to configured frequency; {remaining} until next check'
|
||||||
|
)
|
||||||
|
filtered_checks.remove(check)
|
||||||
|
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
|
||||||
|
def make_check_flags(local_borg_version, storage_config, checks, check_last=None, prefix=None):
|
||||||
|
'''
|
||||||
|
Given the local Borg version, a storage configuration dict, a parsed sequence of checks, the
|
||||||
|
check last value, and a consistency check prefix, transform the checks into tuple of
|
||||||
|
command-line flags.
|
||||||
|
|
||||||
For example, given parsed checks of:
|
For example, given parsed checks of:
|
||||||
|
|
||||||
|
@ -53,61 +160,149 @@ def _make_check_flags(checks, check_last=None, prefix=None):
|
||||||
('--repository-only',)
|
('--repository-only',)
|
||||||
|
|
||||||
However, if both "repository" and "archives" are in checks, then omit them from the returned
|
However, if both "repository" and "archives" are in checks, then omit them from the returned
|
||||||
flags because Borg does both checks by default.
|
flags because Borg does both checks by default. If "data" is in checks, that implies "archives".
|
||||||
|
|
||||||
Additionally, if a check_last value is given and "archives" is in checks, then include a
|
Additionally, if a check_last value is given and "archives" is in checks, then include a
|
||||||
"--last" flag. And if a prefix value is given and "archives" is in checks, then include a
|
"--last" flag. And if a prefix value is given and "archives" is in checks, then include a
|
||||||
"--prefix" flag.
|
"--match-archives" flag.
|
||||||
'''
|
'''
|
||||||
|
if 'data' in checks:
|
||||||
|
data_flags = ('--verify-data',)
|
||||||
|
checks += ('archives',)
|
||||||
|
else:
|
||||||
|
data_flags = ()
|
||||||
|
|
||||||
if 'archives' in checks:
|
if 'archives' in checks:
|
||||||
last_flags = ('--last', str(check_last)) if check_last else ()
|
last_flags = ('--last', str(check_last)) if check_last else ()
|
||||||
prefix_flags = ('--prefix', prefix) if prefix else ()
|
match_archives_flags = (
|
||||||
|
(
|
||||||
|
('--match-archives', f'sh:{prefix}*')
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
|
else ('--glob-archives', f'{prefix}*')
|
||||||
|
)
|
||||||
|
if prefix
|
||||||
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
storage_config.get('match_archives'),
|
||||||
|
storage_config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
last_flags = ()
|
last_flags = ()
|
||||||
prefix_flags = ()
|
match_archives_flags = ()
|
||||||
if check_last:
|
if check_last:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
'Ignoring check_last option, as "archives" is not in consistency checks.'
|
'Ignoring check_last option, as "archives" or "data" are not in consistency checks'
|
||||||
)
|
)
|
||||||
if prefix:
|
if prefix:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
'Ignoring consistency prefix option, as "archives" is not in consistency checks.'
|
'Ignoring consistency prefix option, as "archives" or "data" are not in consistency checks'
|
||||||
)
|
)
|
||||||
|
|
||||||
common_flags = last_flags + prefix_flags + (('--verify-data',) if 'data' in checks else ())
|
common_flags = last_flags + match_archives_flags + data_flags
|
||||||
|
|
||||||
if set(DEFAULT_CHECKS).issubset(set(checks)):
|
if {'repository', 'archives'}.issubset(set(checks)):
|
||||||
return common_flags
|
return common_flags
|
||||||
|
|
||||||
return (
|
return (
|
||||||
tuple('--{}-only'.format(check) for check in checks if check in DEFAULT_CHECKS)
|
tuple(f'--{check}-only' for check in checks if check in ('repository', 'archives'))
|
||||||
+ common_flags
|
+ common_flags
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def make_check_time_path(location_config, borg_repository_id, check_type):
|
||||||
|
'''
|
||||||
|
Given a location configuration dict, a Borg repository ID, and the name of a check type
|
||||||
|
("repository", "archives", etc.), return a path for recording that check's time (the time of
|
||||||
|
that check last occurring).
|
||||||
|
'''
|
||||||
|
return os.path.join(
|
||||||
|
os.path.expanduser(
|
||||||
|
location_config.get(
|
||||||
|
'borgmatic_source_directory', state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
),
|
||||||
|
'checks',
|
||||||
|
borg_repository_id,
|
||||||
|
check_type,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def write_check_time(path): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Record a check time of now as the modification time of the given path.
|
||||||
|
'''
|
||||||
|
logger.debug(f'Writing check time at {path}')
|
||||||
|
|
||||||
|
os.makedirs(os.path.dirname(path), mode=0o700, exist_ok=True)
|
||||||
|
pathlib.Path(path, mode=0o600).touch()
|
||||||
|
|
||||||
|
|
||||||
|
def read_check_time(path):
|
||||||
|
'''
|
||||||
|
Return the check time based on the modification time of the given path. Return None if the path
|
||||||
|
doesn't exist.
|
||||||
|
'''
|
||||||
|
logger.debug(f'Reading check time from {path}')
|
||||||
|
|
||||||
|
try:
|
||||||
|
return datetime.datetime.fromtimestamp(os.stat(path).st_mtime)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
def check_archives(
|
def check_archives(
|
||||||
repository,
|
repository_path,
|
||||||
|
location_config,
|
||||||
storage_config,
|
storage_config,
|
||||||
consistency_config,
|
consistency_config,
|
||||||
|
local_borg_version,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
|
progress=None,
|
||||||
|
repair=None,
|
||||||
only_checks=None,
|
only_checks=None,
|
||||||
|
force=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, a consistency config dict,
|
Given a local or remote repository path, a storage config dict, a consistency config dict,
|
||||||
local/remote commands to run, and an optional list of checks to use instead of configured
|
local/remote commands to run, whether to include progress information, whether to attempt a
|
||||||
checks, check the contained Borg archives for consistency.
|
repair, and an optional list of checks to use instead of configured checks, check the contained
|
||||||
|
Borg archives for consistency.
|
||||||
|
|
||||||
If there are no consistency checks to run, skip running them.
|
If there are no consistency checks to run, skip running them.
|
||||||
|
|
||||||
|
Raises ValueError if the Borg repository ID cannot be determined.
|
||||||
'''
|
'''
|
||||||
checks = _parse_checks(consistency_config, only_checks)
|
try:
|
||||||
|
borg_repository_id = json.loads(
|
||||||
|
rinfo.display_repository_info(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
argparse.Namespace(json=True),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
)['repository']['id']
|
||||||
|
except (json.JSONDecodeError, KeyError):
|
||||||
|
raise ValueError(f'Cannot determine Borg repository ID for {repository_path}')
|
||||||
|
|
||||||
|
checks = filter_checks_on_frequency(
|
||||||
|
location_config,
|
||||||
|
consistency_config,
|
||||||
|
borg_repository_id,
|
||||||
|
parse_checks(consistency_config, only_checks),
|
||||||
|
force,
|
||||||
|
)
|
||||||
check_last = consistency_config.get('check_last', None)
|
check_last = consistency_config.get('check_last', None)
|
||||||
lock_wait = None
|
lock_wait = None
|
||||||
|
extra_borg_options = storage_config.get('extra_borg_options', {}).get('check', '')
|
||||||
|
|
||||||
if set(checks).intersection(set(DEFAULT_CHECKS + ('data',))):
|
if set(checks).intersection({'repository', 'archives', 'data'}):
|
||||||
remote_path_flags = ('--remote-path', remote_path) if remote_path else ()
|
lock_wait = storage_config.get('lock_wait')
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
|
||||||
lock_wait_flags = ('--lock-wait', str(lock_wait)) if lock_wait else ()
|
|
||||||
|
|
||||||
verbosity_flags = ()
|
verbosity_flags = ()
|
||||||
if logger.isEnabledFor(logging.INFO):
|
if logger.isEnabledFor(logging.INFO):
|
||||||
|
@ -115,18 +310,36 @@ def check_archives(
|
||||||
if logger.isEnabledFor(logging.DEBUG):
|
if logger.isEnabledFor(logging.DEBUG):
|
||||||
verbosity_flags = ('--debug', '--show-rc')
|
verbosity_flags = ('--debug', '--show-rc')
|
||||||
|
|
||||||
prefix = consistency_config.get('prefix', DEFAULT_PREFIX)
|
prefix = consistency_config.get('prefix')
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'check')
|
(local_path, 'check')
|
||||||
+ _make_check_flags(checks, check_last, prefix)
|
+ (('--repair',) if repair else ())
|
||||||
+ remote_path_flags
|
+ make_check_flags(local_borg_version, storage_config, checks, check_last, prefix)
|
||||||
+ lock_wait_flags
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ verbosity_flags
|
+ verbosity_flags
|
||||||
+ (repository,)
|
+ (('--progress',) if progress else ())
|
||||||
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
execute_command(full_command, error_on_warnings=True)
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
|
# The Borg repair option triggers an interactive prompt, which won't work when output is
|
||||||
|
# captured. And progress messes with the terminal directly.
|
||||||
|
if repair or progress:
|
||||||
|
execute_command(
|
||||||
|
full_command, output_file=DO_NOT_CAPTURE, extra_environment=borg_environment
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
execute_command(full_command, extra_environment=borg_environment)
|
||||||
|
|
||||||
|
for check in checks:
|
||||||
|
write_check_time(make_check_time_path(location_config, borg_repository_id, check))
|
||||||
|
|
||||||
if 'extract' in checks:
|
if 'extract' in checks:
|
||||||
extract.extract_last_archive_dry_run(repository, lock_wait, local_path, remote_path)
|
extract.extract_last_archive_dry_run(
|
||||||
|
storage_config, local_borg_version, repository_path, lock_wait, local_path, remote_path
|
||||||
|
)
|
||||||
|
write_check_time(make_check_time_path(location_config, borg_repository_id, 'extract'))
|
||||||
|
|
51
borgmatic/borg/compact.py
Normal file
51
borgmatic/borg/compact.py
Normal file
|
@ -0,0 +1,51 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from borgmatic.borg import environment, flags
|
||||||
|
from borgmatic.execute import execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def compact_segments(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
progress=False,
|
||||||
|
cleanup_commits=False,
|
||||||
|
threshold=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given dry-run flag, a local or remote repository path, a storage config dict, and the local
|
||||||
|
Borg version, compact the segments in a repository.
|
||||||
|
'''
|
||||||
|
umask = storage_config.get('umask', None)
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
extra_borg_options = storage_config.get('extra_borg_options', {}).get('compact', '')
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'compact')
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
|
+ (('--progress',) if progress else ())
|
||||||
|
+ (('--cleanup-commits',) if cleanup_commits else ())
|
||||||
|
+ (('--threshold', str(threshold)) if threshold else ())
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
logging.info(f'{repository_path}: Skipping compact (dry run)')
|
||||||
|
return
|
||||||
|
|
||||||
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
output_log_level=logging.INFO,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
|
@ -2,14 +2,23 @@ import glob
|
||||||
import itertools
|
import itertools
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import pathlib
|
||||||
|
import stat
|
||||||
import tempfile
|
import tempfile
|
||||||
|
|
||||||
from borgmatic.execute import execute_command, execute_command_without_capture
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, feature, flags, state
|
||||||
|
from borgmatic.execute import (
|
||||||
|
DO_NOT_CAPTURE,
|
||||||
|
execute_command,
|
||||||
|
execute_command_and_capture_output,
|
||||||
|
execute_command_with_processes,
|
||||||
|
)
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _expand_directory(directory):
|
def expand_directory(directory):
|
||||||
'''
|
'''
|
||||||
Given a directory path, expand any tilde (representing a user's home directory) and any globs
|
Given a directory path, expand any tilde (representing a user's home directory) and any globs
|
||||||
therein. Return a list of one or more resulting paths.
|
therein. Return a list of one or more resulting paths.
|
||||||
|
@ -19,7 +28,7 @@ def _expand_directory(directory):
|
||||||
return glob.glob(expanded_directory) or [expanded_directory]
|
return glob.glob(expanded_directory) or [expanded_directory]
|
||||||
|
|
||||||
|
|
||||||
def _expand_directories(directories):
|
def expand_directories(directories):
|
||||||
'''
|
'''
|
||||||
Given a sequence of directory paths, expand tildes and globs in each one. Return all the
|
Given a sequence of directory paths, expand tildes and globs in each one. Return all the
|
||||||
resulting directories as a single flattened tuple.
|
resulting directories as a single flattened tuple.
|
||||||
|
@ -28,11 +37,11 @@ def _expand_directories(directories):
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
return tuple(
|
return tuple(
|
||||||
itertools.chain.from_iterable(_expand_directory(directory) for directory in directories)
|
itertools.chain.from_iterable(expand_directory(directory) for directory in directories)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _expand_home_directories(directories):
|
def expand_home_directories(directories):
|
||||||
'''
|
'''
|
||||||
Given a sequence of directory paths, expand tildes in each one. Do not perform any globbing.
|
Given a sequence of directory paths, expand tildes in each one. Do not perform any globbing.
|
||||||
Return the results as a tuple.
|
Return the results as a tuple.
|
||||||
|
@ -43,22 +52,101 @@ def _expand_home_directories(directories):
|
||||||
return tuple(os.path.expanduser(directory) for directory in directories)
|
return tuple(os.path.expanduser(directory) for directory in directories)
|
||||||
|
|
||||||
|
|
||||||
def _write_pattern_file(patterns=None):
|
def map_directories_to_devices(directories):
|
||||||
'''
|
'''
|
||||||
Given a sequence of patterns, write them to a named temporary file and return it. Return None
|
Given a sequence of directories, return a map from directory to an identifier for the device on
|
||||||
if no patterns are provided.
|
which that directory resides or None if the path doesn't exist.
|
||||||
|
|
||||||
|
This is handy for determining whether two different directories are on the same filesystem (have
|
||||||
|
the same device identifier).
|
||||||
'''
|
'''
|
||||||
if not patterns:
|
return {
|
||||||
|
directory: os.stat(directory).st_dev if os.path.exists(directory) else None
|
||||||
|
for directory in directories
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def deduplicate_directories(directory_devices, additional_directory_devices):
|
||||||
|
'''
|
||||||
|
Given a map from directory to the identifier for the device on which that directory resides,
|
||||||
|
return the directories as a sorted tuple with all duplicate child directories removed. For
|
||||||
|
instance, if paths is ('/foo', '/foo/bar'), return just: ('/foo',)
|
||||||
|
|
||||||
|
The one exception to this rule is if two paths are on different filesystems (devices). In that
|
||||||
|
case, they won't get de-duplicated in case they both need to be passed to Borg (e.g. the
|
||||||
|
location.one_file_system option is true).
|
||||||
|
|
||||||
|
The idea is that if Borg is given a parent directory, then it doesn't also need to be given
|
||||||
|
child directories, because it will naturally spider the contents of the parent directory. And
|
||||||
|
there are cases where Borg coming across the same file twice will result in duplicate reads and
|
||||||
|
even hangs, e.g. when a database hook is using a named pipe for streaming database dumps to
|
||||||
|
Borg.
|
||||||
|
|
||||||
|
If any additional directory devices are given, also deduplicate against them, but don't include
|
||||||
|
them in the returned directories.
|
||||||
|
'''
|
||||||
|
deduplicated = set()
|
||||||
|
directories = sorted(directory_devices.keys())
|
||||||
|
additional_directories = sorted(additional_directory_devices.keys())
|
||||||
|
all_devices = {**directory_devices, **additional_directory_devices}
|
||||||
|
|
||||||
|
for directory in directories:
|
||||||
|
deduplicated.add(directory)
|
||||||
|
parents = pathlib.PurePath(directory).parents
|
||||||
|
|
||||||
|
# If another directory in the given list (or the additional list) is a parent of current
|
||||||
|
# directory (even n levels up) and both are on the same filesystem, then the current
|
||||||
|
# directory is a duplicate.
|
||||||
|
for other_directory in directories + additional_directories:
|
||||||
|
for parent in parents:
|
||||||
|
if (
|
||||||
|
pathlib.PurePath(other_directory) == parent
|
||||||
|
and all_devices[directory] is not None
|
||||||
|
and all_devices[other_directory] == all_devices[directory]
|
||||||
|
):
|
||||||
|
if directory in deduplicated:
|
||||||
|
deduplicated.remove(directory)
|
||||||
|
break
|
||||||
|
|
||||||
|
return tuple(sorted(deduplicated))
|
||||||
|
|
||||||
|
|
||||||
|
def write_pattern_file(patterns=None, sources=None, pattern_file=None):
|
||||||
|
'''
|
||||||
|
Given a sequence of patterns and an optional sequence of source directories, write them to a
|
||||||
|
named temporary file (with the source directories as additional roots) and return the file.
|
||||||
|
If an optional open pattern file is given, overwrite it instead of making a new temporary file.
|
||||||
|
Return None if no patterns are provided.
|
||||||
|
'''
|
||||||
|
if not patterns and not sources:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
pattern_file = tempfile.NamedTemporaryFile('w')
|
if pattern_file is None:
|
||||||
pattern_file.write('\n'.join(patterns))
|
pattern_file = tempfile.NamedTemporaryFile('w')
|
||||||
|
else:
|
||||||
|
pattern_file.seek(0)
|
||||||
|
|
||||||
|
pattern_file.write(
|
||||||
|
'\n'.join(tuple(patterns or ()) + tuple(f'R {source}' for source in (sources or [])))
|
||||||
|
)
|
||||||
pattern_file.flush()
|
pattern_file.flush()
|
||||||
|
|
||||||
return pattern_file
|
return pattern_file
|
||||||
|
|
||||||
|
|
||||||
def _make_pattern_flags(location_config, pattern_filename=None):
|
def ensure_files_readable(*filename_lists):
|
||||||
|
'''
|
||||||
|
Given a sequence of filename sequences, ensure that each filename is openable. This prevents
|
||||||
|
unreadable files from being passed to Borg, which in certain situations only warns instead of
|
||||||
|
erroring.
|
||||||
|
'''
|
||||||
|
for file_object in itertools.chain.from_iterable(
|
||||||
|
filename_list for filename_list in filename_lists if filename_list
|
||||||
|
):
|
||||||
|
open(file_object).close()
|
||||||
|
|
||||||
|
|
||||||
|
def make_pattern_flags(location_config, pattern_filename=None):
|
||||||
'''
|
'''
|
||||||
Given a location config dict with a potential patterns_from option, and a filename containing
|
Given a location config dict with a potential patterns_from option, and a filename containing
|
||||||
any additional patterns, return the corresponding Borg flags for those files as a tuple.
|
any additional patterns, return the corresponding Borg flags for those files as a tuple.
|
||||||
|
@ -74,7 +162,7 @@ def _make_pattern_flags(location_config, pattern_filename=None):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _make_exclude_flags(location_config, exclude_filename=None):
|
def make_exclude_flags(location_config, exclude_filename=None):
|
||||||
'''
|
'''
|
||||||
Given a location config dict with various exclude options, and a filename containing any exclude
|
Given a location config dict with various exclude options, and a filename containing any exclude
|
||||||
patterns, return the corresponding Borg flags as a tuple.
|
patterns, return the corresponding Borg flags as a tuple.
|
||||||
|
@ -88,8 +176,12 @@ def _make_exclude_flags(location_config, exclude_filename=None):
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
caches_flag = ('--exclude-caches',) if location_config.get('exclude_caches') else ()
|
caches_flag = ('--exclude-caches',) if location_config.get('exclude_caches') else ()
|
||||||
if_present = location_config.get('exclude_if_present')
|
if_present_flags = tuple(
|
||||||
if_present_flags = ('--exclude-if-present', if_present) if if_present else ()
|
itertools.chain.from_iterable(
|
||||||
|
('--exclude-if-present', if_present)
|
||||||
|
for if_present in location_config.get('exclude_if_present', ())
|
||||||
|
)
|
||||||
|
)
|
||||||
keep_exclude_tags_flags = (
|
keep_exclude_tags_flags = (
|
||||||
('--keep-exclude-tags',) if location_config.get('keep_exclude_tags') else ()
|
('--keep-exclude-tags',) if location_config.get('keep_exclude_tags') else ()
|
||||||
)
|
)
|
||||||
|
@ -104,106 +196,327 @@ def _make_exclude_flags(location_config, exclude_filename=None):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
BORGMATIC_SOURCE_DIRECTORY = '~/.borgmatic'
|
def make_list_filter_flags(local_borg_version, dry_run):
|
||||||
|
'''
|
||||||
|
Given the local Borg version and whether this is a dry run, return the corresponding flags for
|
||||||
|
passing to "--list --filter". The general idea is that excludes are shown for a dry run or when
|
||||||
|
the verbosity is debug.
|
||||||
|
'''
|
||||||
|
base_flags = 'AME'
|
||||||
|
show_excludes = logger.isEnabledFor(logging.DEBUG)
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.EXCLUDED_FILES_MINUS, local_borg_version):
|
||||||
|
if show_excludes or dry_run:
|
||||||
|
return f'{base_flags}+-'
|
||||||
|
else:
|
||||||
|
return base_flags
|
||||||
|
|
||||||
|
if show_excludes:
|
||||||
|
return f'{base_flags}x-'
|
||||||
|
else:
|
||||||
|
return f'{base_flags}-'
|
||||||
|
|
||||||
|
|
||||||
def borgmatic_source_directories():
|
DEFAULT_ARCHIVE_NAME_FORMAT = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}' # noqa: FS003
|
||||||
|
|
||||||
|
|
||||||
|
def collect_borgmatic_source_directories(borgmatic_source_directory):
|
||||||
'''
|
'''
|
||||||
Return a list of borgmatic-specific source directories used for state like database backups.
|
Return a list of borgmatic-specific source directories used for state like database backups.
|
||||||
'''
|
'''
|
||||||
|
if not borgmatic_source_directory:
|
||||||
|
borgmatic_source_directory = state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
return (
|
return (
|
||||||
[BORGMATIC_SOURCE_DIRECTORY]
|
[borgmatic_source_directory]
|
||||||
if os.path.exists(os.path.expanduser(BORGMATIC_SOURCE_DIRECTORY))
|
if os.path.exists(os.path.expanduser(borgmatic_source_directory))
|
||||||
else []
|
else []
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
ROOT_PATTERN_PREFIX = 'R '
|
||||||
|
|
||||||
|
|
||||||
|
def pattern_root_directories(patterns=None):
|
||||||
|
'''
|
||||||
|
Given a sequence of patterns, parse out and return just the root directories.
|
||||||
|
'''
|
||||||
|
if not patterns:
|
||||||
|
return []
|
||||||
|
|
||||||
|
return [
|
||||||
|
pattern.split(ROOT_PATTERN_PREFIX, maxsplit=1)[1]
|
||||||
|
for pattern in patterns
|
||||||
|
if pattern.startswith(ROOT_PATTERN_PREFIX)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def special_file(path):
|
||||||
|
'''
|
||||||
|
Return whether the given path is a special file (character device, block device, or named pipe
|
||||||
|
/ FIFO).
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
mode = os.stat(path).st_mode
|
||||||
|
except (FileNotFoundError, OSError):
|
||||||
|
return False
|
||||||
|
|
||||||
|
return stat.S_ISCHR(mode) or stat.S_ISBLK(mode) or stat.S_ISFIFO(mode)
|
||||||
|
|
||||||
|
|
||||||
|
def any_parent_directories(path, candidate_parents):
|
||||||
|
'''
|
||||||
|
Return whether any of the given candidate parent directories are an actual parent of the given
|
||||||
|
path. This includes grandparents, etc.
|
||||||
|
'''
|
||||||
|
for parent in candidate_parents:
|
||||||
|
if pathlib.PurePosixPath(parent) in pathlib.PurePath(path).parents:
|
||||||
|
return True
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def collect_special_file_paths(
|
||||||
|
create_command, local_path, working_directory, borg_environment, skip_directories
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a Borg create command as a tuple, a local Borg path, a working directory, and a dict of
|
||||||
|
environment variables to pass to Borg, and a sequence of parent directories to skip, collect the
|
||||||
|
paths for any special files (character devices, block devices, and named pipes / FIFOs) that
|
||||||
|
Borg would encounter during a create. These are all paths that could cause Borg to hang if its
|
||||||
|
--read-special flag is used.
|
||||||
|
'''
|
||||||
|
paths_output = execute_command_and_capture_output(
|
||||||
|
create_command + ('--dry-run', '--list'),
|
||||||
|
capture_stderr=True,
|
||||||
|
working_directory=working_directory,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
|
||||||
|
paths = tuple(
|
||||||
|
path_line.split(' ', 1)[1]
|
||||||
|
for path_line in paths_output.split('\n')
|
||||||
|
if path_line and path_line.startswith('- ') or path_line.startswith('+ ')
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
path
|
||||||
|
for path in paths
|
||||||
|
if special_file(path) and not any_parent_directories(path, skip_directories)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def check_all_source_directories_exist(source_directories):
|
||||||
|
'''
|
||||||
|
Given a sequence of source directories, check that they all exist. If any do not, raise an
|
||||||
|
exception.
|
||||||
|
'''
|
||||||
|
missing_directories = [
|
||||||
|
source_directory
|
||||||
|
for source_directory in source_directories
|
||||||
|
if not os.path.exists(source_directory)
|
||||||
|
]
|
||||||
|
if missing_directories:
|
||||||
|
raise ValueError(f"Source directories do not exist: {', '.join(missing_directories)}")
|
||||||
|
|
||||||
|
|
||||||
def create_archive(
|
def create_archive(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
location_config,
|
location_config,
|
||||||
storage_config,
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
progress=False,
|
progress=False,
|
||||||
stats=False,
|
stats=False,
|
||||||
json=False,
|
json=False,
|
||||||
|
list_files=False,
|
||||||
|
stream_processes=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given vebosity/dry-run flags, a local or remote repository path, a location config dict, and a
|
Given vebosity/dry-run flags, a local or remote repository path, a location config dict, and a
|
||||||
storage config dict, create a Borg archive and return Borg's JSON output (if any).
|
storage config dict, create a Borg archive and return Borg's JSON output (if any).
|
||||||
|
|
||||||
|
If a sequence of stream processes is given (instances of subprocess.Popen), then execute the
|
||||||
|
create command while also triggering the given processes to produce output.
|
||||||
'''
|
'''
|
||||||
sources = _expand_directories(
|
borgmatic.logger.add_custom_log_levels()
|
||||||
location_config['source_directories'] + borgmatic_source_directories()
|
borgmatic_source_directories = expand_directories(
|
||||||
|
collect_borgmatic_source_directories(location_config.get('borgmatic_source_directory'))
|
||||||
|
)
|
||||||
|
if location_config.get('source_directories_must_exist', False):
|
||||||
|
check_all_source_directories_exist(location_config.get('source_directories'))
|
||||||
|
sources = deduplicate_directories(
|
||||||
|
map_directories_to_devices(
|
||||||
|
expand_directories(
|
||||||
|
tuple(location_config.get('source_directories', ())) + borgmatic_source_directories
|
||||||
|
)
|
||||||
|
),
|
||||||
|
additional_directory_devices=map_directories_to_devices(
|
||||||
|
expand_directories(pattern_root_directories(location_config.get('patterns')))
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
pattern_file = _write_pattern_file(location_config.get('patterns'))
|
ensure_files_readable(location_config.get('patterns_from'), location_config.get('exclude_from'))
|
||||||
exclude_file = _write_pattern_file(
|
|
||||||
_expand_home_directories(location_config.get('exclude_patterns'))
|
try:
|
||||||
|
working_directory = os.path.expanduser(location_config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
|
pattern_file = (
|
||||||
|
write_pattern_file(location_config.get('patterns'), sources)
|
||||||
|
if location_config.get('patterns') or location_config.get('patterns_from')
|
||||||
|
else None
|
||||||
|
)
|
||||||
|
exclude_file = write_pattern_file(
|
||||||
|
expand_home_directories(location_config.get('exclude_patterns'))
|
||||||
)
|
)
|
||||||
checkpoint_interval = storage_config.get('checkpoint_interval', None)
|
checkpoint_interval = storage_config.get('checkpoint_interval', None)
|
||||||
|
checkpoint_volume = storage_config.get('checkpoint_volume', None)
|
||||||
chunker_params = storage_config.get('chunker_params', None)
|
chunker_params = storage_config.get('chunker_params', None)
|
||||||
compression = storage_config.get('compression', None)
|
compression = storage_config.get('compression', None)
|
||||||
remote_rate_limit = storage_config.get('remote_rate_limit', None)
|
upload_rate_limit = storage_config.get('upload_rate_limit', None)
|
||||||
umask = storage_config.get('umask', None)
|
umask = storage_config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
list_filter_flags = make_list_filter_flags(local_borg_version, dry_run)
|
||||||
files_cache = location_config.get('files_cache')
|
files_cache = location_config.get('files_cache')
|
||||||
default_archive_name_format = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
archive_name_format = storage_config.get('archive_name_format', DEFAULT_ARCHIVE_NAME_FORMAT)
|
||||||
archive_name_format = storage_config.get('archive_name_format', default_archive_name_format)
|
extra_borg_options = storage_config.get('extra_borg_options', {}).get('create', '')
|
||||||
|
|
||||||
full_command = (
|
if feature.available(feature.Feature.ATIME, local_borg_version):
|
||||||
(local_path, 'create')
|
atime_flags = ('--atime',) if location_config.get('atime') is True else ()
|
||||||
+ _make_pattern_flags(location_config, pattern_file.name if pattern_file else None)
|
else:
|
||||||
+ _make_exclude_flags(location_config, exclude_file.name if exclude_file else None)
|
atime_flags = ('--noatime',) if location_config.get('atime') is False else ()
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.NOFLAGS, local_borg_version):
|
||||||
|
noflags_flags = ('--noflags',) if location_config.get('flags') is False else ()
|
||||||
|
else:
|
||||||
|
noflags_flags = ('--nobsdflags',) if location_config.get('flags') is False else ()
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.NUMERIC_IDS, local_borg_version):
|
||||||
|
numeric_ids_flags = ('--numeric-ids',) if location_config.get('numeric_ids') else ()
|
||||||
|
else:
|
||||||
|
numeric_ids_flags = ('--numeric-owner',) if location_config.get('numeric_ids') else ()
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.UPLOAD_RATELIMIT, local_borg_version):
|
||||||
|
upload_ratelimit_flags = (
|
||||||
|
('--upload-ratelimit', str(upload_rate_limit)) if upload_rate_limit else ()
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
upload_ratelimit_flags = (
|
||||||
|
('--remote-ratelimit', str(upload_rate_limit)) if upload_rate_limit else ()
|
||||||
|
)
|
||||||
|
|
||||||
|
if stream_processes and location_config.get('read_special') is False:
|
||||||
|
logger.warning(
|
||||||
|
f'{repository_path}: Ignoring configured "read_special" value of false, as true is needed for database hooks.'
|
||||||
|
)
|
||||||
|
|
||||||
|
create_command = (
|
||||||
|
tuple(local_path.split(' '))
|
||||||
|
+ ('create',)
|
||||||
|
+ make_pattern_flags(location_config, pattern_file.name if pattern_file else None)
|
||||||
|
+ make_exclude_flags(location_config, exclude_file.name if exclude_file else None)
|
||||||
+ (('--checkpoint-interval', str(checkpoint_interval)) if checkpoint_interval else ())
|
+ (('--checkpoint-interval', str(checkpoint_interval)) if checkpoint_interval else ())
|
||||||
|
+ (('--checkpoint-volume', str(checkpoint_volume)) if checkpoint_volume else ())
|
||||||
+ (('--chunker-params', chunker_params) if chunker_params else ())
|
+ (('--chunker-params', chunker_params) if chunker_params else ())
|
||||||
+ (('--compression', compression) if compression else ())
|
+ (('--compression', compression) if compression else ())
|
||||||
+ (('--remote-ratelimit', str(remote_rate_limit)) if remote_rate_limit else ())
|
+ upload_ratelimit_flags
|
||||||
+ (('--one-file-system',) if location_config.get('one_file_system') else ())
|
+ (
|
||||||
+ (('--numeric-owner',) if location_config.get('numeric_owner') else ())
|
('--one-file-system',)
|
||||||
+ (('--noatime',) if location_config.get('atime') is False else ())
|
if location_config.get('one_file_system') or stream_processes
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ numeric_ids_flags
|
||||||
|
+ atime_flags
|
||||||
+ (('--noctime',) if location_config.get('ctime') is False else ())
|
+ (('--noctime',) if location_config.get('ctime') is False else ())
|
||||||
+ (('--nobirthtime',) if location_config.get('birthtime') is False else ())
|
+ (('--nobirthtime',) if location_config.get('birthtime') is False else ())
|
||||||
+ (('--read-special',) if location_config.get('read_special') else ())
|
+ (('--read-special',) if location_config.get('read_special') or stream_processes else ())
|
||||||
+ (('--nobsdflags',) if location_config.get('bsd_flags') is False else ())
|
+ noflags_flags
|
||||||
+ (('--files-cache', files_cache) if files_cache else ())
|
+ (('--files-cache', files_cache) if files_cache else ())
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (
|
+ (
|
||||||
('--list', '--filter', 'AME-')
|
('--list', '--filter', list_filter_flags)
|
||||||
if logger.isEnabledFor(logging.INFO) and not json and not progress
|
if list_files and not json and not progress
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO and not json else ())
|
|
||||||
+ (
|
|
||||||
('--stats',)
|
|
||||||
if not dry_run and (logger.isEnabledFor(logging.INFO) or stats) and not json
|
|
||||||
else ()
|
|
||||||
)
|
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) and not json else ())
|
|
||||||
+ (('--dry-run',) if dry_run else ())
|
+ (('--dry-run',) if dry_run else ())
|
||||||
+ (('--progress',) if progress else ())
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
+ (('--json',) if json else ())
|
+ flags.make_repository_archive_flags(
|
||||||
+ (
|
repository_path, archive_name_format, local_borg_version
|
||||||
'{repository}::{archive_name_format}'.format(
|
|
||||||
repository=repository, archive_name_format=archive_name_format
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
+ sources
|
+ (sources if not pattern_file else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
# The progress output isn't compatible with captured and logged output, as progress messes with
|
|
||||||
# the terminal directly.
|
|
||||||
if progress:
|
|
||||||
execute_command_without_capture(full_command, error_on_warnings=False)
|
|
||||||
return
|
|
||||||
|
|
||||||
if json:
|
if json:
|
||||||
output_log_level = None
|
output_log_level = None
|
||||||
elif stats:
|
elif list_files or (stats and not dry_run):
|
||||||
output_log_level = logging.WARNING
|
output_log_level = logging.ANSWER
|
||||||
else:
|
else:
|
||||||
output_log_level = logging.INFO
|
output_log_level = logging.INFO
|
||||||
|
|
||||||
return execute_command(full_command, output_log_level, error_on_warnings=False)
|
# The progress output isn't compatible with captured and logged output, as progress messes with
|
||||||
|
# the terminal directly.
|
||||||
|
output_file = DO_NOT_CAPTURE if progress else None
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
|
# If database hooks are enabled (as indicated by streaming processes), exclude files that might
|
||||||
|
# cause Borg to hang. But skip this if the user has explicitly set the "read_special" to True.
|
||||||
|
if stream_processes and not location_config.get('read_special'):
|
||||||
|
logger.debug(f'{repository_path}: Collecting special file paths')
|
||||||
|
special_file_paths = collect_special_file_paths(
|
||||||
|
create_command,
|
||||||
|
local_path,
|
||||||
|
working_directory,
|
||||||
|
borg_environment,
|
||||||
|
skip_directories=borgmatic_source_directories,
|
||||||
|
)
|
||||||
|
|
||||||
|
if special_file_paths:
|
||||||
|
logger.warning(
|
||||||
|
f'{repository_path}: Excluding special files to prevent Borg from hanging: {", ".join(special_file_paths)}'
|
||||||
|
)
|
||||||
|
exclude_file = write_pattern_file(
|
||||||
|
expand_home_directories(
|
||||||
|
tuple(location_config.get('exclude_patterns') or ()) + special_file_paths
|
||||||
|
),
|
||||||
|
pattern_file=exclude_file,
|
||||||
|
)
|
||||||
|
create_command += make_exclude_flags(location_config, exclude_file.name)
|
||||||
|
|
||||||
|
create_command += (
|
||||||
|
(('--info',) if logger.getEffectiveLevel() == logging.INFO and not json else ())
|
||||||
|
+ (('--stats',) if stats and not json and not dry_run else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) and not json else ())
|
||||||
|
+ (('--progress',) if progress else ())
|
||||||
|
+ (('--json',) if json else ())
|
||||||
|
)
|
||||||
|
|
||||||
|
if stream_processes:
|
||||||
|
return execute_command_with_processes(
|
||||||
|
create_command,
|
||||||
|
stream_processes,
|
||||||
|
output_log_level,
|
||||||
|
output_file,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
working_directory=working_directory,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
elif output_log_level is None:
|
||||||
|
return execute_command_and_capture_output(
|
||||||
|
create_command, working_directory=working_directory, extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
execute_command(
|
||||||
|
create_command,
|
||||||
|
output_log_level,
|
||||||
|
output_file,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
working_directory=working_directory,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
|
|
@ -1,14 +1,14 @@
|
||||||
import os
|
|
||||||
|
|
||||||
OPTION_TO_ENVIRONMENT_VARIABLE = {
|
OPTION_TO_ENVIRONMENT_VARIABLE = {
|
||||||
'borg_base_directory': 'BORG_BASE_DIR',
|
'borg_base_directory': 'BORG_BASE_DIR',
|
||||||
'borg_config_directory': 'BORG_CONFIG_DIR',
|
'borg_config_directory': 'BORG_CONFIG_DIR',
|
||||||
'borg_cache_directory': 'BORG_CACHE_DIR',
|
'borg_cache_directory': 'BORG_CACHE_DIR',
|
||||||
|
'borg_files_cache_ttl': 'BORG_FILES_CACHE_TTL',
|
||||||
'borg_security_directory': 'BORG_SECURITY_DIR',
|
'borg_security_directory': 'BORG_SECURITY_DIR',
|
||||||
'borg_keys_directory': 'BORG_KEYS_DIR',
|
'borg_keys_directory': 'BORG_KEYS_DIR',
|
||||||
'encryption_passcommand': 'BORG_PASSCOMMAND',
|
'encryption_passcommand': 'BORG_PASSCOMMAND',
|
||||||
'encryption_passphrase': 'BORG_PASSPHRASE',
|
'encryption_passphrase': 'BORG_PASSPHRASE',
|
||||||
'ssh_command': 'BORG_RSH',
|
'ssh_command': 'BORG_RSH',
|
||||||
|
'temporary_directory': 'TMPDIR',
|
||||||
}
|
}
|
||||||
|
|
||||||
DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE = {
|
DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE = {
|
||||||
|
@ -17,15 +17,24 @@ DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE = {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def initialize(storage_config):
|
def make_environment(storage_config):
|
||||||
|
'''
|
||||||
|
Given a borgmatic storage configuration dict, return its options converted to a Borg environment
|
||||||
|
variable dict.
|
||||||
|
'''
|
||||||
|
environment = {}
|
||||||
|
|
||||||
for option_name, environment_variable_name in OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
for option_name, environment_variable_name in OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
||||||
value = storage_config.get(option_name)
|
value = storage_config.get(option_name)
|
||||||
|
|
||||||
if value:
|
if value:
|
||||||
os.environ[environment_variable_name] = value
|
environment[environment_variable_name] = str(value)
|
||||||
|
|
||||||
for (
|
for (
|
||||||
option_name,
|
option_name,
|
||||||
environment_variable_name,
|
environment_variable_name,
|
||||||
) in DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
) in DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
||||||
value = storage_config.get(option_name, False)
|
value = storage_config.get(option_name, False)
|
||||||
os.environ[environment_variable_name] = 'yes' if value else 'no'
|
environment[environment_variable_name] = 'yes' if value else 'no'
|
||||||
|
|
||||||
|
return environment
|
||||||
|
|
68
borgmatic/borg/export_tar.py
Normal file
68
borgmatic/borg/export_tar.py
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, flags
|
||||||
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def export_tar_archive(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
archive,
|
||||||
|
paths,
|
||||||
|
destination_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
tar_filter=None,
|
||||||
|
list_files=False,
|
||||||
|
strip_components=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
||||||
|
export from the archive, a destination path to export to, a storage configuration dict, the
|
||||||
|
local Borg version, optional local and remote Borg paths, an optional filter program, whether to
|
||||||
|
include per-file details, and an optional number of path components to strip, export the archive
|
||||||
|
into the given destination path as a tar-formatted file.
|
||||||
|
|
||||||
|
If the destination path is "-", then stream the output to stdout instead of to a file.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
umask = storage_config.get('umask', None)
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'export-tar')
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--list',) if list_files else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ (('--dry-run',) if dry_run else ())
|
||||||
|
+ (('--tar-filter', tar_filter) if tar_filter else ())
|
||||||
|
+ (('--strip-components', str(strip_components)) if strip_components else ())
|
||||||
|
+ flags.make_repository_archive_flags(repository_path, archive, local_borg_version,)
|
||||||
|
+ (destination_path,)
|
||||||
|
+ (tuple(paths) if paths else ())
|
||||||
|
)
|
||||||
|
|
||||||
|
if list_files:
|
||||||
|
output_log_level = logging.ANSWER
|
||||||
|
else:
|
||||||
|
output_log_level = logging.INFO
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
logging.info(f'{repository_path}: Skipping export to tar file (dry run)')
|
||||||
|
return
|
||||||
|
|
||||||
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
output_file=DO_NOT_CAPTURE if destination_path == '-' else None,
|
||||||
|
output_log_level=output_log_level,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
|
@ -1,12 +1,21 @@
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import subprocess
|
||||||
|
|
||||||
from borgmatic.execute import execute_command, execute_command_without_capture
|
from borgmatic.borg import environment, feature, flags, rlist
|
||||||
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def extract_last_archive_dry_run(repository, lock_wait=None, local_path='borg', remote_path=None):
|
def extract_last_archive_dry_run(
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
repository_path,
|
||||||
|
lock_wait=None,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Perform an extraction dry-run of the most recent archive. If there are no archives, skip the
|
Perform an extraction dry-run of the most recent archive. If there are no archives, skip the
|
||||||
dry-run.
|
dry-run.
|
||||||
|
@ -19,36 +28,30 @@ def extract_last_archive_dry_run(repository, lock_wait=None, local_path='borg',
|
||||||
elif logger.isEnabledFor(logging.INFO):
|
elif logger.isEnabledFor(logging.INFO):
|
||||||
verbosity_flags = ('--info',)
|
verbosity_flags = ('--info',)
|
||||||
|
|
||||||
full_list_command = (
|
|
||||||
(local_path, 'list', '--short')
|
|
||||||
+ remote_path_flags
|
|
||||||
+ lock_wait_flags
|
|
||||||
+ verbosity_flags
|
|
||||||
+ (repository,)
|
|
||||||
)
|
|
||||||
|
|
||||||
list_output = execute_command(full_list_command, output_log_level=None, error_on_warnings=False)
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
last_archive_name = list_output.strip().splitlines()[-1]
|
last_archive_name = rlist.resolve_archive_name(
|
||||||
except IndexError:
|
repository_path, 'latest', storage_config, local_borg_version, local_path, remote_path
|
||||||
|
)
|
||||||
|
except ValueError:
|
||||||
|
logger.warning('No archives found. Skipping extract consistency check.')
|
||||||
return
|
return
|
||||||
|
|
||||||
list_flag = ('--list',) if logger.isEnabledFor(logging.DEBUG) else ()
|
list_flag = ('--list',) if logger.isEnabledFor(logging.DEBUG) else ()
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
full_extract_command = (
|
full_extract_command = (
|
||||||
(local_path, 'extract', '--dry-run')
|
(local_path, 'extract', '--dry-run')
|
||||||
+ remote_path_flags
|
+ remote_path_flags
|
||||||
+ lock_wait_flags
|
+ lock_wait_flags
|
||||||
+ verbosity_flags
|
+ verbosity_flags
|
||||||
+ list_flag
|
+ list_flag
|
||||||
+ (
|
+ flags.make_repository_archive_flags(
|
||||||
'{repository}::{last_archive_name}'.format(
|
repository_path, last_archive_name, local_borg_version
|
||||||
repository=repository, last_archive_name=last_archive_name
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
execute_command(full_extract_command, working_directory=None, error_on_warnings=True)
|
execute_command(
|
||||||
|
full_extract_command, working_directory=None, extra_environment=borg_environment
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def extract_archive(
|
def extract_archive(
|
||||||
|
@ -58,45 +61,81 @@ def extract_archive(
|
||||||
paths,
|
paths,
|
||||||
location_config,
|
location_config,
|
||||||
storage_config,
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
destination_path=None,
|
destination_path=None,
|
||||||
|
strip_components=None,
|
||||||
progress=False,
|
progress=False,
|
||||||
error_on_warnings=True,
|
extract_to_stdout=False,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
||||||
restore from the archive, location/storage configuration dicts, optional local and remote Borg
|
restore from the archive, the local Borg version string, location/storage configuration dicts,
|
||||||
paths, and an optional destination path to extract to, extract the archive into the current
|
optional local and remote Borg paths, and an optional destination path to extract to, extract
|
||||||
directory.
|
the archive into the current directory.
|
||||||
|
|
||||||
|
If extract to stdout is True, then start the extraction streaming to stdout, and return that
|
||||||
|
extract process as an instance of subprocess.Popen.
|
||||||
'''
|
'''
|
||||||
umask = storage_config.get('umask', None)
|
umask = storage_config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
if progress and extract_to_stdout:
|
||||||
|
raise ValueError('progress and extract_to_stdout cannot both be set')
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.NUMERIC_IDS, local_borg_version):
|
||||||
|
numeric_ids_flags = ('--numeric-ids',) if location_config.get('numeric_ids') else ()
|
||||||
|
else:
|
||||||
|
numeric_ids_flags = ('--numeric-owner',) if location_config.get('numeric_ids') else ()
|
||||||
|
|
||||||
|
if strip_components == 'all':
|
||||||
|
if not paths:
|
||||||
|
raise ValueError('The --strip-components flag with "all" requires at least one --path')
|
||||||
|
|
||||||
|
# Calculate the maximum number of leading path components of the given paths.
|
||||||
|
strip_components = max(0, *(len(path.split(os.path.sep)) - 1 for path in paths))
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'extract')
|
(local_path, 'extract')
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--numeric-owner',) if location_config.get('numeric_owner') else ())
|
+ numeric_ids_flags
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--list', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--list', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ (('--dry-run',) if dry_run else ())
|
+ (('--dry-run',) if dry_run else ())
|
||||||
|
+ (('--strip-components', str(strip_components)) if strip_components else ())
|
||||||
+ (('--progress',) if progress else ())
|
+ (('--progress',) if progress else ())
|
||||||
+ ('::'.join((repository if ':' in repository else os.path.abspath(repository), archive)),)
|
+ (('--stdout',) if extract_to_stdout else ())
|
||||||
|
+ flags.make_repository_archive_flags(repository, archive, local_borg_version,)
|
||||||
+ (tuple(paths) if paths else ())
|
+ (tuple(paths) if paths else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
# The progress output isn't compatible with captured and logged output, as progress messes with
|
# The progress output isn't compatible with captured and logged output, as progress messes with
|
||||||
# the terminal directly.
|
# the terminal directly.
|
||||||
if progress:
|
if progress:
|
||||||
execute_command_without_capture(
|
return execute_command(
|
||||||
full_command, working_directory=destination_path, error_on_warnings=error_on_warnings
|
full_command,
|
||||||
|
output_file=DO_NOT_CAPTURE,
|
||||||
|
working_directory=destination_path,
|
||||||
|
extra_environment=borg_environment,
|
||||||
)
|
)
|
||||||
return
|
return None
|
||||||
|
|
||||||
# Error on warnings by default, as Borg only gives a warning if the restore paths don't exist in
|
if extract_to_stdout:
|
||||||
# the archive!
|
return execute_command(
|
||||||
|
full_command,
|
||||||
|
output_file=subprocess.PIPE,
|
||||||
|
working_directory=destination_path,
|
||||||
|
run_to_completion=False,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command, working_directory=destination_path, error_on_warnings=error_on_warnings
|
full_command, working_directory=destination_path, extra_environment=borg_environment
|
||||||
)
|
)
|
||||||
|
|
40
borgmatic/borg/feature.py
Normal file
40
borgmatic/borg/feature.py
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
from enum import Enum
|
||||||
|
|
||||||
|
from pkg_resources import parse_version
|
||||||
|
|
||||||
|
|
||||||
|
class Feature(Enum):
|
||||||
|
COMPACT = 1
|
||||||
|
ATIME = 2
|
||||||
|
NOFLAGS = 3
|
||||||
|
NUMERIC_IDS = 4
|
||||||
|
UPLOAD_RATELIMIT = 5
|
||||||
|
SEPARATE_REPOSITORY_ARCHIVE = 6
|
||||||
|
RCREATE = 7
|
||||||
|
RLIST = 8
|
||||||
|
RINFO = 9
|
||||||
|
MATCH_ARCHIVES = 10
|
||||||
|
EXCLUDED_FILES_MINUS = 11
|
||||||
|
|
||||||
|
|
||||||
|
FEATURE_TO_MINIMUM_BORG_VERSION = {
|
||||||
|
Feature.COMPACT: parse_version('1.2.0a2'), # borg compact
|
||||||
|
Feature.ATIME: parse_version('1.2.0a7'), # borg create --atime
|
||||||
|
Feature.NOFLAGS: parse_version('1.2.0a8'), # borg create --noflags
|
||||||
|
Feature.NUMERIC_IDS: parse_version('1.2.0b3'), # borg create/extract/mount --numeric-ids
|
||||||
|
Feature.UPLOAD_RATELIMIT: parse_version('1.2.0b3'), # borg create --upload-ratelimit
|
||||||
|
Feature.SEPARATE_REPOSITORY_ARCHIVE: parse_version('2.0.0a2'), # --repo with separate archive
|
||||||
|
Feature.RCREATE: parse_version('2.0.0a2'), # borg rcreate
|
||||||
|
Feature.RLIST: parse_version('2.0.0a2'), # borg rlist
|
||||||
|
Feature.RINFO: parse_version('2.0.0a2'), # borg rinfo
|
||||||
|
Feature.MATCH_ARCHIVES: parse_version('2.0.0b3'), # borg --match-archives
|
||||||
|
Feature.EXCLUDED_FILES_MINUS: parse_version('2.0.0b5'), # --list --filter uses "-" for excludes
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def available(feature, borg_version):
|
||||||
|
'''
|
||||||
|
Given a Borg Feature constant and a Borg version string, return whether that feature is
|
||||||
|
available in that version of Borg.
|
||||||
|
'''
|
||||||
|
return FEATURE_TO_MINIMUM_BORG_VERSION[feature] <= parse_version(borg_version)
|
|
@ -1,4 +1,7 @@
|
||||||
import itertools
|
import itertools
|
||||||
|
import re
|
||||||
|
|
||||||
|
from borgmatic.borg import feature
|
||||||
|
|
||||||
|
|
||||||
def make_flags(name, value):
|
def make_flags(name, value):
|
||||||
|
@ -8,7 +11,7 @@ def make_flags(name, value):
|
||||||
if not value:
|
if not value:
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
flag = '--{}'.format(name.replace('_', '-'))
|
flag = f"--{name.replace('_', '-')}"
|
||||||
|
|
||||||
if value is True:
|
if value is True:
|
||||||
return (flag,)
|
return (flag,)
|
||||||
|
@ -29,3 +32,52 @@ def make_flags_from_arguments(arguments, excludes=()):
|
||||||
if name not in excludes and not name.startswith('_')
|
if name not in excludes and not name.startswith('_')
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def make_repository_flags(repository_path, local_borg_version):
|
||||||
|
'''
|
||||||
|
Given the path of a Borg repository and the local Borg version, return Borg-version-appropriate
|
||||||
|
command-line flags (as a tuple) for selecting that repository.
|
||||||
|
'''
|
||||||
|
return (
|
||||||
|
('--repo',)
|
||||||
|
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
||||||
|
else ()
|
||||||
|
) + (repository_path,)
|
||||||
|
|
||||||
|
|
||||||
|
def make_repository_archive_flags(repository_path, archive, local_borg_version):
|
||||||
|
'''
|
||||||
|
Given the path of a Borg repository, an archive name or pattern, and the local Borg version,
|
||||||
|
return Borg-version-appropriate command-line flags (as a tuple) for selecting that repository
|
||||||
|
and archive.
|
||||||
|
'''
|
||||||
|
return (
|
||||||
|
('--repo', repository_path, archive)
|
||||||
|
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
||||||
|
else (f'{repository_path}::{archive}',)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def make_match_archives_flags(match_archives, archive_name_format, local_borg_version):
|
||||||
|
'''
|
||||||
|
Return match archives flags based on the given match archives value, if any. If it isn't set,
|
||||||
|
return match archives flags to match archives created with the given archive name format, if
|
||||||
|
any. This is done by replacing certain archive name format placeholders for ephemeral data (like
|
||||||
|
"{now}") with globs.
|
||||||
|
'''
|
||||||
|
if match_archives:
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
||||||
|
return ('--match-archives', match_archives)
|
||||||
|
else:
|
||||||
|
return ('--glob-archives', re.sub(r'^sh:', '', match_archives))
|
||||||
|
|
||||||
|
if not archive_name_format:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
derived_match_archives = re.sub(r'\{(now|utcnow|pid)([:%\w\.-]*)\}', '*', archive_name_format)
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
||||||
|
return ('--match-archives', f'sh:{derived_match_archives}')
|
||||||
|
else:
|
||||||
|
return ('--glob-archives', f'{derived_match_archives}')
|
||||||
|
|
|
@ -1,19 +1,26 @@
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from borgmatic.borg.flags import make_flags, make_flags_from_arguments
|
import borgmatic.logger
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.borg import environment, feature, flags
|
||||||
|
from borgmatic.execute import execute_command, execute_command_and_capture_output
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def display_archives_info(
|
def display_archives_info(
|
||||||
repository, storage_config, info_arguments, local_path='borg', remote_path=None
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
info_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, and the arguments to the info
|
Given a local or remote repository path, a storage config dict, the local Borg version, and the
|
||||||
action, display summary information for Borg archives in the repository or return JSON summary
|
arguments to the info action, display summary information for Borg archives in the repository or
|
||||||
information.
|
return JSON summary information.
|
||||||
'''
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
|
@ -28,18 +35,39 @@ def display_archives_info(
|
||||||
if logger.isEnabledFor(logging.DEBUG) and not info_arguments.json
|
if logger.isEnabledFor(logging.DEBUG) and not info_arguments.json
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
+ make_flags_from_arguments(info_arguments, excludes=('repository', 'archive'))
|
|
||||||
+ (
|
+ (
|
||||||
'::'.join((repository, info_arguments.archive))
|
(
|
||||||
if info_arguments.archive
|
flags.make_flags('match-archives', f'sh:{info_arguments.prefix}*')
|
||||||
else repository,
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
|
else flags.make_flags('glob-archives', f'{info_arguments.prefix}*')
|
||||||
|
)
|
||||||
|
if info_arguments.prefix
|
||||||
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
info_arguments.match_archives
|
||||||
|
or info_arguments.archive
|
||||||
|
or storage_config.get('match_archives'),
|
||||||
|
storage_config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
+ flags.make_flags_from_arguments(
|
||||||
|
info_arguments, excludes=('repository', 'archive', 'prefix', 'match_archives')
|
||||||
|
)
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
return execute_command(
|
if info_arguments.json:
|
||||||
full_command,
|
return execute_command_and_capture_output(
|
||||||
output_log_level=None if info_arguments.json else logging.WARNING,
|
full_command, extra_environment=environment.make_environment(storage_config),
|
||||||
error_on_warnings=False,
|
)
|
||||||
)
|
else:
|
||||||
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
||||||
|
|
|
@ -1,48 +0,0 @@
|
||||||
import logging
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
from borgmatic.execute import execute_command, execute_command_without_capture
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
INFO_REPOSITORY_NOT_FOUND_EXIT_CODE = 2
|
|
||||||
|
|
||||||
|
|
||||||
def initialize_repository(
|
|
||||||
repository,
|
|
||||||
encryption_mode,
|
|
||||||
append_only=None,
|
|
||||||
storage_quota=None,
|
|
||||||
local_path='borg',
|
|
||||||
remote_path=None,
|
|
||||||
):
|
|
||||||
'''
|
|
||||||
Given a local or remote repository path, a Borg encryption mode, whether the repository should
|
|
||||||
be append-only, and the storage quota to use, initialize the repository. If the repository
|
|
||||||
already exists, then log and skip initialization.
|
|
||||||
'''
|
|
||||||
info_command = (local_path, 'info', repository)
|
|
||||||
logger.debug(' '.join(info_command))
|
|
||||||
|
|
||||||
try:
|
|
||||||
execute_command(info_command, output_log_level=None)
|
|
||||||
logger.info('Repository already exists. Skipping initialization.')
|
|
||||||
return
|
|
||||||
except subprocess.CalledProcessError as error:
|
|
||||||
if error.returncode != INFO_REPOSITORY_NOT_FOUND_EXIT_CODE:
|
|
||||||
raise
|
|
||||||
|
|
||||||
init_command = (
|
|
||||||
(local_path, 'init')
|
|
||||||
+ (('--encryption', encryption_mode) if encryption_mode else ())
|
|
||||||
+ (('--append-only',) if append_only else ())
|
|
||||||
+ (('--storage-quota', storage_quota) if storage_quota else ())
|
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
|
||||||
+ (('--debug',) if logger.isEnabledFor(logging.DEBUG) else ())
|
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
|
||||||
+ (repository,)
|
|
||||||
)
|
|
||||||
|
|
||||||
# Don't use execute_command() here because it doesn't support interactive prompts.
|
|
||||||
execute_command_without_capture(init_command, error_on_warnings=False)
|
|
|
@ -1,27 +1,41 @@
|
||||||
|
import argparse
|
||||||
|
import copy
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
|
|
||||||
from borgmatic.borg.flags import make_flags, make_flags_from_arguments
|
import borgmatic.logger
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.borg import environment, feature, flags, rlist
|
||||||
|
from borgmatic.execute import execute_command, execute_command_and_capture_output
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
# A hack to convince Borg to exclude archives ending in ".checkpoint". This assumes that a
|
ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST = ('prefix', 'match_archives', 'sort_by', 'first', 'last')
|
||||||
# non-checkpoint archive name ends in a digit (e.g. from a timestamp).
|
MAKE_FLAGS_EXCLUDES = (
|
||||||
BORG_EXCLUDE_CHECKPOINTS_GLOB = '*[0123456789]'
|
'repository',
|
||||||
|
'archive',
|
||||||
|
'successful',
|
||||||
|
'paths',
|
||||||
|
'find_paths',
|
||||||
|
) + ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST
|
||||||
|
|
||||||
|
|
||||||
def list_archives(repository, storage_config, list_arguments, local_path='borg', remote_path=None):
|
def make_list_command(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
list_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, and the arguments to the list
|
Given a local or remote repository path, a storage config dict, the arguments to the list
|
||||||
action, display the output of listing Borg archives in the repository or return JSON output. Or,
|
action, and local and remote Borg paths, return a command as a tuple to list archives or paths
|
||||||
if an archive name is given, listing the files in that archive.
|
within an archive.
|
||||||
'''
|
'''
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
if list_arguments.successful:
|
|
||||||
list_arguments.glob_archives = BORG_EXCLUDE_CHECKPOINTS_GLOB
|
|
||||||
|
|
||||||
full_command = (
|
return (
|
||||||
(local_path, 'list')
|
(local_path, 'list')
|
||||||
+ (
|
+ (
|
||||||
('--info',)
|
('--info',)
|
||||||
|
@ -33,20 +47,199 @@ def list_archives(repository, storage_config, list_arguments, local_path='borg',
|
||||||
if logger.isEnabledFor(logging.DEBUG) and not list_arguments.json
|
if logger.isEnabledFor(logging.DEBUG) and not list_arguments.json
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
+ make_flags_from_arguments(
|
+ flags.make_flags_from_arguments(list_arguments, excludes=MAKE_FLAGS_EXCLUDES)
|
||||||
list_arguments, excludes=('repository', 'archive', 'successful')
|
|
||||||
)
|
|
||||||
+ (
|
+ (
|
||||||
'::'.join((repository, list_arguments.archive))
|
flags.make_repository_archive_flags(
|
||||||
|
repository_path, list_arguments.archive, local_borg_version
|
||||||
|
)
|
||||||
if list_arguments.archive
|
if list_arguments.archive
|
||||||
else repository,
|
else flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
+ (tuple(list_arguments.paths) if list_arguments.paths else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
return execute_command(
|
|
||||||
full_command,
|
def make_find_paths(find_paths):
|
||||||
output_log_level=None if list_arguments.json else logging.WARNING,
|
'''
|
||||||
error_on_warnings=False,
|
Given a sequence of path fragments or patterns as passed to `--find`, transform all path
|
||||||
|
fragments into glob patterns. Pass through existing patterns untouched.
|
||||||
|
|
||||||
|
For example, given find_paths of:
|
||||||
|
|
||||||
|
['foo.txt', 'pp:root/somedir']
|
||||||
|
|
||||||
|
... transform that into:
|
||||||
|
|
||||||
|
['sh:**/*foo.txt*/**', 'pp:root/somedir']
|
||||||
|
'''
|
||||||
|
if not find_paths:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
find_path
|
||||||
|
if re.compile(r'([-!+RrPp] )|(\w\w:)').match(find_path)
|
||||||
|
else f'sh:**/*{find_path}*/**'
|
||||||
|
for find_path in find_paths
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def capture_archive_listing(
|
||||||
|
repository_path,
|
||||||
|
archive,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
list_path=None,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, an archive name, a storage config dict, the local Borg
|
||||||
|
version, the archive path in which to list files, and local and remote Borg paths, capture the
|
||||||
|
output of listing that archive and return it as a list of file paths.
|
||||||
|
'''
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
execute_command_and_capture_output(
|
||||||
|
make_list_command(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
argparse.Namespace(
|
||||||
|
repository=repository_path,
|
||||||
|
archive=archive,
|
||||||
|
paths=[f'sh:{list_path}'],
|
||||||
|
find_paths=None,
|
||||||
|
json=None,
|
||||||
|
format='{path}{NL}', # noqa: FS003
|
||||||
|
),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
.strip('\n')
|
||||||
|
.split('\n')
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def list_archive(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
list_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage config dict, the local Borg version, the
|
||||||
|
arguments to the list action, and local and remote Borg paths, display the output of listing
|
||||||
|
the files of a Borg archive (or return JSON output). If list_arguments.find_paths are given,
|
||||||
|
list the files by searching across multiple archives. If neither find_paths nor archive name
|
||||||
|
are given, instead list the archives in the given repository.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
|
if not list_arguments.archive and not list_arguments.find_paths:
|
||||||
|
if feature.available(feature.Feature.RLIST, local_borg_version):
|
||||||
|
logger.warning(
|
||||||
|
'Omitting the --archive flag on the list action is deprecated when using Borg 2.x+. Use the rlist action instead.'
|
||||||
|
)
|
||||||
|
|
||||||
|
rlist_arguments = argparse.Namespace(
|
||||||
|
repository=repository_path,
|
||||||
|
short=list_arguments.short,
|
||||||
|
format=list_arguments.format,
|
||||||
|
json=list_arguments.json,
|
||||||
|
prefix=list_arguments.prefix,
|
||||||
|
match_archives=list_arguments.match_archives,
|
||||||
|
sort_by=list_arguments.sort_by,
|
||||||
|
first=list_arguments.first,
|
||||||
|
last=list_arguments.last,
|
||||||
|
)
|
||||||
|
return rlist.list_repository(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
if list_arguments.archive:
|
||||||
|
for name in ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST:
|
||||||
|
if getattr(list_arguments, name, None):
|
||||||
|
logger.warning(
|
||||||
|
f"The --{name.replace('_', '-')} flag on the list action is ignored when using the --archive flag."
|
||||||
|
)
|
||||||
|
|
||||||
|
if list_arguments.json:
|
||||||
|
raise ValueError(
|
||||||
|
'The --json flag on the list action is not supported when using the --archive/--find flags.'
|
||||||
|
)
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
|
# If there are any paths to find (and there's not a single archive already selected), start by
|
||||||
|
# getting a list of archives to search.
|
||||||
|
if list_arguments.find_paths and not list_arguments.archive:
|
||||||
|
rlist_arguments = argparse.Namespace(
|
||||||
|
repository=repository_path,
|
||||||
|
short=True,
|
||||||
|
format=None,
|
||||||
|
json=None,
|
||||||
|
prefix=list_arguments.prefix,
|
||||||
|
match_archives=list_arguments.match_archives,
|
||||||
|
sort_by=list_arguments.sort_by,
|
||||||
|
first=list_arguments.first,
|
||||||
|
last=list_arguments.last,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Ask Borg to list archives. Capture its output for use below.
|
||||||
|
archive_lines = tuple(
|
||||||
|
execute_command_and_capture_output(
|
||||||
|
rlist.make_rlist_command(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
.strip('\n')
|
||||||
|
.split('\n')
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
archive_lines = (list_arguments.archive,)
|
||||||
|
|
||||||
|
# For each archive listed by Borg, run list on the contents of that archive.
|
||||||
|
for archive in archive_lines:
|
||||||
|
logger.answer(f'{repository_path}: Listing archive {archive}')
|
||||||
|
|
||||||
|
archive_arguments = copy.copy(list_arguments)
|
||||||
|
archive_arguments.archive = archive
|
||||||
|
|
||||||
|
# This list call is to show the files in a single archive, not list multiple archives. So
|
||||||
|
# blank out any archive filtering flags. They'll break anyway in Borg 2.
|
||||||
|
for name in ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST:
|
||||||
|
setattr(archive_arguments, name, None)
|
||||||
|
|
||||||
|
main_command = make_list_command(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
archive_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
) + make_find_paths(list_arguments.find_paths)
|
||||||
|
|
||||||
|
execute_command(
|
||||||
|
main_command,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
|
|
|
@ -1,25 +1,28 @@
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from borgmatic.execute import execute_command, execute_command_without_capture
|
from borgmatic.borg import environment, feature, flags
|
||||||
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def mount_archive(
|
def mount_archive(
|
||||||
repository,
|
repository_path,
|
||||||
archive,
|
archive,
|
||||||
mount_point,
|
mount_point,
|
||||||
paths,
|
paths,
|
||||||
foreground,
|
foreground,
|
||||||
options,
|
options,
|
||||||
storage_config,
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, an archive name, a filesystem mount point, zero or more
|
Given a local or remote repository path, an optional archive name, a filesystem mount point,
|
||||||
paths to mount from the archive, extra Borg mount options, a storage configuration dict, and
|
zero or more paths to mount from the archive, extra Borg mount options, a storage configuration
|
||||||
optional local and remote Borg paths, mount the archive onto the mount point.
|
dict, the local Borg version, and optional local and remote Borg paths, mount the archive onto
|
||||||
|
the mount point.
|
||||||
'''
|
'''
|
||||||
umask = storage_config.get('umask', None)
|
umask = storage_config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
@ -33,14 +36,36 @@ def mount_archive(
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ (('--foreground',) if foreground else ())
|
+ (('--foreground',) if foreground else ())
|
||||||
+ (('-o', options) if options else ())
|
+ (('-o', options) if options else ())
|
||||||
+ ('::'.join((repository, archive)),)
|
+ (
|
||||||
|
(
|
||||||
|
flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
+ (
|
||||||
|
('--match-archives', archive)
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
|
else ('--glob-archives', archive)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
||||||
|
else (
|
||||||
|
flags.make_repository_archive_flags(repository_path, archive, local_borg_version)
|
||||||
|
if archive
|
||||||
|
else flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
)
|
||||||
+ (mount_point,)
|
+ (mount_point,)
|
||||||
+ (tuple(paths) if paths else ())
|
+ (tuple(paths) if paths else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
# Don't capture the output when foreground mode is used so that ctrl-C can work properly.
|
# Don't capture the output when foreground mode is used so that ctrl-C can work properly.
|
||||||
if foreground:
|
if foreground:
|
||||||
execute_command_without_capture(full_command, error_on_warnings=False)
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
output_file=DO_NOT_CAPTURE,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
execute_command(full_command, error_on_warnings=False)
|
execute_command(full_command, borg_local_path=local_path, extra_environment=borg_environment)
|
||||||
|
|
|
@ -1,14 +1,16 @@
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, feature, flags
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import execute_command
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _make_prune_flags(retention_config):
|
def make_prune_flags(storage_config, retention_config, local_borg_version):
|
||||||
'''
|
'''
|
||||||
Given a retention config dict mapping from option name to value, tranform it into an iterable of
|
Given a retention config dict mapping from option name to value, transform it into an sequence of
|
||||||
command-line name-value flag pairs.
|
command-line flags.
|
||||||
|
|
||||||
For example, given a retention config of:
|
For example, given a retention config of:
|
||||||
|
|
||||||
|
@ -22,50 +24,73 @@ def _make_prune_flags(retention_config):
|
||||||
)
|
)
|
||||||
'''
|
'''
|
||||||
config = retention_config.copy()
|
config = retention_config.copy()
|
||||||
|
prefix = config.pop('prefix', None)
|
||||||
|
|
||||||
if 'prefix' not in config:
|
flag_pairs = (
|
||||||
config['prefix'] = '{hostname}-'
|
|
||||||
elif not config['prefix']:
|
|
||||||
config.pop('prefix')
|
|
||||||
|
|
||||||
return (
|
|
||||||
('--' + option_name.replace('_', '-'), str(value)) for option_name, value in config.items()
|
('--' + option_name.replace('_', '-'), str(value)) for option_name, value in config.items()
|
||||||
)
|
)
|
||||||
|
|
||||||
|
return tuple(element for pair in flag_pairs for element in pair) + (
|
||||||
|
(
|
||||||
|
('--match-archives', f'sh:{prefix}*')
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
|
else ('--glob-archives', f'{prefix}*')
|
||||||
|
)
|
||||||
|
if prefix
|
||||||
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
storage_config.get('match_archives'),
|
||||||
|
storage_config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def prune_archives(
|
def prune_archives(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
storage_config,
|
||||||
retention_config,
|
retention_config,
|
||||||
|
local_borg_version,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
stats=False,
|
stats=False,
|
||||||
|
list_archives=False,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given dry-run flag, a local or remote repository path, a storage config dict, and a
|
Given dry-run flag, a local or remote repository path, a storage config dict, and a
|
||||||
retention config dict, prune Borg archives according to the retention policy specified in that
|
retention config dict, prune Borg archives according to the retention policy specified in that
|
||||||
configuration.
|
configuration.
|
||||||
'''
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
umask = storage_config.get('umask', None)
|
umask = storage_config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
extra_borg_options = storage_config.get('extra_borg_options', {}).get('prune', '')
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'prune')
|
(local_path, 'prune')
|
||||||
+ tuple(element for pair in _make_prune_flags(retention_config) for element in pair)
|
+ make_prune_flags(storage_config, retention_config, local_borg_version)
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--stats',) if not dry_run and logger.isEnabledFor(logging.INFO) else ())
|
+ (('--stats',) if stats and not dry_run else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--list', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--list',) if list_archives else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ (('--dry-run',) if dry_run else ())
|
+ (('--dry-run',) if dry_run else ())
|
||||||
+ (('--stats',) if stats else ())
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
+ (repository,)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if stats or list_archives:
|
||||||
|
output_log_level = logging.ANSWER
|
||||||
|
else:
|
||||||
|
output_log_level = logging.INFO
|
||||||
|
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_log_level=logging.WARNING if stats else logging.INFO,
|
output_log_level=output_log_level,
|
||||||
error_on_warnings=False,
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
)
|
)
|
||||||
|
|
81
borgmatic/borg/rcreate.py
Normal file
81
borgmatic/borg/rcreate.py
Normal file
|
@ -0,0 +1,81 @@
|
||||||
|
import argparse
|
||||||
|
import logging
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from borgmatic.borg import environment, feature, flags, rinfo
|
||||||
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE = 2
|
||||||
|
|
||||||
|
|
||||||
|
def create_repository(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
encryption_mode,
|
||||||
|
source_repository=None,
|
||||||
|
copy_crypt_key=False,
|
||||||
|
append_only=None,
|
||||||
|
storage_quota=None,
|
||||||
|
make_parent_dirs=False,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a dry-run flag, a local or remote repository path, a storage configuration dict, the local
|
||||||
|
Borg version, a Borg encryption mode, the path to another repo whose key material should be
|
||||||
|
reused, whether the repository should be append-only, and the storage quota to use, create the
|
||||||
|
repository. If the repository already exists, then log and skip creation.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
rinfo.display_repository_info(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
argparse.Namespace(json=True),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.info(f'{repository_path}: Repository already exists. Skipping creation.')
|
||||||
|
return
|
||||||
|
except subprocess.CalledProcessError as error:
|
||||||
|
if error.returncode != RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE:
|
||||||
|
raise
|
||||||
|
|
||||||
|
extra_borg_options = storage_config.get('extra_borg_options', {}).get('rcreate', '')
|
||||||
|
|
||||||
|
rcreate_command = (
|
||||||
|
(local_path,)
|
||||||
|
+ (
|
||||||
|
('rcreate',)
|
||||||
|
if feature.available(feature.Feature.RCREATE, local_borg_version)
|
||||||
|
else ('init',)
|
||||||
|
)
|
||||||
|
+ (('--encryption', encryption_mode) if encryption_mode else ())
|
||||||
|
+ (('--other-repo', source_repository) if source_repository else ())
|
||||||
|
+ (('--copy-crypt-key',) if copy_crypt_key else ())
|
||||||
|
+ (('--append-only',) if append_only else ())
|
||||||
|
+ (('--storage-quota', storage_quota) if storage_quota else ())
|
||||||
|
+ (('--make-parent-dirs',) if make_parent_dirs else ())
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug',) if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
logging.info(f'{repository_path}: Skipping repository creation (dry run)')
|
||||||
|
return
|
||||||
|
|
||||||
|
# Do not capture output here, so as to support interactive prompts.
|
||||||
|
execute_command(
|
||||||
|
rcreate_command,
|
||||||
|
output_file=DO_NOT_CAPTURE,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
61
borgmatic/borg/rinfo.py
Normal file
61
borgmatic/borg/rinfo.py
Normal file
|
@ -0,0 +1,61 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, feature, flags
|
||||||
|
from borgmatic.execute import execute_command, execute_command_and_capture_output
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def display_repository_info(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
rinfo_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage config dict, the local Borg version, and the
|
||||||
|
arguments to the rinfo action, display summary information for the Borg repository or return
|
||||||
|
JSON summary information.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path,)
|
||||||
|
+ (
|
||||||
|
('rinfo',)
|
||||||
|
if feature.available(feature.Feature.RINFO, local_borg_version)
|
||||||
|
else ('info',)
|
||||||
|
)
|
||||||
|
+ (
|
||||||
|
('--info',)
|
||||||
|
if logger.getEffectiveLevel() == logging.INFO and not rinfo_arguments.json
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (
|
||||||
|
('--debug', '--show-rc')
|
||||||
|
if logger.isEnabledFor(logging.DEBUG) and not rinfo_arguments.json
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
|
+ (('--json',) if rinfo_arguments.json else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
extra_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
|
if rinfo_arguments.json:
|
||||||
|
return execute_command_and_capture_output(
|
||||||
|
full_command, extra_environment=extra_environment,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
)
|
143
borgmatic/borg/rlist.py
Normal file
143
borgmatic/borg/rlist.py
Normal file
|
@ -0,0 +1,143 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, feature, flags
|
||||||
|
from borgmatic.execute import execute_command, execute_command_and_capture_output
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_archive_name(
|
||||||
|
repository_path,
|
||||||
|
archive,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, an archive name, a storage config dict, a local Borg
|
||||||
|
path, and a remote Borg path, simply return the archive name. But if the archive name is
|
||||||
|
"latest", then instead introspect the repository for the latest archive and return its name.
|
||||||
|
|
||||||
|
Raise ValueError if "latest" is given but there are no archives in the repository.
|
||||||
|
'''
|
||||||
|
if archive != 'latest':
|
||||||
|
return archive
|
||||||
|
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(
|
||||||
|
local_path,
|
||||||
|
'rlist' if feature.available(feature.Feature.RLIST, local_borg_version) else 'list',
|
||||||
|
)
|
||||||
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
|
+ flags.make_flags('last', 1)
|
||||||
|
+ ('--short',)
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
output = execute_command_and_capture_output(
|
||||||
|
full_command, extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
latest_archive = output.strip().splitlines()[-1]
|
||||||
|
except IndexError:
|
||||||
|
raise ValueError('No archives found in the repository')
|
||||||
|
|
||||||
|
logger.debug(f'{repository_path}: Latest archive is {latest_archive}')
|
||||||
|
|
||||||
|
return latest_archive
|
||||||
|
|
||||||
|
|
||||||
|
MAKE_FLAGS_EXCLUDES = ('repository', 'prefix', 'match_archives')
|
||||||
|
|
||||||
|
|
||||||
|
def make_rlist_command(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage config dict, the local Borg version, the
|
||||||
|
arguments to the rlist action, and local and remote Borg paths, return a command as a tuple to
|
||||||
|
list archives with a repository.
|
||||||
|
'''
|
||||||
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
|
return (
|
||||||
|
(
|
||||||
|
local_path,
|
||||||
|
'rlist' if feature.available(feature.Feature.RLIST, local_borg_version) else 'list',
|
||||||
|
)
|
||||||
|
+ (
|
||||||
|
('--info',)
|
||||||
|
if logger.getEffectiveLevel() == logging.INFO and not rlist_arguments.json
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (
|
||||||
|
('--debug', '--show-rc')
|
||||||
|
if logger.isEnabledFor(logging.DEBUG) and not rlist_arguments.json
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
|
+ (
|
||||||
|
(
|
||||||
|
flags.make_flags('match-archives', f'sh:{rlist_arguments.prefix}*')
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
|
else flags.make_flags('glob-archives', f'{rlist_arguments.prefix}*')
|
||||||
|
)
|
||||||
|
if rlist_arguments.prefix
|
||||||
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
rlist_arguments.match_archives or storage_config.get('match_archives'),
|
||||||
|
storage_config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
+ flags.make_flags_from_arguments(rlist_arguments, excludes=MAKE_FLAGS_EXCLUDES)
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def list_repository(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage config dict, the local Borg version, the
|
||||||
|
arguments to the list action, and local and remote Borg paths, display the output of listing
|
||||||
|
Borg archives in the given repository (or return JSON output).
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
borg_environment = environment.make_environment(storage_config)
|
||||||
|
|
||||||
|
main_command = make_rlist_command(
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
if rlist_arguments.json:
|
||||||
|
return execute_command_and_capture_output(main_command, extra_environment=borg_environment)
|
||||||
|
else:
|
||||||
|
execute_command(
|
||||||
|
main_command,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
)
|
1
borgmatic/borg/state.py
Normal file
1
borgmatic/borg/state.py
Normal file
|
@ -0,0 +1 @@
|
||||||
|
DEFAULT_BORGMATIC_SOURCE_DIRECTORY = '~/.borgmatic'
|
57
borgmatic/borg/transfer.py
Normal file
57
borgmatic/borg/transfer.py
Normal file
|
@ -0,0 +1,57 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, flags
|
||||||
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def transfer_archives(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
storage_config,
|
||||||
|
local_borg_version,
|
||||||
|
transfer_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a dry-run flag, a local or remote repository path, a storage config dict, the local Borg
|
||||||
|
version, and the arguments to the transfer action, transfer archives to the given repository.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'transfer')
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('lock-wait', storage_config.get('lock_wait', None))
|
||||||
|
+ (
|
||||||
|
flags.make_flags_from_arguments(
|
||||||
|
transfer_arguments,
|
||||||
|
excludes=('repository', 'source_repository', 'archive', 'match_archives'),
|
||||||
|
)
|
||||||
|
or (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
transfer_arguments.match_archives
|
||||||
|
or transfer_arguments.archive
|
||||||
|
or storage_config.get('match_archives'),
|
||||||
|
storage_config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
+ flags.make_flags('other-repo', transfer_arguments.source_repository)
|
||||||
|
+ flags.make_flags('dry-run', dry_run)
|
||||||
|
)
|
||||||
|
|
||||||
|
return execute_command(
|
||||||
|
full_command,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
output_file=DO_NOT_CAPTURE if transfer_arguments.progress else None,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
|
@ -17,4 +17,4 @@ def unmount_archive(mount_point, local_path='borg'):
|
||||||
+ (mount_point,)
|
+ (mount_point,)
|
||||||
)
|
)
|
||||||
|
|
||||||
execute_command(full_command, error_on_warnings=True)
|
execute_command(full_command)
|
||||||
|
|
28
borgmatic/borg/version.py
Normal file
28
borgmatic/borg/version.py
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from borgmatic.borg import environment
|
||||||
|
from borgmatic.execute import execute_command_and_capture_output
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def local_borg_version(storage_config, local_path='borg'):
|
||||||
|
'''
|
||||||
|
Given a storage configuration dict and a local Borg binary path, return a version string for it.
|
||||||
|
|
||||||
|
Raise OSError or CalledProcessError if there is a problem running Borg.
|
||||||
|
Raise ValueError if the version cannot be parsed.
|
||||||
|
'''
|
||||||
|
full_command = (
|
||||||
|
(local_path, '--version')
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
)
|
||||||
|
output = execute_command_and_capture_output(
|
||||||
|
full_command, extra_environment=environment.make_environment(storage_config),
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
return output.split(' ')[1].strip()
|
||||||
|
except IndexError:
|
||||||
|
raise ValueError('Could not parse Borg version string')
|
|
@ -1,30 +1,37 @@
|
||||||
import collections
|
import collections
|
||||||
from argparse import ArgumentParser
|
from argparse import Action, ArgumentParser
|
||||||
|
|
||||||
from borgmatic.config import collect
|
from borgmatic.config import collect
|
||||||
|
|
||||||
SUBPARSER_ALIASES = {
|
SUBPARSER_ALIASES = {
|
||||||
'init': ['--init', '-I'],
|
'rcreate': ['init', '-I'],
|
||||||
'prune': ['--prune', '-p'],
|
'prune': ['-p'],
|
||||||
'create': ['--create', '-C'],
|
'compact': [],
|
||||||
'check': ['--check', '-k'],
|
'create': ['-C'],
|
||||||
'extract': ['--extract', '-x'],
|
'check': ['-k'],
|
||||||
'mount': ['--mount', '-m'],
|
'extract': ['-x'],
|
||||||
'umount': ['--umount', '-u'],
|
'export-tar': [],
|
||||||
'restore': ['--restore', '-r'],
|
'mount': ['-m'],
|
||||||
'list': ['--list', '-l'],
|
'umount': ['-u'],
|
||||||
'info': ['--info', '-i'],
|
'restore': ['-r'],
|
||||||
|
'rlist': [],
|
||||||
|
'list': ['-l'],
|
||||||
|
'rinfo': [],
|
||||||
|
'info': ['-i'],
|
||||||
|
'transfer': [],
|
||||||
|
'break-lock': [],
|
||||||
|
'borg': [],
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def parse_subparser_arguments(unparsed_arguments, subparsers):
|
def parse_subparser_arguments(unparsed_arguments, subparsers):
|
||||||
'''
|
'''
|
||||||
Given a sequence of arguments, and a subparsers object as returned by
|
Given a sequence of arguments and a dict from subparser name to argparse.ArgumentParser
|
||||||
argparse.ArgumentParser().add_subparsers(), give each requested action's subparser a shot at
|
instance, give each requested action's subparser a shot at parsing all arguments. This allows
|
||||||
parsing all arguments. This allows common arguments like "--repository" to be shared across
|
common arguments like "--repository" to be shared across multiple subparsers.
|
||||||
multiple subparsers.
|
|
||||||
|
|
||||||
Return the result as a dict mapping from subparser name to a parsed namespace of arguments.
|
Return the result as a tuple of (a dict mapping from subparser name to a parsed namespace of
|
||||||
|
arguments, a list of remaining arguments not claimed by any subparser).
|
||||||
'''
|
'''
|
||||||
arguments = collections.OrderedDict()
|
arguments = collections.OrderedDict()
|
||||||
remaining_arguments = list(unparsed_arguments)
|
remaining_arguments = list(unparsed_arguments)
|
||||||
|
@ -34,11 +41,17 @@ def parse_subparser_arguments(unparsed_arguments, subparsers):
|
||||||
for alias in aliases
|
for alias in aliases
|
||||||
}
|
}
|
||||||
|
|
||||||
for subparser_name, subparser in subparsers.choices.items():
|
# If the "borg" action is used, skip all other subparsers. This avoids confusion like
|
||||||
if subparser_name not in remaining_arguments:
|
# "borg list" triggering borgmatic's own list action.
|
||||||
continue
|
if 'borg' in unparsed_arguments:
|
||||||
|
subparsers = {'borg': subparsers['borg']}
|
||||||
|
|
||||||
canonical_name = alias_to_subparser_name.get(subparser_name, subparser_name)
|
for argument in remaining_arguments:
|
||||||
|
canonical_name = alias_to_subparser_name.get(argument, argument)
|
||||||
|
subparser = subparsers.get(canonical_name)
|
||||||
|
|
||||||
|
if not subparser:
|
||||||
|
continue
|
||||||
|
|
||||||
# If a parsed value happens to be the same as the name of a subparser, remove it from the
|
# If a parsed value happens to be the same as the name of a subparser, remove it from the
|
||||||
# remaining arguments. This prevents, for instance, "check --only extract" from triggering
|
# remaining arguments. This prevents, for instance, "check --only extract" from triggering
|
||||||
|
@ -46,69 +59,70 @@ def parse_subparser_arguments(unparsed_arguments, subparsers):
|
||||||
parsed, unused_remaining = subparser.parse_known_args(unparsed_arguments)
|
parsed, unused_remaining = subparser.parse_known_args(unparsed_arguments)
|
||||||
for value in vars(parsed).values():
|
for value in vars(parsed).values():
|
||||||
if isinstance(value, str):
|
if isinstance(value, str):
|
||||||
if value in subparsers.choices:
|
if value in subparsers:
|
||||||
remaining_arguments.remove(value)
|
remaining_arguments.remove(value)
|
||||||
elif isinstance(value, list):
|
elif isinstance(value, list):
|
||||||
for item in value:
|
for item in value:
|
||||||
if item in subparsers.choices:
|
if item in subparsers:
|
||||||
remaining_arguments.remove(item)
|
remaining_arguments.remove(item)
|
||||||
|
|
||||||
arguments[canonical_name] = parsed
|
arguments[canonical_name] = parsed
|
||||||
|
|
||||||
# If no actions are explicitly requested, assume defaults: prune, create, and check.
|
# If no actions are explicitly requested, assume defaults.
|
||||||
if not arguments and '--help' not in unparsed_arguments and '-h' not in unparsed_arguments:
|
if not arguments and '--help' not in unparsed_arguments and '-h' not in unparsed_arguments:
|
||||||
for subparser_name in ('prune', 'create', 'check'):
|
for subparser_name in ('create', 'prune', 'compact', 'check'):
|
||||||
subparser = subparsers.choices[subparser_name]
|
subparser = subparsers[subparser_name]
|
||||||
parsed, unused_remaining = subparser.parse_known_args(unparsed_arguments)
|
parsed, unused_remaining = subparser.parse_known_args(unparsed_arguments)
|
||||||
arguments[subparser_name] = parsed
|
arguments[subparser_name] = parsed
|
||||||
|
|
||||||
return arguments
|
|
||||||
|
|
||||||
|
|
||||||
def parse_global_arguments(unparsed_arguments, top_level_parser, subparsers):
|
|
||||||
'''
|
|
||||||
Given a sequence of arguments, a top-level parser (containing subparsers), and a subparsers
|
|
||||||
object as returned by argparse.ArgumentParser().add_subparsers(), parse and return any global
|
|
||||||
arguments as a parsed argparse.Namespace instance.
|
|
||||||
'''
|
|
||||||
# Ask each subparser, one by one, to greedily consume arguments. Any arguments that remain
|
|
||||||
# are global arguments.
|
|
||||||
remaining_arguments = list(unparsed_arguments)
|
remaining_arguments = list(unparsed_arguments)
|
||||||
present_subparser_names = set()
|
|
||||||
|
|
||||||
for subparser_name, subparser in subparsers.choices.items():
|
# Now ask each subparser, one by one, to greedily consume arguments.
|
||||||
if subparser_name not in remaining_arguments:
|
for subparser_name, subparser in subparsers.items():
|
||||||
|
if subparser_name not in arguments.keys():
|
||||||
continue
|
continue
|
||||||
|
|
||||||
present_subparser_names.add(subparser_name)
|
subparser = subparsers[subparser_name]
|
||||||
unused_parsed, remaining_arguments = subparser.parse_known_args(remaining_arguments)
|
unused_parsed, remaining_arguments = subparser.parse_known_args(remaining_arguments)
|
||||||
|
|
||||||
# If no actions are explicitly requested, assume defaults: prune, create, and check.
|
# Special case: If "borg" is present in the arguments, consume all arguments after (+1) the
|
||||||
if (
|
# "borg" action.
|
||||||
not present_subparser_names
|
if 'borg' in arguments:
|
||||||
and '--help' not in unparsed_arguments
|
borg_options_index = remaining_arguments.index('borg') + 1
|
||||||
and '-h' not in unparsed_arguments
|
arguments['borg'].options = remaining_arguments[borg_options_index:]
|
||||||
):
|
remaining_arguments = remaining_arguments[:borg_options_index]
|
||||||
for subparser_name in ('prune', 'create', 'check'):
|
|
||||||
subparser = subparsers.choices[subparser_name]
|
|
||||||
unused_parsed, remaining_arguments = subparser.parse_known_args(remaining_arguments)
|
|
||||||
|
|
||||||
# Remove the subparser names themselves.
|
# Remove the subparser names themselves.
|
||||||
for subparser_name in present_subparser_names:
|
for subparser_name, subparser in subparsers.items():
|
||||||
if subparser_name in remaining_arguments:
|
if subparser_name in remaining_arguments:
|
||||||
remaining_arguments.remove(subparser_name)
|
remaining_arguments.remove(subparser_name)
|
||||||
|
|
||||||
return top_level_parser.parse_args(remaining_arguments)
|
return (arguments, remaining_arguments)
|
||||||
|
|
||||||
|
|
||||||
def parse_arguments(*unparsed_arguments):
|
class Extend_action(Action):
|
||||||
'''
|
'''
|
||||||
Given command-line arguments with which this script was invoked, parse the arguments and return
|
An argparse action to support Python 3.8's "extend" action in older versions of Python.
|
||||||
them as a dict mapping from subparser name (or "global") to an argparse.Namespace instance.
|
|
||||||
'''
|
'''
|
||||||
config_paths = collect.get_default_config_paths()
|
|
||||||
|
def __call__(self, parser, namespace, values, option_string=None):
|
||||||
|
items = getattr(namespace, self.dest, None)
|
||||||
|
|
||||||
|
if items:
|
||||||
|
items.extend(values)
|
||||||
|
else:
|
||||||
|
setattr(namespace, self.dest, list(values))
|
||||||
|
|
||||||
|
|
||||||
|
def make_parsers():
|
||||||
|
'''
|
||||||
|
Build a top-level parser and its subparsers and return them as a tuple.
|
||||||
|
'''
|
||||||
|
config_paths = collect.get_default_config_paths(expand_home=True)
|
||||||
|
unexpanded_config_paths = collect.get_default_config_paths(expand_home=False)
|
||||||
|
|
||||||
global_parser = ArgumentParser(add_help=False)
|
global_parser = ArgumentParser(add_help=False)
|
||||||
|
global_parser.register('action', 'extend', Extend_action)
|
||||||
global_group = global_parser.add_argument_group('global arguments')
|
global_group = global_parser.add_argument_group('global arguments')
|
||||||
|
|
||||||
global_group.add_argument(
|
global_group.add_argument(
|
||||||
|
@ -117,9 +131,7 @@ def parse_arguments(*unparsed_arguments):
|
||||||
nargs='*',
|
nargs='*',
|
||||||
dest='config_paths',
|
dest='config_paths',
|
||||||
default=config_paths,
|
default=config_paths,
|
||||||
help='Configuration filenames or directories, defaults to: {}'.format(
|
help=f"Configuration filenames or directories, defaults to: {' '.join(unexpanded_config_paths)}",
|
||||||
' '.join(config_paths)
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
global_group.add_argument(
|
global_group.add_argument(
|
||||||
'--excludes',
|
'--excludes',
|
||||||
|
@ -159,10 +171,39 @@ def parse_arguments(*unparsed_arguments):
|
||||||
help='Log verbose progress to log file (from only errors to very verbose: -1, 0, 1, or 2). Only used when --log-file is given',
|
help='Log verbose progress to log file (from only errors to very verbose: -1, 0, 1, or 2). Only used when --log-file is given',
|
||||||
)
|
)
|
||||||
global_group.add_argument(
|
global_group.add_argument(
|
||||||
'--log-file',
|
'--monitoring-verbosity',
|
||||||
|
type=int,
|
||||||
|
choices=range(-1, 3),
|
||||||
|
default=0,
|
||||||
|
help='Log verbose progress to monitoring integrations that support logging (from only errors to very verbose: -1, 0, 1, or 2)',
|
||||||
|
)
|
||||||
|
global_group.add_argument(
|
||||||
|
'--log-file', type=str, help='Write log messages to this file instead of syslog',
|
||||||
|
)
|
||||||
|
global_group.add_argument(
|
||||||
|
'--log-file-format',
|
||||||
type=str,
|
type=str,
|
||||||
default=None,
|
help='Log format string used for log messages written to the log file',
|
||||||
help='Write log messages to this file instead of syslog',
|
)
|
||||||
|
global_group.add_argument(
|
||||||
|
'--override',
|
||||||
|
metavar='SECTION.OPTION=VALUE',
|
||||||
|
nargs='+',
|
||||||
|
dest='overrides',
|
||||||
|
action='extend',
|
||||||
|
help='One or more configuration file options to override with specified values',
|
||||||
|
)
|
||||||
|
global_group.add_argument(
|
||||||
|
'--no-environment-interpolation',
|
||||||
|
dest='resolve_env',
|
||||||
|
action='store_false',
|
||||||
|
help='Do not resolve environment variables in configuration file',
|
||||||
|
)
|
||||||
|
global_group.add_argument(
|
||||||
|
'--bash-completion',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Show bash completion script and exit',
|
||||||
)
|
)
|
||||||
global_group.add_argument(
|
global_group.add_argument(
|
||||||
'--version',
|
'--version',
|
||||||
|
@ -175,8 +216,8 @@ def parse_arguments(*unparsed_arguments):
|
||||||
top_level_parser = ArgumentParser(
|
top_level_parser = ArgumentParser(
|
||||||
description='''
|
description='''
|
||||||
Simple, configuration-driven backup software for servers and workstations. If none of
|
Simple, configuration-driven backup software for servers and workstations. If none of
|
||||||
the action options are given, then borgmatic defaults to: prune, create, and check
|
the action options are given, then borgmatic defaults to: create, prune, compact, and
|
||||||
archives.
|
check.
|
||||||
''',
|
''',
|
||||||
parents=[global_parser],
|
parents=[global_parser],
|
||||||
)
|
)
|
||||||
|
@ -184,44 +225,118 @@ def parse_arguments(*unparsed_arguments):
|
||||||
subparsers = top_level_parser.add_subparsers(
|
subparsers = top_level_parser.add_subparsers(
|
||||||
title='actions',
|
title='actions',
|
||||||
metavar='',
|
metavar='',
|
||||||
help='Specify zero or more actions. Defaults to prune, create, and check. Use --help with action for details:',
|
help='Specify zero or more actions. Defaults to create, prune, compact, and check. Use --help with action for details:',
|
||||||
)
|
)
|
||||||
init_parser = subparsers.add_parser(
|
rcreate_parser = subparsers.add_parser(
|
||||||
'init',
|
'rcreate',
|
||||||
aliases=SUBPARSER_ALIASES['init'],
|
aliases=SUBPARSER_ALIASES['rcreate'],
|
||||||
help='Initialize an empty Borg repository',
|
help='Create a new, empty Borg repository',
|
||||||
description='Initialize an empty Borg repository',
|
description='Create a new, empty Borg repository',
|
||||||
add_help=False,
|
add_help=False,
|
||||||
)
|
)
|
||||||
init_group = init_parser.add_argument_group('init arguments')
|
rcreate_group = rcreate_parser.add_argument_group('rcreate arguments')
|
||||||
init_group.add_argument(
|
rcreate_group.add_argument(
|
||||||
'-e',
|
'-e',
|
||||||
'--encryption',
|
'--encryption',
|
||||||
dest='encryption_mode',
|
dest='encryption_mode',
|
||||||
help='Borg repository encryption mode',
|
help='Borg repository encryption mode',
|
||||||
required=True,
|
required=True,
|
||||||
)
|
)
|
||||||
init_group.add_argument(
|
rcreate_group.add_argument(
|
||||||
'--append-only',
|
'--source-repository',
|
||||||
dest='append_only',
|
'--other-repo',
|
||||||
|
metavar='KEY_REPOSITORY',
|
||||||
|
help='Path to an existing Borg repository whose key material should be reused (Borg 2.x+ only)',
|
||||||
|
)
|
||||||
|
rcreate_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of the new repository to create (must be already specified in a borgmatic configuration file), defaults to the configured repository if there is only one',
|
||||||
|
)
|
||||||
|
rcreate_group.add_argument(
|
||||||
|
'--copy-crypt-key',
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Create an append-only repository',
|
help='Copy the crypt key used for authenticated encryption from the source repository, defaults to a new random key (Borg 2.x+ only)',
|
||||||
)
|
)
|
||||||
init_group.add_argument(
|
rcreate_group.add_argument(
|
||||||
'--storage-quota',
|
'--append-only', action='store_true', help='Create an append-only repository',
|
||||||
dest='storage_quota',
|
)
|
||||||
help='Create a repository with a fixed storage quota',
|
rcreate_group.add_argument(
|
||||||
|
'--storage-quota', help='Create a repository with a fixed storage quota',
|
||||||
|
)
|
||||||
|
rcreate_group.add_argument(
|
||||||
|
'--make-parent-dirs',
|
||||||
|
action='store_true',
|
||||||
|
help='Create any missing parent directories of the repository directory',
|
||||||
|
)
|
||||||
|
rcreate_group.add_argument(
|
||||||
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
|
)
|
||||||
|
|
||||||
|
transfer_parser = subparsers.add_parser(
|
||||||
|
'transfer',
|
||||||
|
aliases=SUBPARSER_ALIASES['transfer'],
|
||||||
|
help='Transfer archives from one repository to another, optionally upgrading the transferred data (Borg 2.0+ only)',
|
||||||
|
description='Transfer archives from one repository to another, optionally upgrading the transferred data (Borg 2.0+ only)',
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
transfer_group = transfer_parser.add_argument_group('transfer arguments')
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of existing destination repository to transfer archives to, defaults to the configured repository if there is only one',
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--source-repository',
|
||||||
|
help='Path of existing source repository to transfer archives from',
|
||||||
|
required=True,
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--archive',
|
||||||
|
help='Name of single archive to transfer (or "latest"), defaults to transferring all archives',
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--upgrader',
|
||||||
|
help='Upgrader type used to convert the transferred data, e.g. "From12To20" to upgrade data from Borg 1.2 to 2.0 format, defaults to no conversion',
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--progress',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Display progress as each archive is transferred',
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'-a',
|
||||||
|
'--match-archives',
|
||||||
|
'--glob-archives',
|
||||||
|
metavar='PATTERN',
|
||||||
|
help='Only transfer archives with names matching this pattern',
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--first',
|
||||||
|
metavar='N',
|
||||||
|
help='Only transfer first N archives after other filters are applied',
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'--last', metavar='N', help='Only transfer last N archives after other filters are applied'
|
||||||
|
)
|
||||||
|
transfer_group.add_argument(
|
||||||
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
)
|
)
|
||||||
init_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
|
||||||
|
|
||||||
prune_parser = subparsers.add_parser(
|
prune_parser = subparsers.add_parser(
|
||||||
'prune',
|
'prune',
|
||||||
aliases=SUBPARSER_ALIASES['prune'],
|
aliases=SUBPARSER_ALIASES['prune'],
|
||||||
help='Prune archives according to the retention policy',
|
help='Prune archives according to the retention policy (with Borg 1.2+, run compact afterwards to actually free space)',
|
||||||
description='Prune archives according to the retention policy',
|
description='Prune archives according to the retention policy (with Borg 1.2+, run compact afterwards to actually free space)',
|
||||||
add_help=False,
|
add_help=False,
|
||||||
)
|
)
|
||||||
prune_group = prune_parser.add_argument_group('prune arguments')
|
prune_group = prune_parser.add_argument_group('prune arguments')
|
||||||
|
prune_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of specific existing repository to prune (must be already specified in a borgmatic configuration file)',
|
||||||
|
)
|
||||||
prune_group.add_argument(
|
prune_group.add_argument(
|
||||||
'--stats',
|
'--stats',
|
||||||
dest='stats',
|
dest='stats',
|
||||||
|
@ -229,22 +344,65 @@ def parse_arguments(*unparsed_arguments):
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Display statistics of archive',
|
help='Display statistics of archive',
|
||||||
)
|
)
|
||||||
|
prune_group.add_argument(
|
||||||
|
'--list', dest='list_archives', action='store_true', help='List archives kept/pruned'
|
||||||
|
)
|
||||||
prune_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
prune_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
|
compact_parser = subparsers.add_parser(
|
||||||
|
'compact',
|
||||||
|
aliases=SUBPARSER_ALIASES['compact'],
|
||||||
|
help='Compact segments to free space (Borg 1.2+, borgmatic 1.5.23+ only)',
|
||||||
|
description='Compact segments to free space (Borg 1.2+, borgmatic 1.5.23+ only)',
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
compact_group = compact_parser.add_argument_group('compact arguments')
|
||||||
|
compact_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of specific existing repository to compact (must be already specified in a borgmatic configuration file)',
|
||||||
|
)
|
||||||
|
compact_group.add_argument(
|
||||||
|
'--progress',
|
||||||
|
dest='progress',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Display progress as each segment is compacted',
|
||||||
|
)
|
||||||
|
compact_group.add_argument(
|
||||||
|
'--cleanup-commits',
|
||||||
|
dest='cleanup_commits',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Cleanup commit-only 17-byte segment files left behind by Borg 1.1 (flag in Borg 1.2 only)',
|
||||||
|
)
|
||||||
|
compact_group.add_argument(
|
||||||
|
'--threshold',
|
||||||
|
type=int,
|
||||||
|
dest='threshold',
|
||||||
|
help='Minimum saved space percentage threshold for compacting a segment, defaults to 10',
|
||||||
|
)
|
||||||
|
compact_group.add_argument(
|
||||||
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
|
)
|
||||||
|
|
||||||
create_parser = subparsers.add_parser(
|
create_parser = subparsers.add_parser(
|
||||||
'create',
|
'create',
|
||||||
aliases=SUBPARSER_ALIASES['create'],
|
aliases=SUBPARSER_ALIASES['create'],
|
||||||
help='Create archives (actually perform backups)',
|
help='Create an archive (actually perform a backup)',
|
||||||
description='Create archives (actually perform backups)',
|
description='Create an archive (actually perform a backup)',
|
||||||
add_help=False,
|
add_help=False,
|
||||||
)
|
)
|
||||||
create_group = create_parser.add_argument_group('create arguments')
|
create_group = create_parser.add_argument_group('create arguments')
|
||||||
|
create_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of specific existing repository to backup to (must be already specified in a borgmatic configuration file)',
|
||||||
|
)
|
||||||
create_group.add_argument(
|
create_group.add_argument(
|
||||||
'--progress',
|
'--progress',
|
||||||
dest='progress',
|
dest='progress',
|
||||||
default=False,
|
default=False,
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Display progress for each file as it is processed',
|
help='Display progress for each file as it is backed up',
|
||||||
)
|
)
|
||||||
create_group.add_argument(
|
create_group.add_argument(
|
||||||
'--stats',
|
'--stats',
|
||||||
|
@ -253,6 +411,9 @@ def parse_arguments(*unparsed_arguments):
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Display statistics of archive',
|
help='Display statistics of archive',
|
||||||
)
|
)
|
||||||
|
create_group.add_argument(
|
||||||
|
'--list', '--files', dest='list_files', action='store_true', help='Show per-file details'
|
||||||
|
)
|
||||||
create_group.add_argument(
|
create_group.add_argument(
|
||||||
'--json', dest='json', default=False, action='store_true', help='Output results as JSON'
|
'--json', dest='json', default=False, action='store_true', help='Output results as JSON'
|
||||||
)
|
)
|
||||||
|
@ -266,13 +427,37 @@ def parse_arguments(*unparsed_arguments):
|
||||||
add_help=False,
|
add_help=False,
|
||||||
)
|
)
|
||||||
check_group = check_parser.add_argument_group('check arguments')
|
check_group = check_parser.add_argument_group('check arguments')
|
||||||
|
check_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of specific existing repository to check (must be already specified in a borgmatic configuration file)',
|
||||||
|
)
|
||||||
|
check_group.add_argument(
|
||||||
|
'--progress',
|
||||||
|
dest='progress',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Display progress for each file as it is checked',
|
||||||
|
)
|
||||||
|
check_group.add_argument(
|
||||||
|
'--repair',
|
||||||
|
dest='repair',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Attempt to repair any inconsistencies found (for interactive use)',
|
||||||
|
)
|
||||||
check_group.add_argument(
|
check_group.add_argument(
|
||||||
'--only',
|
'--only',
|
||||||
metavar='CHECK',
|
metavar='CHECK',
|
||||||
choices=('repository', 'archives', 'data', 'extract'),
|
choices=('repository', 'archives', 'data', 'extract'),
|
||||||
dest='only',
|
dest='only',
|
||||||
action='append',
|
action='append',
|
||||||
help='Run a particular consistency check (repository, archives, data, or extract) instead of configured checks; can specify flag multiple times',
|
help='Run a particular consistency check (repository, archives, data, or extract) instead of configured checks (subject to configured frequency, can specify flag multiple times)',
|
||||||
|
)
|
||||||
|
check_group.add_argument(
|
||||||
|
'--force',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Ignore configured check frequencies and run checks unconditionally',
|
||||||
)
|
)
|
||||||
check_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
check_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
|
@ -288,7 +473,9 @@ def parse_arguments(*unparsed_arguments):
|
||||||
'--repository',
|
'--repository',
|
||||||
help='Path of repository to extract, defaults to the configured repository if there is only one',
|
help='Path of repository to extract, defaults to the configured repository if there is only one',
|
||||||
)
|
)
|
||||||
extract_group.add_argument('--archive', help='Name of archive to extract', required=True)
|
extract_group.add_argument(
|
||||||
|
'--archive', help='Name of archive to extract (or "latest")', required=True
|
||||||
|
)
|
||||||
extract_group.add_argument(
|
extract_group.add_argument(
|
||||||
'--path',
|
'--path',
|
||||||
'--restore-path',
|
'--restore-path',
|
||||||
|
@ -303,17 +490,69 @@ def parse_arguments(*unparsed_arguments):
|
||||||
dest='destination',
|
dest='destination',
|
||||||
help='Directory to extract files into, defaults to the current directory',
|
help='Directory to extract files into, defaults to the current directory',
|
||||||
)
|
)
|
||||||
|
extract_group.add_argument(
|
||||||
|
'--strip-components',
|
||||||
|
type=lambda number: number if number == 'all' else int(number),
|
||||||
|
metavar='NUMBER',
|
||||||
|
help='Number of leading path components to remove from each extracted path or "all" to strip all leading path components. Skip paths with fewer elements',
|
||||||
|
)
|
||||||
extract_group.add_argument(
|
extract_group.add_argument(
|
||||||
'--progress',
|
'--progress',
|
||||||
dest='progress',
|
dest='progress',
|
||||||
default=False,
|
default=False,
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Display progress for each file as it is processed',
|
help='Display progress for each file as it is extracted',
|
||||||
)
|
)
|
||||||
extract_group.add_argument(
|
extract_group.add_argument(
|
||||||
'-h', '--help', action='help', help='Show this help message and exit'
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
export_tar_parser = subparsers.add_parser(
|
||||||
|
'export-tar',
|
||||||
|
aliases=SUBPARSER_ALIASES['export-tar'],
|
||||||
|
help='Export an archive to a tar-formatted file or stream',
|
||||||
|
description='Export an archive to a tar-formatted file or stream',
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
export_tar_group = export_tar_parser.add_argument_group('export-tar arguments')
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of repository to export from, defaults to the configured repository if there is only one',
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--archive', help='Name of archive to export (or "latest")', required=True
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--path',
|
||||||
|
metavar='PATH',
|
||||||
|
nargs='+',
|
||||||
|
dest='paths',
|
||||||
|
help='Paths to export from archive, defaults to the entire archive',
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--destination',
|
||||||
|
metavar='PATH',
|
||||||
|
dest='destination',
|
||||||
|
help='Path to destination export tar file, or "-" for stdout (but be careful about dirtying output with --verbosity or --list)',
|
||||||
|
required=True,
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--tar-filter', help='Name of filter program to pipe data through'
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--list', '--files', dest='list_files', action='store_true', help='Show per-file details'
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'--strip-components',
|
||||||
|
type=int,
|
||||||
|
metavar='NUMBER',
|
||||||
|
dest='strip_components',
|
||||||
|
help='Number of leading path components to remove from each exported path. Skip paths with fewer elements',
|
||||||
|
)
|
||||||
|
export_tar_group.add_argument(
|
||||||
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
|
)
|
||||||
|
|
||||||
mount_parser = subparsers.add_parser(
|
mount_parser = subparsers.add_parser(
|
||||||
'mount',
|
'mount',
|
||||||
aliases=SUBPARSER_ALIASES['mount'],
|
aliases=SUBPARSER_ALIASES['mount'],
|
||||||
|
@ -326,7 +565,7 @@ def parse_arguments(*unparsed_arguments):
|
||||||
'--repository',
|
'--repository',
|
||||||
help='Path of repository to use, defaults to the configured repository if there is only one',
|
help='Path of repository to use, defaults to the configured repository if there is only one',
|
||||||
)
|
)
|
||||||
mount_group.add_argument('--archive', help='Name of archive to mount', required=True)
|
mount_group.add_argument('--archive', help='Name of archive to mount (or "latest")')
|
||||||
mount_group.add_argument(
|
mount_group.add_argument(
|
||||||
'--mount-point',
|
'--mount-point',
|
||||||
metavar='PATH',
|
metavar='PATH',
|
||||||
|
@ -380,56 +619,108 @@ def parse_arguments(*unparsed_arguments):
|
||||||
'--repository',
|
'--repository',
|
||||||
help='Path of repository to restore from, defaults to the configured repository if there is only one',
|
help='Path of repository to restore from, defaults to the configured repository if there is only one',
|
||||||
)
|
)
|
||||||
restore_group.add_argument('--archive', help='Name of archive to restore from', required=True)
|
restore_group.add_argument(
|
||||||
|
'--archive', help='Name of archive to restore from (or "latest")', required=True
|
||||||
|
)
|
||||||
restore_group.add_argument(
|
restore_group.add_argument(
|
||||||
'--database',
|
'--database',
|
||||||
metavar='NAME',
|
metavar='NAME',
|
||||||
nargs='+',
|
nargs='+',
|
||||||
dest='databases',
|
dest='databases',
|
||||||
help='Names of databases to restore from archive, defaults to all databases. Note that any databases to restore must be defined in borgmatic\'s configuration',
|
help="Names of databases to restore from archive, defaults to all databases. Note that any databases to restore must be defined in borgmatic's configuration",
|
||||||
)
|
|
||||||
restore_group.add_argument(
|
|
||||||
'--progress',
|
|
||||||
dest='progress',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='Display progress for each database dump file as it is extracted from archive',
|
|
||||||
)
|
)
|
||||||
restore_group.add_argument(
|
restore_group.add_argument(
|
||||||
'-h', '--help', action='help', help='Show this help message and exit'
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
rlist_parser = subparsers.add_parser(
|
||||||
|
'rlist',
|
||||||
|
aliases=SUBPARSER_ALIASES['rlist'],
|
||||||
|
help='List repository',
|
||||||
|
description='List the archives in a repository',
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
rlist_group = rlist_parser.add_argument_group('rlist arguments')
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'--repository', help='Path of repository to list, defaults to the configured repositories',
|
||||||
|
)
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'--short', default=False, action='store_true', help='Output only archive names'
|
||||||
|
)
|
||||||
|
rlist_group.add_argument('--format', help='Format for archive listing')
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'--json', default=False, action='store_true', help='Output results as JSON'
|
||||||
|
)
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'-P', '--prefix', help='Deprecated. Only list archive names starting with this prefix'
|
||||||
|
)
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'-a',
|
||||||
|
'--match-archives',
|
||||||
|
'--glob-archives',
|
||||||
|
metavar='PATTERN',
|
||||||
|
help='Only list archive names matching this pattern',
|
||||||
|
)
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
||||||
|
)
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'--first', metavar='N', help='List first N archives after other filters are applied'
|
||||||
|
)
|
||||||
|
rlist_group.add_argument(
|
||||||
|
'--last', metavar='N', help='List last N archives after other filters are applied'
|
||||||
|
)
|
||||||
|
rlist_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
list_parser = subparsers.add_parser(
|
list_parser = subparsers.add_parser(
|
||||||
'list',
|
'list',
|
||||||
aliases=SUBPARSER_ALIASES['list'],
|
aliases=SUBPARSER_ALIASES['list'],
|
||||||
help='List archives',
|
help='List archive',
|
||||||
description='List archives or the contents of an archive',
|
description='List the files in an archive or search for a file across archives',
|
||||||
add_help=False,
|
add_help=False,
|
||||||
)
|
)
|
||||||
list_group = list_parser.add_argument_group('list arguments')
|
list_group = list_parser.add_argument_group('list arguments')
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--repository',
|
'--repository',
|
||||||
help='Path of repository to list, defaults to the configured repository if there is only one',
|
help='Path of repository containing archive to list, defaults to the configured repositories',
|
||||||
)
|
)
|
||||||
list_group.add_argument('--archive', help='Name of archive to list')
|
list_group.add_argument('--archive', help='Name of the archive to list (or "latest")')
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--short', default=False, action='store_true', help='Output only archive or path names'
|
'--path',
|
||||||
|
metavar='PATH',
|
||||||
|
nargs='+',
|
||||||
|
dest='paths',
|
||||||
|
help='Paths or patterns to list from a single selected archive (via "--archive"), defaults to listing the entire archive',
|
||||||
|
)
|
||||||
|
list_group.add_argument(
|
||||||
|
'--find',
|
||||||
|
metavar='PATH',
|
||||||
|
nargs='+',
|
||||||
|
dest='find_paths',
|
||||||
|
help='Partial paths or patterns to search for and list across multiple archives',
|
||||||
|
)
|
||||||
|
list_group.add_argument(
|
||||||
|
'--short', default=False, action='store_true', help='Output only path names'
|
||||||
)
|
)
|
||||||
list_group.add_argument('--format', help='Format for file listing')
|
list_group.add_argument('--format', help='Format for file listing')
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--json', default=False, action='store_true', help='Output results as JSON'
|
'--json', default=False, action='store_true', help='Output results as JSON'
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'-P', '--prefix', help='Only list archive names starting with this prefix'
|
'-P', '--prefix', help='Deprecated. Only list archive names starting with this prefix'
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'-a', '--glob-archives', metavar='GLOB', help='Only list archive names matching this glob'
|
'-a',
|
||||||
|
'--match-archives',
|
||||||
|
'--glob-archives',
|
||||||
|
metavar='PATTERN',
|
||||||
|
help='Only list archive names matching this pattern',
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--successful',
|
'--successful',
|
||||||
default=False,
|
default=True,
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Only list archive names of successful (non-checkpoint) backups',
|
help='Deprecated; no effect. Newer versions of Borg shows successful (non-checkpoint) archives by default.',
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
||||||
|
@ -454,30 +745,50 @@ def parse_arguments(*unparsed_arguments):
|
||||||
)
|
)
|
||||||
list_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
list_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
|
rinfo_parser = subparsers.add_parser(
|
||||||
|
'rinfo',
|
||||||
|
aliases=SUBPARSER_ALIASES['rinfo'],
|
||||||
|
help='Show repository summary information such as disk space used',
|
||||||
|
description='Show repository summary information such as disk space used',
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
rinfo_group = rinfo_parser.add_argument_group('rinfo arguments')
|
||||||
|
rinfo_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of repository to show info for, defaults to the configured repository if there is only one',
|
||||||
|
)
|
||||||
|
rinfo_group.add_argument(
|
||||||
|
'--json', dest='json', default=False, action='store_true', help='Output results as JSON'
|
||||||
|
)
|
||||||
|
rinfo_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
info_parser = subparsers.add_parser(
|
info_parser = subparsers.add_parser(
|
||||||
'info',
|
'info',
|
||||||
aliases=SUBPARSER_ALIASES['info'],
|
aliases=SUBPARSER_ALIASES['info'],
|
||||||
help='Display summary information on archives',
|
help='Show archive summary information such as disk space used',
|
||||||
description='Display summary information on archives',
|
description='Show archive summary information such as disk space used',
|
||||||
add_help=False,
|
add_help=False,
|
||||||
)
|
)
|
||||||
info_group = info_parser.add_argument_group('info arguments')
|
info_group = info_parser.add_argument_group('info arguments')
|
||||||
info_group.add_argument(
|
info_group.add_argument(
|
||||||
'--repository',
|
'--repository',
|
||||||
help='Path of repository to show info for, defaults to the configured repository if there is only one',
|
help='Path of repository containing archive to show info for, defaults to the configured repository if there is only one',
|
||||||
)
|
)
|
||||||
info_group.add_argument('--archive', help='Name of archive to show info for')
|
info_group.add_argument('--archive', help='Name of archive to show info for (or "latest")')
|
||||||
info_group.add_argument(
|
info_group.add_argument(
|
||||||
'--json', dest='json', default=False, action='store_true', help='Output results as JSON'
|
'--json', dest='json', default=False, action='store_true', help='Output results as JSON'
|
||||||
)
|
)
|
||||||
info_group.add_argument(
|
info_group.add_argument(
|
||||||
'-P', '--prefix', help='Only show info for archive names starting with this prefix'
|
'-P',
|
||||||
|
'--prefix',
|
||||||
|
help='Deprecated. Only show info for archive names starting with this prefix',
|
||||||
)
|
)
|
||||||
info_group.add_argument(
|
info_group.add_argument(
|
||||||
'-a',
|
'-a',
|
||||||
|
'--match-archives',
|
||||||
'--glob-archives',
|
'--glob-archives',
|
||||||
metavar='GLOB',
|
metavar='PATTERN',
|
||||||
help='Only show info for archive names matching this glob',
|
help='Only show info for archive names matching this pattern',
|
||||||
)
|
)
|
||||||
info_group.add_argument(
|
info_group.add_argument(
|
||||||
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
||||||
|
@ -488,30 +799,106 @@ def parse_arguments(*unparsed_arguments):
|
||||||
help='Show info for first N archives after other filters are applied',
|
help='Show info for first N archives after other filters are applied',
|
||||||
)
|
)
|
||||||
info_group.add_argument(
|
info_group.add_argument(
|
||||||
'--last', metavar='N', help='Show info for first N archives after other filters are applied'
|
'--last', metavar='N', help='Show info for last N archives after other filters are applied'
|
||||||
)
|
)
|
||||||
info_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
info_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
arguments = parse_subparser_arguments(unparsed_arguments, subparsers)
|
break_lock_parser = subparsers.add_parser(
|
||||||
arguments['global'] = parse_global_arguments(unparsed_arguments, top_level_parser, subparsers)
|
'break-lock',
|
||||||
|
aliases=SUBPARSER_ALIASES['break-lock'],
|
||||||
|
help='Break the repository and cache locks left behind by Borg aborting',
|
||||||
|
description='Break Borg repository and cache locks left behind by Borg aborting',
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
break_lock_group = break_lock_parser.add_argument_group('break-lock arguments')
|
||||||
|
break_lock_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of repository to break the lock for, defaults to the configured repository if there is only one',
|
||||||
|
)
|
||||||
|
break_lock_group.add_argument(
|
||||||
|
'-h', '--help', action='help', help='Show this help message and exit'
|
||||||
|
)
|
||||||
|
|
||||||
|
borg_parser = subparsers.add_parser(
|
||||||
|
'borg',
|
||||||
|
aliases=SUBPARSER_ALIASES['borg'],
|
||||||
|
help='Run an arbitrary Borg command',
|
||||||
|
description="Run an arbitrary Borg command based on borgmatic's configuration",
|
||||||
|
add_help=False,
|
||||||
|
)
|
||||||
|
borg_group = borg_parser.add_argument_group('borg arguments')
|
||||||
|
borg_group.add_argument(
|
||||||
|
'--repository',
|
||||||
|
help='Path of repository to pass to Borg, defaults to the configured repositories',
|
||||||
|
)
|
||||||
|
borg_group.add_argument('--archive', help='Name of archive to pass to Borg (or "latest")')
|
||||||
|
borg_group.add_argument(
|
||||||
|
'--',
|
||||||
|
metavar='OPTION',
|
||||||
|
dest='options',
|
||||||
|
nargs='+',
|
||||||
|
help='Options to pass to Borg, command first ("create", "list", etc). "--" is optional. To specify the repository or the archive, you must use --repository or --archive instead of providing them here.',
|
||||||
|
)
|
||||||
|
borg_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
|
return top_level_parser, subparsers
|
||||||
|
|
||||||
|
|
||||||
|
def parse_arguments(*unparsed_arguments):
|
||||||
|
'''
|
||||||
|
Given command-line arguments with which this script was invoked, parse the arguments and return
|
||||||
|
them as a dict mapping from subparser name (or "global") to an argparse.Namespace instance.
|
||||||
|
'''
|
||||||
|
top_level_parser, subparsers = make_parsers()
|
||||||
|
|
||||||
|
arguments, remaining_arguments = parse_subparser_arguments(
|
||||||
|
unparsed_arguments, subparsers.choices
|
||||||
|
)
|
||||||
|
arguments['global'] = top_level_parser.parse_args(remaining_arguments)
|
||||||
|
|
||||||
if arguments['global'].excludes_filename:
|
if arguments['global'].excludes_filename:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
'The --excludes option has been replaced with exclude_patterns in configuration'
|
'The --excludes flag has been replaced with exclude_patterns in configuration.'
|
||||||
)
|
)
|
||||||
|
|
||||||
if 'init' in arguments and arguments['global'].dry_run:
|
if 'create' in arguments and arguments['create'].list_files and arguments['create'].progress:
|
||||||
raise ValueError('The init action cannot be used with the --dry-run option')
|
raise ValueError(
|
||||||
|
'With the create action, only one of --list (--files) and --progress flags can be used.'
|
||||||
if 'list' in arguments and arguments['list'].glob_archives and arguments['list'].successful:
|
)
|
||||||
raise ValueError('The --glob-archives and --successful options cannot be used together')
|
|
||||||
|
|
||||||
if (
|
if (
|
||||||
'list' in arguments
|
('list' in arguments and 'rinfo' in arguments and arguments['list'].json)
|
||||||
and 'info' in arguments
|
or ('list' in arguments and 'info' in arguments and arguments['list'].json)
|
||||||
and arguments['list'].json
|
or ('rinfo' in arguments and 'info' in arguments and arguments['rinfo'].json)
|
||||||
and arguments['info'].json
|
|
||||||
):
|
):
|
||||||
raise ValueError('With the --json option, list and info actions cannot be used together')
|
raise ValueError('With the --json flag, multiple actions cannot be used together.')
|
||||||
|
|
||||||
|
if (
|
||||||
|
'transfer' in arguments
|
||||||
|
and arguments['transfer'].archive
|
||||||
|
and arguments['transfer'].match_archives
|
||||||
|
):
|
||||||
|
raise ValueError(
|
||||||
|
'With the transfer action, only one of --archive and --match-archives flags can be used.'
|
||||||
|
)
|
||||||
|
|
||||||
|
if 'list' in arguments and (arguments['list'].prefix and arguments['list'].match_archives):
|
||||||
|
raise ValueError(
|
||||||
|
'With the list action, only one of --prefix or --match-archives flags can be used.'
|
||||||
|
)
|
||||||
|
|
||||||
|
if 'rlist' in arguments and (arguments['rlist'].prefix and arguments['rlist'].match_archives):
|
||||||
|
raise ValueError(
|
||||||
|
'With the rlist action, only one of --prefix or --match-archives flags can be used.'
|
||||||
|
)
|
||||||
|
|
||||||
|
if 'info' in arguments and (
|
||||||
|
(arguments['info'].archive and arguments['info'].prefix)
|
||||||
|
or (arguments['info'].archive and arguments['info'].match_archives)
|
||||||
|
or (arguments['info'].prefix and arguments['info'].match_archives)
|
||||||
|
):
|
||||||
|
raise ValueError(
|
||||||
|
'With the info action, only one of --archive, --prefix, or --match-archives flags can be used.'
|
||||||
|
)
|
||||||
|
|
||||||
return arguments
|
return arguments
|
||||||
|
|
|
@ -3,25 +3,36 @@ import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
|
from queue import Queue
|
||||||
from subprocess import CalledProcessError
|
from subprocess import CalledProcessError
|
||||||
|
|
||||||
import colorama
|
import colorama
|
||||||
import pkg_resources
|
import pkg_resources
|
||||||
|
|
||||||
from borgmatic.borg import check as borg_check
|
import borgmatic.actions.borg
|
||||||
from borgmatic.borg import create as borg_create
|
import borgmatic.actions.break_lock
|
||||||
from borgmatic.borg import environment as borg_environment
|
import borgmatic.actions.check
|
||||||
from borgmatic.borg import extract as borg_extract
|
import borgmatic.actions.compact
|
||||||
from borgmatic.borg import info as borg_info
|
import borgmatic.actions.create
|
||||||
from borgmatic.borg import init as borg_init
|
import borgmatic.actions.export_tar
|
||||||
from borgmatic.borg import list as borg_list
|
import borgmatic.actions.extract
|
||||||
from borgmatic.borg import mount as borg_mount
|
import borgmatic.actions.info
|
||||||
from borgmatic.borg import prune as borg_prune
|
import borgmatic.actions.list
|
||||||
|
import borgmatic.actions.mount
|
||||||
|
import borgmatic.actions.prune
|
||||||
|
import borgmatic.actions.rcreate
|
||||||
|
import borgmatic.actions.restore
|
||||||
|
import borgmatic.actions.rinfo
|
||||||
|
import borgmatic.actions.rlist
|
||||||
|
import borgmatic.actions.transfer
|
||||||
|
import borgmatic.commands.completion
|
||||||
from borgmatic.borg import umount as borg_umount
|
from borgmatic.borg import umount as borg_umount
|
||||||
|
from borgmatic.borg import version as borg_version
|
||||||
from borgmatic.commands.arguments import parse_arguments
|
from borgmatic.commands.arguments import parse_arguments
|
||||||
from borgmatic.config import checks, collect, convert, validate
|
from borgmatic.config import checks, collect, convert, validate
|
||||||
from borgmatic.hooks import command, dispatch, dump, monitor
|
from borgmatic.hooks import command, dispatch, monitor
|
||||||
from borgmatic.logger import configure_logging, should_do_markup
|
from borgmatic.logger import add_custom_log_levels, configure_logging, should_do_markup
|
||||||
from borgmatic.signals import configure_signals
|
from borgmatic.signals import configure_signals
|
||||||
from borgmatic.verbosity import verbosity_to_log_level
|
from borgmatic.verbosity import verbosity_to_log_level
|
||||||
|
|
||||||
|
@ -33,8 +44,8 @@ LEGACY_CONFIG_PATH = '/etc/borgmatic/config'
|
||||||
def run_configuration(config_filename, config, arguments):
|
def run_configuration(config_filename, config, arguments):
|
||||||
'''
|
'''
|
||||||
Given a config filename, the corresponding parsed config dict, and command-line arguments as a
|
Given a config filename, the corresponding parsed config dict, and command-line arguments as a
|
||||||
dict from subparser name to a namespace of parsed arguments, execute its defined pruning,
|
dict from subparser name to a namespace of parsed arguments, execute the defined create, prune,
|
||||||
backups, consistency checks, and/or other actions.
|
compact, check, and/or other actions.
|
||||||
|
|
||||||
Yield a combination of:
|
Yield a combination of:
|
||||||
|
|
||||||
|
@ -49,45 +60,62 @@ def run_configuration(config_filename, config, arguments):
|
||||||
|
|
||||||
local_path = location.get('local_path', 'borg')
|
local_path = location.get('local_path', 'borg')
|
||||||
remote_path = location.get('remote_path')
|
remote_path = location.get('remote_path')
|
||||||
borg_environment.initialize(storage)
|
retries = storage.get('retries', 0)
|
||||||
|
retry_wait = storage.get('retry_wait', 0)
|
||||||
encountered_error = None
|
encountered_error = None
|
||||||
error_repository = ''
|
error_repository = ''
|
||||||
|
using_primary_action = {'create', 'prune', 'compact', 'check'}.intersection(arguments)
|
||||||
|
monitoring_log_level = verbosity_to_log_level(global_arguments.monitoring_verbosity)
|
||||||
|
|
||||||
if 'create' in arguments:
|
try:
|
||||||
try:
|
local_borg_version = borg_version.local_borg_version(storage, local_path)
|
||||||
|
except (OSError, CalledProcessError, ValueError) as error:
|
||||||
|
yield from log_error_records(f'{config_filename}: Error getting local Borg version', error)
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
if using_primary_action:
|
||||||
|
dispatch.call_hooks(
|
||||||
|
'initialize_monitor',
|
||||||
|
hooks,
|
||||||
|
config_filename,
|
||||||
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
|
monitoring_log_level,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
if using_primary_action:
|
||||||
dispatch.call_hooks(
|
dispatch.call_hooks(
|
||||||
'ping_monitor',
|
'ping_monitor',
|
||||||
hooks,
|
hooks,
|
||||||
config_filename,
|
config_filename,
|
||||||
monitor.MONITOR_HOOK_NAMES,
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
monitor.State.START,
|
monitor.State.START,
|
||||||
|
monitoring_log_level,
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
)
|
)
|
||||||
command.execute_hook(
|
except (OSError, CalledProcessError) as error:
|
||||||
hooks.get('before_backup'),
|
if command.considered_soft_failure(config_filename, error):
|
||||||
hooks.get('umask'),
|
return
|
||||||
config_filename,
|
|
||||||
'pre-backup',
|
encountered_error = error
|
||||||
global_arguments.dry_run,
|
yield from log_error_records(f'{config_filename}: Error pinging monitor', error)
|
||||||
)
|
|
||||||
dispatch.call_hooks(
|
|
||||||
'dump_databases',
|
|
||||||
hooks,
|
|
||||||
config_filename,
|
|
||||||
dump.DATABASE_HOOK_NAMES,
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
except (OSError, CalledProcessError) as error:
|
|
||||||
encountered_error = error
|
|
||||||
yield from make_error_log_records(
|
|
||||||
'{}: Error running pre-backup hook'.format(config_filename), error
|
|
||||||
)
|
|
||||||
|
|
||||||
if not encountered_error:
|
if not encountered_error:
|
||||||
for repository_path in location['repositories']:
|
repo_queue = Queue()
|
||||||
|
for repo in location['repositories']:
|
||||||
|
repo_queue.put((repo, 0),)
|
||||||
|
|
||||||
|
while not repo_queue.empty():
|
||||||
|
repository, retry_num = repo_queue.get()
|
||||||
|
logger.debug(f'{repository["path"]}: Running actions for repository')
|
||||||
|
timeout = retry_num * retry_wait
|
||||||
|
if timeout:
|
||||||
|
logger.warning(f'{config_filename}: Sleeping {timeout}s before next retry')
|
||||||
|
time.sleep(timeout)
|
||||||
try:
|
try:
|
||||||
yield from run_actions(
|
yield from run_actions(
|
||||||
arguments=arguments,
|
arguments=arguments,
|
||||||
|
config_filename=config_filename,
|
||||||
location=location,
|
location=location,
|
||||||
storage=storage,
|
storage=storage,
|
||||||
retention=retention,
|
retention=retention,
|
||||||
|
@ -95,46 +123,81 @@ def run_configuration(config_filename, config, arguments):
|
||||||
hooks=hooks,
|
hooks=hooks,
|
||||||
local_path=local_path,
|
local_path=local_path,
|
||||||
remote_path=remote_path,
|
remote_path=remote_path,
|
||||||
repository_path=repository_path,
|
local_borg_version=local_borg_version,
|
||||||
|
repository=repository,
|
||||||
)
|
)
|
||||||
except (OSError, CalledProcessError, ValueError) as error:
|
except (OSError, CalledProcessError, ValueError) as error:
|
||||||
encountered_error = error
|
if retry_num < retries:
|
||||||
error_repository = repository_path
|
repo_queue.put((repository, retry_num + 1),)
|
||||||
yield from make_error_log_records(
|
tuple( # Consume the generator so as to trigger logging.
|
||||||
'{}: Error running actions for repository'.format(repository_path), error
|
log_error_records(
|
||||||
)
|
f'{repository["path"]}: Error running actions for repository',
|
||||||
|
error,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: Retrying... attempt {retry_num + 1}/{retries}'
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
if 'create' in arguments and not encountered_error:
|
if command.considered_soft_failure(config_filename, error):
|
||||||
try:
|
return
|
||||||
dispatch.call_hooks(
|
|
||||||
'remove_database_dumps',
|
yield from log_error_records(
|
||||||
hooks,
|
f'{repository["path"]}: Error running actions for repository', error
|
||||||
config_filename,
|
)
|
||||||
dump.DATABASE_HOOK_NAMES,
|
encountered_error = error
|
||||||
global_arguments.dry_run,
|
error_repository = repository['path']
|
||||||
)
|
|
||||||
command.execute_hook(
|
try:
|
||||||
hooks.get('after_backup'),
|
if using_primary_action:
|
||||||
hooks.get('umask'),
|
# send logs irrespective of error
|
||||||
config_filename,
|
|
||||||
'post-backup',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
dispatch.call_hooks(
|
dispatch.call_hooks(
|
||||||
'ping_monitor',
|
'ping_monitor',
|
||||||
hooks,
|
hooks,
|
||||||
config_filename,
|
config_filename,
|
||||||
monitor.MONITOR_HOOK_NAMES,
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
monitor.State.FINISH,
|
monitor.State.LOG,
|
||||||
|
monitoring_log_level,
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
)
|
)
|
||||||
except (OSError, CalledProcessError) as error:
|
except (OSError, CalledProcessError) as error:
|
||||||
encountered_error = error
|
if command.considered_soft_failure(config_filename, error):
|
||||||
yield from make_error_log_records(
|
return
|
||||||
'{}: Error running post-backup hook'.format(config_filename), error
|
|
||||||
)
|
|
||||||
|
|
||||||
if encountered_error:
|
encountered_error = error
|
||||||
|
yield from log_error_records(f'{repository["path"]}: Error pinging monitor', error)
|
||||||
|
|
||||||
|
if not encountered_error:
|
||||||
|
try:
|
||||||
|
if using_primary_action:
|
||||||
|
dispatch.call_hooks(
|
||||||
|
'ping_monitor',
|
||||||
|
hooks,
|
||||||
|
config_filename,
|
||||||
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
|
monitor.State.FINISH,
|
||||||
|
monitoring_log_level,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
dispatch.call_hooks(
|
||||||
|
'destroy_monitor',
|
||||||
|
hooks,
|
||||||
|
config_filename,
|
||||||
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
|
monitoring_log_level,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
except (OSError, CalledProcessError) as error:
|
||||||
|
if command.considered_soft_failure(config_filename, error):
|
||||||
|
return
|
||||||
|
|
||||||
|
encountered_error = error
|
||||||
|
yield from log_error_records(f'{config_filename}: Error pinging monitor', error)
|
||||||
|
|
||||||
|
if encountered_error and using_primary_action:
|
||||||
try:
|
try:
|
||||||
command.execute_hook(
|
command.execute_hook(
|
||||||
hooks.get('on_error'),
|
hooks.get('on_error'),
|
||||||
|
@ -152,17 +215,28 @@ def run_configuration(config_filename, config, arguments):
|
||||||
config_filename,
|
config_filename,
|
||||||
monitor.MONITOR_HOOK_NAMES,
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
monitor.State.FAIL,
|
monitor.State.FAIL,
|
||||||
|
monitoring_log_level,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
dispatch.call_hooks(
|
||||||
|
'destroy_monitor',
|
||||||
|
hooks,
|
||||||
|
config_filename,
|
||||||
|
monitor.MONITOR_HOOK_NAMES,
|
||||||
|
monitoring_log_level,
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
)
|
)
|
||||||
except (OSError, CalledProcessError) as error:
|
except (OSError, CalledProcessError) as error:
|
||||||
yield from make_error_log_records(
|
if command.considered_soft_failure(config_filename, error):
|
||||||
'{}: Error running on-error hook'.format(config_filename), error
|
return
|
||||||
)
|
|
||||||
|
yield from log_error_records(f'{config_filename}: Error running on-error hook', error)
|
||||||
|
|
||||||
|
|
||||||
def run_actions(
|
def run_actions(
|
||||||
*,
|
*,
|
||||||
arguments,
|
arguments,
|
||||||
|
config_filename,
|
||||||
location,
|
location,
|
||||||
storage,
|
storage,
|
||||||
retention,
|
retention,
|
||||||
|
@ -170,190 +244,209 @@ def run_actions(
|
||||||
hooks,
|
hooks,
|
||||||
local_path,
|
local_path,
|
||||||
remote_path,
|
remote_path,
|
||||||
repository_path
|
local_borg_version,
|
||||||
): # pragma: no cover
|
repository,
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given parsed command-line arguments as an argparse.ArgumentParser instance, several different
|
Given parsed command-line arguments as an argparse.ArgumentParser instance, the configuration
|
||||||
configuration dicts, local and remote paths to Borg, and a repository name, run all actions
|
filename, several different configuration dicts, local and remote paths to Borg, a local Borg
|
||||||
from the command-line arguments on the given repository.
|
version string, and a repository name, run all actions from the command-line arguments on the
|
||||||
|
given repository.
|
||||||
|
|
||||||
Yield JSON output strings from executing any actions that produce JSON.
|
Yield JSON output strings from executing any actions that produce JSON.
|
||||||
|
|
||||||
Raise OSError or subprocess.CalledProcessError if an error occurs running a command for an
|
Raise OSError or subprocess.CalledProcessError if an error occurs running a command for an
|
||||||
action. Raise ValueError if the arguments or configuration passed to action are invalid.
|
action or a hook. Raise ValueError if the arguments or configuration passed to action are
|
||||||
|
invalid.
|
||||||
'''
|
'''
|
||||||
repository = os.path.expanduser(repository_path)
|
add_custom_log_levels()
|
||||||
|
repository_path = os.path.expanduser(repository['path'])
|
||||||
global_arguments = arguments['global']
|
global_arguments = arguments['global']
|
||||||
dry_run_label = ' (dry run; not making any changes)' if global_arguments.dry_run else ''
|
dry_run_label = ' (dry run; not making any changes)' if global_arguments.dry_run else ''
|
||||||
if 'init' in arguments:
|
hook_context = {
|
||||||
logger.info('{}: Initializing repository'.format(repository))
|
'repository': repository_path,
|
||||||
borg_init.initialize_repository(
|
# Deprecated: For backwards compatibility with borgmatic < 1.6.0.
|
||||||
repository,
|
'repositories': ','.join([repo['path'] for repo in location['repositories']]),
|
||||||
arguments['init'].encryption_mode,
|
'log_file': global_arguments.log_file if global_arguments.log_file else '',
|
||||||
arguments['init'].append_only,
|
}
|
||||||
arguments['init'].storage_quota,
|
|
||||||
local_path=local_path,
|
command.execute_hook(
|
||||||
remote_path=remote_path,
|
hooks.get('before_actions'),
|
||||||
)
|
hooks.get('umask'),
|
||||||
if 'prune' in arguments:
|
config_filename,
|
||||||
logger.info('{}: Pruning archives{}'.format(repository, dry_run_label))
|
'pre-actions',
|
||||||
borg_prune.prune_archives(
|
global_arguments.dry_run,
|
||||||
global_arguments.dry_run,
|
**hook_context,
|
||||||
repository,
|
)
|
||||||
storage,
|
|
||||||
retention,
|
for (action_name, action_arguments) in arguments.items():
|
||||||
local_path=local_path,
|
if action_name == 'rcreate':
|
||||||
remote_path=remote_path,
|
borgmatic.actions.rcreate.run_rcreate(
|
||||||
stats=arguments['prune'].stats,
|
repository,
|
||||||
)
|
storage,
|
||||||
if 'create' in arguments:
|
local_borg_version,
|
||||||
logger.info('{}: Creating archive{}'.format(repository, dry_run_label))
|
action_arguments,
|
||||||
json_output = borg_create.create_archive(
|
global_arguments,
|
||||||
global_arguments.dry_run,
|
local_path,
|
||||||
repository,
|
remote_path,
|
||||||
location,
|
)
|
||||||
storage,
|
elif action_name == 'transfer':
|
||||||
local_path=local_path,
|
borgmatic.actions.transfer.run_transfer(
|
||||||
remote_path=remote_path,
|
repository,
|
||||||
progress=arguments['create'].progress,
|
storage,
|
||||||
stats=arguments['create'].stats,
|
local_borg_version,
|
||||||
json=arguments['create'].json,
|
action_arguments,
|
||||||
)
|
global_arguments,
|
||||||
if json_output:
|
local_path,
|
||||||
yield json.loads(json_output)
|
remote_path,
|
||||||
if 'check' in arguments and checks.repository_enabled_for_checks(repository, consistency):
|
)
|
||||||
logger.info('{}: Running consistency checks'.format(repository))
|
elif action_name == 'create':
|
||||||
borg_check.check_archives(
|
yield from borgmatic.actions.create.run_create(
|
||||||
repository,
|
config_filename,
|
||||||
storage,
|
|
||||||
consistency,
|
|
||||||
local_path=local_path,
|
|
||||||
remote_path=remote_path,
|
|
||||||
only_checks=arguments['check'].only,
|
|
||||||
)
|
|
||||||
if 'extract' in arguments:
|
|
||||||
if arguments['extract'].repository is None or repository == arguments['extract'].repository:
|
|
||||||
logger.info(
|
|
||||||
'{}: Extracting archive {}'.format(repository, arguments['extract'].archive)
|
|
||||||
)
|
|
||||||
borg_extract.extract_archive(
|
|
||||||
global_arguments.dry_run,
|
|
||||||
repository,
|
repository,
|
||||||
arguments['extract'].archive,
|
|
||||||
arguments['extract'].paths,
|
|
||||||
location,
|
location,
|
||||||
storage,
|
storage,
|
||||||
local_path=local_path,
|
|
||||||
remote_path=remote_path,
|
|
||||||
destination_path=arguments['extract'].destination,
|
|
||||||
progress=arguments['extract'].progress,
|
|
||||||
)
|
|
||||||
if 'mount' in arguments:
|
|
||||||
if arguments['mount'].repository is None or repository == arguments['mount'].repository:
|
|
||||||
logger.info('{}: Mounting archive {}'.format(repository, arguments['mount'].archive))
|
|
||||||
borg_mount.mount_archive(
|
|
||||||
repository,
|
|
||||||
arguments['mount'].archive,
|
|
||||||
arguments['mount'].mount_point,
|
|
||||||
arguments['mount'].paths,
|
|
||||||
arguments['mount'].foreground,
|
|
||||||
arguments['mount'].options,
|
|
||||||
storage,
|
|
||||||
local_path=local_path,
|
|
||||||
remote_path=remote_path,
|
|
||||||
)
|
|
||||||
if 'umount' in arguments:
|
|
||||||
logger.info(
|
|
||||||
'{}: Unmounting mount point {}'.format(repository, arguments['umount'].mount_point)
|
|
||||||
)
|
|
||||||
borg_umount.unmount_archive(
|
|
||||||
mount_point=arguments['umount'].mount_point, local_path=local_path
|
|
||||||
)
|
|
||||||
if 'restore' in arguments:
|
|
||||||
if arguments['restore'].repository is None or repository == arguments['restore'].repository:
|
|
||||||
logger.info(
|
|
||||||
'{}: Restoring databases from archive {}'.format(
|
|
||||||
repository, arguments['restore'].archive
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
restore_names = arguments['restore'].databases or []
|
|
||||||
if 'all' in restore_names:
|
|
||||||
restore_names = []
|
|
||||||
|
|
||||||
# Extract dumps for the named databases from the archive.
|
|
||||||
dump_patterns = dispatch.call_hooks(
|
|
||||||
'make_database_dump_patterns',
|
|
||||||
hooks,
|
hooks,
|
||||||
repository,
|
hook_context,
|
||||||
dump.DATABASE_HOOK_NAMES,
|
local_borg_version,
|
||||||
restore_names,
|
action_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
)
|
)
|
||||||
|
elif action_name == 'prune':
|
||||||
borg_extract.extract_archive(
|
borgmatic.actions.prune.run_prune(
|
||||||
global_arguments.dry_run,
|
config_filename,
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
retention,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
action_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'compact':
|
||||||
|
borgmatic.actions.compact.run_compact(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
retention,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
action_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'check':
|
||||||
|
if checks.repository_enabled_for_checks(repository, consistency):
|
||||||
|
borgmatic.actions.check.run_check(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
consistency,
|
||||||
|
hooks,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
action_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'extract':
|
||||||
|
borgmatic.actions.extract.run_extract(
|
||||||
|
config_filename,
|
||||||
repository,
|
repository,
|
||||||
arguments['restore'].archive,
|
|
||||||
dump.convert_glob_patterns_to_borg_patterns(
|
|
||||||
dump.flatten_dump_patterns(dump_patterns, restore_names)
|
|
||||||
),
|
|
||||||
location,
|
location,
|
||||||
storage,
|
storage,
|
||||||
local_path=local_path,
|
hooks,
|
||||||
remote_path=remote_path,
|
hook_context,
|
||||||
destination_path='/',
|
local_borg_version,
|
||||||
progress=arguments['restore'].progress,
|
action_arguments,
|
||||||
# We don't want glob patterns that don't match to error.
|
global_arguments,
|
||||||
error_on_warnings=False,
|
local_path,
|
||||||
|
remote_path,
|
||||||
)
|
)
|
||||||
|
elif action_name == 'export-tar':
|
||||||
# Map the restore names or detected dumps to the corresponding database configurations.
|
borgmatic.actions.export_tar.run_export_tar(
|
||||||
restore_databases = dump.get_per_hook_database_configurations(
|
|
||||||
hooks, restore_names, dump_patterns
|
|
||||||
)
|
|
||||||
|
|
||||||
# Finally, restore the databases and cleanup the dumps.
|
|
||||||
dispatch.call_hooks(
|
|
||||||
'restore_database_dumps',
|
|
||||||
restore_databases,
|
|
||||||
repository,
|
|
||||||
dump.DATABASE_HOOK_NAMES,
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
dispatch.call_hooks(
|
|
||||||
'remove_database_dumps',
|
|
||||||
restore_databases,
|
|
||||||
repository,
|
|
||||||
dump.DATABASE_HOOK_NAMES,
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
if 'list' in arguments:
|
|
||||||
if arguments['list'].repository is None or repository == arguments['list'].repository:
|
|
||||||
logger.info('{}: Listing archives'.format(repository))
|
|
||||||
json_output = borg_list.list_archives(
|
|
||||||
repository,
|
repository,
|
||||||
storage,
|
storage,
|
||||||
list_arguments=arguments['list'],
|
local_borg_version,
|
||||||
local_path=local_path,
|
action_arguments,
|
||||||
remote_path=remote_path,
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
)
|
)
|
||||||
if json_output:
|
elif action_name == 'mount':
|
||||||
yield json.loads(json_output)
|
borgmatic.actions.mount.run_mount(
|
||||||
if 'info' in arguments:
|
|
||||||
if arguments['info'].repository is None or repository == arguments['info'].repository:
|
|
||||||
logger.info('{}: Displaying summary info for archives'.format(repository))
|
|
||||||
json_output = borg_info.display_archives_info(
|
|
||||||
repository,
|
repository,
|
||||||
storage,
|
storage,
|
||||||
info_arguments=arguments['info'],
|
local_borg_version,
|
||||||
local_path=local_path,
|
arguments['mount'],
|
||||||
remote_path=remote_path,
|
local_path,
|
||||||
|
remote_path,
|
||||||
)
|
)
|
||||||
if json_output:
|
elif action_name == 'restore':
|
||||||
yield json.loads(json_output)
|
borgmatic.actions.restore.run_restore(
|
||||||
|
repository,
|
||||||
|
location,
|
||||||
|
storage,
|
||||||
|
hooks,
|
||||||
|
local_borg_version,
|
||||||
|
action_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'rlist':
|
||||||
|
yield from borgmatic.actions.rlist.run_rlist(
|
||||||
|
repository, storage, local_borg_version, action_arguments, local_path, remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'list':
|
||||||
|
yield from borgmatic.actions.list.run_list(
|
||||||
|
repository, storage, local_borg_version, action_arguments, local_path, remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'rinfo':
|
||||||
|
yield from borgmatic.actions.rinfo.run_rinfo(
|
||||||
|
repository, storage, local_borg_version, action_arguments, local_path, remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'info':
|
||||||
|
yield from borgmatic.actions.info.run_info(
|
||||||
|
repository, storage, local_borg_version, action_arguments, local_path, remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'break-lock':
|
||||||
|
borgmatic.actions.break_lock.run_break_lock(
|
||||||
|
repository,
|
||||||
|
storage,
|
||||||
|
local_borg_version,
|
||||||
|
arguments['break-lock'],
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
elif action_name == 'borg':
|
||||||
|
borgmatic.actions.borg.run_borg(
|
||||||
|
repository, storage, local_borg_version, action_arguments, local_path, remote_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('after_actions'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-actions',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def load_configurations(config_filenames):
|
def load_configurations(config_filenames, overrides=None, resolve_env=True):
|
||||||
'''
|
'''
|
||||||
Given a sequence of configuration filenames, load and validate each configuration file. Return
|
Given a sequence of configuration filenames, load and validate each configuration file. Return
|
||||||
the results as a tuple of: dict of configuration filename to corresponding parsed configuration,
|
the results as a tuple of: dict of configuration filename to corresponding parsed configuration,
|
||||||
|
@ -366,8 +459,21 @@ def load_configurations(config_filenames):
|
||||||
# Parse and load each configuration file.
|
# Parse and load each configuration file.
|
||||||
for config_filename in config_filenames:
|
for config_filename in config_filenames:
|
||||||
try:
|
try:
|
||||||
configs[config_filename] = validate.parse_configuration(
|
configs[config_filename], parse_logs = validate.parse_configuration(
|
||||||
config_filename, validate.schema_filename()
|
config_filename, validate.schema_filename(), overrides, resolve_env
|
||||||
|
)
|
||||||
|
logs.extend(parse_logs)
|
||||||
|
except PermissionError:
|
||||||
|
logs.extend(
|
||||||
|
[
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: Insufficient permissions to read configuration file',
|
||||||
|
)
|
||||||
|
),
|
||||||
|
]
|
||||||
)
|
)
|
||||||
except (ValueError, OSError, validate.Validation_error) as error:
|
except (ValueError, OSError, validate.Validation_error) as error:
|
||||||
logs.extend(
|
logs.extend(
|
||||||
|
@ -376,7 +482,7 @@ def load_configurations(config_filenames):
|
||||||
dict(
|
dict(
|
||||||
levelno=logging.CRITICAL,
|
levelno=logging.CRITICAL,
|
||||||
levelname='CRITICAL',
|
levelname='CRITICAL',
|
||||||
msg='{}: Error parsing configuration file'.format(config_filename),
|
msg=f'{config_filename}: Error parsing configuration file',
|
||||||
)
|
)
|
||||||
),
|
),
|
||||||
logging.makeLogRecord(
|
logging.makeLogRecord(
|
||||||
|
@ -401,34 +507,53 @@ def log_record(suppress_log=False, **kwargs):
|
||||||
return record
|
return record
|
||||||
|
|
||||||
|
|
||||||
def make_error_log_records(message, error=None):
|
def log_error_records(
|
||||||
|
message, error=None, levelno=logging.CRITICAL, log_command_error_output=False
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given error message text and an optional exception object, yield a series of logging.LogRecord
|
Given error message text, an optional exception object, an optional log level, and whether to
|
||||||
instances with error summary information. As a side effect, log each record.
|
log the error output of a CalledProcessError (if any), log error summary information and also
|
||||||
|
yield it as a series of logging.LogRecord instances.
|
||||||
|
|
||||||
|
Note that because the logs are yielded as a generator, logs won't get logged unless you consume
|
||||||
|
the generator output.
|
||||||
'''
|
'''
|
||||||
|
level_name = logging._levelToName[levelno]
|
||||||
|
|
||||||
if not error:
|
if not error:
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=message)
|
yield log_record(levelno=levelno, levelname=level_name, msg=message)
|
||||||
return
|
return
|
||||||
|
|
||||||
try:
|
try:
|
||||||
raise error
|
raise error
|
||||||
except CalledProcessError as error:
|
except CalledProcessError as error:
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=message)
|
yield log_record(levelno=levelno, levelname=level_name, msg=message)
|
||||||
if error.output:
|
if error.output:
|
||||||
# Suppress these logs for now and save full error output for the log summary at the end.
|
# Suppress these logs for now and save full error output for the log summary at the end.
|
||||||
yield log_record(
|
yield log_record(
|
||||||
levelno=logging.CRITICAL, levelname='CRITICAL', msg=error.output, suppress_log=True
|
levelno=levelno,
|
||||||
|
levelname=level_name,
|
||||||
|
msg=error.output,
|
||||||
|
suppress_log=not log_command_error_output,
|
||||||
)
|
)
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=error)
|
yield log_record(levelno=levelno, levelname=level_name, msg=error)
|
||||||
except (ValueError, OSError) as error:
|
except (ValueError, OSError) as error:
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=message)
|
yield log_record(levelno=levelno, levelname=level_name, msg=message)
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=error)
|
yield log_record(levelno=levelno, levelname=level_name, msg=error)
|
||||||
except: # noqa: E722
|
except: # noqa: E722
|
||||||
# Raising above only as a means of determining the error type. Swallow the exception here
|
# Raising above only as a means of determining the error type. Swallow the exception here
|
||||||
# because we don't want the exception to propagate out of this function.
|
# because we don't want the exception to propagate out of this function.
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def get_local_path(configs):
|
||||||
|
'''
|
||||||
|
Arbitrarily return the local path from the first configuration dict. Default to "borg" if not
|
||||||
|
set.
|
||||||
|
'''
|
||||||
|
return next(iter(configs.values())).get('location', {}).get('local_path', 'borg')
|
||||||
|
|
||||||
|
|
||||||
def collect_configuration_run_summary_logs(configs, arguments):
|
def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
'''
|
'''
|
||||||
Given a dict of configuration filename to corresponding parsed configuration, and parsed
|
Given a dict of configuration filename to corresponding parsed configuration, and parsed
|
||||||
|
@ -440,25 +565,25 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
any, to stdout.
|
any, to stdout.
|
||||||
'''
|
'''
|
||||||
# Run cross-file validation checks.
|
# Run cross-file validation checks.
|
||||||
if 'extract' in arguments:
|
repository = None
|
||||||
repository = arguments['extract'].repository
|
|
||||||
elif 'list' in arguments and arguments['list'].archive:
|
|
||||||
repository = arguments['list'].repository
|
|
||||||
elif 'mount' in arguments:
|
|
||||||
repository = arguments['mount'].repository
|
|
||||||
else:
|
|
||||||
repository = None
|
|
||||||
|
|
||||||
if repository:
|
for action_name, action_arguments in arguments.items():
|
||||||
try:
|
if hasattr(action_arguments, 'repository'):
|
||||||
validate.guard_configuration_contains_repository(repository, configs)
|
repository = getattr(action_arguments, 'repository')
|
||||||
except ValueError as error:
|
break
|
||||||
yield from make_error_log_records(str(error))
|
|
||||||
return
|
try:
|
||||||
|
if 'extract' in arguments or 'mount' in arguments:
|
||||||
|
validate.guard_single_repository_selected(repository, configs)
|
||||||
|
|
||||||
|
validate.guard_configuration_contains_repository(repository, configs)
|
||||||
|
except ValueError as error:
|
||||||
|
yield from log_error_records(str(error))
|
||||||
|
return
|
||||||
|
|
||||||
if not configs:
|
if not configs:
|
||||||
yield from make_error_log_records(
|
yield from log_error_records(
|
||||||
'{}: No configuration files found'.format(' '.join(arguments['global'].config_paths))
|
f"{' '.join(arguments['global'].config_paths)}: No valid configuration files found",
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
@ -474,7 +599,7 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
arguments['global'].dry_run,
|
arguments['global'].dry_run,
|
||||||
)
|
)
|
||||||
except (CalledProcessError, ValueError, OSError) as error:
|
except (CalledProcessError, ValueError, OSError) as error:
|
||||||
yield from make_error_log_records('Error running pre-everything hook', error)
|
yield from log_error_records('Error running pre-everything hook', error)
|
||||||
return
|
return
|
||||||
|
|
||||||
# Execute the actions corresponding to each configuration file.
|
# Execute the actions corresponding to each configuration file.
|
||||||
|
@ -484,21 +609,28 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
error_logs = tuple(result for result in results if isinstance(result, logging.LogRecord))
|
error_logs = tuple(result for result in results if isinstance(result, logging.LogRecord))
|
||||||
|
|
||||||
if error_logs:
|
if error_logs:
|
||||||
yield from make_error_log_records(
|
yield from log_error_records(f'{config_filename}: An error occurred')
|
||||||
'{}: Error running configuration file'.format(config_filename)
|
|
||||||
)
|
|
||||||
yield from error_logs
|
yield from error_logs
|
||||||
else:
|
else:
|
||||||
yield logging.makeLogRecord(
|
yield logging.makeLogRecord(
|
||||||
dict(
|
dict(
|
||||||
levelno=logging.INFO,
|
levelno=logging.INFO,
|
||||||
levelname='INFO',
|
levelname='INFO',
|
||||||
msg='{}: Successfully ran configuration file'.format(config_filename),
|
msg=f'{config_filename}: Successfully ran configuration file',
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
if results:
|
if results:
|
||||||
json_results.extend(results)
|
json_results.extend(results)
|
||||||
|
|
||||||
|
if 'umount' in arguments:
|
||||||
|
logger.info(f"Unmounting mount point {arguments['umount'].mount_point}")
|
||||||
|
try:
|
||||||
|
borg_umount.unmount_archive(
|
||||||
|
mount_point=arguments['umount'].mount_point, local_path=get_local_path(configs),
|
||||||
|
)
|
||||||
|
except (CalledProcessError, OSError) as error:
|
||||||
|
yield from log_error_records('Error unmounting mount point', error)
|
||||||
|
|
||||||
if json_results:
|
if json_results:
|
||||||
sys.stdout.write(json.dumps(json_results))
|
sys.stdout.write(json.dumps(json_results))
|
||||||
|
|
||||||
|
@ -514,7 +646,7 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
arguments['global'].dry_run,
|
arguments['global'].dry_run,
|
||||||
)
|
)
|
||||||
except (CalledProcessError, ValueError, OSError) as error:
|
except (CalledProcessError, ValueError, OSError) as error:
|
||||||
yield from make_error_log_records('Error running post-everything hook', error)
|
yield from log_error_records('Error running post-everything hook', error)
|
||||||
|
|
||||||
|
|
||||||
def exit_with_help_link(): # pragma: no cover
|
def exit_with_help_link(): # pragma: no cover
|
||||||
|
@ -539,28 +671,41 @@ def main(): # pragma: no cover
|
||||||
if error.code == 0:
|
if error.code == 0:
|
||||||
raise error
|
raise error
|
||||||
configure_logging(logging.CRITICAL)
|
configure_logging(logging.CRITICAL)
|
||||||
logger.critical('Error parsing arguments: {}'.format(' '.join(sys.argv)))
|
logger.critical(f"Error parsing arguments: {' '.join(sys.argv)}")
|
||||||
exit_with_help_link()
|
exit_with_help_link()
|
||||||
|
|
||||||
global_arguments = arguments['global']
|
global_arguments = arguments['global']
|
||||||
if global_arguments.version:
|
if global_arguments.version:
|
||||||
print(pkg_resources.require('borgmatic')[0].version)
|
print(pkg_resources.require('borgmatic')[0].version)
|
||||||
sys.exit(0)
|
sys.exit(0)
|
||||||
|
if global_arguments.bash_completion:
|
||||||
|
print(borgmatic.commands.completion.bash_completion())
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
config_filenames = tuple(collect.collect_config_filenames(global_arguments.config_paths))
|
config_filenames = tuple(collect.collect_config_filenames(global_arguments.config_paths))
|
||||||
configs, parse_logs = load_configurations(config_filenames)
|
configs, parse_logs = load_configurations(
|
||||||
|
config_filenames, global_arguments.overrides, global_arguments.resolve_env
|
||||||
|
)
|
||||||
|
|
||||||
colorama.init(autoreset=True, strip=not should_do_markup(global_arguments.no_color, configs))
|
any_json_flags = any(
|
||||||
|
getattr(sub_arguments, 'json', False) for sub_arguments in arguments.values()
|
||||||
|
)
|
||||||
|
colorama.init(
|
||||||
|
autoreset=True,
|
||||||
|
strip=not should_do_markup(global_arguments.no_color or any_json_flags, configs),
|
||||||
|
)
|
||||||
try:
|
try:
|
||||||
configure_logging(
|
configure_logging(
|
||||||
verbosity_to_log_level(global_arguments.verbosity),
|
verbosity_to_log_level(global_arguments.verbosity),
|
||||||
verbosity_to_log_level(global_arguments.syslog_verbosity),
|
verbosity_to_log_level(global_arguments.syslog_verbosity),
|
||||||
verbosity_to_log_level(global_arguments.log_file_verbosity),
|
verbosity_to_log_level(global_arguments.log_file_verbosity),
|
||||||
|
verbosity_to_log_level(global_arguments.monitoring_verbosity),
|
||||||
global_arguments.log_file,
|
global_arguments.log_file,
|
||||||
|
global_arguments.log_file_format,
|
||||||
)
|
)
|
||||||
except (FileNotFoundError, PermissionError) as error:
|
except (FileNotFoundError, PermissionError) as error:
|
||||||
configure_logging(logging.CRITICAL)
|
configure_logging(logging.CRITICAL)
|
||||||
logger.critical('Error configuring logging: {}'.format(error))
|
logger.critical(f'Error configuring logging: {error}')
|
||||||
exit_with_help_link()
|
exit_with_help_link()
|
||||||
|
|
||||||
logger.debug('Ensuring legacy configuration is upgraded')
|
logger.debug('Ensuring legacy configuration is upgraded')
|
||||||
|
|
57
borgmatic/commands/completion.py
Normal file
57
borgmatic/commands/completion.py
Normal file
|
@ -0,0 +1,57 @@
|
||||||
|
from borgmatic.commands import arguments
|
||||||
|
|
||||||
|
UPGRADE_MESSAGE = '''
|
||||||
|
Your bash completions script is from a different version of borgmatic than is
|
||||||
|
currently installed. Please upgrade your script so your completions match the
|
||||||
|
command-line flags in your installed borgmatic! Try this to upgrade:
|
||||||
|
|
||||||
|
sudo sh -c "borgmatic --bash-completion > $BASH_SOURCE"
|
||||||
|
source $BASH_SOURCE
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
def parser_flags(parser):
|
||||||
|
'''
|
||||||
|
Given an argparse.ArgumentParser instance, return its argument flags in a space-separated
|
||||||
|
string.
|
||||||
|
'''
|
||||||
|
return ' '.join(option for action in parser._actions for option in action.option_strings)
|
||||||
|
|
||||||
|
|
||||||
|
def bash_completion():
|
||||||
|
'''
|
||||||
|
Return a bash completion script for the borgmatic command. Produce this by introspecting
|
||||||
|
borgmatic's command-line argument parsers.
|
||||||
|
'''
|
||||||
|
top_level_parser, subparsers = arguments.make_parsers()
|
||||||
|
global_flags = parser_flags(top_level_parser)
|
||||||
|
actions = ' '.join(subparsers.choices.keys())
|
||||||
|
|
||||||
|
# Avert your eyes.
|
||||||
|
return '\n'.join(
|
||||||
|
(
|
||||||
|
'check_version() {',
|
||||||
|
' local this_script="$(cat "$BASH_SOURCE" 2> /dev/null)"',
|
||||||
|
' local installed_script="$(borgmatic --bash-completion 2> /dev/null)"',
|
||||||
|
' if [ "$this_script" != "$installed_script" ] && [ "$installed_script" != "" ];'
|
||||||
|
f' then cat << EOF\n{UPGRADE_MESSAGE}\nEOF',
|
||||||
|
' fi',
|
||||||
|
'}',
|
||||||
|
'complete_borgmatic() {',
|
||||||
|
)
|
||||||
|
+ tuple(
|
||||||
|
''' if [[ " ${COMP_WORDS[*]} " =~ " %s " ]]; then
|
||||||
|
COMPREPLY=($(compgen -W "%s %s %s" -- "${COMP_WORDS[COMP_CWORD]}"))
|
||||||
|
return 0
|
||||||
|
fi'''
|
||||||
|
% (action, parser_flags(subparser), actions, global_flags)
|
||||||
|
for action, subparser in subparsers.choices.items()
|
||||||
|
)
|
||||||
|
+ (
|
||||||
|
' COMPREPLY=($(compgen -W "%s %s" -- "${COMP_WORDS[COMP_CWORD]}"))' # noqa: FS003
|
||||||
|
% (actions, global_flags),
|
||||||
|
' (check_version &)',
|
||||||
|
'}',
|
||||||
|
'\ncomplete -o bashdefault -o default -F complete_borgmatic borgmatic',
|
||||||
|
)
|
||||||
|
)
|
|
@ -28,9 +28,7 @@ def parse_arguments(*arguments):
|
||||||
'--source-config',
|
'--source-config',
|
||||||
dest='source_config_filename',
|
dest='source_config_filename',
|
||||||
default=DEFAULT_SOURCE_CONFIG_FILENAME,
|
default=DEFAULT_SOURCE_CONFIG_FILENAME,
|
||||||
help='Source INI-style configuration filename. Default: {}'.format(
|
help=f'Source INI-style configuration filename. Default: {DEFAULT_SOURCE_CONFIG_FILENAME}',
|
||||||
DEFAULT_SOURCE_CONFIG_FILENAME
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
'-e',
|
'-e',
|
||||||
|
@ -46,9 +44,7 @@ def parse_arguments(*arguments):
|
||||||
'--destination-config',
|
'--destination-config',
|
||||||
dest='destination_config_filename',
|
dest='destination_config_filename',
|
||||||
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
||||||
help='Destination YAML configuration filename. Default: {}'.format(
|
help=f'Destination YAML configuration filename. Default: {DEFAULT_DESTINATION_CONFIG_FILENAME}',
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
return parser.parse_args(arguments)
|
||||||
|
@ -59,19 +55,15 @@ TEXT_WRAP_CHARACTERS = 80
|
||||||
|
|
||||||
def display_result(args): # pragma: no cover
|
def display_result(args): # pragma: no cover
|
||||||
result_lines = textwrap.wrap(
|
result_lines = textwrap.wrap(
|
||||||
'Your borgmatic configuration has been upgraded. Please review the result in {}.'.format(
|
f'Your borgmatic configuration has been upgraded. Please review the result in {args.destination_config_filename}.',
|
||||||
args.destination_config_filename
|
|
||||||
),
|
|
||||||
TEXT_WRAP_CHARACTERS,
|
TEXT_WRAP_CHARACTERS,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
excludes_phrase = (
|
||||||
|
f' and {args.source_excludes_filename}' if args.source_excludes_filename else ''
|
||||||
|
)
|
||||||
delete_lines = textwrap.wrap(
|
delete_lines = textwrap.wrap(
|
||||||
'Once you are satisfied, you can safely delete {}{}.'.format(
|
f'Once you are satisfied, you can safely delete {args.source_config_filename}{excludes_phrase}.',
|
||||||
args.source_config_filename,
|
|
||||||
' and {}'.format(args.source_excludes_filename)
|
|
||||||
if args.source_excludes_filename
|
|
||||||
else '',
|
|
||||||
),
|
|
||||||
TEXT_WRAP_CHARACTERS,
|
TEXT_WRAP_CHARACTERS,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -99,7 +91,9 @@ def main(): # pragma: no cover
|
||||||
)
|
)
|
||||||
|
|
||||||
generate.write_configuration(
|
generate.write_configuration(
|
||||||
args.destination_config_filename, destination_config, mode=source_config_file_mode
|
args.destination_config_filename,
|
||||||
|
generate.render_configuration(destination_config),
|
||||||
|
mode=source_config_file_mode,
|
||||||
)
|
)
|
||||||
|
|
||||||
display_result(args)
|
display_result(args)
|
||||||
|
|
|
@ -23,9 +23,13 @@ def parse_arguments(*arguments):
|
||||||
'--destination',
|
'--destination',
|
||||||
dest='destination_filename',
|
dest='destination_filename',
|
||||||
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
||||||
help='Destination YAML configuration file. Default: {}'.format(
|
help=f'Destination YAML configuration file, default: {DEFAULT_DESTINATION_CONFIG_FILENAME}',
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME
|
)
|
||||||
),
|
parser.add_argument(
|
||||||
|
'--overwrite',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Whether to overwrite any existing destination file, defaults to false',
|
||||||
)
|
)
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
return parser.parse_args(arguments)
|
||||||
|
@ -36,23 +40,22 @@ def main(): # pragma: no cover
|
||||||
args = parse_arguments(*sys.argv[1:])
|
args = parse_arguments(*sys.argv[1:])
|
||||||
|
|
||||||
generate.generate_sample_configuration(
|
generate.generate_sample_configuration(
|
||||||
args.source_filename, args.destination_filename, validate.schema_filename()
|
args.source_filename,
|
||||||
|
args.destination_filename,
|
||||||
|
validate.schema_filename(),
|
||||||
|
overwrite=args.overwrite,
|
||||||
)
|
)
|
||||||
|
|
||||||
print('Generated a sample configuration file at {}.'.format(args.destination_filename))
|
print(f'Generated a sample configuration file at {args.destination_filename}.')
|
||||||
print()
|
print()
|
||||||
if args.source_filename:
|
if args.source_filename:
|
||||||
print(
|
print(f'Merged in the contents of configuration file at {args.source_filename}.')
|
||||||
'Merged in the contents of configuration file at {}.'.format(args.source_filename)
|
|
||||||
)
|
|
||||||
print('To review the changes made, run:')
|
print('To review the changes made, run:')
|
||||||
print()
|
print()
|
||||||
print(
|
print(f' diff --unified {args.source_filename} {args.destination_filename}')
|
||||||
' diff --unified {} {}'.format(args.source_filename, args.destination_filename)
|
|
||||||
)
|
|
||||||
print()
|
print()
|
||||||
print('Please edit the file to suit your needs. The values are representative.')
|
print('This includes all available configuration options with example values. The few')
|
||||||
print('All fields are optional except where indicated.')
|
print('required options are indicated. Please edit the file to suit your needs.')
|
||||||
print()
|
print()
|
||||||
print('If you ever need help: https://torsion.org/borgmatic/#issues')
|
print('If you ever need help: https://torsion.org/borgmatic/#issues')
|
||||||
except (ValueError, OSError) as error:
|
except (ValueError, OSError) as error:
|
||||||
|
|
|
@ -2,6 +2,7 @@ import logging
|
||||||
import sys
|
import sys
|
||||||
from argparse import ArgumentParser
|
from argparse import ArgumentParser
|
||||||
|
|
||||||
|
import borgmatic.config.generate
|
||||||
from borgmatic.config import collect, validate
|
from borgmatic.config import collect, validate
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -21,20 +22,24 @@ def parse_arguments(*arguments):
|
||||||
nargs='+',
|
nargs='+',
|
||||||
dest='config_paths',
|
dest='config_paths',
|
||||||
default=config_paths,
|
default=config_paths,
|
||||||
help='Configuration filenames or directories, defaults to: {}'.format(
|
help=f'Configuration filenames or directories, defaults to: {config_paths}',
|
||||||
' '.join(config_paths)
|
)
|
||||||
),
|
parser.add_argument(
|
||||||
|
'-s',
|
||||||
|
'--show',
|
||||||
|
action='store_true',
|
||||||
|
help='Show the validated configuration after all include merging has occurred',
|
||||||
)
|
)
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
return parser.parse_args(arguments)
|
||||||
|
|
||||||
|
|
||||||
def main(): # pragma: no cover
|
def main(): # pragma: no cover
|
||||||
args = parse_arguments(*sys.argv[1:])
|
arguments = parse_arguments(*sys.argv[1:])
|
||||||
|
|
||||||
logging.basicConfig(level=logging.INFO, format='%(message)s')
|
logging.basicConfig(level=logging.INFO, format='%(message)s')
|
||||||
|
|
||||||
config_filenames = tuple(collect.collect_config_filenames(args.config_paths))
|
config_filenames = tuple(collect.collect_config_filenames(arguments.config_paths))
|
||||||
if len(config_filenames) == 0:
|
if len(config_filenames) == 0:
|
||||||
logger.critical('No files to validate found')
|
logger.critical('No files to validate found')
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
@ -42,15 +47,22 @@ def main(): # pragma: no cover
|
||||||
found_issues = False
|
found_issues = False
|
||||||
for config_filename in config_filenames:
|
for config_filename in config_filenames:
|
||||||
try:
|
try:
|
||||||
validate.parse_configuration(config_filename, validate.schema_filename())
|
config, parse_logs = validate.parse_configuration(
|
||||||
|
config_filename, validate.schema_filename()
|
||||||
|
)
|
||||||
except (ValueError, OSError, validate.Validation_error) as error:
|
except (ValueError, OSError, validate.Validation_error) as error:
|
||||||
logging.critical('{}: Error parsing configuration file'.format(config_filename))
|
logging.critical(f'{config_filename}: Error parsing configuration file')
|
||||||
logging.critical(error)
|
logging.critical(error)
|
||||||
found_issues = True
|
found_issues = True
|
||||||
|
else:
|
||||||
|
for log in parse_logs:
|
||||||
|
logger.handle(log)
|
||||||
|
|
||||||
|
if arguments.show:
|
||||||
|
print('---')
|
||||||
|
print(borgmatic.config.generate.render_configuration(config))
|
||||||
|
|
||||||
if found_issues:
|
if found_issues:
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
else:
|
|
||||||
logger.info(
|
logger.info(f"All given configuration files are valid: {', '.join(config_filenames)}")
|
||||||
'All given configuration files are valid: {}'.format(', '.join(config_filenames))
|
|
||||||
)
|
|
||||||
|
|
|
@ -1,20 +1,23 @@
|
||||||
import os
|
import os
|
||||||
|
|
||||||
|
|
||||||
def get_default_config_paths():
|
def get_default_config_paths(expand_home=True):
|
||||||
'''
|
'''
|
||||||
Based on the value of the XDG_CONFIG_HOME and HOME environment variables, return a list of
|
Based on the value of the XDG_CONFIG_HOME and HOME environment variables, return a list of
|
||||||
default configuration paths. This includes both system-wide configuration and configuration in
|
default configuration paths. This includes both system-wide configuration and configuration in
|
||||||
the current user's home directory.
|
the current user's home directory.
|
||||||
|
|
||||||
|
Don't expand the home directory ($HOME) if the expand home flag is False.
|
||||||
'''
|
'''
|
||||||
user_config_directory = os.getenv('XDG_CONFIG_HOME') or os.path.expandvars(
|
user_config_directory = os.getenv('XDG_CONFIG_HOME') or os.path.join('$HOME', '.config')
|
||||||
os.path.join('$HOME', '.config')
|
if expand_home:
|
||||||
)
|
user_config_directory = os.path.expandvars(user_config_directory)
|
||||||
|
|
||||||
return [
|
return [
|
||||||
'/etc/borgmatic/config.yaml',
|
'/etc/borgmatic/config.yaml',
|
||||||
'/etc/borgmatic.d',
|
'/etc/borgmatic.d',
|
||||||
'%s/borgmatic/config.yaml' % user_config_directory,
|
os.path.join(user_config_directory, 'borgmatic/config.yaml'),
|
||||||
|
os.path.join(user_config_directory, 'borgmatic.d'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@ -41,6 +44,9 @@ def collect_config_filenames(config_paths):
|
||||||
yield path
|
yield path
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
if not os.access(path, os.R_OK):
|
||||||
|
continue
|
||||||
|
|
||||||
for filename in sorted(os.listdir(path)):
|
for filename in sorted(os.listdir(path)):
|
||||||
full_filename = os.path.join(path, filename)
|
full_filename = os.path.join(path, filename)
|
||||||
matching_filetype = full_filename.endswith('.yaml') or full_filename.endswith('.yml')
|
matching_filetype = full_filename.endswith('.yaml') or full_filename.endswith('.yml')
|
||||||
|
|
|
@ -17,7 +17,7 @@ def _convert_section(source_section_config, section_schema):
|
||||||
(
|
(
|
||||||
option_name,
|
option_name,
|
||||||
int(option_value)
|
int(option_value)
|
||||||
if section_schema['map'].get(option_name, {}).get('type') == 'int'
|
if section_schema['properties'].get(option_name, {}).get('type') == 'integer'
|
||||||
else option_value,
|
else option_value,
|
||||||
)
|
)
|
||||||
for option_name, option_value in source_section_config.items()
|
for option_name, option_value in source_section_config.items()
|
||||||
|
@ -38,12 +38,12 @@ def convert_legacy_parsed_config(source_config, source_excludes, schema):
|
||||||
'''
|
'''
|
||||||
destination_config = yaml.comments.CommentedMap(
|
destination_config = yaml.comments.CommentedMap(
|
||||||
[
|
[
|
||||||
(section_name, _convert_section(section_config, schema['map'][section_name]))
|
(section_name, _convert_section(section_config, schema['properties'][section_name]))
|
||||||
for section_name, section_config in source_config._asdict().items()
|
for section_name, section_config in source_config._asdict().items()
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
# Split space-seperated values into actual lists, make "repository" into a list, and merge in
|
# Split space-separated values into actual lists, make "repository" into a list, and merge in
|
||||||
# excludes.
|
# excludes.
|
||||||
location = destination_config['location']
|
location = destination_config['location']
|
||||||
location['source_directories'] = source_config.location['source_directories'].split(' ')
|
location['source_directories'] = source_config.location['source_directories'].split(' ')
|
||||||
|
@ -54,11 +54,11 @@ def convert_legacy_parsed_config(source_config, source_excludes, schema):
|
||||||
destination_config['consistency']['checks'] = source_config.consistency['checks'].split(' ')
|
destination_config['consistency']['checks'] = source_config.consistency['checks'].split(' ')
|
||||||
|
|
||||||
# Add comments to each section, and then add comments to the fields in each section.
|
# Add comments to each section, and then add comments to the fields in each section.
|
||||||
generate.add_comments_to_configuration_map(destination_config, schema)
|
generate.add_comments_to_configuration_object(destination_config, schema)
|
||||||
|
|
||||||
for section_name, section_config in destination_config.items():
|
for section_name, section_config in destination_config.items():
|
||||||
generate.add_comments_to_configuration_map(
|
generate.add_comments_to_configuration_object(
|
||||||
section_config, schema['map'][section_name], indent=generate.INDENT
|
section_config, schema['properties'][section_name], indent=generate.INDENT
|
||||||
)
|
)
|
||||||
|
|
||||||
return destination_config
|
return destination_config
|
||||||
|
|
45
borgmatic/config/environment.py
Normal file
45
borgmatic/config/environment.py
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
|
_VARIABLE_PATTERN = re.compile(
|
||||||
|
r'(?P<escape>\\)?(?P<variable>\$\{(?P<name>[A-Za-z0-9_]+)((:?-)(?P<default>[^}]+))?\})'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_string(matcher):
|
||||||
|
'''
|
||||||
|
Get the value from environment given a matcher containing a name and an optional default value.
|
||||||
|
If the variable is not defined in environment and no default value is provided, an Error is raised.
|
||||||
|
'''
|
||||||
|
if matcher.group('escape') is not None:
|
||||||
|
# in case of escaped envvar, unescape it
|
||||||
|
return matcher.group('variable')
|
||||||
|
|
||||||
|
# resolve the env var
|
||||||
|
name, default = matcher.group('name'), matcher.group('default')
|
||||||
|
out = os.getenv(name, default=default)
|
||||||
|
|
||||||
|
if out is None:
|
||||||
|
raise ValueError(f'Cannot find variable {name} in environment')
|
||||||
|
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_env_variables(item):
|
||||||
|
'''
|
||||||
|
Resolves variables like or ${FOO} from given configuration with values from process environment
|
||||||
|
Supported formats:
|
||||||
|
- ${FOO} will return FOO env variable
|
||||||
|
- ${FOO-bar} or ${FOO:-bar} will return FOO env variable if it exists, else "bar"
|
||||||
|
|
||||||
|
If any variable is missing in environment and no default value is provided, an Error is raised.
|
||||||
|
'''
|
||||||
|
if isinstance(item, str):
|
||||||
|
return _VARIABLE_PATTERN.sub(_resolve_string, item)
|
||||||
|
if isinstance(item, list):
|
||||||
|
for i, subitem in enumerate(item):
|
||||||
|
item[i] = resolve_env_variables(subitem)
|
||||||
|
if isinstance(item, dict):
|
||||||
|
for key, value in item.items():
|
||||||
|
item[key] = resolve_env_variables(value)
|
||||||
|
return item
|
|
@ -5,7 +5,7 @@ import re
|
||||||
|
|
||||||
from ruamel import yaml
|
from ruamel import yaml
|
||||||
|
|
||||||
from borgmatic.config import load
|
from borgmatic.config import load, normalize
|
||||||
|
|
||||||
INDENT = 4
|
INDENT = 4
|
||||||
SEQUENCE_INDENT = 2
|
SEQUENCE_INDENT = 2
|
||||||
|
@ -24,35 +24,31 @@ def _insert_newline_before_comment(config, field_name):
|
||||||
def _schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
def _schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
||||||
'''
|
'''
|
||||||
Given a loaded configuration schema, generate and return sample config for it. Include comments
|
Given a loaded configuration schema, generate and return sample config for it. Include comments
|
||||||
for each section based on the schema "desc" description.
|
for each section based on the schema "description".
|
||||||
'''
|
'''
|
||||||
|
schema_type = schema.get('type')
|
||||||
example = schema.get('example')
|
example = schema.get('example')
|
||||||
if example is not None:
|
if example is not None:
|
||||||
return example
|
return example
|
||||||
|
|
||||||
if 'seq' in schema:
|
if schema_type == 'array':
|
||||||
config = yaml.comments.CommentedSeq(
|
config = yaml.comments.CommentedSeq(
|
||||||
[
|
[_schema_to_sample_configuration(schema['items'], level, parent_is_sequence=True)]
|
||||||
_schema_to_sample_configuration(item_schema, level, parent_is_sequence=True)
|
|
||||||
for item_schema in schema['seq']
|
|
||||||
]
|
|
||||||
)
|
)
|
||||||
add_comments_to_configuration_sequence(
|
add_comments_to_configuration_sequence(config, schema, indent=(level * INDENT))
|
||||||
config, schema, indent=(level * INDENT) + SEQUENCE_INDENT
|
elif schema_type == 'object':
|
||||||
)
|
|
||||||
elif 'map' in schema:
|
|
||||||
config = yaml.comments.CommentedMap(
|
config = yaml.comments.CommentedMap(
|
||||||
[
|
[
|
||||||
(field_name, _schema_to_sample_configuration(sub_schema, level + 1))
|
(field_name, _schema_to_sample_configuration(sub_schema, level + 1))
|
||||||
for field_name, sub_schema in schema['map'].items()
|
for field_name, sub_schema in schema['properties'].items()
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
indent = (level * INDENT) + (SEQUENCE_INDENT if parent_is_sequence else 0)
|
indent = (level * INDENT) + (SEQUENCE_INDENT if parent_is_sequence else 0)
|
||||||
add_comments_to_configuration_map(
|
add_comments_to_configuration_object(
|
||||||
config, schema, indent=indent, skip_first=parent_is_sequence
|
config, schema, indent=indent, skip_first=parent_is_sequence
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
raise ValueError('Schema at level {} is unsupported: {}'.format(level, schema))
|
raise ValueError(f'Schema at level {level} is unsupported: {schema}')
|
||||||
|
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
@ -86,9 +82,9 @@ def _comment_out_optional_configuration(rendered_config):
|
||||||
optional = False
|
optional = False
|
||||||
|
|
||||||
for line in rendered_config.split('\n'):
|
for line in rendered_config.split('\n'):
|
||||||
# Upon encountering an optional configuration option, commenting out lines until the next
|
# Upon encountering an optional configuration option, comment out lines until the next blank
|
||||||
# blank line.
|
# line.
|
||||||
if line.strip().startswith('# {}'.format(COMMENTED_OUT_SENTINEL)):
|
if line.strip().startswith(f'# {COMMENTED_OUT_SENTINEL}'):
|
||||||
optional = True
|
optional = True
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
@ -101,7 +97,7 @@ def _comment_out_optional_configuration(rendered_config):
|
||||||
return '\n'.join(lines)
|
return '\n'.join(lines)
|
||||||
|
|
||||||
|
|
||||||
def _render_configuration(config):
|
def render_configuration(config):
|
||||||
'''
|
'''
|
||||||
Given a config data structure of nested OrderedDicts, render the config as YAML and return it.
|
Given a config data structure of nested OrderedDicts, render the config as YAML and return it.
|
||||||
'''
|
'''
|
||||||
|
@ -113,13 +109,16 @@ def _render_configuration(config):
|
||||||
return rendered.getvalue()
|
return rendered.getvalue()
|
||||||
|
|
||||||
|
|
||||||
def write_configuration(config_filename, rendered_config, mode=0o600):
|
def write_configuration(config_filename, rendered_config, mode=0o600, overwrite=False):
|
||||||
'''
|
'''
|
||||||
Given a target config filename and rendered config YAML, write it out to file. Create any
|
Given a target config filename and rendered config YAML, write it out to file. Create any
|
||||||
containing directories as needed.
|
containing directories as needed. But if the file already exists and overwrite is False,
|
||||||
|
abort before writing anything.
|
||||||
'''
|
'''
|
||||||
if os.path.exists(config_filename):
|
if not overwrite and os.path.exists(config_filename):
|
||||||
raise FileExistsError('{} already exists. Aborting.'.format(config_filename))
|
raise FileExistsError(
|
||||||
|
f'{config_filename} already exists. Aborting. Use --overwrite to replace the file.'
|
||||||
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
os.makedirs(os.path.dirname(config_filename), mode=0o700)
|
os.makedirs(os.path.dirname(config_filename), mode=0o700)
|
||||||
|
@ -134,26 +133,26 @@ def write_configuration(config_filename, rendered_config, mode=0o600):
|
||||||
|
|
||||||
def add_comments_to_configuration_sequence(config, schema, indent=0):
|
def add_comments_to_configuration_sequence(config, schema, indent=0):
|
||||||
'''
|
'''
|
||||||
If the given config sequence's items are maps, then mine the schema for the description of the
|
If the given config sequence's items are object, then mine the schema for the description of the
|
||||||
map's first item, and slap that atop the sequence. Indent the comment the given number of
|
object's first item, and slap that atop the sequence. Indent the comment the given number of
|
||||||
characters.
|
characters.
|
||||||
|
|
||||||
Doing this for sequences of maps results in nice comments that look like:
|
Doing this for sequences of maps results in nice comments that look like:
|
||||||
|
|
||||||
```
|
```
|
||||||
things:
|
things:
|
||||||
# First key description. Added by this function.
|
# First key description. Added by this function.
|
||||||
- key: foo
|
- key: foo
|
||||||
# Second key description. Added by add_comments_to_configuration_map().
|
# Second key description. Added by add_comments_to_configuration_object().
|
||||||
other: bar
|
other: bar
|
||||||
```
|
```
|
||||||
'''
|
'''
|
||||||
if 'map' not in schema['seq'][0]:
|
if schema['items'].get('type') != 'object':
|
||||||
return
|
return
|
||||||
|
|
||||||
for field_name in config[0].keys():
|
for field_name in config[0].keys():
|
||||||
field_schema = schema['seq'][0]['map'].get(field_name, {})
|
field_schema = schema['items']['properties'].get(field_name, {})
|
||||||
description = field_schema.get('desc')
|
description = field_schema.get('description')
|
||||||
|
|
||||||
# No description to use? Skip it.
|
# No description to use? Skip it.
|
||||||
if not field_schema or not description:
|
if not field_schema or not description:
|
||||||
|
@ -162,7 +161,7 @@ def add_comments_to_configuration_sequence(config, schema, indent=0):
|
||||||
config[0].yaml_set_start_comment(description, indent=indent)
|
config[0].yaml_set_start_comment(description, indent=indent)
|
||||||
|
|
||||||
# We only want the first key's description here, as the rest of the keys get commented by
|
# We only want the first key's description here, as the rest of the keys get commented by
|
||||||
# add_comments_to_configuration_map().
|
# add_comments_to_configuration_object().
|
||||||
return
|
return
|
||||||
|
|
||||||
|
|
||||||
|
@ -171,7 +170,7 @@ REQUIRED_KEYS = {'source_directories', 'repositories', 'keep_daily'}
|
||||||
COMMENTED_OUT_SENTINEL = 'COMMENT_OUT'
|
COMMENTED_OUT_SENTINEL = 'COMMENT_OUT'
|
||||||
|
|
||||||
|
|
||||||
def add_comments_to_configuration_map(config, schema, indent=0, skip_first=False):
|
def add_comments_to_configuration_object(config, schema, indent=0, skip_first=False):
|
||||||
'''
|
'''
|
||||||
Using descriptions from a schema as a source, add those descriptions as comments to the given
|
Using descriptions from a schema as a source, add those descriptions as comments to the given
|
||||||
config mapping, before each field. Indent the comment the given number of characters.
|
config mapping, before each field. Indent the comment the given number of characters.
|
||||||
|
@ -180,8 +179,8 @@ def add_comments_to_configuration_map(config, schema, indent=0, skip_first=False
|
||||||
if skip_first and index == 0:
|
if skip_first and index == 0:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
field_schema = schema['map'].get(field_name, {})
|
field_schema = schema['properties'].get(field_name, {})
|
||||||
description = field_schema.get('desc', '').strip()
|
description = field_schema.get('description', '').strip()
|
||||||
|
|
||||||
# If this is an optional key, add an indicator to the comment flagging it to be commented
|
# If this is an optional key, add an indicator to the comment flagging it to be commented
|
||||||
# out from the sample configuration. This sentinel is consumed by downstream processing that
|
# out from the sample configuration. This sentinel is consumed by downstream processing that
|
||||||
|
@ -217,7 +216,7 @@ def remove_commented_out_sentinel(config, field_name):
|
||||||
except KeyError:
|
except KeyError:
|
||||||
return
|
return
|
||||||
|
|
||||||
if last_comment_value == '# {}\n'.format(COMMENTED_OUT_SENTINEL):
|
if last_comment_value == f'# {COMMENTED_OUT_SENTINEL}\n':
|
||||||
config.ca.items[field_name][RUAMEL_YAML_COMMENTS_INDEX].pop()
|
config.ca.items[field_name][RUAMEL_YAML_COMMENTS_INDEX].pop()
|
||||||
|
|
||||||
|
|
||||||
|
@ -267,18 +266,22 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
return destination_config
|
return destination_config
|
||||||
|
|
||||||
|
|
||||||
def generate_sample_configuration(source_filename, destination_filename, schema_filename):
|
def generate_sample_configuration(
|
||||||
|
source_filename, destination_filename, schema_filename, overwrite=False
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given an optional source configuration filename, and a required destination configuration
|
Given an optional source configuration filename, and a required destination configuration
|
||||||
filename, and the path to a schema filename in pykwalify YAML schema format, write out a
|
filename, the path to a schema filename in a YAML rendition of the JSON Schema format, and
|
||||||
sample configuration file based on that schema. If a source filename is provided, merge the
|
whether to overwrite a destination file, write out a sample configuration file based on that
|
||||||
parsed contents of that configuration into the generated configuration.
|
schema. If a source filename is provided, merge the parsed contents of that configuration into
|
||||||
|
the generated configuration.
|
||||||
'''
|
'''
|
||||||
schema = yaml.round_trip_load(open(schema_filename))
|
schema = yaml.round_trip_load(open(schema_filename))
|
||||||
source_config = None
|
source_config = None
|
||||||
|
|
||||||
if source_filename:
|
if source_filename:
|
||||||
source_config = load.load_configuration(source_filename)
|
source_config = load.load_configuration(source_filename)
|
||||||
|
normalize.normalize(source_filename, source_config)
|
||||||
|
|
||||||
destination_config = merge_source_configuration_into_destination(
|
destination_config = merge_source_configuration_into_destination(
|
||||||
_schema_to_sample_configuration(schema), source_config
|
_schema_to_sample_configuration(schema), source_config
|
||||||
|
@ -286,5 +289,6 @@ def generate_sample_configuration(source_filename, destination_filename, schema_
|
||||||
|
|
||||||
write_configuration(
|
write_configuration(
|
||||||
destination_filename,
|
destination_filename,
|
||||||
_comment_out_optional_configuration(_render_configuration(destination_config)),
|
_comment_out_optional_configuration(render_configuration(destination_config)),
|
||||||
|
overwrite=overwrite,
|
||||||
)
|
)
|
||||||
|
|
|
@ -70,13 +70,11 @@ def validate_configuration_format(parser, config_format):
|
||||||
section_format.name for section_format in config_format
|
section_format.name for section_format in config_format
|
||||||
)
|
)
|
||||||
if unknown_section_names:
|
if unknown_section_names:
|
||||||
raise ValueError(
|
raise ValueError(f"Unknown config sections found: {', '.join(unknown_section_names)}")
|
||||||
'Unknown config sections found: {}'.format(', '.join(unknown_section_names))
|
|
||||||
)
|
|
||||||
|
|
||||||
missing_section_names = set(required_section_names) - section_names
|
missing_section_names = set(required_section_names) - section_names
|
||||||
if missing_section_names:
|
if missing_section_names:
|
||||||
raise ValueError('Missing config sections: {}'.format(', '.join(missing_section_names)))
|
raise ValueError(f"Missing config sections: {', '.join(missing_section_names)}")
|
||||||
|
|
||||||
for section_format in config_format:
|
for section_format in config_format:
|
||||||
if section_format.name not in section_names:
|
if section_format.name not in section_names:
|
||||||
|
@ -91,9 +89,7 @@ def validate_configuration_format(parser, config_format):
|
||||||
|
|
||||||
if unexpected_option_names:
|
if unexpected_option_names:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
'Unexpected options found in config section {}: {}'.format(
|
f"Unexpected options found in config section {section_format.name}: {', '.join(sorted(unexpected_option_names))}",
|
||||||
section_format.name, ', '.join(sorted(unexpected_option_names))
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
missing_option_names = tuple(
|
missing_option_names = tuple(
|
||||||
|
@ -105,9 +101,7 @@ def validate_configuration_format(parser, config_format):
|
||||||
|
|
||||||
if missing_option_names:
|
if missing_option_names:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
'Required options missing from config section {}: {}'.format(
|
f"Required options missing from config section {section_format.name}: {', '.join(missing_option_names)}",
|
||||||
section_format.name, ', '.join(missing_option_names)
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -137,7 +131,7 @@ def parse_configuration(config_filename, config_format):
|
||||||
'''
|
'''
|
||||||
parser = RawConfigParser()
|
parser = RawConfigParser()
|
||||||
if not parser.read(config_filename):
|
if not parser.read(config_filename):
|
||||||
raise ValueError('Configuration file cannot be opened: {}'.format(config_filename))
|
raise ValueError(f'Configuration file cannot be opened: {config_filename}')
|
||||||
|
|
||||||
validate_configuration_format(parser, config_format)
|
validate_configuration_format(parser, config_format)
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
import functools
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
|
||||||
|
@ -6,26 +8,52 @@ import ruamel.yaml
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def load_configuration(filename):
|
def include_configuration(loader, filename_node, include_directory):
|
||||||
'''
|
'''
|
||||||
Load the given configuration file and return its contents as a data structure of nested dicts
|
Given a ruamel.yaml.loader.Loader, a ruamel.yaml.serializer.ScalarNode containing the included
|
||||||
and lists.
|
filename, and an include directory path to search for matching files, load the given YAML
|
||||||
|
filename (ignoring the given loader so we can use our own) and return its contents as a data
|
||||||
|
structure of nested dicts and lists. If the filename is relative, probe for it within 1. the
|
||||||
|
current working directory and 2. the given include directory.
|
||||||
|
|
||||||
Raise ruamel.yaml.error.YAMLError if something goes wrong parsing the YAML, or RecursionError
|
Raise FileNotFoundError if an included file was not found.
|
||||||
if there are too many recursive includes.
|
|
||||||
'''
|
'''
|
||||||
yaml = ruamel.yaml.YAML(typ='safe')
|
include_directories = [os.getcwd(), os.path.abspath(include_directory)]
|
||||||
yaml.Constructor = Include_constructor
|
include_filename = os.path.expanduser(filename_node.value)
|
||||||
|
|
||||||
return yaml.load(open(filename))
|
if not os.path.isabs(include_filename):
|
||||||
|
candidate_filenames = [
|
||||||
|
os.path.join(directory, include_filename) for directory in include_directories
|
||||||
|
]
|
||||||
|
|
||||||
|
for candidate_filename in candidate_filenames:
|
||||||
|
if os.path.exists(candidate_filename):
|
||||||
|
include_filename = candidate_filename
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
raise FileNotFoundError(
|
||||||
|
f'Could not find include {filename_node.value} at {" or ".join(candidate_filenames)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
return load_configuration(include_filename)
|
||||||
|
|
||||||
|
|
||||||
def include_configuration(loader, filename_node):
|
def retain_node_error(loader, node):
|
||||||
'''
|
'''
|
||||||
Load the given YAML filename (ignoring the given loader so we can use our own), and return its
|
Given a ruamel.yaml.loader.Loader and a YAML node, raise an error.
|
||||||
contents as a data structure of nested dicts and lists.
|
|
||||||
|
Raise ValueError if a mapping or sequence node is given, as that indicates that "!retain" was
|
||||||
|
used in a configuration file without a merge. In configuration files with a merge, mapping and
|
||||||
|
sequence nodes with "!retain" tags are handled by deep_merge_nodes() below.
|
||||||
|
|
||||||
|
Also raise ValueError if a scalar node is given, as "!retain" is not supported on scalar nodes.
|
||||||
'''
|
'''
|
||||||
return load_configuration(os.path.expanduser(filename_node.value))
|
if isinstance(node, (ruamel.yaml.nodes.MappingNode, ruamel.yaml.nodes.SequenceNode)):
|
||||||
|
raise ValueError(
|
||||||
|
'The !retain tag may only be used within a configuration file containing a merged !include tag.'
|
||||||
|
)
|
||||||
|
|
||||||
|
raise ValueError('The !retain tag may only be used on a YAML mapping or sequence.')
|
||||||
|
|
||||||
|
|
||||||
class Include_constructor(ruamel.yaml.SafeConstructor):
|
class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
|
@ -34,20 +62,29 @@ class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
separate YAML configuration files. Example syntax: `retention: !include common.yaml`
|
separate YAML configuration files. Example syntax: `retention: !include common.yaml`
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def __init__(self, preserve_quotes=None, loader=None):
|
def __init__(self, preserve_quotes=None, loader=None, include_directory=None):
|
||||||
super(Include_constructor, self).__init__(preserve_quotes, loader)
|
super(Include_constructor, self).__init__(preserve_quotes, loader)
|
||||||
self.add_constructor('!include', include_configuration)
|
self.add_constructor(
|
||||||
|
'!include',
|
||||||
|
functools.partial(include_configuration, include_directory=include_directory),
|
||||||
|
)
|
||||||
|
self.add_constructor('!retain', retain_node_error)
|
||||||
|
|
||||||
def flatten_mapping(self, node):
|
def flatten_mapping(self, node):
|
||||||
'''
|
'''
|
||||||
Support the special case of shallow merging included configuration into an existing mapping
|
Support the special case of deep merging included configuration into an existing mapping
|
||||||
using the YAML '<<' merge key. Example syntax:
|
using the YAML '<<' merge key. Example syntax:
|
||||||
|
|
||||||
```
|
```
|
||||||
retention:
|
retention:
|
||||||
keep_daily: 1
|
keep_daily: 1
|
||||||
<<: !include common.yaml
|
|
||||||
|
<<: !include common.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
These includes are deep merged into the current configuration file. For instance, in this
|
||||||
|
example, any "retention" options in common.yaml will get merged into the "retention" section
|
||||||
|
in the example configuration file.
|
||||||
'''
|
'''
|
||||||
representer = ruamel.yaml.representer.SafeRepresenter()
|
representer = ruamel.yaml.representer.SafeRepresenter()
|
||||||
|
|
||||||
|
@ -57,3 +94,168 @@ class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
node.value[index] = (key_node, included_value)
|
node.value[index] = (key_node, included_value)
|
||||||
|
|
||||||
super(Include_constructor, self).flatten_mapping(node)
|
super(Include_constructor, self).flatten_mapping(node)
|
||||||
|
|
||||||
|
node.value = deep_merge_nodes(node.value)
|
||||||
|
|
||||||
|
|
||||||
|
def load_configuration(filename):
|
||||||
|
'''
|
||||||
|
Load the given configuration file and return its contents as a data structure of nested dicts
|
||||||
|
and lists. Also, replace any "{constant}" strings with the value of the "constant" key in the
|
||||||
|
"constants" section of the configuration file.
|
||||||
|
|
||||||
|
Raise ruamel.yaml.error.YAMLError if something goes wrong parsing the YAML, or RecursionError
|
||||||
|
if there are too many recursive includes.
|
||||||
|
'''
|
||||||
|
# Use an embedded derived class for the include constructor so as to capture the filename
|
||||||
|
# value. (functools.partial doesn't work for this use case because yaml.Constructor has to be
|
||||||
|
# an actual class.)
|
||||||
|
class Include_constructor_with_include_directory(Include_constructor):
|
||||||
|
def __init__(self, preserve_quotes=None, loader=None):
|
||||||
|
super(Include_constructor_with_include_directory, self).__init__(
|
||||||
|
preserve_quotes, loader, include_directory=os.path.dirname(filename)
|
||||||
|
)
|
||||||
|
|
||||||
|
yaml = ruamel.yaml.YAML(typ='safe')
|
||||||
|
yaml.Constructor = Include_constructor_with_include_directory
|
||||||
|
|
||||||
|
with open(filename) as file:
|
||||||
|
file_contents = file.read()
|
||||||
|
config = yaml.load(file_contents)
|
||||||
|
|
||||||
|
if config and 'constants' in config:
|
||||||
|
for key, value in config['constants'].items():
|
||||||
|
value = json.dumps(value)
|
||||||
|
file_contents = file_contents.replace(f'{{{key}}}', value.strip('"'))
|
||||||
|
|
||||||
|
config = yaml.load(file_contents)
|
||||||
|
del config['constants']
|
||||||
|
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
DELETED_NODE = object()
|
||||||
|
|
||||||
|
|
||||||
|
def deep_merge_nodes(nodes):
|
||||||
|
'''
|
||||||
|
Given a nested borgmatic configuration data structure as a list of tuples in the form of:
|
||||||
|
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode as a key,
|
||||||
|
ruamel.yaml.nodes.MappingNode or other Node as a value,
|
||||||
|
),
|
||||||
|
|
||||||
|
... deep merge any node values corresponding to duplicate keys and return the result. If
|
||||||
|
there are colliding keys with non-MappingNode values (e.g., integers or strings), the last
|
||||||
|
of the values wins.
|
||||||
|
|
||||||
|
For instance, given node values of:
|
||||||
|
|
||||||
|
[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_hourly'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='24')
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='7')
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
... the returned result would be:
|
||||||
|
|
||||||
|
[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_hourly'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='24')
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
If a mapping or sequence node has a YAML "!retain" tag, then that node is not merged.
|
||||||
|
|
||||||
|
The purpose of deep merging like this is to support, for instance, merging one borgmatic
|
||||||
|
configuration file into another for reuse, such that a configuration section ("retention",
|
||||||
|
etc.) does not completely replace the corresponding section in a merged file.
|
||||||
|
'''
|
||||||
|
# Map from original node key/value to the replacement merged node. DELETED_NODE as a replacement
|
||||||
|
# node indications deletion.
|
||||||
|
replaced_nodes = {}
|
||||||
|
|
||||||
|
# To find nodes that require merging, compare each node with each other node.
|
||||||
|
for a_key, a_value in nodes:
|
||||||
|
for b_key, b_value in nodes:
|
||||||
|
# If we've already considered one of the nodes for merging, skip it.
|
||||||
|
if (a_key, a_value) in replaced_nodes or (b_key, b_value) in replaced_nodes:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# If the keys match and the values are different, we need to merge these two A and B nodes.
|
||||||
|
if a_key.tag == b_key.tag and a_key.value == b_key.value and a_value != b_value:
|
||||||
|
# Since we're merging into the B node, consider the A node a duplicate and remove it.
|
||||||
|
replaced_nodes[(a_key, a_value)] = DELETED_NODE
|
||||||
|
|
||||||
|
# If we're dealing with MappingNodes, recurse and merge its values as well.
|
||||||
|
if isinstance(b_value, ruamel.yaml.nodes.MappingNode):
|
||||||
|
# A "!retain" tag says to skip deep merging for this node. Replace the tag so
|
||||||
|
# downstream schema validation doesn't break on our application-specific tag.
|
||||||
|
if b_value.tag == '!retain':
|
||||||
|
b_value.tag = 'tag:yaml.org,2002:map'
|
||||||
|
else:
|
||||||
|
replaced_nodes[(b_key, b_value)] = (
|
||||||
|
b_key,
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag=b_value.tag,
|
||||||
|
value=deep_merge_nodes(a_value.value + b_value.value),
|
||||||
|
start_mark=b_value.start_mark,
|
||||||
|
end_mark=b_value.end_mark,
|
||||||
|
flow_style=b_value.flow_style,
|
||||||
|
comment=b_value.comment,
|
||||||
|
anchor=b_value.anchor,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
# If we're dealing with SequenceNodes, merge by appending one sequence to the other.
|
||||||
|
elif isinstance(b_value, ruamel.yaml.nodes.SequenceNode):
|
||||||
|
# A "!retain" tag says to skip deep merging for this node. Replace the tag so
|
||||||
|
# downstream schema validation doesn't break on our application-specific tag.
|
||||||
|
if b_value.tag == '!retain':
|
||||||
|
b_value.tag = 'tag:yaml.org,2002:seq'
|
||||||
|
else:
|
||||||
|
replaced_nodes[(b_key, b_value)] = (
|
||||||
|
b_key,
|
||||||
|
ruamel.yaml.nodes.SequenceNode(
|
||||||
|
tag=b_value.tag,
|
||||||
|
value=a_value.value + b_value.value,
|
||||||
|
start_mark=b_value.start_mark,
|
||||||
|
end_mark=b_value.end_mark,
|
||||||
|
flow_style=b_value.flow_style,
|
||||||
|
comment=b_value.comment,
|
||||||
|
anchor=b_value.anchor,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
return [
|
||||||
|
replaced_nodes.get(node, node) for node in nodes if replaced_nodes.get(node) != DELETED_NODE
|
||||||
|
]
|
||||||
|
|
105
borgmatic/config/normalize.py
Normal file
105
borgmatic/config/normalize.py
Normal file
|
@ -0,0 +1,105 @@
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
|
||||||
|
def normalize(config_filename, config):
|
||||||
|
'''
|
||||||
|
Given a configuration filename and a configuration dict of its loaded contents, apply particular
|
||||||
|
hard-coded rules to normalize the configuration to adhere to the current schema. Return any log
|
||||||
|
message warnings produced based on the normalization performed.
|
||||||
|
'''
|
||||||
|
logs = []
|
||||||
|
location = config.get('location') or {}
|
||||||
|
storage = config.get('storage') or {}
|
||||||
|
consistency = config.get('consistency') or {}
|
||||||
|
hooks = config.get('hooks') or {}
|
||||||
|
|
||||||
|
# Upgrade exclude_if_present from a string to a list.
|
||||||
|
exclude_if_present = location.get('exclude_if_present')
|
||||||
|
if isinstance(exclude_if_present, str):
|
||||||
|
config['location']['exclude_if_present'] = [exclude_if_present]
|
||||||
|
|
||||||
|
# Upgrade various monitoring hooks from a string to a dict.
|
||||||
|
healthchecks = hooks.get('healthchecks')
|
||||||
|
if isinstance(healthchecks, str):
|
||||||
|
config['hooks']['healthchecks'] = {'ping_url': healthchecks}
|
||||||
|
|
||||||
|
cronitor = hooks.get('cronitor')
|
||||||
|
if isinstance(cronitor, str):
|
||||||
|
config['hooks']['cronitor'] = {'ping_url': cronitor}
|
||||||
|
|
||||||
|
pagerduty = hooks.get('pagerduty')
|
||||||
|
if isinstance(pagerduty, str):
|
||||||
|
config['hooks']['pagerduty'] = {'integration_key': pagerduty}
|
||||||
|
|
||||||
|
cronhub = hooks.get('cronhub')
|
||||||
|
if isinstance(cronhub, str):
|
||||||
|
config['hooks']['cronhub'] = {'ping_url': cronhub}
|
||||||
|
|
||||||
|
# Upgrade consistency checks from a list of strings to a list of dicts.
|
||||||
|
checks = consistency.get('checks')
|
||||||
|
if isinstance(checks, list) and len(checks) and isinstance(checks[0], str):
|
||||||
|
config['consistency']['checks'] = [{'name': check_type} for check_type in checks]
|
||||||
|
|
||||||
|
# Rename various configuration options.
|
||||||
|
numeric_owner = location.pop('numeric_owner', None)
|
||||||
|
if numeric_owner is not None:
|
||||||
|
config['location']['numeric_ids'] = numeric_owner
|
||||||
|
|
||||||
|
bsd_flags = location.pop('bsd_flags', None)
|
||||||
|
if bsd_flags is not None:
|
||||||
|
config['location']['flags'] = bsd_flags
|
||||||
|
|
||||||
|
remote_rate_limit = storage.pop('remote_rate_limit', None)
|
||||||
|
if remote_rate_limit is not None:
|
||||||
|
config['storage']['upload_rate_limit'] = remote_rate_limit
|
||||||
|
|
||||||
|
# Upgrade remote repositories to ssh:// syntax, required in Borg 2.
|
||||||
|
repositories = location.get('repositories')
|
||||||
|
if repositories:
|
||||||
|
if isinstance(repositories[0], str):
|
||||||
|
config['location']['repositories'] = [
|
||||||
|
{'path': repository} for repository in repositories
|
||||||
|
]
|
||||||
|
repositories = config['location']['repositories']
|
||||||
|
config['location']['repositories'] = []
|
||||||
|
for repository_dict in repositories:
|
||||||
|
repository_path = repository_dict['path']
|
||||||
|
if '~' in repository_path:
|
||||||
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: Repository paths containing "~" are deprecated in borgmatic and no longer work in Borg 2.x+.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if ':' in repository_path:
|
||||||
|
if repository_path.startswith('file://'):
|
||||||
|
updated_repository_path = os.path.abspath(
|
||||||
|
repository_path.partition('file://')[-1]
|
||||||
|
)
|
||||||
|
config['location']['repositories'].append(
|
||||||
|
dict(repository_dict, path=updated_repository_path,)
|
||||||
|
)
|
||||||
|
elif repository_path.startswith('ssh://'):
|
||||||
|
config['location']['repositories'].append(repository_dict)
|
||||||
|
else:
|
||||||
|
rewritten_repository_path = f"ssh://{repository_path.replace(':~', '/~').replace(':/', '/').replace(':', '/./')}"
|
||||||
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: Remote repository paths without ssh:// syntax are deprecated. Interpreting "{repository_path}" as "{rewritten_repository_path}"',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['location']['repositories'].append(
|
||||||
|
dict(repository_dict, path=rewritten_repository_path,)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
config['location']['repositories'].append(repository_dict)
|
||||||
|
|
||||||
|
return logs
|
79
borgmatic/config/override.py
Normal file
79
borgmatic/config/override.py
Normal file
|
@ -0,0 +1,79 @@
|
||||||
|
import io
|
||||||
|
|
||||||
|
import ruamel.yaml
|
||||||
|
|
||||||
|
|
||||||
|
def set_values(config, keys, value):
|
||||||
|
'''
|
||||||
|
Given a hierarchy of configuration dicts, a sequence of parsed key strings, and a string value,
|
||||||
|
descend into the hierarchy based on the keys to set the value into the right place.
|
||||||
|
'''
|
||||||
|
if not keys:
|
||||||
|
return
|
||||||
|
|
||||||
|
first_key = keys[0]
|
||||||
|
if len(keys) == 1:
|
||||||
|
config[first_key] = value
|
||||||
|
return
|
||||||
|
|
||||||
|
if first_key not in config:
|
||||||
|
config[first_key] = {}
|
||||||
|
|
||||||
|
set_values(config[first_key], keys[1:], value)
|
||||||
|
|
||||||
|
|
||||||
|
def convert_value_type(value):
|
||||||
|
'''
|
||||||
|
Given a string value, determine its logical type (string, boolean, integer, etc.), and return it
|
||||||
|
converted to that type.
|
||||||
|
|
||||||
|
Raise ruamel.yaml.error.YAMLError if there's a parse issue with the YAML.
|
||||||
|
'''
|
||||||
|
return ruamel.yaml.YAML(typ='safe').load(io.StringIO(value))
|
||||||
|
|
||||||
|
|
||||||
|
def parse_overrides(raw_overrides):
|
||||||
|
'''
|
||||||
|
Given a sequence of configuration file override strings in the form of "section.option=value",
|
||||||
|
parse and return a sequence of tuples (keys, values), where keys is a sequence of strings. For
|
||||||
|
instance, given the following raw overrides:
|
||||||
|
|
||||||
|
['section.my_option=value1', 'section.other_option=value2']
|
||||||
|
|
||||||
|
... return this:
|
||||||
|
|
||||||
|
(
|
||||||
|
(('section', 'my_option'), 'value1'),
|
||||||
|
(('section', 'other_option'), 'value2'),
|
||||||
|
)
|
||||||
|
|
||||||
|
Raise ValueError if an override can't be parsed.
|
||||||
|
'''
|
||||||
|
if not raw_overrides:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
parsed_overrides = []
|
||||||
|
|
||||||
|
for raw_override in raw_overrides:
|
||||||
|
try:
|
||||||
|
raw_keys, value = raw_override.split('=', 1)
|
||||||
|
parsed_overrides.append((tuple(raw_keys.split('.')), convert_value_type(value),))
|
||||||
|
except ValueError:
|
||||||
|
raise ValueError(
|
||||||
|
f"Invalid override '{raw_override}'. Make sure you use the form: SECTION.OPTION=VALUE"
|
||||||
|
)
|
||||||
|
except ruamel.yaml.error.YAMLError as error:
|
||||||
|
raise ValueError(f"Invalid override '{raw_override}': {error.problem}")
|
||||||
|
|
||||||
|
return tuple(parsed_overrides)
|
||||||
|
|
||||||
|
|
||||||
|
def apply_overrides(config, raw_overrides):
|
||||||
|
'''
|
||||||
|
Given a configuration dict and a sequence of configuration file override strings in the form of
|
||||||
|
"section.option=value", parse each override and set it the configuration dict.
|
||||||
|
'''
|
||||||
|
overrides = parse_overrides(raw_overrides)
|
||||||
|
|
||||||
|
for (keys, value) in overrides:
|
||||||
|
set_values(config, keys, value)
|
File diff suppressed because it is too large
Load Diff
|
@ -1,11 +1,10 @@
|
||||||
import logging
|
import os
|
||||||
|
|
||||||
|
import jsonschema
|
||||||
import pkg_resources
|
import pkg_resources
|
||||||
import pykwalify.core
|
|
||||||
import pykwalify.errors
|
|
||||||
import ruamel.yaml
|
import ruamel.yaml
|
||||||
|
|
||||||
from borgmatic.config import load
|
from borgmatic.config import environment, load, normalize, override
|
||||||
|
|
||||||
|
|
||||||
def schema_filename():
|
def schema_filename():
|
||||||
|
@ -16,23 +15,49 @@ def schema_filename():
|
||||||
return pkg_resources.resource_filename('borgmatic', 'config/schema.yaml')
|
return pkg_resources.resource_filename('borgmatic', 'config/schema.yaml')
|
||||||
|
|
||||||
|
|
||||||
|
def format_json_error_path_element(path_element):
|
||||||
|
'''
|
||||||
|
Given a path element into a JSON data structure, format it for display as a string.
|
||||||
|
'''
|
||||||
|
if isinstance(path_element, int):
|
||||||
|
return str(f'[{path_element}]')
|
||||||
|
|
||||||
|
return str(f'.{path_element}')
|
||||||
|
|
||||||
|
|
||||||
|
def format_json_error(error):
|
||||||
|
'''
|
||||||
|
Given an instance of jsonschema.exceptions.ValidationError, format it for display as a string.
|
||||||
|
'''
|
||||||
|
if not error.path:
|
||||||
|
return f'At the top level: {error.message}'
|
||||||
|
|
||||||
|
formatted_path = ''.join(format_json_error_path_element(element) for element in error.path)
|
||||||
|
return f"At '{formatted_path.lstrip('.')}': {error.message}"
|
||||||
|
|
||||||
|
|
||||||
class Validation_error(ValueError):
|
class Validation_error(ValueError):
|
||||||
'''
|
'''
|
||||||
A collection of error message strings generated when attempting to validate a particular
|
A collection of error messages generated when attempting to validate a particular
|
||||||
configurartion file.
|
configuration file.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def __init__(self, config_filename, error_messages):
|
def __init__(self, config_filename, errors):
|
||||||
|
'''
|
||||||
|
Given a configuration filename path and a sequence of string error messages, create a
|
||||||
|
Validation_error.
|
||||||
|
'''
|
||||||
self.config_filename = config_filename
|
self.config_filename = config_filename
|
||||||
self.error_messages = error_messages
|
self.errors = errors
|
||||||
|
|
||||||
def __str__(self):
|
def __str__(self):
|
||||||
'''
|
'''
|
||||||
Render a validation error as a user-facing string.
|
Render a validation error as a user-facing string.
|
||||||
'''
|
'''
|
||||||
return 'An error occurred while parsing a configuration file at {}:\n'.format(
|
return (
|
||||||
self.config_filename
|
f'An error occurred while parsing a configuration file at {self.config_filename}:\n'
|
||||||
) + '\n'.join(self.error_messages)
|
+ '\n'.join(error for error in self.errors)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def apply_logical_validation(config_filename, parsed_configuration):
|
def apply_logical_validation(config_filename, parsed_configuration):
|
||||||
|
@ -41,103 +66,103 @@ def apply_logical_validation(config_filename, parsed_configuration):
|
||||||
below), run through any additional logical validation checks. If there are any such validation
|
below), run through any additional logical validation checks. If there are any such validation
|
||||||
problems, raise a Validation_error.
|
problems, raise a Validation_error.
|
||||||
'''
|
'''
|
||||||
archive_name_format = parsed_configuration.get('storage', {}).get('archive_name_format')
|
|
||||||
prefix = parsed_configuration.get('retention', {}).get('prefix')
|
|
||||||
|
|
||||||
if archive_name_format and not prefix:
|
|
||||||
raise Validation_error(
|
|
||||||
config_filename,
|
|
||||||
('If you provide an archive_name_format, you must also specify a retention prefix.',),
|
|
||||||
)
|
|
||||||
|
|
||||||
location_repositories = parsed_configuration.get('location', {}).get('repositories')
|
location_repositories = parsed_configuration.get('location', {}).get('repositories')
|
||||||
check_repositories = parsed_configuration.get('consistency', {}).get('check_repositories', [])
|
check_repositories = parsed_configuration.get('consistency', {}).get('check_repositories', [])
|
||||||
for repository in check_repositories:
|
for repository in check_repositories:
|
||||||
if repository not in location_repositories:
|
if not any(
|
||||||
|
repositories_match(repository, config_repository)
|
||||||
|
for config_repository in location_repositories
|
||||||
|
):
|
||||||
raise Validation_error(
|
raise Validation_error(
|
||||||
config_filename,
|
config_filename,
|
||||||
(
|
(
|
||||||
'Unknown repository in the consistency section\'s check_repositories: {}'.format(
|
f'Unknown repository in the "consistency" section\'s "check_repositories": {repository}',
|
||||||
repository
|
|
||||||
),
|
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def remove_examples(schema):
|
def parse_configuration(config_filename, schema_filename, overrides=None, resolve_env=True):
|
||||||
'''
|
'''
|
||||||
pykwalify gets angry if the example field is not a string. So rather than bend to its will,
|
Given the path to a config filename in YAML format, the path to a schema filename in a YAML
|
||||||
remove all examples from the given schema before passing the schema to pykwalify.
|
rendition of JSON Schema format, a sequence of configuration file override strings in the form
|
||||||
'''
|
of "section.option=value", return the parsed configuration as a data structure of nested dicts
|
||||||
if 'map' in schema:
|
and lists corresponding to the schema. Example return value:
|
||||||
for item_name, item_schema in schema['map'].items():
|
|
||||||
item_schema.pop('example', None)
|
|
||||||
remove_examples(item_schema)
|
|
||||||
elif 'seq' in schema:
|
|
||||||
for item_schema in schema['seq']:
|
|
||||||
item_schema.pop('example', None)
|
|
||||||
remove_examples(item_schema)
|
|
||||||
|
|
||||||
return schema
|
|
||||||
|
|
||||||
|
|
||||||
def parse_configuration(config_filename, schema_filename):
|
|
||||||
'''
|
|
||||||
Given the path to a config filename in YAML format and the path to a schema filename in
|
|
||||||
pykwalify YAML schema format, return the parsed configuration as a data structure of nested
|
|
||||||
dicts and lists corresponding to the schema. Example return value:
|
|
||||||
|
|
||||||
{'location': {'source_directories': ['/home', '/etc'], 'repository': 'hostname.borg'},
|
{'location': {'source_directories': ['/home', '/etc'], 'repository': 'hostname.borg'},
|
||||||
'retention': {'keep_daily': 7}, 'consistency': {'checks': ['repository', 'archives']}}
|
'retention': {'keep_daily': 7}, 'consistency': {'checks': ['repository', 'archives']}}
|
||||||
|
|
||||||
|
Also return a sequence of logging.LogRecord instances containing any warnings about the
|
||||||
|
configuration.
|
||||||
|
|
||||||
Raise FileNotFoundError if the file does not exist, PermissionError if the user does not
|
Raise FileNotFoundError if the file does not exist, PermissionError if the user does not
|
||||||
have permissions to read the file, or Validation_error if the config does not match the schema.
|
have permissions to read the file, or Validation_error if the config does not match the schema.
|
||||||
'''
|
'''
|
||||||
logging.getLogger('pykwalify').setLevel(logging.ERROR)
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
config = load.load_configuration(config_filename)
|
config = load.load_configuration(config_filename)
|
||||||
schema = load.load_configuration(schema_filename)
|
schema = load.load_configuration(schema_filename)
|
||||||
except (ruamel.yaml.error.YAMLError, RecursionError) as error:
|
except (ruamel.yaml.error.YAMLError, RecursionError) as error:
|
||||||
raise Validation_error(config_filename, (str(error),))
|
raise Validation_error(config_filename, (str(error),))
|
||||||
|
|
||||||
validator = pykwalify.core.Core(source_data=config, schema_data=remove_examples(schema))
|
override.apply_overrides(config, overrides)
|
||||||
parsed_result = validator.validate(raise_exception=False)
|
logs = normalize.normalize(config_filename, config)
|
||||||
|
if resolve_env:
|
||||||
|
environment.resolve_env_variables(config)
|
||||||
|
|
||||||
if validator.validation_errors:
|
try:
|
||||||
raise Validation_error(config_filename, validator.validation_errors)
|
validator = jsonschema.Draft7Validator(schema)
|
||||||
|
except AttributeError: # pragma: no cover
|
||||||
|
validator = jsonschema.Draft4Validator(schema)
|
||||||
|
validation_errors = tuple(validator.iter_errors(config))
|
||||||
|
|
||||||
apply_logical_validation(config_filename, parsed_result)
|
if validation_errors:
|
||||||
|
raise Validation_error(
|
||||||
|
config_filename, tuple(format_json_error(error) for error in validation_errors)
|
||||||
|
)
|
||||||
|
|
||||||
return parsed_result
|
apply_logical_validation(config_filename, config)
|
||||||
|
|
||||||
|
return config, logs
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_repository_path(repository):
|
||||||
|
'''
|
||||||
|
Given a repository path, return the absolute path of it (for local repositories).
|
||||||
|
'''
|
||||||
|
# A colon in the repository could mean that it's either a file:// URL or a remote repository.
|
||||||
|
# If it's a remote repository, we don't want to normalize it. If it's a file:// URL, we do.
|
||||||
|
if ':' not in repository:
|
||||||
|
return os.path.abspath(repository)
|
||||||
|
elif repository.startswith('file://'):
|
||||||
|
return os.path.abspath(repository.partition('file://')[-1])
|
||||||
|
else:
|
||||||
|
return repository
|
||||||
|
|
||||||
|
|
||||||
|
def repositories_match(first, second):
|
||||||
|
'''
|
||||||
|
Given two repository dicts with keys 'path' (relative and/or absolute),
|
||||||
|
and 'label', or two repository paths, return whether they match.
|
||||||
|
'''
|
||||||
|
if isinstance(first, str):
|
||||||
|
first = {'path': first, 'label': first}
|
||||||
|
if isinstance(second, str):
|
||||||
|
second = {'path': second, 'label': second}
|
||||||
|
return (first.get('label') == second.get('label')) or (
|
||||||
|
normalize_repository_path(first.get('path'))
|
||||||
|
== normalize_repository_path(second.get('path'))
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def guard_configuration_contains_repository(repository, configurations):
|
def guard_configuration_contains_repository(repository, configurations):
|
||||||
'''
|
'''
|
||||||
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
||||||
dict, ensure that the repository is declared exactly once in all of the configurations.
|
dict, ensure that the repository is declared exactly once in all of the configurations. If no
|
||||||
|
repository is given, skip this check.
|
||||||
If no repository is given, then error if there are multiple configured repositories.
|
|
||||||
|
|
||||||
Raise ValueError if the repository is not found in a configuration, or is declared multiple
|
Raise ValueError if the repository is not found in a configuration, or is declared multiple
|
||||||
times.
|
times.
|
||||||
'''
|
'''
|
||||||
if not repository:
|
if not repository:
|
||||||
count = len(
|
|
||||||
tuple(
|
|
||||||
config_repository
|
|
||||||
for config in configurations.values()
|
|
||||||
for config_repository in config['location']['repositories']
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
if count > 1:
|
|
||||||
raise ValueError(
|
|
||||||
'Can\'t determine which repository to use. Use --repository option to disambiguate'.format(
|
|
||||||
repository
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
|
|
||||||
count = len(
|
count = len(
|
||||||
|
@ -145,11 +170,34 @@ def guard_configuration_contains_repository(repository, configurations):
|
||||||
config_repository
|
config_repository
|
||||||
for config in configurations.values()
|
for config in configurations.values()
|
||||||
for config_repository in config['location']['repositories']
|
for config_repository in config['location']['repositories']
|
||||||
if repository == config_repository
|
if repositories_match(config_repository, repository)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
if count == 0:
|
if count == 0:
|
||||||
raise ValueError('Repository {} not found in configuration files'.format(repository))
|
raise ValueError(f'Repository {repository} not found in configuration files')
|
||||||
if count > 1:
|
if count > 1:
|
||||||
raise ValueError('Repository {} found in multiple configuration files'.format(repository))
|
raise ValueError(f'Repository {repository} found in multiple configuration files')
|
||||||
|
|
||||||
|
|
||||||
|
def guard_single_repository_selected(repository, configurations):
|
||||||
|
'''
|
||||||
|
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
||||||
|
dict, ensure either a single repository exists across all configuration files or a repository
|
||||||
|
path was given.
|
||||||
|
'''
|
||||||
|
if repository:
|
||||||
|
return
|
||||||
|
|
||||||
|
count = len(
|
||||||
|
tuple(
|
||||||
|
config_repository
|
||||||
|
for config in configurations.values()
|
||||||
|
for config_repository in config['location']['repositories']
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if count != 1:
|
||||||
|
raise ValueError(
|
||||||
|
"Can't determine which repository to use. Use --repository to disambiguate"
|
||||||
|
)
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
|
import collections
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import select
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -9,52 +11,182 @@ ERROR_OUTPUT_MAX_LINE_COUNT = 25
|
||||||
BORG_ERROR_EXIT_CODE = 2
|
BORG_ERROR_EXIT_CODE = 2
|
||||||
|
|
||||||
|
|
||||||
def exit_code_indicates_error(command, exit_code, error_on_warnings=True):
|
def exit_code_indicates_error(command, exit_code, borg_local_path=None):
|
||||||
'''
|
'''
|
||||||
Return True if the given exit code from running the command corresponds to an error.
|
Return True if the given exit code from running a command corresponds to an error. If a Borg
|
||||||
If error on warnings is False, then treat exit code 1 as a warning instead of an error.
|
local path is given and matches the process' command, then treat exit code 1 as a warning
|
||||||
|
instead of an error.
|
||||||
'''
|
'''
|
||||||
if error_on_warnings:
|
if exit_code is None:
|
||||||
return bool(exit_code != 0)
|
return False
|
||||||
|
|
||||||
return bool(exit_code >= BORG_ERROR_EXIT_CODE)
|
if borg_local_path and command[0] == borg_local_path:
|
||||||
|
return bool(exit_code < 0 or exit_code >= BORG_ERROR_EXIT_CODE)
|
||||||
|
|
||||||
|
return bool(exit_code != 0)
|
||||||
|
|
||||||
|
|
||||||
def log_output(command, process, output_buffer, output_log_level, error_on_warnings):
|
def command_for_process(process):
|
||||||
'''
|
'''
|
||||||
Given a command already executed, its process opened by subprocess.Popen(), and the process'
|
Given a process as an instance of subprocess.Popen, return the command string that was used to
|
||||||
relevant output buffer (stderr or stdout), log its output with the requested log level.
|
invoke it.
|
||||||
Additionally, raise a CalledProcessException if the process exits with an error (or a warning,
|
|
||||||
if error on warnings is True).
|
|
||||||
'''
|
'''
|
||||||
last_lines = []
|
return process.args if isinstance(process.args, str) else ' '.join(process.args)
|
||||||
|
|
||||||
while process.poll() is None:
|
|
||||||
line = output_buffer.readline().rstrip().decode()
|
|
||||||
if not line:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# Keep the last few lines of output in case the command errors, and we need the output for
|
def output_buffer_for_process(process, exclude_stdouts):
|
||||||
# the exception below.
|
'''
|
||||||
last_lines.append(line)
|
Given a process as an instance of subprocess.Popen and a sequence of stdouts to exclude, return
|
||||||
if len(last_lines) > ERROR_OUTPUT_MAX_LINE_COUNT:
|
either the process's stdout or stderr. The idea is that if stdout is excluded for a process, we
|
||||||
last_lines.pop(0)
|
still have stderr to log.
|
||||||
|
'''
|
||||||
|
return process.stderr if process.stdout in exclude_stdouts else process.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def append_last_lines(last_lines, captured_output, line, output_log_level):
|
||||||
|
'''
|
||||||
|
Given a rolling list of last lines, a list of captured output, a line to append, and an output
|
||||||
|
log level, append the line to the last lines and (if necessary) the captured output. Then log
|
||||||
|
the line at the requested output log level.
|
||||||
|
'''
|
||||||
|
last_lines.append(line)
|
||||||
|
|
||||||
|
if len(last_lines) > ERROR_OUTPUT_MAX_LINE_COUNT:
|
||||||
|
last_lines.pop(0)
|
||||||
|
|
||||||
|
if output_log_level is None:
|
||||||
|
captured_output.append(line)
|
||||||
|
else:
|
||||||
logger.log(output_log_level, line)
|
logger.log(output_log_level, line)
|
||||||
|
|
||||||
remaining_output = output_buffer.read().rstrip().decode()
|
|
||||||
if remaining_output: # pragma: no cover
|
|
||||||
logger.log(output_log_level, remaining_output)
|
|
||||||
|
|
||||||
exit_code = process.poll()
|
def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
|
||||||
|
'''
|
||||||
|
Given a sequence of subprocess.Popen() instances for multiple processes, log the output for each
|
||||||
|
process with the requested log level. Additionally, raise a CalledProcessError if a process
|
||||||
|
exits with an error (or a warning for exit code 1, if that process does not match the Borg local
|
||||||
|
path).
|
||||||
|
|
||||||
if exit_code_indicates_error(command, exit_code, error_on_warnings):
|
If output log level is None, then instead of logging, capture output for each process and return
|
||||||
# If an error occurs, include its output in the raised exception so that we don't
|
it as a dict from the process to its output.
|
||||||
# inadvertently hide error output.
|
|
||||||
if len(last_lines) == ERROR_OUTPUT_MAX_LINE_COUNT:
|
|
||||||
last_lines.insert(0, '...')
|
|
||||||
|
|
||||||
raise subprocess.CalledProcessError(exit_code, ' '.join(command), '\n'.join(last_lines))
|
For simplicity, it's assumed that the output buffer for each process is its stdout. But if any
|
||||||
|
stdouts are given to exclude, then for any matching processes, log from their stderr instead.
|
||||||
|
|
||||||
|
Note that stdout for a process can be None if output is intentionally not captured. In which
|
||||||
|
case it won't be logged.
|
||||||
|
'''
|
||||||
|
# Map from output buffer to sequence of last lines.
|
||||||
|
buffer_last_lines = collections.defaultdict(list)
|
||||||
|
process_for_output_buffer = {
|
||||||
|
output_buffer_for_process(process, exclude_stdouts): process
|
||||||
|
for process in processes
|
||||||
|
if process.stdout or process.stderr
|
||||||
|
}
|
||||||
|
output_buffers = list(process_for_output_buffer.keys())
|
||||||
|
captured_outputs = collections.defaultdict(list)
|
||||||
|
still_running = True
|
||||||
|
|
||||||
|
# Log output for each process until they all exit.
|
||||||
|
while True:
|
||||||
|
if output_buffers:
|
||||||
|
(ready_buffers, _, _) = select.select(output_buffers, [], [])
|
||||||
|
|
||||||
|
for ready_buffer in ready_buffers:
|
||||||
|
ready_process = process_for_output_buffer.get(ready_buffer)
|
||||||
|
|
||||||
|
# The "ready" process has exited, but it might be a pipe destination with other
|
||||||
|
# processes (pipe sources) waiting to be read from. So as a measure to prevent
|
||||||
|
# hangs, vent all processes when one exits.
|
||||||
|
if ready_process and ready_process.poll() is not None:
|
||||||
|
for other_process in processes:
|
||||||
|
if (
|
||||||
|
other_process.poll() is None
|
||||||
|
and other_process.stdout
|
||||||
|
and other_process.stdout not in output_buffers
|
||||||
|
):
|
||||||
|
# Add the process's output to output_buffers to ensure it'll get read.
|
||||||
|
output_buffers.append(other_process.stdout)
|
||||||
|
|
||||||
|
while True:
|
||||||
|
line = ready_buffer.readline().rstrip().decode()
|
||||||
|
if not line or not ready_process:
|
||||||
|
break
|
||||||
|
|
||||||
|
# Keep the last few lines of output in case the process errors, and we need the output for
|
||||||
|
# the exception below.
|
||||||
|
append_last_lines(
|
||||||
|
buffer_last_lines[ready_buffer],
|
||||||
|
captured_outputs[ready_process],
|
||||||
|
line,
|
||||||
|
output_log_level,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not still_running:
|
||||||
|
break
|
||||||
|
|
||||||
|
still_running = False
|
||||||
|
|
||||||
|
for process in processes:
|
||||||
|
exit_code = process.poll() if output_buffers else process.wait()
|
||||||
|
|
||||||
|
if exit_code is None:
|
||||||
|
still_running = True
|
||||||
|
|
||||||
|
command = process.args.split(' ') if isinstance(process.args, str) else process.args
|
||||||
|
# If any process errors, then raise accordingly.
|
||||||
|
if exit_code_indicates_error(command, exit_code, borg_local_path):
|
||||||
|
# If an error occurs, include its output in the raised exception so that we don't
|
||||||
|
# inadvertently hide error output.
|
||||||
|
output_buffer = output_buffer_for_process(process, exclude_stdouts)
|
||||||
|
last_lines = buffer_last_lines[output_buffer] if output_buffer else []
|
||||||
|
|
||||||
|
# Collect any straggling output lines that came in since we last gathered output.
|
||||||
|
while output_buffer: # pragma: no cover
|
||||||
|
line = output_buffer.readline().rstrip().decode()
|
||||||
|
if not line:
|
||||||
|
break
|
||||||
|
|
||||||
|
append_last_lines(
|
||||||
|
last_lines, captured_outputs[process], line, output_log_level=logging.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
|
if len(last_lines) == ERROR_OUTPUT_MAX_LINE_COUNT:
|
||||||
|
last_lines.insert(0, '...')
|
||||||
|
|
||||||
|
# Something has gone wrong. So vent each process' output buffer to prevent it from
|
||||||
|
# hanging. And then kill the process.
|
||||||
|
for other_process in processes:
|
||||||
|
if other_process.poll() is None:
|
||||||
|
other_process.stdout.read(0)
|
||||||
|
other_process.kill()
|
||||||
|
|
||||||
|
raise subprocess.CalledProcessError(
|
||||||
|
exit_code, command_for_process(process), '\n'.join(last_lines)
|
||||||
|
)
|
||||||
|
|
||||||
|
if captured_outputs:
|
||||||
|
return {
|
||||||
|
process: '\n'.join(output_lines) for process, output_lines in captured_outputs.items()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def log_command(full_command, input_file=None, output_file=None):
|
||||||
|
'''
|
||||||
|
Log the given command (a sequence of command/argument strings), along with its input/output file
|
||||||
|
paths.
|
||||||
|
'''
|
||||||
|
logger.debug(
|
||||||
|
' '.join(full_command)
|
||||||
|
+ (f" < {getattr(input_file, 'name', '')}" if input_file else '')
|
||||||
|
+ (f" > {getattr(output_file, 'name', '')}" if output_file else '')
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# An sentinel passed as an output file to execute_command() to indicate that the command's output
|
||||||
|
# should be allowed to flow through to stdout without being captured for logging. Useful for
|
||||||
|
# commands with interactive prompts or those that mess directly with the console.
|
||||||
|
DO_NOT_CAPTURE = object()
|
||||||
|
|
||||||
|
|
||||||
def execute_command(
|
def execute_command(
|
||||||
|
@ -65,64 +197,137 @@ def execute_command(
|
||||||
shell=False,
|
shell=False,
|
||||||
extra_environment=None,
|
extra_environment=None,
|
||||||
working_directory=None,
|
working_directory=None,
|
||||||
error_on_warnings=True,
|
borg_local_path=None,
|
||||||
|
run_to_completion=True,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Execute the given command (a sequence of command/argument strings) and log its output at the
|
Execute the given command (a sequence of command/argument strings) and log its output at the
|
||||||
given log level. If output log level is None, instead capture and return the output. If an
|
given log level. If an open output file object is given, then write stdout to the file and only
|
||||||
open output file object is given, then write stdout to the file and only log stderr (but only
|
log stderr. If an open input file object is given, then read stdin from the file. If shell is
|
||||||
if an output log level is set). If an open input file object is given, then read stdin from the
|
True, execute the command within a shell. If an extra environment dict is given, then use it to
|
||||||
file. If shell is True, execute the command within a shell. If an extra environment dict is
|
augment the current environment, and pass the result into the command. If a working directory is
|
||||||
given, then use it to augment the current environment, and pass the result into the command. If
|
given, use that as the present working directory when running the command. If a Borg local path
|
||||||
a working directory is given, use that as the present working directory when running the
|
is given, and the command matches it (regardless of arguments), treat exit code 1 as a warning
|
||||||
command. If error on warnings is False, then treat exit code 1 as a warning instead of an error.
|
instead of an error. If run to completion is False, then return the process for the command
|
||||||
|
without executing it to completion.
|
||||||
|
|
||||||
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
||||||
'''
|
'''
|
||||||
logger.debug(
|
log_command(full_command, input_file, output_file)
|
||||||
' '.join(full_command)
|
|
||||||
+ (' < {}'.format(input_file.name) if input_file else '')
|
|
||||||
+ (' > {}'.format(output_file.name) if output_file else '')
|
|
||||||
)
|
|
||||||
environment = {**os.environ, **extra_environment} if extra_environment else None
|
environment = {**os.environ, **extra_environment} if extra_environment else None
|
||||||
|
do_not_capture = bool(output_file is DO_NOT_CAPTURE)
|
||||||
|
command = ' '.join(full_command) if shell else full_command
|
||||||
|
|
||||||
if output_log_level is None:
|
process = subprocess.Popen(
|
||||||
|
command,
|
||||||
|
stdin=input_file,
|
||||||
|
stdout=None if do_not_capture else (output_file or subprocess.PIPE),
|
||||||
|
stderr=None if do_not_capture else (subprocess.PIPE if output_file else subprocess.STDOUT),
|
||||||
|
shell=shell,
|
||||||
|
env=environment,
|
||||||
|
cwd=working_directory,
|
||||||
|
)
|
||||||
|
if not run_to_completion:
|
||||||
|
return process
|
||||||
|
|
||||||
|
log_outputs(
|
||||||
|
(process,), (input_file, output_file), output_log_level, borg_local_path=borg_local_path
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def execute_command_and_capture_output(
|
||||||
|
full_command, capture_stderr=False, shell=False, extra_environment=None, working_directory=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Execute the given command (a sequence of command/argument strings), capturing and returning its
|
||||||
|
output (stdout). If capture stderr is True, then capture and return stderr in addition to
|
||||||
|
stdout. If shell is True, execute the command within a shell. If an extra environment dict is
|
||||||
|
given, then use it to augment the current environment, and pass the result into the command. If
|
||||||
|
a working directory is given, use that as the present working directory when running the command.
|
||||||
|
|
||||||
|
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
||||||
|
'''
|
||||||
|
log_command(full_command)
|
||||||
|
environment = {**os.environ, **extra_environment} if extra_environment else None
|
||||||
|
command = ' '.join(full_command) if shell else full_command
|
||||||
|
|
||||||
|
try:
|
||||||
output = subprocess.check_output(
|
output = subprocess.check_output(
|
||||||
full_command, shell=shell, env=environment, cwd=working_directory
|
command,
|
||||||
)
|
stderr=subprocess.STDOUT if capture_stderr else None,
|
||||||
return output.decode() if output is not None else None
|
|
||||||
else:
|
|
||||||
process = subprocess.Popen(
|
|
||||||
full_command,
|
|
||||||
stdin=input_file,
|
|
||||||
stdout=output_file or subprocess.PIPE,
|
|
||||||
stderr=subprocess.PIPE if output_file else subprocess.STDOUT,
|
|
||||||
shell=shell,
|
shell=shell,
|
||||||
env=environment,
|
env=environment,
|
||||||
cwd=working_directory,
|
cwd=working_directory,
|
||||||
)
|
)
|
||||||
log_output(
|
except subprocess.CalledProcessError as error:
|
||||||
full_command,
|
if exit_code_indicates_error(command, error.returncode):
|
||||||
process,
|
raise
|
||||||
process.stderr if output_file else process.stdout,
|
output = error.output
|
||||||
output_log_level,
|
|
||||||
error_on_warnings,
|
return output.decode() if output is not None else None
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def execute_command_without_capture(full_command, working_directory=None, error_on_warnings=True):
|
def execute_command_with_processes(
|
||||||
|
full_command,
|
||||||
|
processes,
|
||||||
|
output_log_level=logging.INFO,
|
||||||
|
output_file=None,
|
||||||
|
input_file=None,
|
||||||
|
shell=False,
|
||||||
|
extra_environment=None,
|
||||||
|
working_directory=None,
|
||||||
|
borg_local_path=None,
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Execute the given command (a sequence of command/argument strings), but don't capture or log its
|
Execute the given command (a sequence of command/argument strings) and log its output at the
|
||||||
output in any way. This is necessary for commands that monkey with the terminal (e.g. progress
|
given log level. Simultaneously, continue to poll one or more active processes so that they
|
||||||
display) or provide interactive prompts.
|
run as well. This is useful, for instance, for processes that are streaming output to a named
|
||||||
|
pipe that the given command is consuming from.
|
||||||
|
|
||||||
If a working directory is given, use that as the present working directory when running the
|
If an open output file object is given, then write stdout to the file and only log stderr. But
|
||||||
command. If error on warnings is False, then treat exit code 1 as a warning instead of an error.
|
if output log level is None, instead suppress logging and return the captured output for (only)
|
||||||
|
the given command. If an open input file object is given, then read stdin from the file. If
|
||||||
|
shell is True, execute the command within a shell. If an extra environment dict is given, then
|
||||||
|
use it to augment the current environment, and pass the result into the command. If a working
|
||||||
|
directory is given, use that as the present working directory when running the command. If a
|
||||||
|
Borg local path is given, then for any matching command or process (regardless of arguments),
|
||||||
|
treat exit code 1 as a warning instead of an error.
|
||||||
|
|
||||||
|
Raise subprocesses.CalledProcessError if an error occurs while running the command or in the
|
||||||
|
upstream process.
|
||||||
'''
|
'''
|
||||||
logger.debug(' '.join(full_command))
|
log_command(full_command, input_file, output_file)
|
||||||
|
environment = {**os.environ, **extra_environment} if extra_environment else None
|
||||||
|
do_not_capture = bool(output_file is DO_NOT_CAPTURE)
|
||||||
|
command = ' '.join(full_command) if shell else full_command
|
||||||
|
|
||||||
try:
|
try:
|
||||||
subprocess.check_call(full_command, cwd=working_directory)
|
command_process = subprocess.Popen(
|
||||||
except subprocess.CalledProcessError as error:
|
command,
|
||||||
if exit_code_indicates_error(full_command, error.returncode, error_on_warnings):
|
stdin=input_file,
|
||||||
raise
|
stdout=None if do_not_capture else (output_file or subprocess.PIPE),
|
||||||
|
stderr=None
|
||||||
|
if do_not_capture
|
||||||
|
else (subprocess.PIPE if output_file else subprocess.STDOUT),
|
||||||
|
shell=shell,
|
||||||
|
env=environment,
|
||||||
|
cwd=working_directory,
|
||||||
|
)
|
||||||
|
except (subprocess.CalledProcessError, OSError):
|
||||||
|
# Something has gone wrong. So vent each process' output buffer to prevent it from hanging.
|
||||||
|
# And then kill the process.
|
||||||
|
for process in processes:
|
||||||
|
if process.poll() is None:
|
||||||
|
process.stdout.read(0)
|
||||||
|
process.kill()
|
||||||
|
raise
|
||||||
|
|
||||||
|
captured_outputs = log_outputs(
|
||||||
|
tuple(processes) + (command_process,),
|
||||||
|
(input_file, output_file),
|
||||||
|
output_log_level,
|
||||||
|
borg_local_path=borg_local_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
if output_log_level is None:
|
||||||
|
return captured_outputs.get(command_process)
|
||||||
|
|
|
@ -1,18 +1,27 @@
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
from borgmatic import execute
|
from borgmatic import execute
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def interpolate_context(command, context):
|
SOFT_FAIL_EXIT_CODE = 75
|
||||||
|
|
||||||
|
|
||||||
|
def interpolate_context(config_filename, hook_description, command, context):
|
||||||
'''
|
'''
|
||||||
Given a single hook command and a dict of context names/values, interpolate the values by
|
Given a config filename, a hook description, a single hook command, and a dict of context
|
||||||
"{name}" into the command and return the result.
|
names/values, interpolate the values by "{name}" into the command and return the result.
|
||||||
'''
|
'''
|
||||||
for name, value in context.items():
|
for name, value in context.items():
|
||||||
command = command.replace('{%s}' % name, str(value))
|
command = command.replace(f'{{{name}}}', str(value))
|
||||||
|
|
||||||
|
for unsupported_variable in re.findall(r'{\w+}', command):
|
||||||
|
logger.warning(
|
||||||
|
f"{config_filename}: Variable '{unsupported_variable}' is not supported in {hook_description} hook"
|
||||||
|
)
|
||||||
|
|
||||||
return command
|
return command
|
||||||
|
|
||||||
|
@ -23,35 +32,32 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
a hook description, and whether this is a dry run, run the given commands. Or, don't run them
|
a hook description, and whether this is a dry run, run the given commands. Or, don't run them
|
||||||
if this is a dry run.
|
if this is a dry run.
|
||||||
|
|
||||||
The context contains optional values interpolated by name into the hook commands. Currently,
|
The context contains optional values interpolated by name into the hook commands.
|
||||||
this only applies to the on_error hook.
|
|
||||||
|
|
||||||
Raise ValueError if the umask cannot be parsed.
|
Raise ValueError if the umask cannot be parsed.
|
||||||
Raise subprocesses.CalledProcessError if an error occurs in a hook.
|
Raise subprocesses.CalledProcessError if an error occurs in a hook.
|
||||||
'''
|
'''
|
||||||
if not commands:
|
if not commands:
|
||||||
logger.debug('{}: No commands to run for {} hook'.format(config_filename, description))
|
logger.debug(f'{config_filename}: No commands to run for {description} hook')
|
||||||
return
|
return
|
||||||
|
|
||||||
dry_run_label = ' (dry run; not actually running hooks)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually running hooks)' if dry_run else ''
|
||||||
|
|
||||||
context['configuration_filename'] = config_filename
|
context['configuration_filename'] = config_filename
|
||||||
commands = [interpolate_context(command, context) for command in commands]
|
commands = [
|
||||||
|
interpolate_context(config_filename, description, command, context) for command in commands
|
||||||
|
]
|
||||||
|
|
||||||
if len(commands) == 1:
|
if len(commands) == 1:
|
||||||
logger.info(
|
logger.info(f'{config_filename}: Running command for {description} hook{dry_run_label}')
|
||||||
'{}: Running command for {} hook{}'.format(config_filename, description, dry_run_label)
|
|
||||||
)
|
|
||||||
else:
|
else:
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Running {} commands for {} hook{}'.format(
|
f'{config_filename}: Running {len(commands)} commands for {description} hook{dry_run_label}',
|
||||||
config_filename, len(commands), description, dry_run_label
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
if umask:
|
if umask:
|
||||||
parsed_umask = int(str(umask), 8)
|
parsed_umask = int(str(umask), 8)
|
||||||
logger.debug('{}: Set hook umask to {}'.format(config_filename, oct(parsed_umask)))
|
logger.debug(f'{config_filename}: Set hook umask to {oct(parsed_umask)}')
|
||||||
original_umask = os.umask(parsed_umask)
|
original_umask = os.umask(parsed_umask)
|
||||||
else:
|
else:
|
||||||
original_umask = None
|
original_umask = None
|
||||||
|
@ -69,3 +75,22 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
finally:
|
finally:
|
||||||
if original_umask:
|
if original_umask:
|
||||||
os.umask(original_umask)
|
os.umask(original_umask)
|
||||||
|
|
||||||
|
|
||||||
|
def considered_soft_failure(config_filename, error):
|
||||||
|
'''
|
||||||
|
Given a configuration filename and an exception object, return whether the exception object
|
||||||
|
represents a subprocess.CalledProcessError with a return code of SOFT_FAIL_EXIT_CODE. If so,
|
||||||
|
that indicates that the error is a "soft failure", and should not result in an error.
|
||||||
|
'''
|
||||||
|
exit_code = getattr(error, 'returncode', None)
|
||||||
|
if exit_code is None:
|
||||||
|
return False
|
||||||
|
|
||||||
|
if exit_code == SOFT_FAIL_EXIT_CODE:
|
||||||
|
logger.info(
|
||||||
|
f'{config_filename}: Command hook exited with soft failure exit code ({SOFT_FAIL_EXIT_CODE}); skipping remaining actions',
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
|
@ -13,20 +13,51 @@ MONITOR_STATE_TO_CRONHUB = {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(ping_url, config_filename, state, dry_run):
|
def initialize_monitor(
|
||||||
|
ping_url, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Ping the given Cronhub URL, modified with the monitor.State. Use the given configuration
|
No initialization is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Ping the configured Cronhub URL, modified with the monitor.State. Use the given configuration
|
||||||
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
if state not in MONITOR_STATE_TO_CRONHUB:
|
||||||
formatted_state = '/{}/'.format(MONITOR_STATE_TO_CRONHUB[state])
|
logger.debug(
|
||||||
ping_url = ping_url.replace('/start/', formatted_state).replace('/ping/', formatted_state)
|
f'{config_filename}: Ignoring unsupported monitoring {state.name.lower()} in Cronhub hook'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
logger.info(
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
'{}: Pinging Cronhub {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
formatted_state = f'/{MONITOR_STATE_TO_CRONHUB[state]}/'
|
||||||
|
ping_url = (
|
||||||
|
hook_config['ping_url']
|
||||||
|
.replace('/start/', formatted_state)
|
||||||
|
.replace('/ping/', formatted_state)
|
||||||
)
|
)
|
||||||
logger.debug('{}: Using Cronhub ping URL {}'.format(config_filename, ping_url))
|
|
||||||
|
logger.info(f'{config_filename}: Pinging Cronhub {state.name.lower()}{dry_run_label}')
|
||||||
|
logger.debug(f'{config_filename}: Using Cronhub ping URL {ping_url}')
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.get(ping_url)
|
try:
|
||||||
|
response = requests.get(ping_url)
|
||||||
|
if not response.ok:
|
||||||
|
response.raise_for_status()
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: Cronhub error: {error}')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(
|
||||||
|
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
No destruction is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
||||||
|
|
|
@ -13,19 +13,46 @@ MONITOR_STATE_TO_CRONITOR = {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(ping_url, config_filename, state, dry_run):
|
def initialize_monitor(
|
||||||
|
ping_url, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Ping the given Cronitor URL, modified with the monitor.State. Use the given configuration
|
No initialization is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Ping the configured Cronitor URL, modified with the monitor.State. Use the given configuration
|
||||||
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
if state not in MONITOR_STATE_TO_CRONITOR:
|
||||||
ping_url = '{}/{}'.format(ping_url, MONITOR_STATE_TO_CRONITOR[state])
|
logger.debug(
|
||||||
|
f'{config_filename}: Ignoring unsupported monitoring {state.name.lower()} in Cronitor hook'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
logger.info(
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
'{}: Pinging Cronitor {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
ping_url = f"{hook_config['ping_url']}/{MONITOR_STATE_TO_CRONITOR[state]}"
|
||||||
)
|
|
||||||
logger.debug('{}: Using Cronitor ping URL {}'.format(config_filename, ping_url))
|
logger.info(f'{config_filename}: Pinging Cronitor {state.name.lower()}{dry_run_label}')
|
||||||
|
logger.debug(f'{config_filename}: Using Cronitor ping URL {ping_url}')
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.get(ping_url)
|
try:
|
||||||
|
response = requests.get(ping_url)
|
||||||
|
if not response.ok:
|
||||||
|
response.raise_for_status()
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: Cronitor error: {error}')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(
|
||||||
|
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
No destruction is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
||||||
|
|
|
@ -1,15 +1,29 @@
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from borgmatic.hooks import cronhub, cronitor, healthchecks, mysql, postgresql
|
from borgmatic.hooks import (
|
||||||
|
cronhub,
|
||||||
|
cronitor,
|
||||||
|
healthchecks,
|
||||||
|
mongodb,
|
||||||
|
mysql,
|
||||||
|
ntfy,
|
||||||
|
pagerduty,
|
||||||
|
postgresql,
|
||||||
|
sqlite,
|
||||||
|
)
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
HOOK_NAME_TO_MODULE = {
|
HOOK_NAME_TO_MODULE = {
|
||||||
'healthchecks': healthchecks,
|
|
||||||
'cronitor': cronitor,
|
|
||||||
'cronhub': cronhub,
|
'cronhub': cronhub,
|
||||||
'postgresql_databases': postgresql,
|
'cronitor': cronitor,
|
||||||
|
'healthchecks': healthchecks,
|
||||||
|
'mongodb_databases': mongodb,
|
||||||
'mysql_databases': mysql,
|
'mysql_databases': mysql,
|
||||||
|
'ntfy': ntfy,
|
||||||
|
'pagerduty': pagerduty,
|
||||||
|
'postgresql_databases': postgresql,
|
||||||
|
'sqlite_databases': sqlite,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -17,26 +31,21 @@ def call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs):
|
||||||
'''
|
'''
|
||||||
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
||||||
function of the Python module corresponding to the given hook name. Supply that call with the
|
function of the Python module corresponding to the given hook name. Supply that call with the
|
||||||
configuration for this hook, the log prefix, and any given args and kwargs. Return any return
|
configuration for this hook (if any), the log prefix, and any given args and kwargs. Return any
|
||||||
value.
|
return value.
|
||||||
|
|
||||||
If the hook name is not present in the hooks configuration, then bail without calling anything.
|
|
||||||
|
|
||||||
Raise ValueError if the hook name is unknown.
|
Raise ValueError if the hook name is unknown.
|
||||||
Raise AttributeError if the function name is not found in the module.
|
Raise AttributeError if the function name is not found in the module.
|
||||||
Raise anything else that the called function raises.
|
Raise anything else that the called function raises.
|
||||||
'''
|
'''
|
||||||
config = hooks.get(hook_name)
|
config = hooks.get(hook_name, {})
|
||||||
if not config:
|
|
||||||
logger.debug('{}: No {} hook configured.'.format(log_prefix, hook_name))
|
|
||||||
return
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
module = HOOK_NAME_TO_MODULE[hook_name]
|
module = HOOK_NAME_TO_MODULE[hook_name]
|
||||||
except KeyError:
|
except KeyError:
|
||||||
raise ValueError('Unknown hook name: {}'.format(hook_name))
|
raise ValueError(f'Unknown hook name: {hook_name}')
|
||||||
|
|
||||||
logger.debug('{}: Calling {} hook function {}'.format(log_prefix, hook_name, function_name))
|
logger.debug(f'{log_prefix}: Calling {hook_name} hook function {function_name}')
|
||||||
return getattr(module, function_name)(config, log_prefix, *args, **kwargs)
|
return getattr(module, function_name)(config, log_prefix, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
@ -47,7 +56,7 @@ def call_hooks(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
||||||
configuration for that hook, the log prefix, and any given args and kwargs. Collect any return
|
configuration for that hook, the log prefix, and any given args and kwargs. Collect any return
|
||||||
values into a dict from hook name to return value.
|
values into a dict from hook name to return value.
|
||||||
|
|
||||||
If the hook name is not present in the hooks configuration, then don't call the function for it,
|
If the hook name is not present in the hooks configuration, then don't call the function for it
|
||||||
and omit it from the return values.
|
and omit it from the return values.
|
||||||
|
|
||||||
Raise ValueError if the hook name is unknown.
|
Raise ValueError if the hook name is unknown.
|
||||||
|
@ -57,5 +66,21 @@ def call_hooks(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
||||||
return {
|
return {
|
||||||
hook_name: call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs)
|
hook_name: call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs)
|
||||||
for hook_name in hook_names
|
for hook_name in hook_names
|
||||||
if hook_name in hooks
|
if hooks.get(hook_name)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def call_hooks_even_if_unconfigured(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
||||||
|
'''
|
||||||
|
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
||||||
|
function of the Python module corresponding to each given hook name. Supply each call with the
|
||||||
|
configuration for that hook, the log prefix, and any given args and kwargs. Collect any return
|
||||||
|
values into a dict from hook name to return value.
|
||||||
|
|
||||||
|
Raise AttributeError if the function name is not found in the module.
|
||||||
|
Raise anything else that a called function raises. An error stops calls to subsequent functions.
|
||||||
|
'''
|
||||||
|
return {
|
||||||
|
hook_name: call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs)
|
||||||
|
for hook_name in hook_names
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,10 +1,28 @@
|
||||||
import glob
|
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import shutil
|
||||||
|
|
||||||
|
from borgmatic.borg.state import DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
DATABASE_HOOK_NAMES = ('postgresql_databases', 'mysql_databases')
|
DATABASE_HOOK_NAMES = (
|
||||||
|
'postgresql_databases',
|
||||||
|
'mysql_databases',
|
||||||
|
'mongodb_databases',
|
||||||
|
'sqlite_databases',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def make_database_dump_path(borgmatic_source_directory, database_hook_name):
|
||||||
|
'''
|
||||||
|
Given a borgmatic source directory (or None) and a database hook name, construct a database dump
|
||||||
|
path.
|
||||||
|
'''
|
||||||
|
if not borgmatic_source_directory:
|
||||||
|
borgmatic_source_directory = DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
|
return os.path.join(borgmatic_source_directory, database_hook_name)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_filename(dump_path, name, hostname=None):
|
def make_database_dump_filename(dump_path, name, hostname=None):
|
||||||
|
@ -15,66 +33,42 @@ def make_database_dump_filename(dump_path, name, hostname=None):
|
||||||
Raise ValueError if the database name is invalid.
|
Raise ValueError if the database name is invalid.
|
||||||
'''
|
'''
|
||||||
if os.path.sep in name:
|
if os.path.sep in name:
|
||||||
raise ValueError('Invalid database name {}'.format(name))
|
raise ValueError(f'Invalid database name {name}')
|
||||||
|
|
||||||
return os.path.join(os.path.expanduser(dump_path), hostname or 'localhost', name)
|
return os.path.join(os.path.expanduser(dump_path), hostname or 'localhost', name)
|
||||||
|
|
||||||
|
|
||||||
def flatten_dump_patterns(dump_patterns, names):
|
def create_parent_directory_for_dump(dump_path):
|
||||||
'''
|
'''
|
||||||
Given a dict from a database hook name to glob patterns matching the dumps for the named
|
Create a directory to contain the given dump path.
|
||||||
databases, flatten out all the glob patterns into a single sequence, and return it.
|
|
||||||
|
|
||||||
Raise ValueError if there are no resulting glob patterns, which indicates that databases are not
|
|
||||||
configured in borgmatic's configuration.
|
|
||||||
'''
|
'''
|
||||||
flattened = [pattern for patterns in dump_patterns.values() for pattern in patterns]
|
os.makedirs(os.path.dirname(dump_path), mode=0o700, exist_ok=True)
|
||||||
|
|
||||||
if not flattened:
|
|
||||||
raise ValueError(
|
|
||||||
'Cannot restore database(s) {} missing from borgmatic\'s configuration'.format(
|
|
||||||
', '.join(names) or '"all"'
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
return flattened
|
|
||||||
|
|
||||||
|
|
||||||
def remove_database_dumps(dump_path, databases, database_type_name, log_prefix, dry_run):
|
def create_named_pipe_for_dump(dump_path):
|
||||||
'''
|
'''
|
||||||
Remove the database dumps for the given databases in the dump directory path. The databases are
|
Create a named pipe at the given dump path.
|
||||||
supplied as a sequence of dicts, one dict describing each database as per the configuration
|
|
||||||
schema. Use the name of the database type and the log prefix in any log entries. If this is a
|
|
||||||
dry run, then don't actually remove anything.
|
|
||||||
'''
|
'''
|
||||||
if not databases:
|
create_parent_directory_for_dump(dump_path)
|
||||||
logger.debug('{}: No {} databases configured'.format(log_prefix, database_type_name))
|
os.mkfifo(dump_path, mode=0o600)
|
||||||
return
|
|
||||||
|
|
||||||
|
|
||||||
|
def remove_database_dumps(dump_path, database_type_name, log_prefix, dry_run):
|
||||||
|
'''
|
||||||
|
Remove all database dumps in the given dump directory path (including the directory itself). If
|
||||||
|
this is a dry run, then don't actually remove anything.
|
||||||
|
'''
|
||||||
dry_run_label = ' (dry run; not actually removing anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually removing anything)' if dry_run else ''
|
||||||
|
|
||||||
logger.info(
|
logger.debug(f'{log_prefix}: Removing {database_type_name} database dumps{dry_run_label}')
|
||||||
'{}: Removing {} database dumps{}'.format(log_prefix, database_type_name, dry_run_label)
|
|
||||||
)
|
|
||||||
|
|
||||||
for database in databases:
|
expanded_path = os.path.expanduser(dump_path)
|
||||||
dump_filename = make_database_dump_filename(
|
|
||||||
dump_path, database['name'], database.get('hostname')
|
|
||||||
)
|
|
||||||
|
|
||||||
logger.debug(
|
if dry_run:
|
||||||
'{}: Removing {} database dump {} from {}{}'.format(
|
return
|
||||||
log_prefix, database_type_name, database['name'], dump_filename, dry_run_label
|
|
||||||
)
|
|
||||||
)
|
|
||||||
if dry_run:
|
|
||||||
continue
|
|
||||||
|
|
||||||
os.remove(dump_filename)
|
if os.path.exists(expanded_path):
|
||||||
dump_file_dir = os.path.dirname(dump_filename)
|
shutil.rmtree(expanded_path)
|
||||||
|
|
||||||
if len(os.listdir(dump_file_dir)) == 0:
|
|
||||||
os.rmdir(dump_file_dir)
|
|
||||||
|
|
||||||
|
|
||||||
def convert_glob_patterns_to_borg_patterns(patterns):
|
def convert_glob_patterns_to_borg_patterns(patterns):
|
||||||
|
@ -82,81 +76,4 @@ def convert_glob_patterns_to_borg_patterns(patterns):
|
||||||
Convert a sequence of shell glob patterns like "/etc/*" to the corresponding Borg archive
|
Convert a sequence of shell glob patterns like "/etc/*" to the corresponding Borg archive
|
||||||
patterns like "sh:etc/*".
|
patterns like "sh:etc/*".
|
||||||
'''
|
'''
|
||||||
return ['sh:{}'.format(pattern.lstrip(os.path.sep)) for pattern in patterns]
|
return [f'sh:{pattern.lstrip(os.path.sep)}' for pattern in patterns]
|
||||||
|
|
||||||
|
|
||||||
def get_database_names_from_dumps(patterns):
|
|
||||||
'''
|
|
||||||
Given a sequence of database dump patterns, find the corresponding database dumps on disk and
|
|
||||||
return the database names from their filenames.
|
|
||||||
'''
|
|
||||||
return [os.path.basename(dump_path) for pattern in patterns for dump_path in glob.glob(pattern)]
|
|
||||||
|
|
||||||
|
|
||||||
def get_database_configurations(databases, names):
|
|
||||||
'''
|
|
||||||
Given the full database configuration dicts as per the configuration schema, and a sequence of
|
|
||||||
database names, filter down and yield the configuration for just the named databases.
|
|
||||||
Additionally, if a database configuration is named "all", project out that configuration for
|
|
||||||
each named database.
|
|
||||||
'''
|
|
||||||
named_databases = {database['name']: database for database in databases}
|
|
||||||
|
|
||||||
for name in names:
|
|
||||||
database = named_databases.get(name)
|
|
||||||
if database:
|
|
||||||
yield database
|
|
||||||
continue
|
|
||||||
|
|
||||||
if 'all' in named_databases:
|
|
||||||
yield {**named_databases['all'], **{'name': name}}
|
|
||||||
continue
|
|
||||||
|
|
||||||
|
|
||||||
def get_per_hook_database_configurations(hooks, names, dump_patterns):
|
|
||||||
'''
|
|
||||||
Given the hooks configuration dict as per the configuration schema, a sequence of database
|
|
||||||
names to restore, and a dict from database hook name to glob patterns for matching dumps,
|
|
||||||
filter down the configuration for just the named databases.
|
|
||||||
|
|
||||||
If there are no named databases given, then find the corresponding database dumps on disk and
|
|
||||||
use the database names from their filenames. Additionally, if a database configuration is named
|
|
||||||
"all", project out that configuration for each named database.
|
|
||||||
|
|
||||||
Return the results as a dict from database hook name to a sequence of database configuration
|
|
||||||
dicts for that database type.
|
|
||||||
|
|
||||||
Raise ValueError if one of the database names cannot be matched to a database in borgmatic's
|
|
||||||
database configuration.
|
|
||||||
'''
|
|
||||||
hook_databases = {
|
|
||||||
hook_name: list(
|
|
||||||
get_database_configurations(
|
|
||||||
hooks.get(hook_name),
|
|
||||||
names or get_database_names_from_dumps(dump_patterns[hook_name]),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
for hook_name in DATABASE_HOOK_NAMES
|
|
||||||
if hook_name in hooks
|
|
||||||
}
|
|
||||||
|
|
||||||
if not names or 'all' in names:
|
|
||||||
if not any(hook_databases.values()):
|
|
||||||
raise ValueError(
|
|
||||||
'Cannot restore database "all", as there are no database dumps in the archive'
|
|
||||||
)
|
|
||||||
|
|
||||||
return hook_databases
|
|
||||||
|
|
||||||
found_names = {
|
|
||||||
database['name'] for databases in hook_databases.values() for database in databases
|
|
||||||
}
|
|
||||||
missing_names = sorted(set(names) - found_names)
|
|
||||||
if missing_names:
|
|
||||||
raise ValueError(
|
|
||||||
'Cannot restore database(s) {} missing from borgmatic\'s configuration'.format(
|
|
||||||
', '.join(missing_names)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
return hook_databases
|
|
||||||
|
|
|
@ -10,31 +10,37 @@ MONITOR_STATE_TO_HEALTHCHECKS = {
|
||||||
monitor.State.START: 'start',
|
monitor.State.START: 'start',
|
||||||
monitor.State.FINISH: None, # Healthchecks doesn't append to the URL for the finished state.
|
monitor.State.FINISH: None, # Healthchecks doesn't append to the URL for the finished state.
|
||||||
monitor.State.FAIL: 'fail',
|
monitor.State.FAIL: 'fail',
|
||||||
|
monitor.State.LOG: 'log',
|
||||||
}
|
}
|
||||||
|
|
||||||
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
||||||
PAYLOAD_LIMIT_BYTES = 10 * 1024 - len(PAYLOAD_TRUNCATION_INDICATOR)
|
DEFAULT_PING_BODY_LIMIT_BYTES = 100000
|
||||||
|
|
||||||
|
|
||||||
class Forgetful_buffering_handler(logging.Handler):
|
class Forgetful_buffering_handler(logging.Handler):
|
||||||
'''
|
'''
|
||||||
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
||||||
first) once a particular capacity in bytes is reached.
|
first) once a particular capacity in bytes is reached. But if the given byte capacity is zero,
|
||||||
|
don't throw away any messages.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def __init__(self, byte_capacity):
|
def __init__(self, byte_capacity, log_level):
|
||||||
super().__init__()
|
super().__init__()
|
||||||
|
|
||||||
self.byte_capacity = byte_capacity
|
self.byte_capacity = byte_capacity
|
||||||
self.byte_count = 0
|
self.byte_count = 0
|
||||||
self.buffer = []
|
self.buffer = []
|
||||||
self.forgot = False
|
self.forgot = False
|
||||||
|
self.setLevel(log_level)
|
||||||
|
|
||||||
def emit(self, record):
|
def emit(self, record):
|
||||||
message = record.getMessage() + '\n'
|
message = record.getMessage() + '\n'
|
||||||
self.byte_count += len(message)
|
self.byte_count += len(message)
|
||||||
self.buffer.append(message)
|
self.buffer.append(message)
|
||||||
|
|
||||||
|
if not self.byte_capacity:
|
||||||
|
return
|
||||||
|
|
||||||
while self.byte_count > self.byte_capacity and self.buffer:
|
while self.byte_count > self.byte_capacity and self.buffer:
|
||||||
self.byte_count -= len(self.buffer[0])
|
self.byte_count -= len(self.buffer[0])
|
||||||
self.buffer.pop(0)
|
self.buffer.pop(0)
|
||||||
|
@ -64,37 +70,76 @@ def format_buffered_logs_for_payload():
|
||||||
return payload
|
return payload
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(ping_url_or_uuid, config_filename, state, dry_run):
|
def initialize_monitor(hook_config, config_filename, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the given Healthchecks URL or UUID, modified with the monitor.State. Use the given
|
Add a handler to the root logger that stores in memory the most recent logs emitted. That way,
|
||||||
configuration filename in any log entries. If this is a dry run, then don't actually ping
|
we can send them all to Healthchecks upon a finish or failure state. But skip this if the
|
||||||
anything.
|
"send_logs" option is false.
|
||||||
'''
|
'''
|
||||||
if state is monitor.State.START:
|
if hook_config.get('send_logs') is False:
|
||||||
# Add a handler to the root logger that stores in memory the most recent logs emitted. That
|
return
|
||||||
# way, we can send them all to Healthchecks upon a finish or failure state.
|
|
||||||
logging.getLogger().addHandler(Forgetful_buffering_handler(PAYLOAD_LIMIT_BYTES))
|
|
||||||
payload = ''
|
|
||||||
|
|
||||||
|
ping_body_limit = max(
|
||||||
|
hook_config.get('ping_body_limit', DEFAULT_PING_BODY_LIMIT_BYTES)
|
||||||
|
- len(PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
|
||||||
|
logging.getLogger().addHandler(
|
||||||
|
Forgetful_buffering_handler(ping_body_limit, monitoring_log_level)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Ping the configured Healthchecks URL or UUID, modified with the monitor.State. Use the given
|
||||||
|
configuration filename in any log entries, and log to Healthchecks with the giving log level.
|
||||||
|
If this is a dry run, then don't actually ping anything.
|
||||||
|
'''
|
||||||
ping_url = (
|
ping_url = (
|
||||||
ping_url_or_uuid
|
hook_config['ping_url']
|
||||||
if ping_url_or_uuid.startswith('http')
|
if hook_config['ping_url'].startswith('http')
|
||||||
else 'https://hc-ping.com/{}'.format(ping_url_or_uuid)
|
else f"https://hc-ping.com/{hook_config['ping_url']}"
|
||||||
)
|
)
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
|
|
||||||
|
if 'states' in hook_config and state.name.lower() not in hook_config['states']:
|
||||||
|
logger.info(
|
||||||
|
f'{config_filename}: Skipping Healthchecks {state.name.lower()} ping due to configured states'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
||||||
if healthchecks_state:
|
if healthchecks_state:
|
||||||
ping_url = '{}/{}'.format(ping_url, healthchecks_state)
|
ping_url = f'{ping_url}/{healthchecks_state}'
|
||||||
|
|
||||||
logger.info(
|
logger.info(f'{config_filename}: Pinging Healthchecks {state.name.lower()}{dry_run_label}')
|
||||||
'{}: Pinging Healthchecks {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
logger.debug(f'{config_filename}: Using Healthchecks ping URL {ping_url}')
|
||||||
)
|
|
||||||
logger.debug('{}: Using Healthchecks ping URL {}'.format(config_filename, ping_url))
|
|
||||||
|
|
||||||
if state in (monitor.State.FINISH, monitor.State.FAIL):
|
if state in (monitor.State.FINISH, monitor.State.FAIL, monitor.State.LOG):
|
||||||
payload = format_buffered_logs_for_payload()
|
payload = format_buffered_logs_for_payload()
|
||||||
|
else:
|
||||||
|
payload = ''
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.post(ping_url, data=payload.encode('utf-8'))
|
try:
|
||||||
|
response = requests.post(
|
||||||
|
ping_url, data=payload.encode('utf-8'), verify=hook_config.get('verify_tls', True)
|
||||||
|
)
|
||||||
|
if not response.ok:
|
||||||
|
response.raise_for_status()
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: Healthchecks error: {error}')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(hook_config, config_filename, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
||||||
|
getting reused by other instances of this monitor.
|
||||||
|
'''
|
||||||
|
logger = logging.getLogger()
|
||||||
|
|
||||||
|
for handler in tuple(logger.handlers):
|
||||||
|
if isinstance(handler, Forgetful_buffering_handler):
|
||||||
|
logger.removeHandler(handler)
|
||||||
|
|
164
borgmatic/hooks/mongodb.py
Normal file
164
borgmatic/hooks/mongodb.py
Normal file
|
@ -0,0 +1,164 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from borgmatic.execute import execute_command, execute_command_with_processes
|
||||||
|
from borgmatic.hooks import dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def make_dump_path(location_config): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Make the dump path from the given location configuration and the name of this hook.
|
||||||
|
'''
|
||||||
|
return dump.make_database_dump_path(
|
||||||
|
location_config.get('borgmatic_source_directory'), 'mongodb_databases'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_databases(databases, log_prefix, location_config, dry_run):
|
||||||
|
'''
|
||||||
|
Dump the given MongoDB databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
dicts, one dict describing each database as per the configuration schema. Use the given log
|
||||||
|
prefix in any log entries. Use the given location configuration dict to construct the
|
||||||
|
destination path.
|
||||||
|
|
||||||
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
|
||||||
|
logger.info(f'{log_prefix}: Dumping MongoDB databases{dry_run_label}')
|
||||||
|
|
||||||
|
processes = []
|
||||||
|
for database in databases:
|
||||||
|
name = database['name']
|
||||||
|
dump_filename = dump.make_database_dump_filename(
|
||||||
|
make_dump_path(location_config), name, database.get('hostname')
|
||||||
|
)
|
||||||
|
dump_format = database.get('format', 'archive')
|
||||||
|
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping MongoDB database {name} to {dump_filename}{dry_run_label}',
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
|
command = build_dump_command(database, dump_filename, dump_format)
|
||||||
|
|
||||||
|
if dump_format == 'directory':
|
||||||
|
dump.create_parent_directory_for_dump(dump_filename)
|
||||||
|
execute_command(command, shell=True)
|
||||||
|
else:
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
processes.append(execute_command(command, shell=True, run_to_completion=False))
|
||||||
|
|
||||||
|
return processes
|
||||||
|
|
||||||
|
|
||||||
|
def build_dump_command(database, dump_filename, dump_format):
|
||||||
|
'''
|
||||||
|
Return the mongodump command from a single database configuration.
|
||||||
|
'''
|
||||||
|
all_databases = database['name'] == 'all'
|
||||||
|
command = ['mongodump']
|
||||||
|
if dump_format == 'directory':
|
||||||
|
command.extend(('--out', dump_filename))
|
||||||
|
if 'hostname' in database:
|
||||||
|
command.extend(('--host', database['hostname']))
|
||||||
|
if 'port' in database:
|
||||||
|
command.extend(('--port', str(database['port'])))
|
||||||
|
if 'username' in database:
|
||||||
|
command.extend(('--username', database['username']))
|
||||||
|
if 'password' in database:
|
||||||
|
command.extend(('--password', database['password']))
|
||||||
|
if 'authentication_database' in database:
|
||||||
|
command.extend(('--authenticationDatabase', database['authentication_database']))
|
||||||
|
if not all_databases:
|
||||||
|
command.extend(('--db', database['name']))
|
||||||
|
if 'options' in database:
|
||||||
|
command.extend(database['options'].split(' '))
|
||||||
|
if dump_format != 'directory':
|
||||||
|
command.extend(('--archive', '>', dump_filename))
|
||||||
|
return command
|
||||||
|
|
||||||
|
|
||||||
|
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Remove all database dump files for this hook regardless of the given databases. Use the log
|
||||||
|
prefix in any log entries. Use the given location configuration dict to construct the
|
||||||
|
destination path. If this is a dry run, then don't actually remove anything.
|
||||||
|
'''
|
||||||
|
dump.remove_database_dumps(make_dump_path(location_config), 'MongoDB', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
|
def make_database_dump_pattern(
|
||||||
|
databases, log_prefix, location_config, name=None
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Given a sequence of configurations dicts, a prefix to log with, a location configuration dict,
|
||||||
|
and a database name to match, return the corresponding glob patterns to match the database dump
|
||||||
|
in an archive.
|
||||||
|
'''
|
||||||
|
return dump.make_database_dump_filename(make_dump_path(location_config), name, hostname='*')
|
||||||
|
|
||||||
|
|
||||||
|
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
||||||
|
'''
|
||||||
|
Restore the given MongoDB database from an extract stream. The database is supplied as a
|
||||||
|
one-element sequence containing a dict describing the database, as per the configuration schema.
|
||||||
|
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
||||||
|
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
||||||
|
output to consume.
|
||||||
|
|
||||||
|
If the extract process is None, then restore the dump from the filesystem rather than from an
|
||||||
|
extract stream.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
|
||||||
|
if len(database_config) != 1:
|
||||||
|
raise ValueError('The database configuration value is invalid')
|
||||||
|
|
||||||
|
database = database_config[0]
|
||||||
|
dump_filename = dump.make_database_dump_filename(
|
||||||
|
make_dump_path(location_config), database['name'], database.get('hostname')
|
||||||
|
)
|
||||||
|
restore_command = build_restore_command(extract_process, database, dump_filename)
|
||||||
|
|
||||||
|
logger.debug(f"{log_prefix}: Restoring MongoDB database {database['name']}{dry_run_label}")
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
|
execute_command_with_processes(
|
||||||
|
restore_command,
|
||||||
|
[extract_process] if extract_process else [],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout if extract_process else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def build_restore_command(extract_process, database, dump_filename):
|
||||||
|
'''
|
||||||
|
Return the mongorestore command from a single database configuration.
|
||||||
|
'''
|
||||||
|
command = ['mongorestore']
|
||||||
|
if extract_process:
|
||||||
|
command.append('--archive')
|
||||||
|
else:
|
||||||
|
command.extend(('--dir', dump_filename))
|
||||||
|
if database['name'] != 'all':
|
||||||
|
command.extend(('--drop', '--db', database['name']))
|
||||||
|
if 'hostname' in database:
|
||||||
|
command.extend(('--host', database['hostname']))
|
||||||
|
if 'port' in database:
|
||||||
|
command.extend(('--port', str(database['port'])))
|
||||||
|
if 'username' in database:
|
||||||
|
command.extend(('--username', database['username']))
|
||||||
|
if 'password' in database:
|
||||||
|
command.extend(('--password', database['password']))
|
||||||
|
if 'authentication_database' in database:
|
||||||
|
command.extend(('--authenticationDatabase', database['authentication_database']))
|
||||||
|
if 'restore_options' in database:
|
||||||
|
command.extend(database['restore_options'].split(' '))
|
||||||
|
return command
|
|
@ -1,9 +1,10 @@
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
|
|
||||||
MONITOR_HOOK_NAMES = ('healthchecks', 'cronitor', 'cronhub')
|
MONITOR_HOOK_NAMES = ('healthchecks', 'cronitor', 'cronhub', 'pagerduty', 'ntfy')
|
||||||
|
|
||||||
|
|
||||||
class State(Enum):
|
class State(Enum):
|
||||||
START = 1
|
START = 1
|
||||||
FINISH = 2
|
FINISH = 2
|
||||||
FAIL = 3
|
FAIL = 3
|
||||||
|
LOG = 4
|
||||||
|
|
|
@ -1,94 +1,222 @@
|
||||||
|
import copy
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import (
|
||||||
|
execute_command,
|
||||||
|
execute_command_and_capture_output,
|
||||||
|
execute_command_with_processes,
|
||||||
|
)
|
||||||
from borgmatic.hooks import dump
|
from borgmatic.hooks import dump
|
||||||
|
|
||||||
DUMP_PATH = '~/.borgmatic/mysql_databases'
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def dump_databases(databases, log_prefix, dry_run):
|
def make_dump_path(location_config): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Dump the given MySQL/MariaDB databases to disk. The databases are supplied as a sequence of
|
Make the dump path from the given location configuration and the name of this hook.
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the given log
|
'''
|
||||||
prefix in any log entries. If this is a dry run, then don't actually dump anything.
|
return dump.make_database_dump_path(
|
||||||
|
location_config.get('borgmatic_source_directory'), 'mysql_databases'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
SYSTEM_DATABASE_NAMES = ('information_schema', 'mysql', 'performance_schema', 'sys')
|
||||||
|
|
||||||
|
|
||||||
|
def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
|
'''
|
||||||
|
Given a requested database config, return the corresponding sequence of database names to dump.
|
||||||
|
In the case of "all", query for the names of databases on the configured host and return them,
|
||||||
|
excluding any system databases that will cause problems during restore.
|
||||||
|
'''
|
||||||
|
if database['name'] != 'all':
|
||||||
|
return (database['name'],)
|
||||||
|
if dry_run:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
show_command = (
|
||||||
|
('mysql',)
|
||||||
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
||||||
|
+ (('--user', database['username']) if 'username' in database else ())
|
||||||
|
+ ('--skip-column-names', '--batch')
|
||||||
|
+ ('--execute', 'show schemas')
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_prefix}: Querying for "all" MySQL databases to dump')
|
||||||
|
show_output = execute_command_and_capture_output(
|
||||||
|
show_command, extra_environment=extra_environment
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
show_name
|
||||||
|
for show_name in show_output.strip().splitlines()
|
||||||
|
if show_name not in SYSTEM_DATABASE_NAMES
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def execute_dump_command(
|
||||||
|
database, log_prefix, dump_path, database_names, extra_environment, dry_run, dry_run_label
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Kick off a dump for the given MySQL/MariaDB database (provided as a configuration dict) to a
|
||||||
|
named pipe constructed from the given dump path and database names. Use the given log prefix in
|
||||||
|
any log entries.
|
||||||
|
|
||||||
|
Return a subprocess.Popen instance for the dump process ready to spew to a named pipe. But if
|
||||||
|
this is a dry run, then don't actually dump anything and return None.
|
||||||
|
'''
|
||||||
|
database_name = database['name']
|
||||||
|
dump_filename = dump.make_database_dump_filename(
|
||||||
|
dump_path, database['name'], database.get('hostname')
|
||||||
|
)
|
||||||
|
if os.path.exists(dump_filename):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: Skipping duplicate dump of MySQL database "{database_name}" to {dump_filename}'
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
dump_command = (
|
||||||
|
('mysqldump',)
|
||||||
|
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
||||||
|
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
||||||
|
+ (('--user', database['username']) if 'username' in database else ())
|
||||||
|
+ ('--databases',)
|
||||||
|
+ database_names
|
||||||
|
+ ('--result-file', dump_filename)
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping MySQL database "{database_name}" to {dump_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
return None
|
||||||
|
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
|
||||||
|
return execute_command(
|
||||||
|
dump_command, extra_environment=extra_environment, run_to_completion=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_databases(databases, log_prefix, location_config, dry_run):
|
||||||
|
'''
|
||||||
|
Dump the given MySQL/MariaDB databases to a named pipe. The databases are supplied as a sequence
|
||||||
|
of dicts, one dict describing each database as per the configuration schema. Use the given log
|
||||||
|
prefix in any log entries. Use the given location configuration dict to construct the
|
||||||
|
destination path.
|
||||||
|
|
||||||
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
processes = []
|
||||||
|
|
||||||
logger.info('{}: Dumping MySQL databases{}'.format(log_prefix, dry_run_label))
|
logger.info(f'{log_prefix}: Dumping MySQL databases{dry_run_label}')
|
||||||
|
|
||||||
for database in databases:
|
for database in databases:
|
||||||
name = database['name']
|
dump_path = make_dump_path(location_config)
|
||||||
dump_filename = dump.make_database_dump_filename(DUMP_PATH, name, database.get('hostname'))
|
|
||||||
command = (
|
|
||||||
('mysqldump', '--add-drop-database')
|
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
|
||||||
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
|
||||||
+ (('--user', database['username']) if 'username' in database else ())
|
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
|
||||||
+ (('--all-databases',) if name == 'all' else ('--databases', name))
|
|
||||||
)
|
|
||||||
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
||||||
|
dump_database_names = database_names_to_dump(
|
||||||
logger.debug(
|
database, extra_environment, log_prefix, dry_run
|
||||||
'{}: Dumping MySQL database {} to {}{}'.format(
|
|
||||||
log_prefix, name, dump_filename, dry_run_label
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
if not dry_run:
|
|
||||||
os.makedirs(os.path.dirname(dump_filename), mode=0o700, exist_ok=True)
|
if not dump_database_names:
|
||||||
execute_command(
|
if dry_run:
|
||||||
command, output_file=open(dump_filename, 'w'), extra_environment=extra_environment
|
continue
|
||||||
|
|
||||||
|
raise ValueError('Cannot find any MySQL databases to dump.')
|
||||||
|
|
||||||
|
if database['name'] == 'all' and database.get('format'):
|
||||||
|
for dump_name in dump_database_names:
|
||||||
|
renamed_database = copy.copy(database)
|
||||||
|
renamed_database['name'] = dump_name
|
||||||
|
processes.append(
|
||||||
|
execute_dump_command(
|
||||||
|
renamed_database,
|
||||||
|
log_prefix,
|
||||||
|
dump_path,
|
||||||
|
(dump_name,),
|
||||||
|
extra_environment,
|
||||||
|
dry_run,
|
||||||
|
dry_run_label,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
processes.append(
|
||||||
|
execute_dump_command(
|
||||||
|
database,
|
||||||
|
log_prefix,
|
||||||
|
dump_path,
|
||||||
|
dump_database_names,
|
||||||
|
extra_environment,
|
||||||
|
dry_run,
|
||||||
|
dry_run_label,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
return [process for process in processes if process]
|
||||||
def remove_database_dumps(databases, log_prefix, dry_run): # pragma: no cover
|
|
||||||
'''
|
|
||||||
Remove the database dumps for the given databases. The databases are supplied as a sequence of
|
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the log prefix in
|
|
||||||
any log entries. If this is a dry run, then don't actually remove anything.
|
|
||||||
'''
|
|
||||||
dump.remove_database_dumps(DUMP_PATH, databases, 'MySQL', log_prefix, dry_run)
|
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_patterns(databases, log_prefix, names):
|
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Given a sequence of configurations dicts, a prefix to log with, and a sequence of database
|
Remove all database dump files for this hook regardless of the given databases. Use the log
|
||||||
names to match, return the corresponding glob patterns to match the database dumps in an
|
prefix in any log entries. Use the given location configuration dict to construct the
|
||||||
archive. An empty sequence of names indicates that the patterns should match all dumps.
|
destination path. If this is a dry run, then don't actually remove anything.
|
||||||
'''
|
'''
|
||||||
return [
|
dump.remove_database_dumps(make_dump_path(location_config), 'MySQL', log_prefix, dry_run)
|
||||||
dump.make_database_dump_filename(DUMP_PATH, name, hostname='*') for name in (names or ['*'])
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def restore_database_dumps(databases, log_prefix, dry_run):
|
def make_database_dump_pattern(
|
||||||
|
databases, log_prefix, location_config, name=None
|
||||||
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Restore the given MySQL/MariaDB databases from disk. The databases are supplied as a sequence of
|
Given a sequence of configurations dicts, a prefix to log with, a location configuration dict,
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the given log
|
and a database name to match, return the corresponding glob patterns to match the database dump
|
||||||
prefix in any log entries. If this is a dry run, then don't actually restore anything.
|
in an archive.
|
||||||
|
'''
|
||||||
|
return dump.make_database_dump_filename(make_dump_path(location_config), name, hostname='*')
|
||||||
|
|
||||||
|
|
||||||
|
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
||||||
|
'''
|
||||||
|
Restore the given MySQL/MariaDB database from an extract stream. The database is supplied as a
|
||||||
|
one-element sequence containing a dict describing the database, as per the configuration schema.
|
||||||
|
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
||||||
|
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
||||||
|
output to consume.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
|
||||||
for database in databases:
|
if len(database_config) != 1:
|
||||||
dump_filename = dump.make_database_dump_filename(
|
raise ValueError('The database configuration value is invalid')
|
||||||
DUMP_PATH, database['name'], database.get('hostname')
|
|
||||||
)
|
|
||||||
restore_command = (
|
|
||||||
('mysql', '--batch')
|
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
|
||||||
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
|
||||||
+ (('--user', database['username']) if 'username' in database else ())
|
|
||||||
)
|
|
||||||
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
|
||||||
|
|
||||||
logger.debug(
|
database = database_config[0]
|
||||||
'{}: Restoring MySQL database {}{}'.format(log_prefix, database['name'], dry_run_label)
|
restore_command = (
|
||||||
)
|
('mysql', '--batch')
|
||||||
if not dry_run:
|
+ (tuple(database['restore_options'].split(' ')) if 'restore_options' in database else ())
|
||||||
execute_command(
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
restore_command, input_file=open(dump_filename), extra_environment=extra_environment
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
)
|
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
||||||
|
+ (('--user', database['username']) if 'username' in database else ())
|
||||||
|
)
|
||||||
|
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
||||||
|
|
||||||
|
logger.debug(f"{log_prefix}: Restoring MySQL database {database['name']}{dry_run_label}")
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
|
execute_command_with_processes(
|
||||||
|
restore_command,
|
||||||
|
[extract_process],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
)
|
||||||
|
|
83
borgmatic/hooks/ntfy.py
Normal file
83
borgmatic/hooks/ntfy.py
Normal file
|
@ -0,0 +1,83 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def initialize_monitor(
|
||||||
|
ping_url, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
No initialization is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Ping the configured Ntfy topic. Use the given configuration filename in any log entries.
|
||||||
|
If this is a dry run, then don't actually ping anything.
|
||||||
|
'''
|
||||||
|
|
||||||
|
run_states = hook_config.get('states', ['fail'])
|
||||||
|
|
||||||
|
if state.name.lower() in run_states:
|
||||||
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
|
|
||||||
|
state_config = hook_config.get(
|
||||||
|
state.name.lower(),
|
||||||
|
{
|
||||||
|
'title': f'A Borgmatic {state.name} event happened',
|
||||||
|
'message': f'A Borgmatic {state.name} event happened',
|
||||||
|
'priority': 'default',
|
||||||
|
'tags': 'borgmatic',
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
base_url = hook_config.get('server', 'https://ntfy.sh')
|
||||||
|
topic = hook_config.get('topic')
|
||||||
|
|
||||||
|
logger.info(f'{config_filename}: Pinging ntfy topic {topic}{dry_run_label}')
|
||||||
|
logger.debug(f'{config_filename}: Using Ntfy ping URL {base_url}/{topic}')
|
||||||
|
|
||||||
|
headers = {
|
||||||
|
'X-Title': state_config.get('title'),
|
||||||
|
'X-Message': state_config.get('message'),
|
||||||
|
'X-Priority': state_config.get('priority'),
|
||||||
|
'X-Tags': state_config.get('tags'),
|
||||||
|
}
|
||||||
|
|
||||||
|
username = hook_config.get('username')
|
||||||
|
password = hook_config.get('password')
|
||||||
|
|
||||||
|
auth = None
|
||||||
|
if (username and password) is not None:
|
||||||
|
auth = requests.auth.HTTPBasicAuth(username, password)
|
||||||
|
logger.info(f'{config_filename}: Using basic auth with user {username} for ntfy')
|
||||||
|
elif username is not None:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: Password missing for ntfy authentication, defaulting to no auth'
|
||||||
|
)
|
||||||
|
elif password is not None:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: Username missing for ntfy authentication, defaulting to no auth'
|
||||||
|
)
|
||||||
|
|
||||||
|
if not dry_run:
|
||||||
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
|
try:
|
||||||
|
response = requests.post(f'{base_url}/{topic}', headers=headers, auth=auth)
|
||||||
|
if not response.ok:
|
||||||
|
response.raise_for_status()
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: ntfy error: {error}')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(
|
||||||
|
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
No destruction is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
83
borgmatic/hooks/pagerduty.py
Normal file
83
borgmatic/hooks/pagerduty.py
Normal file
|
@ -0,0 +1,83 @@
|
||||||
|
import datetime
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import platform
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
from borgmatic.hooks import monitor
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
EVENTS_API_URL = 'https://events.pagerduty.com/v2/enqueue'
|
||||||
|
|
||||||
|
|
||||||
|
def initialize_monitor(
|
||||||
|
integration_key, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
No initialization is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
If this is an error state, create a PagerDuty event with the configured integration key. Use
|
||||||
|
the given configuration filename in any log entries. If this is a dry run, then don't actually
|
||||||
|
create an event.
|
||||||
|
'''
|
||||||
|
if state != monitor.State.FAIL:
|
||||||
|
logger.debug(
|
||||||
|
f'{config_filename}: Ignoring unsupported monitoring {state.name.lower()} in PagerDuty hook',
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
dry_run_label = ' (dry run; not actually sending)' if dry_run else ''
|
||||||
|
logger.info(f'{config_filename}: Sending failure event to PagerDuty {dry_run_label}')
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
hostname = platform.node()
|
||||||
|
local_timestamp = (
|
||||||
|
datetime.datetime.utcnow().replace(tzinfo=datetime.timezone.utc).astimezone().isoformat()
|
||||||
|
)
|
||||||
|
payload = json.dumps(
|
||||||
|
{
|
||||||
|
'routing_key': hook_config['integration_key'],
|
||||||
|
'event_action': 'trigger',
|
||||||
|
'payload': {
|
||||||
|
'summary': f'backup failed on {hostname}',
|
||||||
|
'severity': 'error',
|
||||||
|
'source': hostname,
|
||||||
|
'timestamp': local_timestamp,
|
||||||
|
'component': 'borgmatic',
|
||||||
|
'group': 'backups',
|
||||||
|
'class': 'backup failure',
|
||||||
|
'custom_details': {
|
||||||
|
'hostname': hostname,
|
||||||
|
'configuration filename': config_filename,
|
||||||
|
'server time': local_timestamp,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
logger.debug(f'{config_filename}: Using PagerDuty payload: {payload}')
|
||||||
|
|
||||||
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
|
try:
|
||||||
|
response = requests.post(EVENTS_API_URL, data=payload.encode('utf-8'))
|
||||||
|
if not response.ok:
|
||||||
|
response.raise_for_status()
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: PagerDuty error: {error}')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(
|
||||||
|
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
No destruction is necessary for this monitor.
|
||||||
|
'''
|
||||||
|
pass
|
|
@ -1,104 +1,244 @@
|
||||||
|
import csv
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import (
|
||||||
|
execute_command,
|
||||||
|
execute_command_and_capture_output,
|
||||||
|
execute_command_with_processes,
|
||||||
|
)
|
||||||
from borgmatic.hooks import dump
|
from borgmatic.hooks import dump
|
||||||
|
|
||||||
DUMP_PATH = '~/.borgmatic/postgresql_databases'
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def dump_databases(databases, log_prefix, dry_run):
|
def make_dump_path(location_config): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Dump the given PostgreSQL databases to disk. The databases are supplied as a sequence of dicts,
|
Make the dump path from the given location configuration and the name of this hook.
|
||||||
one dict describing each database as per the configuration schema. Use the given log prefix in
|
'''
|
||||||
any log entries. If this is a dry run, then don't actually dump anything.
|
return dump.make_database_dump_path(
|
||||||
|
location_config.get('borgmatic_source_directory'), 'postgresql_databases'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def make_extra_environment(database):
|
||||||
|
'''
|
||||||
|
Make the extra_environment dict from the given database configuration.
|
||||||
|
'''
|
||||||
|
extra = dict()
|
||||||
|
if 'password' in database:
|
||||||
|
extra['PGPASSWORD'] = database['password']
|
||||||
|
extra['PGSSLMODE'] = database.get('ssl_mode', 'disable')
|
||||||
|
if 'ssl_cert' in database:
|
||||||
|
extra['PGSSLCERT'] = database['ssl_cert']
|
||||||
|
if 'ssl_key' in database:
|
||||||
|
extra['PGSSLKEY'] = database['ssl_key']
|
||||||
|
if 'ssl_root_cert' in database:
|
||||||
|
extra['PGSSLROOTCERT'] = database['ssl_root_cert']
|
||||||
|
if 'ssl_crl' in database:
|
||||||
|
extra['PGSSLCRL'] = database['ssl_crl']
|
||||||
|
return extra
|
||||||
|
|
||||||
|
|
||||||
|
EXCLUDED_DATABASE_NAMES = ('template0', 'template1')
|
||||||
|
|
||||||
|
|
||||||
|
def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
|
'''
|
||||||
|
Given a requested database config, return the corresponding sequence of database names to dump.
|
||||||
|
In the case of "all" when a database format is given, query for the names of databases on the
|
||||||
|
configured host and return them. For "all" without a database format, just return a sequence
|
||||||
|
containing "all".
|
||||||
|
'''
|
||||||
|
requested_name = database['name']
|
||||||
|
|
||||||
|
if requested_name != 'all':
|
||||||
|
return (requested_name,)
|
||||||
|
if not database.get('format'):
|
||||||
|
return ('all',)
|
||||||
|
if dry_run:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
list_command = (
|
||||||
|
('psql', '--list', '--no-password', '--csv', '--tuples-only')
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--username', database['username']) if 'username' in database else ())
|
||||||
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_prefix}: Querying for "all" PostgreSQL databases to dump')
|
||||||
|
list_output = execute_command_and_capture_output(
|
||||||
|
list_command, extra_environment=extra_environment
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
row[0]
|
||||||
|
for row in csv.reader(list_output.splitlines(), delimiter=',', quotechar='"')
|
||||||
|
if row[0] not in EXCLUDED_DATABASE_NAMES
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_databases(databases, log_prefix, location_config, dry_run):
|
||||||
|
'''
|
||||||
|
Dump the given PostgreSQL databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
dicts, one dict describing each database as per the configuration schema. Use the given log
|
||||||
|
prefix in any log entries. Use the given location configuration dict to construct the
|
||||||
|
destination path.
|
||||||
|
|
||||||
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
|
|
||||||
|
Raise ValueError if the databases to dump cannot be determined.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
processes = []
|
||||||
|
|
||||||
logger.info('{}: Dumping PostgreSQL databases{}'.format(log_prefix, dry_run_label))
|
logger.info(f'{log_prefix}: Dumping PostgreSQL databases{dry_run_label}')
|
||||||
|
|
||||||
for database in databases:
|
for database in databases:
|
||||||
name = database['name']
|
extra_environment = make_extra_environment(database)
|
||||||
dump_filename = dump.make_database_dump_filename(DUMP_PATH, name, database.get('hostname'))
|
dump_path = make_dump_path(location_config)
|
||||||
all_databases = bool(name == 'all')
|
dump_database_names = database_names_to_dump(
|
||||||
command = (
|
database, extra_environment, log_prefix, dry_run
|
||||||
('pg_dumpall' if all_databases else 'pg_dump', '--no-password', '--clean')
|
|
||||||
+ ('--file', dump_filename)
|
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
|
||||||
+ (() if all_databases else ('--format', database.get('format', 'custom')))
|
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
|
||||||
+ (() if all_databases else (name,))
|
|
||||||
)
|
)
|
||||||
extra_environment = {'PGPASSWORD': database['password']} if 'password' in database else None
|
|
||||||
|
|
||||||
logger.debug(
|
if not dump_database_names:
|
||||||
'{}: Dumping PostgreSQL database {} to {}{}'.format(
|
if dry_run:
|
||||||
log_prefix, name, dump_filename, dry_run_label
|
continue
|
||||||
|
|
||||||
|
raise ValueError('Cannot find any PostgreSQL databases to dump.')
|
||||||
|
|
||||||
|
for database_name in dump_database_names:
|
||||||
|
dump_format = database.get('format', None if database_name == 'all' else 'custom')
|
||||||
|
default_dump_command = 'pg_dumpall' if database_name == 'all' else 'pg_dump'
|
||||||
|
dump_command = database.get('pg_dump_command') or default_dump_command
|
||||||
|
dump_filename = dump.make_database_dump_filename(
|
||||||
|
dump_path, database_name, database.get('hostname')
|
||||||
)
|
)
|
||||||
)
|
if os.path.exists(dump_filename):
|
||||||
if not dry_run:
|
logger.warning(
|
||||||
os.makedirs(os.path.dirname(dump_filename), mode=0o700, exist_ok=True)
|
f'{log_prefix}: Skipping duplicate dump of PostgreSQL database "{database_name}" to {dump_filename}'
|
||||||
execute_command(command, extra_environment=extra_environment)
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
command = (
|
||||||
|
(dump_command, '--no-password', '--clean', '--if-exists',)
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--username', database['username']) if 'username' in database else ())
|
||||||
|
+ (('--format', dump_format) if dump_format else ())
|
||||||
|
+ (('--file', dump_filename) if dump_format == 'directory' else ())
|
||||||
|
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
||||||
|
+ (() if database_name == 'all' else (database_name,))
|
||||||
|
# Use shell redirection rather than the --file flag to sidestep synchronization issues
|
||||||
|
# when pg_dump/pg_dumpall tries to write to a named pipe. But for the directory dump
|
||||||
|
# format in a particular, a named destination is required, and redirection doesn't work.
|
||||||
|
+ (('>', dump_filename) if dump_format != 'directory' else ())
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping PostgreSQL database "{database_name}" to {dump_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if dump_format == 'directory':
|
||||||
|
dump.create_parent_directory_for_dump(dump_filename)
|
||||||
|
execute_command(
|
||||||
|
command, shell=True, extra_environment=extra_environment,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
processes.append(
|
||||||
|
execute_command(
|
||||||
|
command,
|
||||||
|
shell=True,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
run_to_completion=False,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
return processes
|
||||||
|
|
||||||
|
|
||||||
def remove_database_dumps(databases, log_prefix, dry_run): # pragma: no cover
|
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Remove the database dumps for the given databases. The databases are supplied as a sequence of
|
Remove all database dump files for this hook regardless of the given databases. Use the log
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the log prefix in
|
prefix in any log entries. Use the given location configuration dict to construct the
|
||||||
any log entries. If this is a dry run, then don't actually remove anything.
|
destination path. If this is a dry run, then don't actually remove anything.
|
||||||
'''
|
'''
|
||||||
dump.remove_database_dumps(DUMP_PATH, databases, 'PostgreSQL', log_prefix, dry_run)
|
dump.remove_database_dumps(make_dump_path(location_config), 'PostgreSQL', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_patterns(databases, log_prefix, names):
|
def make_database_dump_pattern(
|
||||||
|
databases, log_prefix, location_config, name=None
|
||||||
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Given a sequence of configurations dicts, a prefix to log with, and a sequence of database
|
Given a sequence of configurations dicts, a prefix to log with, a location configuration dict,
|
||||||
names to match, return the corresponding glob patterns to match the database dumps in an
|
and a database name to match, return the corresponding glob patterns to match the database dump
|
||||||
archive. An empty sequence of names indicates that the patterns should match all dumps.
|
in an archive.
|
||||||
'''
|
'''
|
||||||
return [
|
return dump.make_database_dump_filename(make_dump_path(location_config), name, hostname='*')
|
||||||
dump.make_database_dump_filename(DUMP_PATH, name, hostname='*') for name in (names or ['*'])
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def restore_database_dumps(databases, log_prefix, dry_run):
|
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
||||||
'''
|
'''
|
||||||
Restore the given PostgreSQL databases from disk. The databases are supplied as a sequence of
|
Restore the given PostgreSQL database from an extract stream. The database is supplied as a
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the given log
|
one-element sequence containing a dict describing the database, as per the configuration schema.
|
||||||
prefix in any log entries. If this is a dry run, then don't actually restore anything.
|
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
||||||
|
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
||||||
|
output to consume.
|
||||||
|
|
||||||
|
If the extract process is None, then restore the dump from the filesystem rather than from an
|
||||||
|
extract stream.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
|
||||||
for database in databases:
|
if len(database_config) != 1:
|
||||||
dump_filename = dump.make_database_dump_filename(
|
raise ValueError('The database configuration value is invalid')
|
||||||
DUMP_PATH, database['name'], database.get('hostname')
|
|
||||||
)
|
|
||||||
restore_command = (
|
|
||||||
('pg_restore', '--no-password', '--clean', '--if-exists', '--exit-on-error')
|
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
|
||||||
+ ('--dbname', database['name'])
|
|
||||||
+ (dump_filename,)
|
|
||||||
)
|
|
||||||
extra_environment = {'PGPASSWORD': database['password']} if 'password' in database else None
|
|
||||||
analyze_command = (
|
|
||||||
('psql', '--no-password', '--quiet')
|
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
|
||||||
+ ('--dbname', database['name'])
|
|
||||||
+ ('--command', 'ANALYZE')
|
|
||||||
)
|
|
||||||
|
|
||||||
logger.debug(
|
database = database_config[0]
|
||||||
'{}: Restoring PostgreSQL database {}{}'.format(
|
all_databases = bool(database['name'] == 'all')
|
||||||
log_prefix, database['name'], dry_run_label
|
dump_filename = dump.make_database_dump_filename(
|
||||||
)
|
make_dump_path(location_config), database['name'], database.get('hostname')
|
||||||
|
)
|
||||||
|
psql_command = database.get('psql_command') or 'psql'
|
||||||
|
analyze_command = (
|
||||||
|
(psql_command, '--no-password', '--quiet')
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--username', database['username']) if 'username' in database else ())
|
||||||
|
+ (('--dbname', database['name']) if not all_databases else ())
|
||||||
|
+ (tuple(database['analyze_options'].split(' ')) if 'analyze_options' in database else ())
|
||||||
|
+ ('--command', 'ANALYZE')
|
||||||
|
)
|
||||||
|
pg_restore_command = database.get('pg_restore_command') or 'pg_restore'
|
||||||
|
restore_command = (
|
||||||
|
(psql_command if all_databases else pg_restore_command, '--no-password')
|
||||||
|
+ (
|
||||||
|
('--if-exists', '--exit-on-error', '--clean', '--dbname', database['name'])
|
||||||
|
if not all_databases
|
||||||
|
else ()
|
||||||
)
|
)
|
||||||
if not dry_run:
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
execute_command(restore_command, extra_environment=extra_environment)
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
execute_command(analyze_command, extra_environment=extra_environment)
|
+ (('--username', database['username']) if 'username' in database else ())
|
||||||
|
+ (tuple(database['restore_options'].split(' ')) if 'restore_options' in database else ())
|
||||||
|
+ (() if extract_process else (dump_filename,))
|
||||||
|
)
|
||||||
|
extra_environment = make_extra_environment(database)
|
||||||
|
|
||||||
|
logger.debug(f"{log_prefix}: Restoring PostgreSQL database {database['name']}{dry_run_label}")
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
|
execute_command_with_processes(
|
||||||
|
restore_command,
|
||||||
|
[extract_process] if extract_process else [],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout if extract_process else None,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
)
|
||||||
|
execute_command(analyze_command, extra_environment=extra_environment)
|
||||||
|
|
125
borgmatic/hooks/sqlite.py
Normal file
125
borgmatic/hooks/sqlite.py
Normal file
|
@ -0,0 +1,125 @@
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
from borgmatic.execute import execute_command, execute_command_with_processes
|
||||||
|
from borgmatic.hooks import dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def make_dump_path(location_config): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Make the dump path from the given location configuration and the name of this hook.
|
||||||
|
'''
|
||||||
|
return dump.make_database_dump_path(
|
||||||
|
location_config.get('borgmatic_source_directory'), 'sqlite_databases'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_databases(databases, log_prefix, location_config, dry_run):
|
||||||
|
'''
|
||||||
|
Dump the given SQLite3 databases to a file. The databases are supplied as a sequence of
|
||||||
|
configuration dicts, as per the configuration schema. Use the given log prefix in any log
|
||||||
|
entries. Use the given location configuration dict to construct the destination path. If this
|
||||||
|
is a dry run, then don't actually dump anything.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
processes = []
|
||||||
|
|
||||||
|
logger.info(f'{log_prefix}: Dumping SQLite databases{dry_run_label}')
|
||||||
|
|
||||||
|
for database in databases:
|
||||||
|
database_path = database['path']
|
||||||
|
|
||||||
|
if database['name'] == 'all':
|
||||||
|
logger.warning('The "all" database name has no meaning for SQLite3 databases')
|
||||||
|
if not os.path.exists(database_path):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: No SQLite database at {database_path}; An empty database will be created and dumped'
|
||||||
|
)
|
||||||
|
|
||||||
|
dump_path = make_dump_path(location_config)
|
||||||
|
dump_filename = dump.make_database_dump_filename(dump_path, database['name'])
|
||||||
|
if os.path.exists(dump_filename):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: Skipping duplicate dump of SQLite database at {database_path} to {dump_filename}'
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
command = (
|
||||||
|
'sqlite3',
|
||||||
|
database_path,
|
||||||
|
'.dump',
|
||||||
|
'>',
|
||||||
|
dump_filename,
|
||||||
|
)
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping SQLite database at {database_path} to {dump_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
|
dump.create_parent_directory_for_dump(dump_filename)
|
||||||
|
processes.append(execute_command(command, shell=True, run_to_completion=False))
|
||||||
|
|
||||||
|
return processes
|
||||||
|
|
||||||
|
|
||||||
|
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Remove the given SQLite3 database dumps from the filesystem. The databases are supplied as a
|
||||||
|
sequence of configuration dicts, as per the configuration schema. Use the given log prefix in
|
||||||
|
any log entries. Use the given location configuration dict to construct the destination path.
|
||||||
|
If this is a dry run, then don't actually remove anything.
|
||||||
|
'''
|
||||||
|
dump.remove_database_dumps(make_dump_path(location_config), 'SQLite', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
|
def make_database_dump_pattern(
|
||||||
|
databases, log_prefix, location_config, name=None
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Make a pattern that matches the given SQLite3 databases. The databases are supplied as a
|
||||||
|
sequence of configuration dicts, as per the configuration schema.
|
||||||
|
'''
|
||||||
|
return dump.make_database_dump_filename(make_dump_path(location_config), name)
|
||||||
|
|
||||||
|
|
||||||
|
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
||||||
|
'''
|
||||||
|
Restore the given SQLite3 database from an extract stream. The database is supplied as a
|
||||||
|
one-element sequence containing a dict describing the database, as per the configuration schema.
|
||||||
|
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
||||||
|
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
||||||
|
output to consume.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
|
||||||
|
if len(database_config) != 1:
|
||||||
|
raise ValueError('The database configuration value is invalid')
|
||||||
|
|
||||||
|
database_path = database_config[0]['path']
|
||||||
|
|
||||||
|
logger.debug(f'{log_prefix}: Restoring SQLite database at {database_path}{dry_run_label}')
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
os.remove(database_path)
|
||||||
|
logger.warning(f'{log_prefix}: Removed existing SQLite database at {database_path}')
|
||||||
|
except FileNotFoundError: # pragma: no cover
|
||||||
|
pass
|
||||||
|
|
||||||
|
restore_command = (
|
||||||
|
'sqlite3',
|
||||||
|
database_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
|
execute_command_with_processes(
|
||||||
|
restore_command,
|
||||||
|
[extract_process],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout,
|
||||||
|
)
|
|
@ -1,4 +1,5 @@
|
||||||
import logging
|
import logging
|
||||||
|
import logging.handlers
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
@ -26,7 +27,7 @@ def interactive_console():
|
||||||
Return whether the current console is "interactive". Meaning: Capable of
|
Return whether the current console is "interactive". Meaning: Capable of
|
||||||
user input and not just something like a cron job.
|
user input and not just something like a cron job.
|
||||||
'''
|
'''
|
||||||
return sys.stdout.isatty() and os.environ.get('TERM') != 'dumb'
|
return sys.stderr.isatty() and os.environ.get('TERM') != 'dumb'
|
||||||
|
|
||||||
|
|
||||||
def should_do_markup(no_color, configs):
|
def should_do_markup(no_color, configs):
|
||||||
|
@ -48,18 +49,55 @@ def should_do_markup(no_color, configs):
|
||||||
return interactive_console()
|
return interactive_console()
|
||||||
|
|
||||||
|
|
||||||
LOG_LEVEL_TO_COLOR = {
|
class Multi_stream_handler(logging.Handler):
|
||||||
logging.CRITICAL: colorama.Fore.RED,
|
'''
|
||||||
logging.ERROR: colorama.Fore.RED,
|
A logging handler that dispatches each log record to one of multiple stream handlers depending
|
||||||
logging.WARN: colorama.Fore.YELLOW,
|
on the record's log level.
|
||||||
logging.INFO: colorama.Fore.GREEN,
|
'''
|
||||||
logging.DEBUG: colorama.Fore.CYAN,
|
|
||||||
}
|
def __init__(self, log_level_to_stream_handler):
|
||||||
|
super(Multi_stream_handler, self).__init__()
|
||||||
|
self.log_level_to_handler = log_level_to_stream_handler
|
||||||
|
self.handlers = set(self.log_level_to_handler.values())
|
||||||
|
|
||||||
|
def flush(self): # pragma: no cover
|
||||||
|
super(Multi_stream_handler, self).flush()
|
||||||
|
|
||||||
|
for handler in self.handlers:
|
||||||
|
handler.flush()
|
||||||
|
|
||||||
|
def emit(self, record):
|
||||||
|
'''
|
||||||
|
Dispatch the log record to the appropriate stream handler for the record's log level.
|
||||||
|
'''
|
||||||
|
self.log_level_to_handler[record.levelno].emit(record)
|
||||||
|
|
||||||
|
def setFormatter(self, formatter): # pragma: no cover
|
||||||
|
super(Multi_stream_handler, self).setFormatter(formatter)
|
||||||
|
|
||||||
|
for handler in self.handlers:
|
||||||
|
handler.setFormatter(formatter)
|
||||||
|
|
||||||
|
def setLevel(self, level): # pragma: no cover
|
||||||
|
super(Multi_stream_handler, self).setLevel(level)
|
||||||
|
|
||||||
|
for handler in self.handlers:
|
||||||
|
handler.setLevel(level)
|
||||||
|
|
||||||
|
|
||||||
class Console_color_formatter(logging.Formatter):
|
class Console_color_formatter(logging.Formatter):
|
||||||
def format(self, record):
|
def format(self, record):
|
||||||
color = LOG_LEVEL_TO_COLOR.get(record.levelno)
|
add_custom_log_levels()
|
||||||
|
|
||||||
|
color = {
|
||||||
|
logging.CRITICAL: colorama.Fore.RED,
|
||||||
|
logging.ERROR: colorama.Fore.RED,
|
||||||
|
logging.WARN: colorama.Fore.YELLOW,
|
||||||
|
logging.ANSWER: colorama.Fore.MAGENTA,
|
||||||
|
logging.INFO: colorama.Fore.GREEN,
|
||||||
|
logging.DEBUG: colorama.Fore.CYAN,
|
||||||
|
}.get(record.levelno)
|
||||||
|
|
||||||
return color_text(color, record.msg)
|
return color_text(color, record.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@ -70,11 +108,55 @@ def color_text(color, message):
|
||||||
if not color:
|
if not color:
|
||||||
return message
|
return message
|
||||||
|
|
||||||
return '{}{}{}'.format(color, message, colorama.Style.RESET_ALL)
|
return f'{color}{message}{colorama.Style.RESET_ALL}'
|
||||||
|
|
||||||
|
|
||||||
|
def add_logging_level(level_name, level_number):
|
||||||
|
'''
|
||||||
|
Globally add a custom logging level based on the given (all uppercase) level name and number.
|
||||||
|
Do this idempotently.
|
||||||
|
|
||||||
|
Inspired by https://stackoverflow.com/questions/2183233/how-to-add-a-custom-loglevel-to-pythons-logging-facility/35804945#35804945
|
||||||
|
'''
|
||||||
|
method_name = level_name.lower()
|
||||||
|
|
||||||
|
if not hasattr(logging, level_name):
|
||||||
|
logging.addLevelName(level_number, level_name)
|
||||||
|
setattr(logging, level_name, level_number)
|
||||||
|
|
||||||
|
if not hasattr(logging, method_name):
|
||||||
|
|
||||||
|
def log_for_level(self, message, *args, **kwargs): # pragma: no cover
|
||||||
|
if self.isEnabledFor(level_number):
|
||||||
|
self._log(level_number, message, args, **kwargs)
|
||||||
|
|
||||||
|
setattr(logging.getLoggerClass(), method_name, log_for_level)
|
||||||
|
|
||||||
|
if not hasattr(logging.getLoggerClass(), method_name):
|
||||||
|
|
||||||
|
def log_to_root(message, *args, **kwargs): # pragma: no cover
|
||||||
|
logging.log(level_number, message, *args, **kwargs)
|
||||||
|
|
||||||
|
setattr(logging, method_name, log_to_root)
|
||||||
|
|
||||||
|
|
||||||
|
ANSWER = logging.WARN - 5
|
||||||
|
|
||||||
|
|
||||||
|
def add_custom_log_levels(): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Add a custom log level between WARN and INFO for user-requested answers.
|
||||||
|
'''
|
||||||
|
add_logging_level('ANSWER', ANSWER)
|
||||||
|
|
||||||
|
|
||||||
def configure_logging(
|
def configure_logging(
|
||||||
console_log_level, syslog_log_level=None, log_file_log_level=None, log_file=None
|
console_log_level,
|
||||||
|
syslog_log_level=None,
|
||||||
|
log_file_log_level=None,
|
||||||
|
monitoring_log_level=None,
|
||||||
|
log_file=None,
|
||||||
|
log_file_format=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Configure logging to go to both the console and (syslog or log file). Use the given log levels,
|
Configure logging to go to both the console and (syslog or log file). Use the given log levels,
|
||||||
|
@ -86,8 +168,25 @@ def configure_logging(
|
||||||
syslog_log_level = console_log_level
|
syslog_log_level = console_log_level
|
||||||
if log_file_log_level is None:
|
if log_file_log_level is None:
|
||||||
log_file_log_level = console_log_level
|
log_file_log_level = console_log_level
|
||||||
|
if monitoring_log_level is None:
|
||||||
|
monitoring_log_level = console_log_level
|
||||||
|
|
||||||
console_handler = logging.StreamHandler()
|
add_custom_log_levels()
|
||||||
|
|
||||||
|
# Log certain log levels to console stderr and others to stdout. This supports use cases like
|
||||||
|
# grepping (non-error) output.
|
||||||
|
console_error_handler = logging.StreamHandler(sys.stderr)
|
||||||
|
console_standard_handler = logging.StreamHandler(sys.stdout)
|
||||||
|
console_handler = Multi_stream_handler(
|
||||||
|
{
|
||||||
|
logging.CRITICAL: console_error_handler,
|
||||||
|
logging.ERROR: console_error_handler,
|
||||||
|
logging.WARN: console_error_handler,
|
||||||
|
logging.ANSWER: console_standard_handler,
|
||||||
|
logging.INFO: console_standard_handler,
|
||||||
|
logging.DEBUG: console_standard_handler,
|
||||||
|
}
|
||||||
|
)
|
||||||
console_handler.setFormatter(Console_color_formatter())
|
console_handler.setFormatter(Console_color_formatter())
|
||||||
console_handler.setLevel(console_log_level)
|
console_handler.setLevel(console_log_level)
|
||||||
|
|
||||||
|
@ -97,20 +196,29 @@ def configure_logging(
|
||||||
syslog_path = '/dev/log'
|
syslog_path = '/dev/log'
|
||||||
elif os.path.exists('/var/run/syslog'):
|
elif os.path.exists('/var/run/syslog'):
|
||||||
syslog_path = '/var/run/syslog'
|
syslog_path = '/var/run/syslog'
|
||||||
|
elif os.path.exists('/var/run/log'):
|
||||||
|
syslog_path = '/var/run/log'
|
||||||
|
|
||||||
if syslog_path and not interactive_console():
|
if syslog_path and not interactive_console():
|
||||||
syslog_handler = logging.handlers.SysLogHandler(address=syslog_path)
|
syslog_handler = logging.handlers.SysLogHandler(address=syslog_path)
|
||||||
syslog_handler.setFormatter(logging.Formatter('borgmatic: %(levelname)s %(message)s'))
|
syslog_handler.setFormatter(
|
||||||
|
logging.Formatter('borgmatic: {levelname} {message}', style='{') # noqa: FS003
|
||||||
|
)
|
||||||
syslog_handler.setLevel(syslog_log_level)
|
syslog_handler.setLevel(syslog_log_level)
|
||||||
handlers = (console_handler, syslog_handler)
|
handlers = (console_handler, syslog_handler)
|
||||||
elif log_file:
|
elif log_file:
|
||||||
file_handler = logging.handlers.WatchedFileHandler(log_file)
|
file_handler = logging.handlers.WatchedFileHandler(log_file)
|
||||||
file_handler.setFormatter(logging.Formatter('[%(asctime)s] %(levelname)s: %(message)s'))
|
file_handler.setFormatter(
|
||||||
|
logging.Formatter(
|
||||||
|
log_file_format or '[{asctime}] {levelname}: {message}', style='{' # noqa: FS003
|
||||||
|
)
|
||||||
|
)
|
||||||
file_handler.setLevel(log_file_log_level)
|
file_handler.setLevel(log_file_log_level)
|
||||||
handlers = (console_handler, file_handler)
|
handlers = (console_handler, file_handler)
|
||||||
else:
|
else:
|
||||||
handlers = (console_handler,)
|
handlers = (console_handler,)
|
||||||
|
|
||||||
logging.basicConfig(
|
logging.basicConfig(
|
||||||
level=min(console_log_level, syslog_log_level, log_file_log_level), handlers=handlers
|
level=min(console_log_level, syslog_log_level, log_file_log_level, monitoring_log_level),
|
||||||
|
handlers=handlers,
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,18 +1,34 @@
|
||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
import signal
|
import signal
|
||||||
|
import sys
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _handle_signal(signal_number, frame): # pragma: no cover
|
EXIT_CODE_FROM_SIGNAL = 128
|
||||||
|
|
||||||
|
|
||||||
|
def handle_signal(signal_number, frame):
|
||||||
'''
|
'''
|
||||||
Send the signal to all processes in borgmatic's process group, which includes child process.
|
Send the signal to all processes in borgmatic's process group, which includes child processes.
|
||||||
'''
|
'''
|
||||||
|
# Prevent infinite signal handler recursion. If the parent frame is this very same handler
|
||||||
|
# function, we know we're recursing.
|
||||||
|
if frame.f_back.f_code.co_name == handle_signal.__name__:
|
||||||
|
return
|
||||||
|
|
||||||
os.killpg(os.getpgrp(), signal_number)
|
os.killpg(os.getpgrp(), signal_number)
|
||||||
|
|
||||||
|
if signal_number == signal.SIGTERM:
|
||||||
|
logger.critical('Exiting due to TERM signal')
|
||||||
|
sys.exit(EXIT_CODE_FROM_SIGNAL + signal.SIGTERM)
|
||||||
|
|
||||||
def configure_signals(): # pragma: no cover
|
|
||||||
|
def configure_signals():
|
||||||
'''
|
'''
|
||||||
Configure borgmatic's signal handlers to pass relevant signals through to any child processes
|
Configure borgmatic's signal handlers to pass relevant signals through to any child processes
|
||||||
like Borg. Note that SIGINT gets passed through even without these changes.
|
like Borg. Note that SIGINT gets passed through even without these changes.
|
||||||
'''
|
'''
|
||||||
for signal_number in (signal.SIGHUP, signal.SIGTERM, signal.SIGUSR1, signal.SIGUSR2):
|
for signal_number in (signal.SIGHUP, signal.SIGTERM, signal.SIGUSR1, signal.SIGUSR2):
|
||||||
signal.signal(signal_number, _handle_signal)
|
signal.signal(signal_number, handle_signal)
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
|
||||||
VERBOSITY_ERROR = -1
|
VERBOSITY_ERROR = -1
|
||||||
VERBOSITY_WARNING = 0
|
VERBOSITY_ANSWER = 0
|
||||||
VERBOSITY_SOME = 1
|
VERBOSITY_SOME = 1
|
||||||
VERBOSITY_LOTS = 2
|
VERBOSITY_LOTS = 2
|
||||||
|
|
||||||
|
@ -10,9 +12,11 @@ def verbosity_to_log_level(verbosity):
|
||||||
'''
|
'''
|
||||||
Given a borgmatic verbosity value, return the corresponding Python log level.
|
Given a borgmatic verbosity value, return the corresponding Python log level.
|
||||||
'''
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
return {
|
return {
|
||||||
VERBOSITY_ERROR: logging.ERROR,
|
VERBOSITY_ERROR: logging.ERROR,
|
||||||
VERBOSITY_WARNING: logging.WARNING,
|
VERBOSITY_ANSWER: logging.ANSWER,
|
||||||
VERBOSITY_SOME: logging.INFO,
|
VERBOSITY_SOME: logging.INFO,
|
||||||
VERBOSITY_LOTS: logging.DEBUG,
|
VERBOSITY_LOTS: logging.DEBUG,
|
||||||
}.get(verbosity, logging.WARNING)
|
}.get(verbosity, logging.WARNING)
|
||||||
|
|
|
@ -1,13 +1,14 @@
|
||||||
FROM python:3.7.4-alpine3.10 as borgmatic
|
FROM docker.io/alpine:3.17.1 as borgmatic
|
||||||
|
|
||||||
COPY . /app
|
COPY . /app
|
||||||
|
RUN apk add --no-cache py3-pip py3-ruamel.yaml py3-ruamel.yaml.clib
|
||||||
RUN pip install --no-cache /app && generate-borgmatic-config && chmod +r /etc/borgmatic/config.yaml
|
RUN pip install --no-cache /app && generate-borgmatic-config && chmod +r /etc/borgmatic/config.yaml
|
||||||
RUN borgmatic --help > /command-line.txt \
|
RUN borgmatic --help > /command-line.txt \
|
||||||
&& for action in init prune create check extract mount umount restore list info; do \
|
&& for action in rcreate transfer create prune compact check extract export-tar mount umount restore rlist list rinfo info break-lock borg; do \
|
||||||
echo -e "\n--------------------------------------------------------------------------------\n" >> /command-line.txt \
|
echo -e "\n--------------------------------------------------------------------------------\n" >> /command-line.txt \
|
||||||
&& borgmatic "$action" --help >> /command-line.txt; done
|
&& borgmatic "$action" --help >> /command-line.txt; done
|
||||||
|
|
||||||
FROM node:12.10.0-alpine as html
|
FROM docker.io/node:19.5.0-alpine as html
|
||||||
|
|
||||||
ARG ENVIRONMENT=production
|
ARG ENVIRONMENT=production
|
||||||
|
|
||||||
|
@ -16,6 +17,8 @@ WORKDIR /source
|
||||||
RUN npm install @11ty/eleventy \
|
RUN npm install @11ty/eleventy \
|
||||||
@11ty/eleventy-plugin-syntaxhighlight \
|
@11ty/eleventy-plugin-syntaxhighlight \
|
||||||
@11ty/eleventy-plugin-inclusive-language \
|
@11ty/eleventy-plugin-inclusive-language \
|
||||||
|
@11ty/eleventy-navigation \
|
||||||
|
eleventy-plugin-code-clipboard \
|
||||||
markdown-it \
|
markdown-it \
|
||||||
markdown-it-anchor \
|
markdown-it-anchor \
|
||||||
markdown-it-replace-link
|
markdown-it-replace-link
|
||||||
|
@ -25,7 +28,7 @@ COPY . /source
|
||||||
RUN NODE_ENV=${ENVIRONMENT} npx eleventy --input=/source/docs --output=/output/docs \
|
RUN NODE_ENV=${ENVIRONMENT} npx eleventy --input=/source/docs --output=/output/docs \
|
||||||
&& mv /output/docs/index.html /output/index.html
|
&& mv /output/docs/index.html /output/index.html
|
||||||
|
|
||||||
FROM nginx:1.16.1-alpine
|
FROM docker.io/nginx:1.22.1-alpine
|
||||||
|
|
||||||
COPY --from=html /output /usr/share/nginx/html
|
COPY --from=html /output /usr/share/nginx/html
|
||||||
COPY --from=borgmatic /etc/borgmatic/config.yaml /usr/share/nginx/html/docs/reference/config.yaml
|
COPY --from=borgmatic /etc/borgmatic/config.yaml /usr/share/nginx/html/docs/reference/config.yaml
|
||||||
|
|
19
docs/SECURITY.md
Normal file
19
docs/SECURITY.md
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
title: Security policy
|
||||||
|
permalink: security-policy/index.html
|
||||||
|
---
|
||||||
|
|
||||||
|
## Supported versions
|
||||||
|
|
||||||
|
While we want to hear about security vulnerabilities in all versions of
|
||||||
|
borgmatic, security fixes will only be made to the most recently released
|
||||||
|
version. It's not practical for our small volunteer effort to maintain
|
||||||
|
multiple different release branches and put out separate security patches for
|
||||||
|
each.
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
If you find a security vulnerability, please [file a
|
||||||
|
ticket](https://torsion.org/borgmatic/#issues) or [send email
|
||||||
|
directly](mailto:witten@torsion.org) as appropriate. You should expect to hear
|
||||||
|
back within a few days at most, and generally sooner.
|
|
@ -1,8 +1,7 @@
|
||||||
/* Buzzwords */
|
/* Buzzwords */
|
||||||
@keyframes rainbow {
|
@keyframes rainbow {
|
||||||
0% { background-position: 0% 50%; }
|
0% { background-position: 0% 50%; }
|
||||||
50% { background-position: 100% 50%; }
|
100% { background-position: 100% 50%; }
|
||||||
100% { background-position: 0% 50%; }
|
|
||||||
}
|
}
|
||||||
.buzzword-list,
|
.buzzword-list,
|
||||||
.inlinelist {
|
.inlinelist {
|
||||||
|
@ -25,6 +24,7 @@
|
||||||
margin: 4px 4px 4px 0;
|
margin: 4px 4px 4px 0;
|
||||||
transition: .15s linear outline;
|
transition: .15s linear outline;
|
||||||
}
|
}
|
||||||
|
|
||||||
.inlinelist .inlinelist-item.active {
|
.inlinelist .inlinelist-item.active {
|
||||||
background-color: #222;
|
background-color: #222;
|
||||||
color: #fff;
|
color: #fff;
|
||||||
|
@ -36,6 +36,33 @@
|
||||||
}
|
}
|
||||||
.inlinelist .inlinelist-item code {
|
.inlinelist .inlinelist-item code {
|
||||||
background-color: transparent;
|
background-color: transparent;
|
||||||
|
font-size: 80%;
|
||||||
|
margin-left: 6px;
|
||||||
|
padding-left: 6px;
|
||||||
|
display: inline-block;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
@media (max-width: 26.8125em) { /* 429px */
|
||||||
|
.inlinelist .inlinelist-item {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
.inlinelist .inlinelist-item code {
|
||||||
|
float: right;
|
||||||
|
line-height: 1.75;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (min-width: 26.875em) { /* 430px */
|
||||||
|
.inlinelist .inlinelist-item code {
|
||||||
|
float: none;
|
||||||
|
}
|
||||||
|
.inlinelist .inlinelist-item code:before {
|
||||||
|
content: " ";
|
||||||
|
border-left: 1px solid rgba(255,255,255,.8);
|
||||||
|
position: absolute;
|
||||||
|
left: -2px;
|
||||||
|
top: -2px;
|
||||||
|
bottom: 2px;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
a.buzzword {
|
a.buzzword {
|
||||||
text-decoration: underline;
|
text-decoration: underline;
|
||||||
|
@ -67,36 +94,49 @@ a.buzzword {
|
||||||
.buzzword-list li:hover,
|
.buzzword-list li:hover,
|
||||||
.buzzword-list li:focus,
|
.buzzword-list li:focus,
|
||||||
.buzzword:hover,
|
.buzzword:hover,
|
||||||
.buzzword:focus {
|
.buzzword:focus,
|
||||||
|
.rainbow-active:hover,
|
||||||
|
.rainbow-active:focus {
|
||||||
position: relative;
|
position: relative;
|
||||||
background-image: linear-gradient(238deg, #ff0000, #ff8000, #ffff00, #80ff00, #00ff00, #00ff80, #00ffff, #0080ff, #0000ff, #8000ff, #ff0080);
|
background-image: linear-gradient(238deg, #ff0000, #ff8000, #ffff00, #80ff00, #00ff00, #00ff80, #00ffff, #0080ff, #0000ff, #8000ff, #ff0080);
|
||||||
background-size: 1200% 1200%;
|
background-size: 1200% 1200%;
|
||||||
|
background-position: 2% 80%;
|
||||||
color: #fff;
|
color: #fff;
|
||||||
text-shadow: 0 0 2px rgba(0,0,0,.9);
|
text-shadow: 0 0 2px rgba(0,0,0,.9);
|
||||||
animation: rainbow 1.6s infinite;
|
animation: rainbow 4s ease-out alternate infinite;
|
||||||
|
}
|
||||||
|
.rainbow-active-noanim {
|
||||||
|
animation: none !important;
|
||||||
}
|
}
|
||||||
.inlinelist .inlinelist-item:hover a,
|
.inlinelist .inlinelist-item:hover a,
|
||||||
.inlinelist .inlinelist-item:focus a,
|
.inlinelist .inlinelist-item:focus a,
|
||||||
.buzzword-list li:hover a,
|
.buzzword-list li:hover a,
|
||||||
.buzzword-list li:focus a,
|
.buzzword-list li:focus a,
|
||||||
a.buzzword:hover,
|
a.buzzword:hover,
|
||||||
a.buzzword:focus {
|
a.buzzword:focus,
|
||||||
|
a.rainbow-active:hover,
|
||||||
|
a.rainbow-active:focus {
|
||||||
color: #fff;
|
color: #fff;
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
}
|
}
|
||||||
/*
|
@media (prefers-reduced-motion: reduce) {
|
||||||
I wish there were a PE friendly way to do this but media queries don’t work work with @supports
|
.inlinelist .inlinelist-item:hover,
|
||||||
@media (prefers-reduced-motion: no-preference) {
|
.inlinelist .inlinelist-item:focus,
|
||||||
|
.buzzword-list li:hover,
|
||||||
|
.buzzword-list li:focus,
|
||||||
.buzzword:hover,
|
.buzzword:hover,
|
||||||
.buzzword:focus {
|
.buzzword:focus,
|
||||||
animation: rainbow 1s infinite;
|
.rainbow-active:hover,
|
||||||
|
.rainbow-active:focus {
|
||||||
|
animation: none;
|
||||||
}
|
}
|
||||||
}*/
|
}
|
||||||
|
|
||||||
.buzzword-list li:hover:after,
|
.buzzword-list li:hover:after,
|
||||||
.buzzword-list li:focus:after,
|
.buzzword-list li:focus:after,
|
||||||
.buzzword:hover:after,
|
.buzzword:hover:after,
|
||||||
.buzzword:focus:after {
|
.buzzword:focus:after {
|
||||||
font-family: system-ui, sans-serif;
|
font-family: system-ui, -apple-system, sans-serif;
|
||||||
content: "Buzzword alert!!!";
|
content: "Buzzword alert!!!";
|
||||||
position: absolute;
|
position: absolute;
|
||||||
left: 0;
|
left: 0;
|
||||||
|
@ -123,4 +163,83 @@ main h2 a.buzzword,
|
||||||
main h3 a.buzzword,
|
main h3 a.buzzword,
|
||||||
main p a.buzzword {
|
main p a.buzzword {
|
||||||
text-decoration: underline;
|
text-decoration: underline;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Small viewport */
|
||||||
|
@media (max-width: 26.8125em) { /* 429px */
|
||||||
|
.inlinelist .inlinelist-item {
|
||||||
|
display: block;
|
||||||
|
width: auto;
|
||||||
|
padding: 0;
|
||||||
|
line-height: 1.4;
|
||||||
|
}
|
||||||
|
.inlinelist .inlinelist-item > a {
|
||||||
|
display: block;
|
||||||
|
padding: .2em .5em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (min-width: 26.875em) { /* 430px */
|
||||||
|
.inlinelist .inlinelist-item > a {
|
||||||
|
display: inline-block;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.numberflag {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
background-color: #dff7ff;
|
||||||
|
border-radius: 50%;
|
||||||
|
width: 1.75em;
|
||||||
|
height: 1.75em;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
h1 .numberflag,
|
||||||
|
h2 .numberflag,
|
||||||
|
h3 .numberflag,
|
||||||
|
h4 .numberflag,
|
||||||
|
h5 .numberflag {
|
||||||
|
width: 1.25em;
|
||||||
|
height: 1.25em;
|
||||||
|
}
|
||||||
|
h2 .numberflag {
|
||||||
|
position: relative;
|
||||||
|
margin-right: 0.25em; /* 10px /40 */
|
||||||
|
}
|
||||||
|
h2 .numberflag:after {
|
||||||
|
content: " ";
|
||||||
|
position: absolute;
|
||||||
|
bottom: -1px;
|
||||||
|
left: 0;
|
||||||
|
height: 1px;
|
||||||
|
background-color: #fff;
|
||||||
|
width: calc(100% + 0.4em); /* 16px /40 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Super featured list on home page */
|
||||||
|
.list-superfeatured .avatar {
|
||||||
|
width: calc(30px + 5vw);
|
||||||
|
height: calc(30px + 5vw);
|
||||||
|
max-width: 60px;
|
||||||
|
max-height: 60px;
|
||||||
|
margin-left: 0;
|
||||||
|
}
|
||||||
|
@media (max-width: 26.8125em) { /* 429px */
|
||||||
|
.list-superfeatured .inlinelist-item > a {
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (min-width: 26.875em) { /* 430px */
|
||||||
|
.list-superfeatured .inlinelist-item {
|
||||||
|
font-size: 110%;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Only top level */
|
||||||
|
.inlinelist-no-nest ul,
|
||||||
|
.inlinelist-no-nest ol {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
|
@ -10,7 +10,10 @@
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
margin: 0 0.4285714285714em 0.07142857142857em 0; /* 0 6px 1px 0 /14 */
|
margin: 0 0.4285714285714em 0.07142857142857em 0; /* 0 6px 1px 0 /14 */
|
||||||
line-height: 1.285714285714; /* 18px /14 */
|
line-height: 1.285714285714; /* 18px /14 */
|
||||||
font-family: system-ui, sans-serif;
|
font-family: system-ui, -apple-system, sans-serif;
|
||||||
|
}
|
||||||
|
table .minilink {
|
||||||
|
margin-top: 6px;
|
||||||
}
|
}
|
||||||
.minilink[href] {
|
.minilink[href] {
|
||||||
box-shadow: 0 1px 1px 0 rgba(0,0,0,.5);
|
box-shadow: 0 1px 1px 0 rgba(0,0,0,.5);
|
||||||
|
@ -35,6 +38,49 @@ p.minilink {
|
||||||
margin-left: 2em;
|
margin-left: 2em;
|
||||||
margin-bottom: 2em;
|
margin-bottom: 2em;
|
||||||
}
|
}
|
||||||
|
h1 .minilink,
|
||||||
|
h2 .minilink,
|
||||||
|
h3 .minilink,
|
||||||
|
h4 .minilink {
|
||||||
|
font-size: 0.9375rem; /* 15px /16 */
|
||||||
|
vertical-align: middle;
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
h3 .minilink,
|
||||||
|
h4 .minilink {
|
||||||
|
font-size: 0.8125rem; /* 13px /16 */
|
||||||
|
}
|
||||||
.minilink + pre[class*=language-] {
|
.minilink + pre[class*=language-] {
|
||||||
clear: both;
|
clear: both;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.minilink-addedin {
|
||||||
|
text-transform: none;
|
||||||
|
box-shadow: 0 0 0 1px rgba(0,0,0,0.3);
|
||||||
|
}
|
||||||
|
.minilink-addedin:not(:first-child) {
|
||||||
|
margin-left: .5em;
|
||||||
|
}
|
||||||
|
.minilink-addedin.minilink-inline {
|
||||||
|
margin: 0 4px;
|
||||||
|
background-color: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.minilink-lower {
|
||||||
|
text-transform: none;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
.minilink-lower[href] {
|
||||||
|
box-shadow: 0 0 0 1px rgba(0,0,0,0.5);
|
||||||
|
}
|
||||||
|
.minilink-lower[href]:hover,
|
||||||
|
.minilink-lower[href]:focus {
|
||||||
|
background-color: #eee;
|
||||||
|
}
|
||||||
|
|
||||||
|
.minilink > .minilink {
|
||||||
|
margin: -.125em .375em -.125em -.375em;
|
||||||
|
box-shadow: none;
|
||||||
|
border-top-right-radius: 0;
|
||||||
|
border-bottom-right-radius: 0;
|
||||||
|
}
|
||||||
|
|
|
@ -1,18 +0,0 @@
|
||||||
#suggestion-form textarea {
|
|
||||||
font-family: sans-serif;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#suggestion-form label {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
#suggestion-form input[type=email] {
|
|
||||||
font-size: 16px;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#suggestion-form .form-error {
|
|
||||||
color: red;
|
|
||||||
}
|
|
||||||
|
|
|
@ -1,33 +0,0 @@
|
||||||
<h2>Improve this documentation</h2>
|
|
||||||
|
|
||||||
<p>Have an idea on how to make this documentation even better? Send your
|
|
||||||
feedback below! (But if you need help installing or using borgmatic, please
|
|
||||||
use our <a href="https://torsion.org/borgmatic/#issues">issue tracker</a>
|
|
||||||
instead.)</p>
|
|
||||||
|
|
||||||
<form id="suggestion-form">
|
|
||||||
<div><label for="suggestion">Suggestion</label></div>
|
|
||||||
<textarea id="suggestion" rows="8" cols="60" name="suggestion"></textarea>
|
|
||||||
<div data-sk-error="suggestion" class="form-error"></div>
|
|
||||||
<input id="_page" type="hidden" name="_page">
|
|
||||||
<input id="_subject" type="hidden" name="_subject" value="borgmatic documentation suggestion">
|
|
||||||
<br />
|
|
||||||
<label for="email">Email address</label>
|
|
||||||
<div><input id="email" type="email" name="email" placeholder="Only required if you want a response!"></div>
|
|
||||||
<div data-sk-error="email" class="form-error"></div>
|
|
||||||
<br />
|
|
||||||
<div><button type="submit">Send</button></div>
|
|
||||||
<br />
|
|
||||||
</form>
|
|
||||||
|
|
||||||
<script>
|
|
||||||
document.getElementById('_page').value = window.location.href;
|
|
||||||
window.sk=window.sk||function(){(sk.q=sk.q||[]).push(arguments)};
|
|
||||||
|
|
||||||
sk('form', 'init', {
|
|
||||||
id: '1d536680ab96',
|
|
||||||
element: '#suggestion-form'
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<script defer src="https://js.statickit.com/statickit.js"></script>
|
|
5
docs/_includes/components/suggestion-link.html
Normal file
5
docs/_includes/components/suggestion-link.html
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
<h2>Improve this documentation</h2>
|
||||||
|
|
||||||
|
<p>Have an idea on how to make this documentation even better? Use our <a
|
||||||
|
href="https://projects.torsion.org/borgmatic-collective/borgmatic/issues">issue tracker</a> to send your
|
||||||
|
feedback!</p>
|
|
@ -1,63 +1,100 @@
|
||||||
.elv-toc {
|
.elv-toc {
|
||||||
font-size: 1rem; /* Reset */
|
font-size: 1rem; /* Reset */
|
||||||
}
|
}
|
||||||
|
.elv-toc details {
|
||||||
|
--details-force-closed: (max-width: 63.9375em); /* 1023px */
|
||||||
|
}
|
||||||
|
.elv-toc details > summary {
|
||||||
|
font-size: 1.375rem; /* 22px /16 */
|
||||||
|
margin-bottom: .5em;
|
||||||
|
}
|
||||||
@media (min-width: 64em) { /* 1024px */
|
@media (min-width: 64em) { /* 1024px */
|
||||||
.elv-toc {
|
.elv-toc {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
left: -17rem;
|
left: 3rem;
|
||||||
width: 16rem;
|
width: 16rem;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
.elv-toc details > summary {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
.js .elv-toc details > summary {
|
||||||
|
display: none;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
.elv-toc-list {
|
.elv-toc-list {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
justify-content: space-between;
|
||||||
padding-left: 0;
|
padding-left: 0;
|
||||||
padding-right: 0;
|
padding-right: 0;
|
||||||
|
margin: 0 0 2.5em;
|
||||||
list-style: none;
|
list-style: none;
|
||||||
}
|
}
|
||||||
|
.elv-toc-list li {
|
||||||
|
font-size: 0.9375em; /* 15px /16 */
|
||||||
|
line-height: 1.466666666667; /* 22px /15 */
|
||||||
|
}
|
||||||
/* Nested lists */
|
/* Nested lists */
|
||||||
.elv-toc-list ul {
|
.elv-toc-list ul {
|
||||||
padding: 0;
|
padding: 0 0 .75em 0;
|
||||||
display: none;
|
margin: 0;
|
||||||
margin-bottom: 1.5em;
|
|
||||||
list-style: none;
|
list-style: none;
|
||||||
}
|
}
|
||||||
.elv-toc-list ul li {
|
|
||||||
padding-left: 0.875em; /* 14px /16 */
|
/* Menus nested 2 or more deep */
|
||||||
|
.elv-toc-list ul ul {
|
||||||
|
padding-bottom: 0;
|
||||||
|
padding-left: 0.625rem; /* 10px /16 */
|
||||||
}
|
}
|
||||||
@media (min-width: 64em) and (min-height: 48em) { /* 1024 x 768px */
|
/* Hide inactive menus 3 or more deep */
|
||||||
.elv-toc-list ul {
|
.elv-toc-list ul ul > li:not(.elv-toc-active) > ul > li:not(.elv-toc-active) {
|
||||||
display: block;
|
display: none;
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* List items */
|
/* List items */
|
||||||
|
.elv-toc summary,
|
||||||
|
.elv-toc-list a {
|
||||||
|
padding: .15em .25em;
|
||||||
|
}
|
||||||
|
.elv-toc-list a {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
.elv-toc-list a:not(:hover) {
|
.elv-toc-list a:not(:hover) {
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
}
|
}
|
||||||
.elv-toc-list li {
|
.elv-toc-list li {
|
||||||
padding-top: 0;
|
margin: 0;
|
||||||
padding-bottom: 0;
|
padding: 0;
|
||||||
margin: .1em 0 .5em;
|
}
|
||||||
|
.elv-toc-list > li {
|
||||||
|
flex-grow: 1;
|
||||||
|
flex-basis: 14.375rem; /* 230px /16 */
|
||||||
}
|
}
|
||||||
/* Top level links */
|
/* Top level links */
|
||||||
.elv-toc-list > li > a {
|
.elv-toc-list > li > a {
|
||||||
font-weight: 400;
|
|
||||||
font-size: 1.0625em; /* 17px /16 */
|
|
||||||
color: #222;
|
color: #222;
|
||||||
|
font-weight: 600;
|
||||||
|
border-bottom: 1px solid #ddd;
|
||||||
|
margin-bottom: 0.25em; /* 4px /16 */
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Active links */
|
/* Active links */
|
||||||
.elv-toc-list li.elv-toc-active > a {
|
.elv-toc-list li.elv-toc-active > a {
|
||||||
font-weight: 700;
|
background-color: #dff7ff;
|
||||||
text-decoration: underline;
|
|
||||||
}
|
}
|
||||||
.elv-toc-active > a:after {
|
.elv-toc-list ul .elv-toc-active > a:after {
|
||||||
content: " ⬅";
|
content: "";
|
||||||
line-height: .5;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Show only active nested lists */
|
/* Show only active nested lists */
|
||||||
.elv-toc-list ul.elv-toc-active,
|
.elv-toc-list ul.elv-toc-active,
|
||||||
.elv-toc-list li.elv-toc-active > ul {
|
.elv-toc-list li.elv-toc-active > ul {
|
||||||
display: block;
|
display: block;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Footer category navigation */
|
||||||
|
.elv-cat-list-active {
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
|
@ -181,7 +181,7 @@ pre {
|
||||||
padding: .5em;
|
padding: .5em;
|
||||||
margin: 1em -.5em 2em -.5em;
|
margin: 1em -.5em 2em -.5em;
|
||||||
overflow-x: auto;
|
overflow-x: auto;
|
||||||
background-color: #eee;
|
background-color: #fafafa;
|
||||||
font-size: 0.75em; /* 12px /16 */
|
font-size: 0.75em; /* 12px /16 */
|
||||||
}
|
}
|
||||||
pre,
|
pre,
|
||||||
|
@ -194,7 +194,7 @@ code {
|
||||||
-webkit-hyphens: manual;
|
-webkit-hyphens: manual;
|
||||||
-moz-hyphens: manual;
|
-moz-hyphens: manual;
|
||||||
hyphens: manual;
|
hyphens: manual;
|
||||||
background-color: #efefef;
|
background-color: #fafafa;
|
||||||
}
|
}
|
||||||
pre + pre[class*="language-"] {
|
pre + pre[class*="language-"] {
|
||||||
margin-top: 1em;
|
margin-top: 1em;
|
||||||
|
@ -234,6 +234,9 @@ pre + .note {
|
||||||
max-width: 42rem;
|
max-width: 42rem;
|
||||||
clear: both;
|
clear: both;
|
||||||
}
|
}
|
||||||
|
header.elv-layout {
|
||||||
|
padding: 0 1rem;
|
||||||
|
}
|
||||||
footer.elv-layout {
|
footer.elv-layout {
|
||||||
margin-bottom: 5em;
|
margin-bottom: 5em;
|
||||||
}
|
}
|
||||||
|
@ -242,7 +245,7 @@ footer.elv-layout {
|
||||||
}
|
}
|
||||||
@media (min-width: 64em) { /* 1024px */
|
@media (min-width: 64em) { /* 1024px */
|
||||||
.elv-layout-toc {
|
.elv-layout-toc {
|
||||||
margin-left: 18rem;
|
padding-left: 15rem;
|
||||||
max-width: 60rem;
|
max-width: 60rem;
|
||||||
margin-right: 1rem;
|
margin-right: 1rem;
|
||||||
position: relative;
|
position: relative;
|
||||||
|
@ -254,14 +257,21 @@ footer.elv-layout {
|
||||||
|
|
||||||
/* Header */
|
/* Header */
|
||||||
.elv-header {
|
.elv-header {
|
||||||
color: #222;
|
|
||||||
position: relative;
|
position: relative;
|
||||||
|
text-align: center;
|
||||||
}
|
}
|
||||||
.elv-header-default {
|
.elv-header-default {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
justify-content: center;
|
justify-content: center;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
padding-top: 0;
|
||||||
|
}
|
||||||
|
.elv-header-c {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
.elv-header-docs .elv-header-c {
|
||||||
|
padding: 1rem 0;
|
||||||
}
|
}
|
||||||
.elv-header-docs:before,
|
.elv-header-docs:before,
|
||||||
.elv-header-docs:after {
|
.elv-header-docs:after {
|
||||||
|
@ -272,53 +282,84 @@ footer.elv-layout {
|
||||||
clear: both;
|
clear: both;
|
||||||
}
|
}
|
||||||
/* Header Hero */
|
/* Header Hero */
|
||||||
.elv-hero img {
|
.elv-hero {
|
||||||
max-width: 80vw;
|
background-color: #222;
|
||||||
max-height: 60vh;
|
|
||||||
}
|
}
|
||||||
|
.elv-hero img,
|
||||||
|
.elv-hero svg {
|
||||||
|
width: 42.95774646vh;
|
||||||
|
height: 60vh;
|
||||||
|
}
|
||||||
|
.elv-hero:hover img,
|
||||||
|
.elv-hero:hover svg {
|
||||||
|
background-color: inherit;
|
||||||
|
}
|
||||||
|
.elv-header-default .elv-hero {
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
width: calc(100% + 2rem);
|
||||||
|
margin-left: -1rem;
|
||||||
|
margin-right: -1rem;
|
||||||
|
}
|
||||||
|
.elv-hero:hover {
|
||||||
|
background-color: #333;
|
||||||
|
}
|
||||||
|
|
||||||
.elv-header-docs .elv-hero {
|
.elv-header-docs .elv-hero {
|
||||||
float: left;
|
float: left;
|
||||||
margin-right: 1.5em;
|
margin-right: .5em;
|
||||||
}
|
}
|
||||||
.elv-header-docs .elv-hero img {
|
.elv-header-default .elv-hero img,
|
||||||
|
.elv-header-default .elv-hero svg {
|
||||||
|
position: relative;
|
||||||
|
background-color: transparent;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
.elv-header-docs .elv-hero img,
|
||||||
|
.elv-header-docs .elv-hero svg {
|
||||||
|
width: auto;
|
||||||
height: 3em;
|
height: 3em;
|
||||||
}
|
}
|
||||||
@media (min-width: 37.5em) { /* 600px */
|
@media (min-width: 43.75em) { /* 700px */
|
||||||
.elv-header-docs .elv-hero img {
|
.elv-header-docs .elv-hero {
|
||||||
|
margin-right: 1em;
|
||||||
|
}
|
||||||
|
.elv-header-docs .elv-hero img,
|
||||||
|
.elv-header-docs .elv-hero svg {
|
||||||
width: 4.303125em; /* 68.85px /16 */
|
width: 4.303125em; /* 68.85px /16 */
|
||||||
height: 6em;
|
height: 6em;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
/* Header Possum */
|
/* Header Possum */
|
||||||
|
.elv-possum-anchor {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
.elv-possum {
|
.elv-possum {
|
||||||
display: none;
|
|
||||||
position: absolute;
|
position: absolute;
|
||||||
right: 1em;
|
right: .5rem;
|
||||||
top: 1em;
|
top: 1rem;
|
||||||
width: 16vmin;
|
transition: .3s opacity ease-out;
|
||||||
}
|
}
|
||||||
@media (min-width: 31.25em) { /* 500px */
|
.elv-header-docs .elv-possum {
|
||||||
.elv-possum {
|
width: 15vw;
|
||||||
display: block;
|
max-width: 6.25rem; /* 100px /16 */
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
.elv-header-default {
|
||||||
/* Header Heading */
|
overflow: hidden;
|
||||||
.elv-hed {
|
|
||||||
font-size: 3em;
|
|
||||||
margin-top: 1.5em;
|
|
||||||
margin-bottom: .25em;
|
|
||||||
text-align: center;
|
|
||||||
text-transform: none;
|
|
||||||
}
|
}
|
||||||
.elv-header-docs .elv-hed {
|
.elv-header-default .elv-possum {
|
||||||
font-size: 2.3em;
|
pointer-events: none;
|
||||||
margin: 0;
|
width: auto;
|
||||||
text-align: left;
|
height: calc((60vh - 2rem) / 1.6);
|
||||||
|
top: 36%;
|
||||||
|
left: 1vw;
|
||||||
|
right: auto;
|
||||||
|
animation-duration: 180s;
|
||||||
|
animation-name: balloonFloat;
|
||||||
}
|
}
|
||||||
@media (min-width: 37.5em) { /* 600px */
|
@media (prefers-reduced-motion: reduce) {
|
||||||
.elv-header-docs .elv-hed {
|
.elv-header-default .elv-possum {
|
||||||
font-size: 3em;
|
display: none;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -484,3 +525,26 @@ main .elv-toc + h1 .direct-link {
|
||||||
display: none ;
|
display: none ;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.header-anchor {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.header-anchor:hover::after {
|
||||||
|
content: " 🔗";
|
||||||
|
}
|
||||||
|
|
||||||
|
.mdi {
|
||||||
|
display: inline-block;
|
||||||
|
width: 1em;
|
||||||
|
height: 1em;
|
||||||
|
background-color: currentColor;
|
||||||
|
-webkit-mask: no-repeat center / 100%;
|
||||||
|
mask: no-repeat center / 100%;
|
||||||
|
-webkit-mask-image: var(--svg);
|
||||||
|
mask-image: var(--svg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.mdi.mdi-content-copy {
|
||||||
|
--svg: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' width='24' height='24'%3E%3Cpath fill='black' d='M19 21H8V7h11m0-2H8a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h11a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2m-3-4H4a2 2 0 0 0-2 2v14h2V3h12V1Z'/%3E%3C/svg%3E");
|
||||||
|
}
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<link rel="icon" href="docs/static/borgmatic.png" type="image/x-icon">
|
||||||
<title>{{ subtitle + ' - ' if subtitle}}{{ title }}</title>
|
<title>{{ subtitle + ' - ' if subtitle}}{{ title }}</title>
|
||||||
{%- set css %}
|
{%- set css %}
|
||||||
{% include 'index.css' %}
|
{% include 'index.css' %}
|
||||||
|
@ -11,7 +12,6 @@
|
||||||
{% include 'components/minilink.css' %}
|
{% include 'components/minilink.css' %}
|
||||||
{% include 'components/toc.css' %}
|
{% include 'components/toc.css' %}
|
||||||
{% include 'components/info-blocks.css' %}
|
{% include 'components/info-blocks.css' %}
|
||||||
{% include 'components/suggestion-form.css' %}
|
|
||||||
{% include 'prism-theme.css' %}
|
{% include 'prism-theme.css' %}
|
||||||
{% include 'asciinema.css' %}
|
{% include 'asciinema.css' %}
|
||||||
{% endset %}
|
{% endset %}
|
||||||
|
@ -23,6 +23,6 @@
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
{{ content | safe }}
|
{{ content | safe }}
|
||||||
|
{% initClipboardJS %}
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
@ -6,9 +6,27 @@ headerClass: elv-header-default
|
||||||
{% include "header.njk" %}
|
{% include "header.njk" %}
|
||||||
|
|
||||||
<main class="elv-layout{% if layoutClass %} {{ layoutClass }}{% endif %}">
|
<main class="elv-layout{% if layoutClass %} {{ layoutClass }}{% endif %}">
|
||||||
<article>
|
<div id="documentation" class="elv-toc">
|
||||||
{{ content | safe }}
|
<div>
|
||||||
|
{% set navPages = collections.all | eleventyNavigation %}
|
||||||
|
{% macro renderNavListItem(entry) -%}
|
||||||
|
<li{% if entry.url == page.url %} class="elv-toc-active"{% endif %}>
|
||||||
|
<a {% if entry.url %}href="https://torsion.org/borgmatic/docs{{ entry.url | url }}"{% endif %}>{{ entry.title }}</a>
|
||||||
|
{%- if entry.children.length -%}
|
||||||
|
<ul>
|
||||||
|
{%- for child in entry.children %}{{ renderNavListItem(child) }}{% endfor -%}
|
||||||
|
</ul>
|
||||||
|
{%- endif -%}
|
||||||
|
</li>
|
||||||
|
{%- endmacro %}
|
||||||
|
|
||||||
{% include 'components/suggestion-form.html' %}
|
<ul class="elv-toc-list">
|
||||||
</article>
|
{%- for entry in navPages %}{{ renderNavListItem(entry) }}{%- endfor -%}
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{{ content | safe }}
|
||||||
|
|
||||||
|
{% include 'components/suggestion-link.html' %}
|
||||||
</main>
|
</main>
|
||||||
|
|
|
@ -3,9 +3,12 @@
|
||||||
* Based on dabblet (http://dabblet.com)
|
* Based on dabblet (http://dabblet.com)
|
||||||
* @author Lea Verou
|
* @author Lea Verou
|
||||||
*/
|
*/
|
||||||
|
/*
|
||||||
|
* Modified with an approximation of the One Light syntax highlighting theme.
|
||||||
|
*/
|
||||||
code[class*="language-"],
|
code[class*="language-"],
|
||||||
pre[class*="language-"] {
|
pre[class*="language-"] {
|
||||||
color: #ABB2BF;
|
color: #494b53;
|
||||||
background: none;
|
background: none;
|
||||||
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
|
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
|
@ -26,13 +29,15 @@ pre[class*="language-"] {
|
||||||
pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
|
pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
|
||||||
code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
|
code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
|
||||||
text-shadow: none;
|
text-shadow: none;
|
||||||
background: #383e49;
|
color: #232324;
|
||||||
|
background: #dbdbdc;
|
||||||
}
|
}
|
||||||
|
|
||||||
pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
|
pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
|
||||||
code[class*="language-"]::selection, code[class*="language-"] ::selection {
|
code[class*="language-"]::selection, code[class*="language-"] ::selection {
|
||||||
text-shadow: none;
|
text-shadow: none;
|
||||||
background: #9aa2b1;
|
color: #232324;
|
||||||
|
background: #dbdbdc;
|
||||||
}
|
}
|
||||||
|
|
||||||
@media print {
|
@media print {
|
||||||
|
@ -50,7 +55,7 @@ pre[class*="language-"] {
|
||||||
|
|
||||||
:not(pre) > code[class*="language-"],
|
:not(pre) > code[class*="language-"],
|
||||||
pre[class*="language-"] {
|
pre[class*="language-"] {
|
||||||
background: #282c34;
|
background: #fafafa;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Inline code */
|
/* Inline code */
|
||||||
|
@ -64,16 +69,16 @@ pre[class*="language-"] {
|
||||||
.token.prolog,
|
.token.prolog,
|
||||||
.token.doctype,
|
.token.doctype,
|
||||||
.token.cdata {
|
.token.cdata {
|
||||||
color: #5C6370;
|
color: #505157;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.punctuation {
|
.token.punctuation {
|
||||||
color: #abb2bf;
|
color: #526fff;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.selector,
|
.token.selector,
|
||||||
.token.tag {
|
.token.tag {
|
||||||
color: #e06c75;
|
color: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.property,
|
.token.property,
|
||||||
|
@ -83,7 +88,7 @@ pre[class*="language-"] {
|
||||||
.token.symbol,
|
.token.symbol,
|
||||||
.token.attr-name,
|
.token.attr-name,
|
||||||
.token.deleted {
|
.token.deleted {
|
||||||
color: #d19a66;
|
color: #986801;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.string,
|
.token.string,
|
||||||
|
@ -91,7 +96,7 @@ pre[class*="language-"] {
|
||||||
.token.attr-value,
|
.token.attr-value,
|
||||||
.token.builtin,
|
.token.builtin,
|
||||||
.token.inserted {
|
.token.inserted {
|
||||||
color: #98c379;
|
color: #50a14f;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.operator,
|
.token.operator,
|
||||||
|
@ -99,22 +104,22 @@ pre[class*="language-"] {
|
||||||
.token.url,
|
.token.url,
|
||||||
.language-css .token.string,
|
.language-css .token.string,
|
||||||
.style .token.string {
|
.style .token.string {
|
||||||
color: #56b6c2;
|
color: #526fff;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.atrule,
|
.token.atrule,
|
||||||
.token.keyword {
|
.token.keyword {
|
||||||
color: #e06c75;
|
color: #e45649;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.function {
|
.token.function {
|
||||||
color: #61afef;
|
color: #4078f2;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.regex,
|
.token.regex,
|
||||||
.token.important,
|
.token.important,
|
||||||
.token.variable {
|
.token.variable {
|
||||||
color: #c678dd;
|
color: #e45649;
|
||||||
}
|
}
|
||||||
|
|
||||||
.token.important,
|
.token.important,
|
||||||
|
|
|
@ -1,13 +1,18 @@
|
||||||
---
|
---
|
||||||
title: How to add preparation and cleanup steps to backups
|
title: How to add preparation and cleanup steps to backups
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 🧹 Add preparation and cleanup steps
|
||||||
|
parent: How-to guides
|
||||||
|
order: 9
|
||||||
---
|
---
|
||||||
## Preparation and cleanup hooks
|
## Preparation and cleanup hooks
|
||||||
|
|
||||||
If you find yourself performing prepraration tasks before your backup runs, or
|
If you find yourself performing preparation tasks before your backup runs, or
|
||||||
cleanup work afterwards, borgmatic hooks may be of interest. Hooks are shell
|
cleanup work afterwards, borgmatic hooks may be of interest. Hooks are shell
|
||||||
commands that borgmatic executes for you at various points, and they're
|
commands that borgmatic executes for you at various points as it runs, and
|
||||||
configured in the `hooks` section of your configuration file. But if you're
|
they're configured in the `hooks` section of your configuration file. But if
|
||||||
looking to backup a database, it's probably easier to use the [database backup
|
you're looking to backup a database, it's probably easier to use the [database
|
||||||
|
backup
|
||||||
feature](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
feature](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
|
@ -23,11 +28,55 @@ hooks:
|
||||||
- umount /some/filesystem
|
- umount /some/filesystem
|
||||||
```
|
```
|
||||||
|
|
||||||
The `before_backup` and `after_backup` hooks each run once per configuration
|
<span class="minilink minilink-addedin">New in version 1.6.0</span> The
|
||||||
file. `before_backup` hooks run prior to backups of all repositories in a
|
`before_backup` and `after_backup` hooks each run once per repository in a
|
||||||
configuration file, right before the `create` action. `after_backup` hooks run
|
configuration file. `before_backup` hooks runs right before the `create`
|
||||||
afterwards, but not if an error occurs in a previous hook or in the backups
|
action for a particular repository, and `after_backup` hooks run afterwards,
|
||||||
themselves.
|
but not if an error occurs in a previous hook or in the backups themselves.
|
||||||
|
(Prior to borgmatic 1.6.0, these hooks instead ran once per configuration file
|
||||||
|
rather than once per repository.)
|
||||||
|
|
||||||
|
There are additional hooks that run before/after other actions as well. For
|
||||||
|
instance, `before_prune` runs before a `prune` action for a repository, while
|
||||||
|
`after_prune` runs after it.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.0</span> The
|
||||||
|
`before_actions` and `after_actions` hooks run before/after all the actions
|
||||||
|
(like `create`, `prune`, etc.) for each repository. These hooks are a good
|
||||||
|
place to run per-repository steps like mounting/unmounting a remote
|
||||||
|
filesystem.
|
||||||
|
|
||||||
|
|
||||||
|
## Variable interpolation
|
||||||
|
|
||||||
|
The before and after action hooks support interpolating particular runtime
|
||||||
|
variables into the hook command. Here's an example that assumes you provide a
|
||||||
|
separate shell script:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
after_prune:
|
||||||
|
- record-prune.sh "{configuration_filename}" "{repository}"
|
||||||
|
```
|
||||||
|
|
||||||
|
In this example, when the hook is triggered, borgmatic interpolates runtime
|
||||||
|
values into the hook command: the borgmatic configuration filename and the
|
||||||
|
paths of the current Borg repository. Here's the full set of supported
|
||||||
|
variables you can use here:
|
||||||
|
|
||||||
|
* `configuration_filename`: borgmatic configuration filename in which the
|
||||||
|
hook was defined
|
||||||
|
* `log_file`
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.12</span>:
|
||||||
|
path of the borgmatic log file, only set when the `--log-file` flag is used
|
||||||
|
* `repository`: path of the current repository as configured in the current
|
||||||
|
borgmatic configuration file
|
||||||
|
|
||||||
|
Note that you can also interpolate in [arbitrary environment
|
||||||
|
variables](https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/).
|
||||||
|
|
||||||
|
|
||||||
|
## Global hooks
|
||||||
|
|
||||||
You can also use `before_everything` and `after_everything` hooks to perform
|
You can also use `before_everything` and `after_everything` hooks to perform
|
||||||
global setup or cleanup:
|
global setup or cleanup:
|
||||||
|
@ -50,6 +99,8 @@ but only if there is a `create` action. It runs even if an error occurs during
|
||||||
a backup or a backup hook, but not if an error occurs during a
|
a backup or a backup hook, but not if an error occurs during a
|
||||||
`before_everything` hook.
|
`before_everything` hook.
|
||||||
|
|
||||||
|
## Error hooks
|
||||||
|
|
||||||
borgmatic also runs `on_error` hooks if an error occurs, either when creating
|
borgmatic also runs `on_error` hooks if an error occurs, either when creating
|
||||||
a backup or running a backup hook. See the [monitoring and alerting
|
a backup or running a backup hook. See the [monitoring and alerting
|
||||||
documentation](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
|
documentation](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
|
||||||
|
@ -69,11 +120,3 @@ with the user permissions of borgmatic itself. So to prevent potential shell
|
||||||
injection or privilege escalation, do not forget to set secure permissions
|
injection or privilege escalation, do not forget to set secure permissions
|
||||||
on borgmatic configuration files (`chmod 0600`) and scripts (`chmod 0700`)
|
on borgmatic configuration files (`chmod 0600`) and scripts (`chmod 0700`)
|
||||||
invoked by hooks.
|
invoked by hooks.
|
||||||
|
|
||||||
|
|
||||||
## Related documentation
|
|
||||||
|
|
||||||
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/)
|
|
||||||
* [Backup your databases](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
|
||||||
* [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)
|
|
||||||
* [Monitor your backups](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
|
|
||||||
|
|
|
@ -0,0 +1,135 @@
|
||||||
|
---
|
||||||
|
title: How to backup to a removable drive or an intermittent server
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 💾 Backup to a removable drive/server
|
||||||
|
parent: How-to guides
|
||||||
|
order: 10
|
||||||
|
---
|
||||||
|
## Occasional backups
|
||||||
|
|
||||||
|
A common situation is backing up to a repository that's only sometimes online.
|
||||||
|
For instance, you might send most of your backups to the cloud, but
|
||||||
|
occasionally you want to plug in an external hard drive or backup to your
|
||||||
|
buddy's sometimes-online server for that extra level of redundancy.
|
||||||
|
|
||||||
|
But if you run borgmatic and your hard drive isn't plugged in, or your buddy's
|
||||||
|
server is offline, then you'll get an annoying error message and the overall
|
||||||
|
borgmatic run will fail (even if individual repositories still complete).
|
||||||
|
|
||||||
|
Another variant is when the source machine is only sometimes available for
|
||||||
|
backups, e.g. a laptop where you want to skip backups when the battery falls
|
||||||
|
below a certain level.
|
||||||
|
|
||||||
|
So what if you want borgmatic to swallow the error of a missing drive
|
||||||
|
or an offline server or a low battery—and exit gracefully? That's where the
|
||||||
|
concept of "soft failure" come in.
|
||||||
|
|
||||||
|
|
||||||
|
## Soft failure command hooks
|
||||||
|
|
||||||
|
This feature leverages [borgmatic command
|
||||||
|
hooks](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/),
|
||||||
|
so first familiarize yourself with them. The idea is that you write a simple
|
||||||
|
test in the form of a borgmatic hook to see if backups should proceed or not.
|
||||||
|
|
||||||
|
The way the test works is that if any of your hook commands return a special
|
||||||
|
exit status of 75, that indicates to borgmatic that it's a temporary failure,
|
||||||
|
and borgmatic should skip all subsequent actions for that configuration file.
|
||||||
|
If you return any other status, then it's a standard success or error. (Zero is
|
||||||
|
success; anything else other than 75 is an error).
|
||||||
|
|
||||||
|
So for instance, if you have an external drive that's only sometimes mounted,
|
||||||
|
declare its repository in its own [separate configuration
|
||||||
|
file](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/),
|
||||||
|
say at `/etc/borgmatic.d/removable.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
location:
|
||||||
|
source_directories:
|
||||||
|
- /home
|
||||||
|
|
||||||
|
repositories:
|
||||||
|
- path: /mnt/removable/backup.borg
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">Prior to version 1.7.10</span> Omit
|
||||||
|
the `path:` portion of the `repositories` list.
|
||||||
|
|
||||||
|
Then, write a `before_backup` hook in that same configuration file that uses
|
||||||
|
the external `findmnt` utility to see whether the drive is mounted before
|
||||||
|
proceeding.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
before_backup:
|
||||||
|
- findmnt /mnt/removable > /dev/null || exit 75
|
||||||
|
```
|
||||||
|
|
||||||
|
What this does is check if the `findmnt` command errors when probing for a
|
||||||
|
particular mount point. If it does error, then it returns exit code 75 to
|
||||||
|
borgmatic. borgmatic logs the soft failure, skips all further actions in that
|
||||||
|
configurable file, and proceeds onward to any other borgmatic configuration
|
||||||
|
files you may have.
|
||||||
|
|
||||||
|
Note that `before_backup` only runs on the `create` action. See below about
|
||||||
|
optionally using `before_actions` instead.
|
||||||
|
|
||||||
|
You can imagine a similar check for the sometimes-online server case:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
location:
|
||||||
|
source_directories:
|
||||||
|
- /home
|
||||||
|
|
||||||
|
repositories:
|
||||||
|
- path: ssh://me@buddys-server.org/./backup.borg
|
||||||
|
|
||||||
|
hooks:
|
||||||
|
before_backup:
|
||||||
|
- ping -q -c 1 buddys-server.org > /dev/null || exit 75
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">Prior to version 1.7.10</span> Omit
|
||||||
|
the `path:` portion of the `repositories` list.
|
||||||
|
|
||||||
|
Or to only run backups if the battery level is high enough:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
before_backup:
|
||||||
|
- is_battery_percent_at_least.sh 25
|
||||||
|
```
|
||||||
|
|
||||||
|
(Writing the battery script is left as an exercise to the reader.)
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.0</span> The
|
||||||
|
`before_actions` and `after_actions` hooks run before/after all the actions
|
||||||
|
(like `create`, `prune`, etc.) for each repository. So if you'd like your soft
|
||||||
|
failure command hook to run regardless of action, consider using
|
||||||
|
`before_actions` instead of `before_backup`.
|
||||||
|
|
||||||
|
|
||||||
|
## Caveats and details
|
||||||
|
|
||||||
|
There are some caveats you should be aware of with this feature.
|
||||||
|
|
||||||
|
* You'll generally want to put a soft failure command in the `before_backup`
|
||||||
|
hook, so as to gate whether the backup action occurs. While a soft failure is
|
||||||
|
also supported in the `after_backup` hook, returning a soft failure there
|
||||||
|
won't prevent any actions from occurring, because they've already occurred!
|
||||||
|
Similarly, you can return a soft failure from an `on_error` hook, but at
|
||||||
|
that point it's too late to prevent the error.
|
||||||
|
* Returning a soft failure does prevent further commands in the same hook from
|
||||||
|
executing. So, like a standard error, it is an "early out". Unlike a standard
|
||||||
|
error, borgmatic does not display it in angry red text or consider it a
|
||||||
|
failure.
|
||||||
|
* The soft failure only applies to the scope of a single borgmatic
|
||||||
|
configuration file. So put anything that you don't want soft-failed, like
|
||||||
|
always-online cloud backups, in separate configuration files from your
|
||||||
|
soft-failing repositories.
|
||||||
|
* The soft failure doesn't have to apply to a repository. You can even perform
|
||||||
|
a test to make sure that individual source directories are mounted and
|
||||||
|
available. Use your imagination!
|
||||||
|
* The soft failure feature also works for before/after hooks for other
|
||||||
|
actions as well. But it is not implemented for `before_everything` or
|
||||||
|
`after_everything`.
|
|
@ -1,5 +1,9 @@
|
||||||
---
|
---
|
||||||
title: How to backup your databases
|
title: How to backup your databases
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 🗄️ Backup your databases
|
||||||
|
parent: How-to guides
|
||||||
|
order: 8
|
||||||
---
|
---
|
||||||
## Database dump hooks
|
## Database dump hooks
|
||||||
|
|
||||||
|
@ -11,7 +15,7 @@ consistent snapshot that is more suited for backups.
|
||||||
|
|
||||||
Fortunately, borgmatic includes built-in support for creating database dumps
|
Fortunately, borgmatic includes built-in support for creating database dumps
|
||||||
prior to running backups. For example, here is everything you need to dump and
|
prior to running backups. For example, here is everything you need to dump and
|
||||||
backup a couple of local PostgreSQL databases and a MySQL/MariaDB database:
|
backup a couple of local PostgreSQL databases and a MySQL/MariaDB database.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
|
@ -22,9 +26,40 @@ hooks:
|
||||||
- name: posts
|
- name: posts
|
||||||
```
|
```
|
||||||
|
|
||||||
Prior to each backup, borgmatic dumps each configured database to a file
|
<span class="minilink minilink-addedin">New in version 1.5.22</span> You can
|
||||||
(located in `~/.borgmatic/`) and includes it in the backup. After the backup
|
also dump MongoDB databases. For example:
|
||||||
completes, borgmatic removes the database dump files to recover disk space.
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
mongodb_databases:
|
||||||
|
- name: messages
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.9</span>
|
||||||
|
Additionally, you can dump SQLite databases. For example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
sqlite_databases:
|
||||||
|
- name: mydb
|
||||||
|
path: /var/lib/sqlite3/mydb.sqlite
|
||||||
|
```
|
||||||
|
|
||||||
|
As part of each backup, borgmatic streams a database dump for each configured
|
||||||
|
database directly to Borg, so it's included in the backup without consuming
|
||||||
|
additional disk space. (The exceptions are the PostgreSQL/MongoDB "directory"
|
||||||
|
dump formats, which can't stream and therefore do consume temporary disk
|
||||||
|
space. Additionally, prior to borgmatic 1.5.3, all database dumps consumed
|
||||||
|
temporary disk space.)
|
||||||
|
|
||||||
|
To support this, borgmatic creates temporary named pipes in `~/.borgmatic` by
|
||||||
|
default. To customize this path, set the `borgmatic_source_directory` option
|
||||||
|
in the `location` section of borgmatic's configuration.
|
||||||
|
|
||||||
|
Also note that using a database hook implicitly enables both the
|
||||||
|
`read_special` and `one_file_system` configuration settings (even if they're
|
||||||
|
disabled in your configuration) to support this dump and restore streaming.
|
||||||
|
See Limitations below for more on this.
|
||||||
|
|
||||||
Here's a more involved example that connects to remote databases:
|
Here's a more involved example that connects to remote databases:
|
||||||
|
|
||||||
|
@ -33,6 +68,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
|
||||||
|
@ -40,13 +77,32 @@ 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:
|
||||||
|
- name: messages
|
||||||
|
hostname: database4.example.org
|
||||||
|
port: 27018
|
||||||
|
username: dbuser
|
||||||
|
password: trustsome1
|
||||||
|
authentication_database: mongousers
|
||||||
|
options: "--ssl"
|
||||||
|
sqlite_databases:
|
||||||
|
- name: mydb
|
||||||
|
path: /var/lib/sqlite3/mydb.sqlite
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See your [borgmatic configuration
|
||||||
|
file](https://torsion.org/borgmatic/docs/reference/configuration/) for
|
||||||
|
additional customization of the options passed to database commands (when
|
||||||
|
listing databases, restoring databases, etc.).
|
||||||
|
|
||||||
|
|
||||||
|
### All databases
|
||||||
|
|
||||||
If you want to dump all databases on a host, use `all` for the database name:
|
If you want to dump all databases on a host, use `all` for the database name:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -55,11 +111,104 @@ hooks:
|
||||||
- name: all
|
- name: all
|
||||||
mysql_databases:
|
mysql_databases:
|
||||||
- name: all
|
- name: all
|
||||||
|
mongodb_databases:
|
||||||
|
- name: all
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that you may need to use a `username` of the `postgres` superuser for
|
Note that you may need to use a `username` of the `postgres` superuser for
|
||||||
this to work with PostgreSQL.
|
this to work with PostgreSQL.
|
||||||
|
|
||||||
|
The SQLite hook in particular does not consider "all" a special database name.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.6</span> With
|
||||||
|
PostgreSQL and MySQL, you can optionally dump "all" databases to separate
|
||||||
|
files instead of one combined dump file, allowing more convenient restores of
|
||||||
|
individual databases. Enable this by specifying your desired database dump
|
||||||
|
`format`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
postgresql_databases:
|
||||||
|
- name: all
|
||||||
|
format: custom
|
||||||
|
mysql_databases:
|
||||||
|
- name: all
|
||||||
|
format: sql
|
||||||
|
```
|
||||||
|
|
||||||
|
### Containers
|
||||||
|
|
||||||
|
If your database is running within a Docker container and borgmatic is too, no
|
||||||
|
problem—simply configure borgmatic to connect to the container's name on its
|
||||||
|
exposed port. For instance:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
postgresql_databases:
|
||||||
|
- name: users
|
||||||
|
hostname: your-database-container-name
|
||||||
|
port: 5433
|
||||||
|
username: postgres
|
||||||
|
password: trustsome1
|
||||||
|
```
|
||||||
|
|
||||||
|
But what if borgmatic is running on the host? You can still connect to a
|
||||||
|
database container if its ports are properly exposed to the host. For
|
||||||
|
instance, when running the database container with Docker, you can specify
|
||||||
|
`--publish 127.0.0.1:5433:5432` so that it exposes the container's port 5432
|
||||||
|
to port 5433 on the host (only reachable on localhost, in this case). Or the
|
||||||
|
same thing with Docker Compose:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
your-database-container-name:
|
||||||
|
image: postgres
|
||||||
|
ports:
|
||||||
|
- 127.0.0.1:5433:5432
|
||||||
|
```
|
||||||
|
|
||||||
|
And then you can connect to the database from borgmatic running on the host:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
postgresql_databases:
|
||||||
|
- name: users
|
||||||
|
hostname: 127.0.0.1
|
||||||
|
port: 5433
|
||||||
|
username: postgres
|
||||||
|
password: trustsome1
|
||||||
|
```
|
||||||
|
|
||||||
|
Of course, alter the ports in these examples to suit your particular database
|
||||||
|
system.
|
||||||
|
|
||||||
|
|
||||||
|
### No source directories
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.1</span> If you
|
||||||
|
would like to backup databases only and not source directories, you can omit
|
||||||
|
`source_directories` entirely.
|
||||||
|
|
||||||
|
In older versions of borgmatic, instead specify an empty `source_directories`
|
||||||
|
value, as it is a mandatory option prior to version 1.7.1:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
location:
|
||||||
|
source_directories: []
|
||||||
|
hooks:
|
||||||
|
mysql_databases:
|
||||||
|
- name: all
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### External passwords
|
||||||
|
|
||||||
|
If you don't want to keep your database passwords in your borgmatic
|
||||||
|
configuration file, you can instead pass them in via [environment
|
||||||
|
variables](https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/)
|
||||||
|
or command-line [configuration
|
||||||
|
overrides](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#configuration-overrides).
|
||||||
|
|
||||||
|
|
||||||
### Configuration backups
|
### Configuration backups
|
||||||
|
|
||||||
|
@ -72,42 +221,47 @@ bring back any missing configuration files in order to restore a database.
|
||||||
|
|
||||||
## Supported databases
|
## Supported databases
|
||||||
|
|
||||||
As of now, borgmatic supports PostgreSQL and MySQL/MariaDB databases
|
As of now, borgmatic supports PostgreSQL, MySQL/MariaDB, MongoDB, and SQLite
|
||||||
directly. But see below about general-purpose preparation and cleanup hooks as
|
databases directly. But see below about general-purpose preparation and
|
||||||
a work-around with other database systems. Also, please [file a
|
cleanup hooks as a work-around with other database systems. Also, please [file
|
||||||
ticket](https://torsion.org/borgmatic/#issues) for additional database systems
|
a ticket](https://torsion.org/borgmatic/#issues) for additional database
|
||||||
that you'd like supported.
|
systems that you'd like supported.
|
||||||
|
|
||||||
|
|
||||||
## Database restoration
|
## Database restoration
|
||||||
|
|
||||||
To restore a database dump from an archive, use the `borgmatic restore`
|
To restore a database dump from an archive, use the `borgmatic restore`
|
||||||
action. But the first step is to figure out which archive to restore from. A
|
action. But the first step is to figure out which archive to restore from. A
|
||||||
good way to do that is to use the `list` action:
|
good way to do that is to use the `rlist` action:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic list
|
borgmatic rlist
|
||||||
```
|
```
|
||||||
|
|
||||||
(No borgmatic `list` action? Try the old-style `--list`, or upgrade
|
(No borgmatic `rlist` action? Try `list` instead or upgrade borgmatic!)
|
||||||
borgmatic!)
|
|
||||||
|
|
||||||
That should yield output looking something like:
|
That should yield output looking something like:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
host-2019-01-01T04:05:06.070809 Tue, 2019-01-01 04:05:06 [...]
|
host-2023-01-01T04:05:06.070809 Tue, 2023-01-01 04:05:06 [...]
|
||||||
host-2019-01-02T04:06:07.080910 Wed, 2019-01-02 04:06:07 [...]
|
host-2023-01-02T04:06:07.080910 Wed, 2023-01-02 04:06:07 [...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Assuming that you want to restore all database dumps from the archive with the
|
Assuming that you want to restore all database dumps from the archive with the
|
||||||
most up-to-date files and therefore the latest timestamp, run a command like:
|
most up-to-date files and therefore the latest timestamp, run a command like:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic restore --archive host-2019-01-02T04:06:07.080910
|
borgmatic restore --archive host-2023-01-02T04:06:07.080910
|
||||||
```
|
```
|
||||||
|
|
||||||
(No borgmatic `restore` action? Upgrade borgmatic!)
|
(No borgmatic `restore` action? Upgrade borgmatic!)
|
||||||
|
|
||||||
|
With newer versions of borgmatic, you can simplify this to:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic restore --archive latest
|
||||||
|
```
|
||||||
|
|
||||||
The `--archive` value is the name of the archive to restore from. This
|
The `--archive` value is the name of the archive to restore from. This
|
||||||
restores all databases dumps that borgmatic originally backed up to that
|
restores all databases dumps that borgmatic originally backed up to that
|
||||||
archive.
|
archive.
|
||||||
|
@ -123,10 +277,11 @@ If you have a single repository in your borgmatic configuration file(s), no
|
||||||
problem: the `restore` action figures out which repository to use.
|
problem: the `restore` action figures out which repository to use.
|
||||||
|
|
||||||
But if you have multiple repositories configured, then you'll need to specify
|
But if you have multiple repositories configured, then you'll need to specify
|
||||||
the repository path containing the archive to restore. Here's an example:
|
the repository to use via the `--repository` flag. This can be done either
|
||||||
|
with the repository's path or its label as configured in your borgmatic configuration file.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic restore --repository repo.borg --archive host-2019-...
|
borgmatic restore --repository repo.borg --archive host-2023-...
|
||||||
```
|
```
|
||||||
|
|
||||||
### Restore particular databases
|
### Restore particular databases
|
||||||
|
@ -136,9 +291,39 @@ restore one of them, use the `--database` flag to select one or more
|
||||||
databases. For instance:
|
databases. For instance:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic restore --archive host-2019-... --database users
|
borgmatic restore --archive host-2023-... --database users
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.6</span> You can
|
||||||
|
also restore individual databases even if you dumped them as "all"—as long as
|
||||||
|
you dumped them into separate files via use of the "format" option. See above
|
||||||
|
for more information.
|
||||||
|
|
||||||
|
|
||||||
|
### Restore all databases
|
||||||
|
|
||||||
|
To restore all databases:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic restore --archive host-2023-... --database all
|
||||||
|
```
|
||||||
|
|
||||||
|
Or omit the `--database` flag entirely:
|
||||||
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic restore --archive host-2023-...
|
||||||
|
```
|
||||||
|
|
||||||
|
Prior to borgmatic version 1.7.6, this restores a combined "all" database
|
||||||
|
dump from the archive.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.6</span> Restoring
|
||||||
|
"all" databases restores each database found in the selected archive. That
|
||||||
|
includes any combined dump file named "all" and any other individual database
|
||||||
|
dumps found in the archive.
|
||||||
|
|
||||||
|
|
||||||
### Limitations
|
### Limitations
|
||||||
|
|
||||||
There are a few important limitations with borgmatic's current database
|
There are a few important limitations with borgmatic's current database
|
||||||
|
@ -152,15 +337,36 @@ borgmatic's own configuration file. So include your configuration file in
|
||||||
backups to avoid getting caught without a way to restore a database.
|
backups to avoid getting caught without a way to restore a database.
|
||||||
3. borgmatic does not currently support backing up or restoring multiple
|
3. borgmatic does not currently support backing up or restoring multiple
|
||||||
databases that share the exact same name on different hosts.
|
databases that share the exact same name on different hosts.
|
||||||
|
4. Because database hooks implicitly enable the `read_special` configuration
|
||||||
|
setting to support dump and restore streaming, you'll need to ensure that any
|
||||||
|
special files are excluded from backups (named pipes, block devices,
|
||||||
|
character devices, and sockets) to prevent hanging. Try a command like
|
||||||
|
`find /your/source/path -type b -or -type c -or -type p -or -type s` to find
|
||||||
|
such files. Common directories to exclude are `/dev` and `/run`, but that may
|
||||||
|
not be exhaustive. <span class="minilink minilink-addedin">New in version
|
||||||
|
1.7.3</span> When database hooks are enabled, borgmatic automatically excludes
|
||||||
|
special files that may cause Borg to hang, so you no longer need to manually
|
||||||
|
exclude them. (This includes symlinks with special files as a destination.) You
|
||||||
|
can override/prevent this behavior by explicitly setting `read_special` to true.
|
||||||
|
|
||||||
|
|
||||||
### Manual restoration
|
### Manual restoration
|
||||||
|
|
||||||
If you prefer to restore a database without the help of borgmatic, first
|
If you prefer to restore a database without the help of borgmatic, first
|
||||||
[extract](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/) an
|
[extract](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/) an
|
||||||
archive containing a database dump, and then manually restore the dump file
|
archive containing a database dump.
|
||||||
found within the extracted `~/.borgmatic/` path (e.g. with `pg_restore` or
|
|
||||||
`mysql` commands).
|
borgmatic extracts the dump file into the *`username`*`/.borgmatic/` directory
|
||||||
|
within the extraction destination path, where *`username`* is the user that
|
||||||
|
created the backup. For example, if you created the backup with the `root`
|
||||||
|
user and you're extracting to `/tmp`, then the dump will be in
|
||||||
|
`/tmp/root/.borgmatic`.
|
||||||
|
|
||||||
|
After extraction, you can manually restore the dump file using native database
|
||||||
|
commands like `pg_restore`, `mysql`, `mongorestore`, `sqlite`, or similar.
|
||||||
|
|
||||||
|
Also see the documentation on [listing database
|
||||||
|
dumps](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#listing-database-dumps).
|
||||||
|
|
||||||
|
|
||||||
## Preparation and cleanup hooks
|
## Preparation and cleanup hooks
|
||||||
|
@ -175,6 +381,23 @@ dumps with any database system.
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
### PostgreSQL/MySQL authentication errors
|
||||||
|
|
||||||
|
With PostgreSQL and MySQL/MariaDB, if you're getting authentication errors
|
||||||
|
when borgmatic tries to connect to your database, a natural reaction is to
|
||||||
|
increase your borgmatic verbosity with `--verbosity 2` and go looking in the
|
||||||
|
logs. You'll notice however that your database password does not show up in
|
||||||
|
the logs. This is likely not the cause of the authentication problem unless
|
||||||
|
you mistyped your password, however; borgmatic passes your password to the
|
||||||
|
database via an environment variable that does not appear in the logs.
|
||||||
|
|
||||||
|
The cause of an authentication error is often on the database side—in the
|
||||||
|
configuration of which users are allowed to connect and how they are
|
||||||
|
authenticated. For instance, with PostgreSQL, check your
|
||||||
|
[pg_hba.conf](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html)
|
||||||
|
file for that configuration.
|
||||||
|
|
||||||
|
|
||||||
### MySQL table lock errors
|
### MySQL table lock errors
|
||||||
|
|
||||||
If you encounter table lock errors during a database dump with MySQL/MariaDB,
|
If you encounter table lock errors during a database dump with MySQL/MariaDB,
|
||||||
|
@ -190,10 +413,17 @@ hooks:
|
||||||
options: "--single-transaction --quick"
|
options: "--single-transaction --quick"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### borgmatic hangs during backup
|
||||||
|
|
||||||
## Related documentation
|
See Limitations above about `read_special`. You may need to exclude certain
|
||||||
|
paths with named pipes, block devices, character devices, or sockets on which
|
||||||
|
borgmatic is hanging.
|
||||||
|
|
||||||
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/)
|
Alternatively, if excluding special files is too onerous, you can create two
|
||||||
* [Add preparation and cleanup steps to backups](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/)
|
separate borgmatic configuration files—one for your source files and a
|
||||||
* [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)
|
separate one for backing up databases. That way, the database `read_special`
|
||||||
* [Extract a backup](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/)
|
option will not be active when backing up special files.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.3</span> See
|
||||||
|
Limitations above about borgmatic's automatic exclusion of special files to
|
||||||
|
prevent Borg hangs.
|
||||||
|
|
|
@ -1,64 +1,164 @@
|
||||||
---
|
---
|
||||||
title: How to deal with very large backups
|
title: How to deal with very large backups
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 📏 Deal with very large backups
|
||||||
|
parent: How-to guides
|
||||||
|
order: 4
|
||||||
---
|
---
|
||||||
## Biggish data
|
## Biggish data
|
||||||
|
|
||||||
Borg itself is great for efficiently de-duplicating data across successive
|
Borg itself is great for efficiently de-duplicating data across successive
|
||||||
backup archives, even when dealing with very large repositories. But you may
|
backup archives, even when dealing with very large repositories. But you may
|
||||||
find that while borgmatic's default mode of "prune, create, and check" works
|
find that while borgmatic's default actions of `create`, `prune`, `compact`,
|
||||||
well on small repositories, it's not so great on larger ones. That's because
|
and `check` works well on small repositories, it's not so great on larger
|
||||||
running the default consistency checks takes a long time on large
|
ones. That's because running the default pruning, compact, and consistency
|
||||||
repositories.
|
checks take a long time on large repositories.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">Prior to version 1.7.9</span> The
|
||||||
|
default action ordering was `prune`, `compact`, `create`, and `check`.
|
||||||
|
|
||||||
### A la carte actions
|
### A la carte actions
|
||||||
|
|
||||||
If you find yourself in this situation, you have some options. First, you can
|
If you find yourself wanting to customize the actions, you have some options.
|
||||||
run borgmatic's pruning, creating, or checking actions separately. For
|
First, you can run borgmatic's `prune`, `compact`, `create`, or `check`
|
||||||
instance, the the following optional actions are available:
|
actions separately. For instance, the following optional actions are
|
||||||
|
available (among others):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic prune
|
|
||||||
borgmatic create
|
borgmatic create
|
||||||
|
borgmatic prune
|
||||||
|
borgmatic compact
|
||||||
borgmatic check
|
borgmatic check
|
||||||
```
|
```
|
||||||
|
|
||||||
(No borgmatic `prune`, `create`, or `check` actions? Try the old-style
|
You can run borgmatic with only one of these actions provided, or you can mix
|
||||||
`--prune`, `--create`, or `--check`. Or upgrade borgmatic!)
|
and match any number of them in a single borgmatic run. This supports
|
||||||
|
approaches like skipping certain actions while running others. For instance,
|
||||||
|
this skips `prune` and `compact` and only runs `create` and `check`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic create check
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.9</span> borgmatic
|
||||||
|
now respects your specified command-line action order, running actions in the
|
||||||
|
order you specify. In previous versions, borgmatic ran your specified actions
|
||||||
|
in a fixed ordering regardless of the order they appeared on the command-line.
|
||||||
|
|
||||||
|
But instead of running actions together, another option is to run backups with
|
||||||
|
`create` on a frequent schedule (e.g. with `borgmatic create` called from one
|
||||||
|
cron job), while only running expensive consistency checks with `check` on a
|
||||||
|
much less frequent basis (e.g. with `borgmatic check` called from a separate
|
||||||
|
cron job).
|
||||||
|
|
||||||
You can run with only one of these actions provided, or you can mix and match
|
|
||||||
any number of them in a single borgmatic run. This supports approaches like
|
|
||||||
making backups with `create` on a frequent schedule, while only running
|
|
||||||
expensive consistency checks with `check` on a much less frequent basis from
|
|
||||||
a separate cron job.
|
|
||||||
|
|
||||||
### Consistency check configuration
|
### Consistency check configuration
|
||||||
|
|
||||||
Another option is to customize your consistency checks. The default
|
Another option is to customize your consistency checks. By default, if you
|
||||||
consistency checks run both full-repository checks and per-archive checks
|
omit consistency checks from configuration, borgmatic runs full-repository
|
||||||
within each repository.
|
checks (`repository`) and per-archive checks (`archives`) within each
|
||||||
|
repository. (Although see below about check frequency.) This is equivalent to
|
||||||
|
what `borg check` does if run without options.
|
||||||
|
|
||||||
But if you find that archive checks are too slow, for example, you can
|
But if you find that archive checks are too slow, for example, you can
|
||||||
configure borgmatic to run repository checks only. Configure this in the
|
configure borgmatic to run repository checks only. Configure this in the
|
||||||
`consistency` section of borgmatic configuration:
|
`consistency` section of borgmatic configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
consistency:
|
||||||
|
checks:
|
||||||
|
- name: repository
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">Prior to version 1.6.2</span> The
|
||||||
|
`checks` option was a plain list of strings without the `name:` part, and
|
||||||
|
borgmatic ran each configured check every time checks were run. For example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
consistency:
|
consistency:
|
||||||
checks:
|
checks:
|
||||||
- repository
|
- repository
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Here are the available checks from fastest to slowest:
|
||||||
|
|
||||||
|
* `repository`: Checks the consistency of the repository itself.
|
||||||
|
* `archives`: Checks all of the archives in the repository.
|
||||||
|
* `extract`: Performs an extraction dry-run of the most recent archive.
|
||||||
|
* `data`: Verifies the data integrity of all archives contents, decrypting and decompressing all data.
|
||||||
|
|
||||||
|
Note that the `data` check is a more thorough version of the `archives` check,
|
||||||
|
so enabling the `data` check implicitly enables the `archives` check as well.
|
||||||
|
|
||||||
|
See [Borg's check
|
||||||
|
documentation](https://borgbackup.readthedocs.io/en/stable/usage/check.html)
|
||||||
|
for more information.
|
||||||
|
|
||||||
|
### Check frequency
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.6.2</span> You can
|
||||||
|
optionally configure checks to run on a periodic basis rather than every time
|
||||||
|
borgmatic runs checks. For instance:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
consistency:
|
||||||
|
checks:
|
||||||
|
- name: repository
|
||||||
|
frequency: 2 weeks
|
||||||
|
- name: archives
|
||||||
|
frequency: 1 month
|
||||||
|
```
|
||||||
|
|
||||||
|
This tells borgmatic to run the `repository` consistency check at most once
|
||||||
|
every two weeks for a given repository and the `archives` check at most once a
|
||||||
|
month. The `frequency` value is a number followed by a unit of time, e.g. "3
|
||||||
|
days", "1 week", "2 months", etc.
|
||||||
|
|
||||||
|
The `frequency` defaults to `always` for a check configured without a
|
||||||
|
`frequency`, which means run this check every time checks run. But if you omit
|
||||||
|
consistency checks from configuration entirely, borgmatic runs full-repository
|
||||||
|
checks (`repository`) and per-archive checks (`archives`) within each
|
||||||
|
repository, at most once a month.
|
||||||
|
|
||||||
|
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
|
||||||
|
it's been since the last check for a given repository (as recorded in a file
|
||||||
|
within `~/.borgmatic/checks`). If it hasn't been long enough, the check is
|
||||||
|
skipped. And you still have to run `borgmatic check` (or `borgmatic` without
|
||||||
|
actions) in order for checks to run, even when a `frequency` is configured!
|
||||||
|
|
||||||
|
This also applies *across* configuration files that have the same repository
|
||||||
|
configured. Make sure you have the same check frequency configured in each
|
||||||
|
though—or the most frequently configured check will apply.
|
||||||
|
|
||||||
|
If you want to temporarily ignore your configured frequencies, you can invoke
|
||||||
|
`borgmatic check --force` to run checks unconditionally.
|
||||||
|
|
||||||
|
|
||||||
|
### Disabling checks
|
||||||
|
|
||||||
If that's still too slow, you can disable consistency checks entirely,
|
If that's still too slow, you can disable consistency checks entirely,
|
||||||
either for a single repository or for all repositories.
|
either for a single repository or for all repositories.
|
||||||
|
|
||||||
Disabling all consistency checks looks like this:
|
Disabling all consistency checks looks like this:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
consistency:
|
||||||
|
checks:
|
||||||
|
- name: disabled
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">Prior to version 1.6.2</span> `checks`
|
||||||
|
was a plain list of strings without the `name:` part. For instance:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
consistency:
|
consistency:
|
||||||
checks:
|
checks:
|
||||||
- disabled
|
- disabled
|
||||||
```
|
```
|
||||||
|
|
||||||
Or, if you have multiple repositories in your borgmatic configuration file,
|
If you have multiple repositories in your borgmatic configuration file,
|
||||||
you can keep running consistency checks, but only against a subset of the
|
you can keep running consistency checks, but only against a subset of the
|
||||||
repositories:
|
repositories:
|
||||||
|
|
||||||
|
@ -76,7 +176,8 @@ borgmatic check --only data --only extract
|
||||||
```
|
```
|
||||||
|
|
||||||
This is useful for running slow consistency checks on an infrequent basis,
|
This is useful for running slow consistency checks on an infrequent basis,
|
||||||
separate from your regular checks.
|
separate from your regular checks. It is still subject to any configured
|
||||||
|
check frequencies unless the `--force` flag is used.
|
||||||
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
@ -102,8 +203,3 @@ the following to the `~/.ssh/config` file on the client:
|
||||||
|
|
||||||
This should make the client keep the connection alive while validating
|
This should make the client keep the connection alive while validating
|
||||||
backups.
|
backups.
|
||||||
|
|
||||||
|
|
||||||
## Related documentation
|
|
||||||
|
|
||||||
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/)
|
|
||||||
|
|
|
@ -1,28 +1,32 @@
|
||||||
---
|
---
|
||||||
title: How to develop on borgmatic
|
title: How to develop on borgmatic
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 🏗️ Develop on borgmatic
|
||||||
|
parent: How-to guides
|
||||||
|
order: 13
|
||||||
---
|
---
|
||||||
## Source code
|
## Source code
|
||||||
|
|
||||||
To get set up to hack on borgmatic, first clone master via HTTPS or SSH:
|
To get set up to hack on borgmatic, first clone master via HTTPS or SSH:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://projects.torsion.org/witten/borgmatic.git
|
git clone https://projects.torsion.org/borgmatic-collective/borgmatic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
Or:
|
Or:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone ssh://git@projects.torsion.org:3022/witten/borgmatic.git
|
git clone ssh://git@projects.torsion.org:3022/borgmatic-collective/borgmatic.git
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, install borgmatic
|
Then, install borgmatic
|
||||||
"[editable](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)"
|
"[editable](https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs)"
|
||||||
so that you can run borgmatic commands while you're hacking on them to
|
so that you can run borgmatic commands while you're hacking on them to
|
||||||
make sure your changes work.
|
make sure your changes work.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd borgmatic/
|
cd borgmatic
|
||||||
pip3 install --editable --user .
|
pip3 install --user --editable .
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that this will typically install the borgmatic commands into
|
Note that this will typically install the borgmatic commands into
|
||||||
|
@ -47,7 +51,6 @@ pip3 install --user tox
|
||||||
Finally, to actually run tests, run:
|
Finally, to actually run tests, run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd borgmatic
|
|
||||||
tox
|
tox
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -62,8 +65,6 @@ following:
|
||||||
tox -e black
|
tox -e black
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that Black requires at minimum Python 3.6.
|
|
||||||
|
|
||||||
And if you get a complaint from the
|
And if you get a complaint from the
|
||||||
[isort](https://github.com/timothycrosley/isort) Python import orderer, you
|
[isort](https://github.com/timothycrosley/isort) Python import orderer, you
|
||||||
can ask isort to order your imports for you:
|
can ask isort to order your imports for you:
|
||||||
|
@ -72,17 +73,58 @@ can ask isort to order your imports for you:
|
||||||
tox -e isort
|
tox -e isort
|
||||||
```
|
```
|
||||||
|
|
||||||
### End-to-end tests
|
Similarly, if you get errors about spelling mistakes in source code, you can
|
||||||
|
ask [codespell](https://github.com/codespell-project/codespell) to correct
|
||||||
borgmatic additionally includes some end-to-end tests that integration test
|
|
||||||
with Borg for a few representative scenarios. These tests don't run by default
|
|
||||||
because they're relatively slow and depend on Borg. If you would like to run
|
|
||||||
them:
|
them:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tox -e end-to-end
|
tox -e codespell
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### End-to-end tests
|
||||||
|
|
||||||
|
borgmatic additionally includes some end-to-end tests that integration test
|
||||||
|
with Borg and supported databases for a few representative scenarios. These
|
||||||
|
tests don't run by default when running `tox`, because they're relatively slow
|
||||||
|
and depend on Docker containers for runtime dependencies. These tests tests do
|
||||||
|
run on the continuous integration (CI) server, and running them on your
|
||||||
|
developer machine is the closest thing to CI test parity.
|
||||||
|
|
||||||
|
If you would like to run the full test suite, first install Docker and [Docker
|
||||||
|
Compose](https://docs.docker.com/compose/install/). Then run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scripts/run-end-to-end-dev-tests
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that this scripts assumes you have permission to run Docker. If you
|
||||||
|
don't, then you may need to run with `sudo`.
|
||||||
|
|
||||||
|
|
||||||
|
#### Podman
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.12</span>
|
||||||
|
borgmatic's end-to-end tests optionally support using
|
||||||
|
[rootless](https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md)
|
||||||
|
[Podman](https://podman.io/) instead of Docker.
|
||||||
|
|
||||||
|
Setting up Podman is outside the scope of this documentation, but here are
|
||||||
|
some key points to double-check:
|
||||||
|
|
||||||
|
* Install Podman along with `podman-docker` and your desired networking
|
||||||
|
support.
|
||||||
|
* Configure `/etc/subuid` and `/etc/subgid` to map users/groups for the
|
||||||
|
non-root user who will run tests.
|
||||||
|
* Create a non-root Podman socket for that user:
|
||||||
|
```bash
|
||||||
|
systemctl --user enable --now podman.socket
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you'll be able to run end-to-end tests as per normal, and the test script
|
||||||
|
will automatically use your non-root Podman socket instead of a Docker socket.
|
||||||
|
|
||||||
|
|
||||||
## Code style
|
## Code style
|
||||||
|
|
||||||
Start with [PEP 8](https://www.python.org/dev/peps/pep-0008/). But then, apply
|
Start with [PEP 8](https://www.python.org/dev/peps/pep-0008/). But then, apply
|
||||||
|
@ -91,10 +133,10 @@ the following deviations from it:
|
||||||
* For strings, prefer single quotes over double quotes.
|
* For strings, prefer single quotes over double quotes.
|
||||||
* Limit all lines to a maximum of 100 characters.
|
* Limit all lines to a maximum of 100 characters.
|
||||||
* Use trailing commas within multiline values or argument lists.
|
* Use trailing commas within multiline values or argument lists.
|
||||||
* For multiline constructs, put opening and closing delimeters on lines
|
* For multiline constructs, put opening and closing delimiters on lines
|
||||||
separate from their contents.
|
separate from their contents.
|
||||||
* Within multiline constructs, use standard four-space indentation. Don't align
|
* Within multiline constructs, use standard four-space indentation. Don't align
|
||||||
indentation with an opening delimeter.
|
indentation with an opening delimiter.
|
||||||
|
|
||||||
borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
|
borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
|
||||||
formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
|
formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
|
||||||
|
@ -106,7 +148,7 @@ See the Black, Flake8, and isort documentation for more information.
|
||||||
|
|
||||||
Each pull request triggers a continuous integration build which runs the test
|
Each pull request triggers a continuous integration build which runs the test
|
||||||
suite. You can view these builds on
|
suite. You can view these builds on
|
||||||
[build.torsion.org](https://build.torsion.org/witten/borgmatic), and they're
|
[build.torsion.org](https://build.torsion.org/borgmatic-collective/borgmatic), and they're
|
||||||
also linked from the commits list on each pull request.
|
also linked from the commits list on each pull request.
|
||||||
|
|
||||||
## Documentation development
|
## Documentation development
|
||||||
|
@ -132,6 +174,14 @@ To close the documentation server, ctrl-C the script. Note that it does not
|
||||||
currently auto-reload, so you'll need to stop it and re-run it for any
|
currently auto-reload, so you'll need to stop it and re-run it for any
|
||||||
additional documentation changes to take effect.
|
additional documentation changes to take effect.
|
||||||
|
|
||||||
## Related documentation
|
|
||||||
|
|
||||||
* [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)
|
#### Podman
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.7.12</span>
|
||||||
|
borgmatic's developer build for documentation optionally supports using
|
||||||
|
[rootless](https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md)
|
||||||
|
[Podman](https://podman.io/) instead of Docker.
|
||||||
|
|
||||||
|
Setting up Podman is outside the scope of this documentation. But once you
|
||||||
|
install `podman-docker`, then `scripts/dev-docs` should automatically use
|
||||||
|
Podman instead of Docker.
|
||||||
|
|
|
@ -1,39 +1,48 @@
|
||||||
---
|
---
|
||||||
title: How to extract a backup
|
title: How to extract a backup
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 📤 Extract a backup
|
||||||
|
parent: How-to guides
|
||||||
|
order: 7
|
||||||
---
|
---
|
||||||
## Extract
|
## Extract
|
||||||
|
|
||||||
When the worst happens—or you want to test your backups—the first step is
|
When the worst happens—or you want to test your backups—the first step is
|
||||||
to figure out which archive to extract. A good way to do that is to use the
|
to figure out which archive to extract. A good way to do that is to use the
|
||||||
`list` action:
|
`rlist` action:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic list
|
borgmatic rlist
|
||||||
```
|
```
|
||||||
|
|
||||||
(No borgmatic `list` action? Try the old-style `--list`, or upgrade
|
(No borgmatic `rlist` action? Try `list` instead or upgrade borgmatic!)
|
||||||
borgmatic!)
|
|
||||||
|
|
||||||
That should yield output looking something like:
|
That should yield output looking something like:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
host-2019-01-01T04:05:06.070809 Tue, 2019-01-01 04:05:06 [...]
|
host-2023-01-01T04:05:06.070809 Tue, 2023-01-01 04:05:06 [...]
|
||||||
host-2019-01-02T04:06:07.080910 Wed, 2019-01-02 04:06:07 [...]
|
host-2023-01-02T04:06:07.080910 Wed, 2023-01-02 04:06:07 [...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Assuming that you want to extract the archive with the most up-to-date files
|
Assuming that you want to extract the archive with the most up-to-date files
|
||||||
and therefore the latest timestamp, run a command like:
|
and therefore the latest timestamp, run a command like:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic extract --archive host-2019-01-02T04:06:07.080910
|
borgmatic extract --archive host-2023-01-02T04:06:07.080910
|
||||||
```
|
```
|
||||||
|
|
||||||
(No borgmatic `extract` action? Try the old-style `--extract`, or upgrade
|
(No borgmatic `extract` action? Upgrade borgmatic!)
|
||||||
borgmatic!)
|
|
||||||
|
Or simplify this to:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic extract --archive latest
|
||||||
|
```
|
||||||
|
|
||||||
The `--archive` value is the name of the archive to extract. This extracts the
|
The `--archive` value is the name of the archive to extract. This extracts the
|
||||||
entire contents of the archive to the current directory, so make sure you're
|
entire contents of the archive to the current directory, so make sure you're
|
||||||
in the right place before running the command.
|
in the right place before running the command—or see below about the
|
||||||
|
`--destination` flag.
|
||||||
|
|
||||||
|
|
||||||
## Repository selection
|
## Repository selection
|
||||||
|
@ -42,10 +51,11 @@ If you have a single repository in your borgmatic configuration file(s), no
|
||||||
problem: the `extract` action figures out which repository to use.
|
problem: the `extract` action figures out which repository to use.
|
||||||
|
|
||||||
But if you have multiple repositories configured, then you'll need to specify
|
But if you have multiple repositories configured, then you'll need to specify
|
||||||
the repository path containing the archive to extract. Here's an example:
|
the repository to use via the `--repository` flag. This can be done either
|
||||||
|
with the repository's path or its label as configured in your borgmatic configuration file.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic extract --repository repo.borg --archive host-2019-...
|
borgmatic extract --repository repo.borg --archive host-2023-...
|
||||||
```
|
```
|
||||||
|
|
||||||
## Extract particular files
|
## Extract particular files
|
||||||
|
@ -55,13 +65,22 @@ everything from an archive. To do that, tack on one or more `--path` values.
|
||||||
For instance:
|
For instance:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic extract --archive host-2019-... --path path/1 path/2
|
borgmatic extract --archive latest --path path/1 path/2
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that the specified restore paths should not have a leading slash. Like a
|
Note that the specified restore paths should not have a leading slash. Like a
|
||||||
whole-archive extract, this also extracts into the current directory. So for
|
whole-archive extract, this also extracts into the current directory by
|
||||||
example, if you happen to be in the directory `/var` and you run the `extract`
|
default. So for example, if you happen to be in the directory `/var` and you
|
||||||
command above, borgmatic will extract `/var/path/1` and `/var/path/2`.
|
run the `extract` command above, borgmatic will extract `/var/path/1` and
|
||||||
|
`/var/path/2`.
|
||||||
|
|
||||||
|
|
||||||
|
### Searching for files
|
||||||
|
|
||||||
|
If you're not sure which archive contains the files you're looking for, you
|
||||||
|
can [search across
|
||||||
|
archives](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#searching-for-a-file).
|
||||||
|
|
||||||
|
|
||||||
## Extract to a particular destination
|
## Extract to a particular destination
|
||||||
|
|
||||||
|
@ -70,7 +89,7 @@ extract files to a particular destination directory, use the `--destination`
|
||||||
flag:
|
flag:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic extract --archive host-2019-... --destination /tmp
|
borgmatic extract --archive latest --destination /tmp
|
||||||
```
|
```
|
||||||
|
|
||||||
When using the `--destination` flag, be careful not to overwrite your system's
|
When using the `--destination` flag, be careful not to overwrite your system's
|
||||||
|
@ -94,18 +113,30 @@ archive as a [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace)
|
||||||
filesystem, you can use the `borgmatic mount` action. Here's an example:
|
filesystem, you can use the `borgmatic mount` action. Here's an example:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic mount --archive host-2019-... --mount-point /mnt
|
borgmatic mount --archive latest --mount-point /mnt
|
||||||
```
|
```
|
||||||
|
|
||||||
This mounts the entire archive on the given mount point `/mnt`, so that you
|
This mounts the entire archive on the given mount point `/mnt`, so that you
|
||||||
can look in there for your files.
|
can look in there for your files.
|
||||||
|
|
||||||
|
Omit the `--archive` flag to mount all archives (lazy-loaded):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic mount --mount-point /mnt
|
||||||
|
```
|
||||||
|
|
||||||
|
Or use the "latest" value for the archive to mount the latest archive:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic mount --archive latest --mount-point /mnt
|
||||||
|
```
|
||||||
|
|
||||||
If you'd like to restrict the mounted filesystem to only particular paths from
|
If you'd like to restrict the mounted filesystem to only particular paths from
|
||||||
your archive, use the `--path` flag, similar to the `extract` action above.
|
your archive, use the `--path` flag, similar to the `extract` action above.
|
||||||
For instance:
|
For instance:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic mount --archive host-2019-... --mount-point /mnt --path var/lib
|
borgmatic mount --archive latest --mount-point /mnt --path var/lib
|
||||||
```
|
```
|
||||||
|
|
||||||
When you're all done exploring your files, unmount your mount point. No
|
When you're all done exploring your files, unmount your mount point. No
|
||||||
|
@ -114,11 +145,3 @@ When you're all done exploring your files, unmount your mount point. No
|
||||||
```bash
|
```bash
|
||||||
borgmatic umount --mount-point /mnt
|
borgmatic umount --mount-point /mnt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Related documentation
|
|
||||||
|
|
||||||
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/)
|
|
||||||
* [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)
|
|
||||||
* [Monitor your backups](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
|
|
||||||
* [Backup your databases](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
|
||||||
|
|
5
docs/how-to/index.md
Normal file
5
docs/how-to/index.md
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
eleventyNavigation:
|
||||||
|
key: How-to guides
|
||||||
|
permalink: false
|
||||||
|
---
|
|
@ -1,5 +1,9 @@
|
||||||
---
|
---
|
||||||
title: How to inspect your backups
|
title: How to inspect your backups
|
||||||
|
eleventyNavigation:
|
||||||
|
key: 🔎 Inspect your backups
|
||||||
|
parent: How-to guides
|
||||||
|
order: 5
|
||||||
---
|
---
|
||||||
## Backup progress
|
## Backup progress
|
||||||
|
|
||||||
|
@ -33,18 +37,72 @@ borgmatic --stats
|
||||||
## Existing backups
|
## Existing backups
|
||||||
|
|
||||||
borgmatic provides convenient actions for Borg's
|
borgmatic provides convenient actions for Borg's
|
||||||
[list](https://borgbackup.readthedocs.io/en/stable/usage/list.html) and
|
[`list`](https://borgbackup.readthedocs.io/en/stable/usage/list.html) and
|
||||||
[info](https://borgbackup.readthedocs.io/en/stable/usage/info.html)
|
[`info`](https://borgbackup.readthedocs.io/en/stable/usage/info.html)
|
||||||
functionality:
|
functionality:
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic list
|
borgmatic list
|
||||||
borgmatic info
|
borgmatic info
|
||||||
```
|
```
|
||||||
|
|
||||||
(No borgmatic `list` or `info` actions? Try the old-style `--list` or
|
You can change the output format of `borgmatic list` by specifying your own
|
||||||
`--info`. Or upgrade borgmatic!)
|
with `--format`. Refer to the [borg list --format
|
||||||
|
documentation](https://borgbackup.readthedocs.io/en/stable/usage/list.html#the-format-specifier-syntax)
|
||||||
|
for available values.
|
||||||
|
|
||||||
|
*(No borgmatic `list` or `info` actions? Upgrade borgmatic!)*
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in borgmatic version 1.7.0</span>
|
||||||
|
There are also `rlist` and `rinfo` actions for displaying repository
|
||||||
|
information with Borg 2.x:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic rlist
|
||||||
|
borgmatic rinfo
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [borgmatic command-line
|
||||||
|
reference](https://torsion.org/borgmatic/docs/reference/command-line/) for
|
||||||
|
more information.
|
||||||
|
|
||||||
|
|
||||||
|
### Searching for a file
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.6.3</span> Let's say
|
||||||
|
you've accidentally deleted a file and want to find the backup archive(s)
|
||||||
|
containing it. `borgmatic list` provides a `--find` flag for exactly this
|
||||||
|
purpose. For instance, if you're looking for a `foo.txt`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic list --find foo.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
This will list your archives and indicate those with files matching
|
||||||
|
`*foo.txt*` anywhere in the archive. The `--find` parameter can alternatively
|
||||||
|
be a [Borg
|
||||||
|
pattern](https://borgbackup.readthedocs.io/en/stable/usage/help.html#borg-patterns).
|
||||||
|
|
||||||
|
To limit the archives searched, use the standard `list` parameters for
|
||||||
|
filtering archives such as `--last`, `--archive`, `--match-archives`, etc. For
|
||||||
|
example, to search only the last five archives:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic list --find foo.txt --last 5
|
||||||
|
```
|
||||||
|
|
||||||
|
## Listing database dumps
|
||||||
|
|
||||||
|
If you have enabled borgmatic's [database
|
||||||
|
hooks](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/), you
|
||||||
|
can list backed up database dumps via borgmatic. For example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic list --archive latest --find .borgmatic/*_databases
|
||||||
|
```
|
||||||
|
|
||||||
|
This gives you a listing of all database dump files contained in the latest
|
||||||
|
archive, complete with file sizes.
|
||||||
|
|
||||||
|
|
||||||
## Logging
|
## Logging
|
||||||
|
@ -53,7 +111,7 @@ By default, borgmatic logs to a local syslog-compatible daemon if one is
|
||||||
present and borgmatic is running in a non-interactive console. Where those
|
present and borgmatic is running in a non-interactive console. Where those
|
||||||
logs show up depends on your particular system. If you're using systemd, try
|
logs show up depends on your particular system. If you're using systemd, try
|
||||||
running `journalctl -xe`. Otherwise, try viewing `/var/log/syslog` or
|
running `journalctl -xe`. Otherwise, try viewing `/var/log/syslog` or
|
||||||
similiar.
|
similar.
|
||||||
|
|
||||||
You can customize the log level used for syslog logging with the
|
You can customize the log level used for syslog logging with the
|
||||||
`--syslog-verbosity` flag, and this is independent from the console logging
|
`--syslog-verbosity` flag, and this is independent from the console logging
|
||||||
|
@ -95,13 +153,40 @@ borgmatic --log-file /path/to/file.log
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that if you use the `--log-file` flag, you are responsible for rotating
|
Note that if you use the `--log-file` flag, you are responsible for rotating
|
||||||
the log file so it doesn't grow too large. Also, there is a
|
the log file so it doesn't grow too large, for example with
|
||||||
`--log-file-verbosity` flag to customize the log file's log level.
|
[logrotate](https://wiki.archlinux.org/index.php/Logrotate).
|
||||||
|
|
||||||
|
You can the `--log-file-verbosity` flag to customize the log file's log level:
|
||||||
|
|
||||||
## Related documentation
|
```bash
|
||||||
|
borgmatic --log-file /path/to/file.log --log-file-verbosity 2
|
||||||
|
```
|
||||||
|
|
||||||
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/)
|
<span class="minilink minilink-addedin">New in version 1.7.11</span> Use the
|
||||||
* [Monitor your backups](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
|
`--log-file-format` flag to override the default log message format. This
|
||||||
* [Add preparation and cleanup steps to backups](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/)
|
format string can contain a series of named placeholders wrapped in curly
|
||||||
* [Develop on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/)
|
brackets. For instance, the default log format is: `[{asctime}] {levelname}:
|
||||||
|
{message}`. This means each log message is recorded as the log time (in square
|
||||||
|
brackets), a logging level name, a colon, and the actual log message.
|
||||||
|
|
||||||
|
So if you just want each log message to get logged *without* a timestamp or a
|
||||||
|
logging level name:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic --log-file /path/to/file.log --log-file-format "{message}"
|
||||||
|
```
|
||||||
|
|
||||||
|
Here is a list of available placeholders:
|
||||||
|
|
||||||
|
* `{asctime}`: time the log message was created
|
||||||
|
* `{levelname}`: level of the log message (`INFO`, `DEBUG`, etc.)
|
||||||
|
* `{lineno}`: line number in the source file where the log message originated
|
||||||
|
* `{message}`: actual log message
|
||||||
|
* `{pathname}`: path of the source file where the log message originated
|
||||||
|
|
||||||
|
See the [Python logging
|
||||||
|
documentation](https://docs.python.org/3/library/logging.html#logrecord-attributes)
|
||||||
|
for additional placeholders.
|
||||||
|
|
||||||
|
Note that this `--log-file-format` flg only applies to the specified
|
||||||
|
`--log-file` and not to syslog or other logging.
|
||||||
|
|
55
docs/how-to/make-backups-redundant.md
Normal file
55
docs/how-to/make-backups-redundant.md
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
---
|
||||||
|
title: How to make backups redundant
|
||||||
|
eleventyNavigation:
|
||||||
|
key: ☁️ Make backups redundant
|
||||||
|
parent: How-to guides
|
||||||
|
order: 3
|
||||||
|
---
|
||||||
|
## Multiple repositories
|
||||||
|
|
||||||
|
If you really care about your data, you probably want more than one backup of
|
||||||
|
it. borgmatic supports this in its configuration by specifying multiple backup
|
||||||
|
repositories. Here's an example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
location:
|
||||||
|
# List of source directories to backup.
|
||||||
|
source_directories:
|
||||||
|
- /home
|
||||||
|
- /etc
|
||||||
|
|
||||||
|
# Paths of local or remote repositories to backup to.
|
||||||
|
repositories:
|
||||||
|
- path: ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
|
||||||
|
- path: /var/lib/backups/local.borg
|
||||||
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">Prior to version 1.7.10</span> Omit
|
||||||
|
the `path:` portion of the `repositories` list.
|
||||||
|
|
||||||
|
When you run borgmatic with this configuration, it invokes Borg once for each
|
||||||
|
configured repository in sequence. (So, not in parallel.) That means—in each
|
||||||
|
repository—borgmatic creates a single new backup archive containing all of
|
||||||
|
your source directories.
|
||||||
|
|
||||||
|
Here's a way of visualizing what borgmatic does with the above configuration:
|
||||||
|
|
||||||
|
1. Backup `/home` and `/etc` to `k8pDxu32@k8pDxu32.repo.borgbase.com:repo`
|
||||||
|
2. Backup `/home` and `/etc` to `/var/lib/backups/local.borg`
|
||||||
|
|
||||||
|
This gives you redundancy of your data across repositories and even
|
||||||
|
potentially across providers.
|
||||||
|
|
||||||
|
See [Borg repository URLs
|
||||||
|
documentation](https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls)
|
||||||
|
for more information on how to specify local and remote repository paths.
|
||||||
|
|
||||||
|
### Different options per repository
|
||||||
|
|
||||||
|
What if you want borgmatic to backup to multiple repositories—while also
|
||||||
|
setting different options for each one? In that case, you'll need to use
|
||||||
|
[a separate borgmatic configuration file for each
|
||||||
|
repository](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/)
|
||||||
|
instead of the multiple repositories in one configuration file as described
|
||||||
|
above. That's because all of the repositories in a particular configuration
|
||||||
|
file get the same options applied.
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user