├── LICENSE ├── README.md └── lvm-restic-backup.sh /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LVM restic & rescript backup 2 | 3 | This bash script backups logical volumes via [restic](https://restic.net/). To simplify repo handling, this script takes repo details from [rescript](https://gitlab.com/sulfuror/rescript.sh) config. 4 | 5 | ## Requirements 6 | - [restic](https://restic.net/) 7 | - [rescript](https://gitlab.com/sulfuror/rescript.sh) 8 | - [pigz](https://zlib.net/pigz/) 9 | - [awk]() 10 | 11 | ## Additional requirements for Restore 12 | - [pv](https://packages.debian.org/bullseye/pv) 13 | - [jq](https://packages.debian.org/bullseye/jq) 14 | - pip3 15 | - python3: humanfriendly 16 | 17 | ## Optional Req. for Zabbix Monitoring 18 | - zabbix-sender 19 | - pip3 20 | - python3: humanfriendly 21 | - Zabbix [Rescript Restic Backup Template](https://github.com/sebastian13/zabbix-template-rescript) 22 | 23 | ## How to use 24 | 25 | ```bash 26 | lvm-rescript [repo_name] [command] [lv_name|path-to-list] 27 | ``` 28 | 29 | ### Commands 30 | - `block-level-backup` creates a lvm-snapshot & pipes the volume using dd to restic 31 | - `block-level-gz-backup` creates a lvm-snapshot & pipes the volume using dd and pigz to restic 32 | - `file-level-backup` creates a lvm-snapshot & creates a restic backup using the mounted snapshot 33 | - `block-level-restore` restores dd stored logical volume(s) 34 | - `block-level-gz-restore` restores dd and pigz stored logical volume(s) 35 | - `file-level-restore` restores as ext4 disk using a volume mount 36 | 37 | ### Logical Volume 38 | - Provide the LV name without VG. 39 | - Provide the path to a list of LV names. LVs listed as #comment won't be backed up. 40 | - Omit, to backup all volumes, except \*bak, \*cache, \*swap, \*swp and \*tmp. 41 | 42 | ## How to install 43 | 44 | ```bash 45 | curl -o /usr/bin/lvm-rescript https://raw.githubusercontent.com/sebastian13/lvm-restic-backup/master/lvm-restic-backup.sh 46 | chmod +x /usr/bin/lvm-rescript 47 | ``` 48 | 49 | For Zabbix LVM Discovery also download the [script](https://github.com/sebastian13/zabbix-template-rescript): 50 | 51 | ```bash 52 | curl -o /etc/zabbix/scripts/rescript-lvm-discovery.pl https://raw.githubusercontent.com/sebastian13/zabbix-templates/master/rescript-restic-backup/scripts/rescript-lvm-discovery.pl 53 | chmod +x /etc/zabbix/scripts/rescript-lvm-discovery.pl 54 | ``` 55 | -------------------------------------------------------------------------------- /lvm-restic-backup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # ------------------------------------------------------- 4 | # How To Use 5 | # ------------------------------------------------------- 6 | 7 | # Exit if any statement returns a non-true value 8 | set -e 9 | set -o pipefail 10 | 11 | # Define various output colors 12 | cecho () { 13 | local _color=$1; shift 14 | # If running via cron, don't use colors. 15 | if tty -s 16 | then 17 | echo -e "$(tput setaf $_color)$@$(tput sgr0)" 18 | else 19 | echo $1 20 | fi 21 | } 22 | black=0; red=1; green=2; yellow=3; blue=4; pink=5; cyan=6; white=7; 23 | 24 | help () { 25 | echo 26 | cecho $blue "LVM RESCRIPT & RESTIC BACKUP" 27 | cecho $blue "----------------------------" 28 | cecho $blue "Author: Sebastian Plocek" 29 | cecho $blue "URL: https://github.com/sebastian13/lvm-restic-backup" 30 | echo 31 | cecho $blue "Usage:" 32 | cecho $blue " lvm-rescript [repo_name] [command] [lv_name|path-to-list]" 33 | echo 34 | cecho $blue "Commands:" 35 | cecho $blue " block-level-backup Creates a lvm-snapshot & pipes the volume using dd to restic" 36 | cecho $blue " block-level-gz-backup Creates a lvm-snapshot & pipes the volume using dd and pigz to restic" 37 | cecho $blue " file-level-backup Creates a lvm-snapshot & creates a restic backup using the mounted snapshot" 38 | cecho $blue " restore Restores logical volume(s)" 39 | echo 40 | cecho $blue "Logical Volume:" 41 | cecho $blue " Provide the LV name without VG." 42 | cecho $blue " Provide the path to a list of LV names. LVs listed as #comment won't be backed up." 43 | cecho $blue " Omit, to backup all volumes, except *bak, *cache, *swap, *swp and *tmp." 44 | echo 45 | } 46 | 47 | # initialise variables 48 | CURRDIR="$(dirname "$(readlink -f "$0")")" 49 | RESTIC_EXCLUDE="/etc/restic/exclude.txt" 50 | LVM_SNAPSHOT_BUFFER="10G" 51 | WORKDIR="/" 52 | 53 | # Change to WORKDIR 54 | # Restic will save this path 55 | cd $WORKDIR 56 | 57 | # Create Log Directory 58 | LOGDIR="/var/log/lvm-restic" 59 | mkdir -p $LOGDIR 60 | RLOG="${LOGDIR}/lvm-rescript-running.log" 61 | 62 | # ------------------------------------------------------- 63 | # Check package availability 64 | # ------------------------------------------------------- 65 | 66 | command -v restic >/dev/null 2>&1 || { echo "[Error] Please install restic"; exit 1; } 67 | command -v rescript >/dev/null 2>&1 || { echo "[Error] Please install rescript"; exit 1; } 68 | 69 | # ------------------------------------------------------- 70 | # Loop to load arguments 71 | # ------------------------------------------------------- 72 | 73 | # if no argument, display help 74 | if [ $# -eq 0 ] 75 | then 76 | help 77 | exit 78 | fi 79 | 80 | case "$1" in 81 | help) 82 | help 83 | exit 84 | ;; 85 | esac 86 | 87 | # ------------------------------------------------------- 88 | # Load Repository Details 89 | # ------------------------------------------------------- 90 | repo="$1" 91 | rescript_dir="$HOME/.rescript" 92 | config_dir="$rescript_dir/config" 93 | config_file="$config_dir/$repo.conf" 94 | 95 | # Check if repo config exists 96 | if [[ ! -e "$config_dir/$1.conf" && ! -e "$config_dir/$1.conf.gpg" ]] ; then 97 | echo "There is no repo or command for [$1]. Indicate a valid" 98 | echo "repo name or command to proceed. Run [lvm-rescript help] for usage." 99 | exit 100 | fi 101 | 102 | # Check if the repository exists 103 | echo "[INFO] Looking for your restic repository. Please be patient." 104 | rescript ${repo} snapshots > /dev/null 2>&1 || { echo "[Error]"; rescript ${repo} snapshots; exit 1; } 105 | 106 | source "$config_file" 107 | export RESTIC_REPOSITORY="$RESTIC_REPO" 108 | export B2_ACCOUNT_ID="$B2_ID" 109 | export B2_ACCOUNT_KEY="$B2_KEY" 110 | export AWS_ACCESS_KEY_ID="$AWS_ID" 111 | export AWS_SECRET_ACCESS_KEY="$AWS_KEY" 112 | export AZURE_ACCOUNT_NAME="$AZURE_NAME" 113 | export AZURE_ACCOUNT_KEY="$AZURE_KEY" 114 | export GOOGLE_PROJECT_ID="$GOOGLE_ID" 115 | export GOOGLE_APPLICATION_CREDENTIALS="$GOOGLE_CREDENTIALS" 116 | if [[ "$RESCRIPT_PASS" ]] ; then 117 | export RESTIC_PASSWORD="$RESCRIPT_PASS" 118 | else 119 | export RESTIC_PASSWORD="$RESTIC_PASSWORD" 120 | fi 121 | 122 | 123 | # ------------------------------------------------------- 124 | # Avoid running multiple instances of this script 125 | # 126 | # Copyright (C) 2009 Przemyslaw Pawelczyk 127 | # https://gist.github.com/przemoc/571091 128 | # SPDX-License-Identifier: MIT 129 | # ------------------------------------------------------- 130 | 131 | # Suppress LVM warning about open file descriptors 132 | export LVM_SUPPRESS_FD_WARNINGS=1 133 | 134 | LOCKFILE="/var/lock/lvm-restic-backup" 135 | LOCKFD=99 136 | 137 | _lock() { flock -"$@" $LOCKFD; } 138 | _no_more_locking() { _lock u; _lock xn && rm -f $LOCKFILE; } 139 | _prepare_locking() { eval "exec $LOCKFD>\"$LOCKFILE\""; trap _no_more_locking EXIT; } 140 | 141 | _prepare_locking 142 | 143 | exlock_now() { _lock xn; } # obtain an exclusive lock immediately or fail 144 | exlock() { _lock xw 36000; } # obtain an exclusive lock, fail if cannot be acquired within 10h 145 | shlock() { _lock s; } # obtain a shared lock 146 | unlock() { _lock u; } # drop a lock 147 | chlock() { _lock n; } # check a lock 148 | 149 | chlock || { cecho $yellow "[INFO] A lockfile on ${LOCKFILE} is present. This indicates"; \ 150 | cecho $yellow " another instance of lvm-restic-backup is currently running."; \ 151 | cecho $yellow " Will wait for max. 10 hours for the other instance to finish."; } 152 | 153 | exlock || { cecho $red "[ABORTED] A lockfile on ${LOCKFILE} is present. This indicates"; \ 154 | cecho $red " another instance of lvm-restic-backup was running."; \ 155 | cecho $red " The execution was stopped after waiting for 10h."; exit 1; } 156 | 157 | # ------------------------------------------------------- 158 | # The backup tasks 159 | # ------------------------------------------------------- 160 | 161 | failed () { 162 | echo 163 | echo " ___ ___ __ " 164 | echo "|__ /\ | | |__ | \ " 165 | echo "| /--\ | |___ |___ |__/ " 166 | echo 167 | exit 1 168 | } 169 | 170 | all-done () { 171 | echo " __ __ ___ " 172 | echo " /\ | | | \ / \ |\ | |__ " 173 | echo "/--\ |___ |___ |__/ \__/ | \| |___ " 174 | echo 175 | exit 0 176 | } 177 | 178 | # ------------------------------------------------------- 179 | # Cleaning Functions 180 | # ------------------------------------------------------- 181 | 182 | clean-snapshot () { 183 | # Look for old snapshots of ${SNAPSHOT_PATH} 184 | if (lvs -o lv_path --noheadings -S "lv_attr=~[^s.*]" | grep -wo "${SNAPSHOT_PATH}") 185 | then 186 | cecho $red "[WARNING] ${SNAPSHOT_NAME} already exists." 187 | cecho $red " I will remove it in 5 seconds!" 188 | sleep 5 189 | lvremove -f ${SNAPSHOT_PATH} 190 | fi 191 | } 192 | 193 | clean-all-snapshots () { 194 | # Look for old snapshots 195 | ACTIVE_SNAPSHOTS=$(lvs -o lv_path --noheadings --select "lv_name=~[_snapshot$],lv_attr=~[^s.*]" | tr -d ' ') 196 | if [ -n "$ACTIVE_SNAPSHOTS" ] 197 | then 198 | cecho $red "Removing the following active snapshots:" 199 | cecho $red "${ACTIVE_SNAPSHOTS}" 200 | echo 201 | sleep 10 202 | for i in ${ACTIVE_SNAPSHOTS} 203 | do 204 | SNAPSHOT_LV_NAME=$(lvs -o lv_name --noheadings --select "lv_path=$i" | tr -d ' ') 205 | SNAPSHOT_MOUNTPOINT="/mnt/${SNAPSHOT_LV_NAME}" 206 | if [ -d ${SNAPSHOT_MOUNTPOINT} ] 207 | then 208 | if (mountpoint -q "$SNAPSHOT_MOUNTPOINT") 209 | then 210 | cecho $red "$SNAPSHOT_LV_NAME is mounted! I will unmount ${SNAPSHOT_MOUNTPOINT} in 5 seconds!" 211 | sleep 5 212 | umount ${SNAPSHOT_MOUNTPOINT} 213 | echo 214 | fi 215 | cecho $red "Removing ${SNAPSHOT_MOUNTPOINT}" 216 | rmdir ${SNAPSHOT_MOUNTPOINT} 217 | echo 218 | fi 219 | cecho $red "Removing LV $i" 220 | lvremove -f $i 221 | echo 222 | done 223 | else 224 | cecho $green "There are no active snapshots named *_snapshot on this system." 225 | echo 226 | fi 227 | } 228 | 229 | # trap ctrl-c and call ctrl_c() 230 | trap ctrl_c INT 231 | ctrl_c () { 232 | echo 233 | cecho $red "=======================================================" 234 | cecho $red "Trapped CTRL-C" 235 | cecho $red "Signal interrupt received, cleaning up" 236 | echo 237 | clean-all-snapshots 238 | exit 130 239 | } 240 | 241 | # ------------------------------------------------------- 242 | # Backup Functions 243 | # ------------------------------------------------------- 244 | 245 | # Block Level Backup piped to restic 246 | block-level-backup () { 247 | printf "\n======\n`date`\nBACKUP_LV: ${BACKUP_LV}\n\n" | tee -a ${LOGDIR}/lvm-restic-block-level-backup.log 248 | 249 | dd if=${SNAPSHOT_PATH} bs=4M status=none | \ 250 | restic backup \ 251 | --verbose \ 252 | --tag LV \ 253 | --tag block-level-backup \ 254 | --tag ${BACKUP_LV_SIZE}g_size \ 255 | --tag ${BACKUP_LV} \ 256 | --stdin \ 257 | --stdin-filename ${BACKUP_LV}.img | \ 258 | tee -a ${LOGDIR}/lvm-restic-block-level-backup.log | \ 259 | tee ${RLOG} 260 | echo 261 | } 262 | 263 | block-level-gz-backup () { 264 | command -v pigz >/dev/null 2>&1 || { echo "[Error] Please install pigz"; exit 1; } 265 | 266 | printf "\n======\n`date`\nBACKUP_LV: ${BACKUP_LV}\n\n" | tee -a ${LOGDIR}/lvm-restic-block-level-gz-backup.log 267 | 268 | dd if=${SNAPSHOT_PATH} bs=4M status=none | \ 269 | pigz --fast --rsyncable | \ 270 | restic backup \ 271 | --verbose \ 272 | --tag LV \ 273 | --tag block-level-backup \ 274 | --tag pigz \ 275 | --tag ${BACKUP_LV} \ 276 | --tag ${BACKUP_LV_SIZE}g_size \ 277 | --stdin \ 278 | --stdin-filename ${BACKUP_LV}.img.gz | \ 279 | tee -a ${LOGDIR}/lvm-restic-block-level-gz-backup.log | \ 280 | tee ${RLOG} 281 | echo 282 | } 283 | 284 | # File Level Backup using restic 285 | file-level-backup () { 286 | SNAPSHOT_MOUNTPOINT="/mnt/${SNAPSHOT_NAME}" 287 | 288 | # Create the snapshot mount directory 289 | if [ ! -d ${SNAPSHOT_MOUNTPOINT} ] ; then 290 | mkdir ${SNAPSHOT_MOUNTPOINT} 291 | fi 292 | 293 | # Protect the snapshot mount-point 294 | chmod go-rwx ${SNAPSHOT_MOUNTPOINT} 295 | 296 | # Mount the snapshot read-only 297 | mount -o ro ${SNAPSHOT_PATH} ${SNAPSHOT_MOUNTPOINT} 298 | 299 | # Check free Space on volume 300 | DF=$(df -hlP ${SNAPSHOT_MOUNTPOINT} | awk 'int($5)>80{print "Volume "$1" has only "$4" free space left."}') 301 | 302 | printf "\n======\n`date`\nBACKUP_LV: ${BACKUP_LV}\n\n" | tee -a ${LOGDIR}/lvm-restic-file-level-backup.log 303 | 304 | restic \ 305 | --verbose \ 306 | --tag LV \ 307 | --tag file-level-backup \ 308 | --tag ${BACKUP_LV} \ 309 | --tag ${BACKUP_LV_SIZE}g_size \ 310 | backup ${SNAPSHOT_MOUNTPOINT} \ 311 | --exclude-file="${RESTIC_EXCLUDE}" | \ 312 | tee -a ${LOGDIR}/lvm-restic-file-level-backup.log | \ 313 | tee ${RLOG} 314 | 315 | # Unmount the Snapshot & Delete the mount-point 316 | umount ${SNAPSHOT_MOUNTPOINT} 317 | rmdir ${SNAPSHOT_MOUNTPOINT} 318 | } 319 | 320 | snap-and-back () { 321 | echo 322 | cecho $blue "=======================================================" 323 | cecho $blue "Starting backup of LV $BACKUP_LV" 324 | echo 325 | sleep 5 326 | 327 | # Get the Path + Size of the LV to Backup 328 | BACKUP_LV_PATH=$(lvs --noheading -o lv_path | grep -P "/${BACKUP_LV}( |$)" | tr -d ' ') 329 | BACKUP_LV_SIZE=$(lvs ${BACKUP_LV_PATH} -o LV_SIZE --noheadings --units g --nosuffix | sed 's/,/./g') 330 | SNAPSHOT_NAME="${BACKUP_LV}_snapshot" 331 | SNAPSHOT_PATH="${BACKUP_LV_PATH}_snapshot" 332 | 333 | # Check if LV does exist 334 | if [ ! ${BACKUP_LV_PATH} ] 335 | then 336 | echo "[Error] Cannot find path for ${BACKUP_LV}" 337 | failed 338 | exit 1 339 | fi 340 | 341 | # Check for old snapshots 342 | clean-snapshot 343 | 344 | # Create the snapshot 345 | lvcreate --quiet -L${LVM_SNAPSHOT_BUFFER} -s -n ${SNAPSHOT_NAME} ${BACKUP_LV_PATH} > /dev/null 346 | 347 | eval $cmd 348 | 349 | lvremove -f ${SNAPSHOT_PATH} > /dev/null 350 | 351 | log-backup 352 | } 353 | 354 | backup () { 355 | zabbix-requirements 356 | zabbix-discovery 357 | 358 | if [ "${LV_TO_BACKUP}" ] 359 | then 360 | if [ -f "${LV_TO_BACKUP}" ] 361 | then 362 | echo "[INFO] Verify that all listed LVs exist" 363 | echo "# Temporary backup list `date`" > /tmp/backuplist.tmp 364 | grep -v '^#' ${LV_TO_BACKUP} | while read -r line 365 | do 366 | if (lvs --noheading -o lv_path | grep -P "/$line( |$)"); then 367 | echo "$line" >> /tmp/backuplist.tmp 368 | else 369 | echo 370 | cecho $red "[ERROR] Could not find $line ! <<<<<<<<" 371 | cecho $red " $line cannot be included in this backup ! <<<<<<<<" 372 | echo 373 | fi 374 | done 375 | 376 | # Rewrite Backup List to exclude missing LVs 377 | LV_TO_BACKUP="/tmp/backuplist.tmp" 378 | 379 | # Read the file provided and backup each LV 380 | grep -v '^#' ${LV_TO_BACKUP} | while read -r line 381 | do 382 | BACKUP_LV=$line 383 | snap-and-back 384 | done 385 | else 386 | # Backup LV provided 387 | BACKUP_LV=${LV_TO_BACKUP} 388 | snap-and-back 389 | fi 390 | else 391 | lvs --noheading -o lv_name --select 'lv_attr!~[^s],lv_name!~[bak$|cache$|swap$|swp$|tmp$]' | \ 392 | tr -d ' ' | while read line 393 | do 394 | BACKUP_LV=$line 395 | snap-and-back 396 | done 397 | fi 398 | } 399 | 400 | # ------------------------------------------------------- 401 | # The restore task 402 | # ------------------------------------------------------- 403 | 404 | block-level-restore () { 405 | command -v pv >/dev/null 2>&1 || { echo "[Error] Please install pv"; exit 1; } 406 | command -v awk >/dev/null 2>&1 || { echo "[Error] Please install awk"; exit 1; } 407 | command -v jq >/dev/null 2>&1 || { echo "[Error] Please install jq"; exit 1; } 408 | command -v pip3 >/dev/null 2>&1 || { echo "[Error] Please install python3-pip"; exit 1; } 409 | if ! `python3 -c 'import humanfriendly' >/dev/null 2>&1` 410 | then 411 | cecho $red "Could not import python3 humanfriendly!" 412 | cecho $red "Please run 'pip3 install humanfriendly'." 413 | fi 414 | 415 | cecho $pink "Getting all snapshots of ${restore_lv_name}" 416 | restic snapshots --tag block-level-backup,${restore_lv_name} 417 | 418 | snapshots_json=$(restic snapshots --json --path \/${restore_lv_name}.img) 419 | arr=( $(echo $snapshots_json | jq -r '.[].short_id') ) 420 | 421 | COLUMNS=12 422 | cecho $pink "Which snapshot should be restored?" 423 | select short_id in ${arr[@]} 424 | do 425 | [ $short_id ] && break 426 | done 427 | unset COLUMNS 428 | 429 | cecho $pink "ID $short_id selected. Reading properties." 430 | restore_lv_info=$(restic snapshots --json $short_id) 431 | restore_lv_size=$(echo $restore_lv_info | jq '.[0].tags' | grep -o '[0-9]*\.[0-9]*._size' | sed 's/_size$//') 432 | restore_lv_size_int=$( echo $restore_lv_size | python3 -c 'import sys; import humanfriendly; print (humanfriendly.parse_size(sys.stdin.read(), binary=True))') 433 | 434 | echo "[INFO] LV Name: ${restore_lv_name}" 435 | echo "[INFO] LV Size: ${restore_lv_size}, ${restore_lv_size_int}" 436 | 437 | # Check if a similar lv is present 438 | if [ $(lvs --noheading -o lv_path ${vg} | grep "${restore_lv_name}") ] 439 | then 440 | cecho $red "There is already an LV with the name ${restore_lv_name} on ${vg}." 441 | cecho $red "Please rename or remove the LV manually!" 442 | failed 443 | exit 444 | fi 445 | 446 | # Create the new LV 447 | echo "Creating LV ${restore_lv_name}, ${restore_lv_size} on ${vg}" 448 | sleep 2 449 | lvcreate -n ${restore_lv_name} -L ${restore_lv_size} ${vg} ${pv} 450 | 451 | restore_lv_path=$(lvs --noheading -o lv_path | grep -P "/${restore_lv_name}( |$)" | tr -d ' ') 452 | echo "[INFO] LV PATH: $restore_lv_path" 453 | 454 | echo 455 | cecho $green "====================" 456 | cecho $green "STARTING THE RESTORE" 457 | echo 458 | sleep 5 459 | restic dump $short_id ${restore_lv_name}.img | \ 460 | pv -s ${restore_lv_size_int} | \ 461 | dd of=${restore_lv_path} bs=4M 462 | } 463 | 464 | block-level-gz-restore () { 465 | command -v unpigz >/dev/null 2>&1 || { echo "[Error] Please install pigz"; exit 1; } 466 | command -v pv >/dev/null 2>&1 || { echo "[Error] Please install pv"; exit 1; } 467 | command -v awk >/dev/null 2>&1 || { echo "[Error] Please install awk"; exit 1; } 468 | command -v jq >/dev/null 2>&1 || { echo "[Error] Please install jq"; exit 1; } 469 | command -v pip3 >/dev/null 2>&1 || { echo "[Error] Please install python3-pip"; exit 1; } 470 | if ! `python3 -c 'import humanfriendly' >/dev/null 2>&1` 471 | then 472 | cecho $red "Could not import python3 humanfriendly!" 473 | cecho $red "Please run 'pip3 install humanfriendly'." 474 | fi 475 | 476 | cecho $pink "Getting all snapshots of ${restore_lv_name}" 477 | restic snapshots --tag block-level-gz-backup,${restore_lv_name} 478 | 479 | snapshots_json=$(restic snapshots --json --path \/${restore_lv_name}.img.gz) 480 | arr=( $(echo $snapshots_json | jq -r '.[].short_id') ) 481 | 482 | COLUMNS=12 483 | cecho $pink "Which snapshot should be restored?" 484 | select short_id in ${arr[@]} 485 | do 486 | [ $short_id ] && break 487 | done 488 | unset COLUMNS 489 | 490 | cecho $pink "ID $short_id selected. Reading properties." 491 | restore_lv_info=$(restic snapshots --json $short_id) 492 | restore_lv_size=$(echo $restore_lv_info | jq '.[0].tags' | grep -o '[0-9]*\.[0-9]*._size' | sed 's/_size$//') 493 | restore_lv_size_int=$( echo $restore_lv_size | python3 -c 'import sys; import humanfriendly; print (humanfriendly.parse_size(sys.stdin.read(), binary=True))') 494 | 495 | echo "[INFO] LV Name: ${restore_lv_name}" 496 | echo "[INFO] LV Size: ${restore_lv_size}, ${restore_lv_size_int}" 497 | 498 | # Check if a similar lv is present 499 | if [ $(lvs --noheading -o lv_path ${vg} | grep "${restore_lv_name}") ] 500 | then 501 | cecho $red "There is already an LV with the name ${restore_lv_name} on ${vg}." 502 | cecho $red "Please rename or remove the LV manually!" 503 | failed 504 | exit 505 | fi 506 | 507 | # Create the new LV 508 | echo "Creating LV ${restore_lv_name}, ${restore_lv_size} on ${vg}" 509 | sleep 2 510 | lvcreate -n ${restore_lv_name} -L ${restore_lv_size} ${vg} ${pv} 511 | 512 | restore_lv_path=$(lvs --noheading -o lv_path | grep -P "/${restore_lv_name}( |$)" | tr -d ' ') 513 | echo "[INFO] LV PATH: $restore_lv_path" 514 | 515 | echo 516 | cecho $green "====================" 517 | cecho $green "STARTING THE RESTORE" 518 | echo 519 | sleep 5 520 | restic dump $short_id ${restore_lv_name}.img.gz | \ 521 | unpigz | pv -s ${restore_lv_size_int} | \ 522 | dd of=${restore_lv_path} bs=4M 523 | } 524 | 525 | file-level-restore () { 526 | command -v pv >/dev/null 2>&1 || { echo "[Error] Please install pv"; exit 1; } 527 | command -v awk >/dev/null 2>&1 || { echo "[Error] Please install awk"; exit 1; } 528 | command -v jq >/dev/null 2>&1 || { echo "[Error] Please install jq"; exit 1; } 529 | command -v pip3 >/dev/null 2>&1 || { echo "[Error] Please install python3-pip"; exit 1; } 530 | if ! `python3 -c 'import humanfriendly' >/dev/null 2>&1` 531 | then 532 | cecho $red "Could not import python3 humanfriendly!" 533 | cecho $red "Please run 'pip3 install humanfriendly'." 534 | fi 535 | 536 | cecho $pink "Getting all snapshots of ${restore_lv_name}" 537 | restic snapshots --tag file-level-backup,${restore_lv_name} 538 | 539 | snapshots_json=$(restic snapshots --json --tag file-level-backup,${restore_lv_name}) 540 | arr=( $(echo $snapshots_json | jq -r '.[].short_id') ) 541 | 542 | COLUMNS=12 543 | cecho $pink "Which snapshot should be restored?" 544 | select short_id in ${arr[@]} 545 | do 546 | [ $short_id ] && break 547 | done 548 | unset COLUMNS 549 | 550 | echo "ID $short_id selected. Reading properties." 551 | restore_lv_info=$(restic snapshots --json $short_id) 552 | restore_lv_org_size=$(echo $restore_lv_info | jq '.[0].tags' | grep -o '[0-9]*\.[0-9]*._size' | sed 's/_size$//') 553 | restore_lv_org_size_int=$( echo $restore_lv_org_size | python3 -c 'import sys; import humanfriendly; print (humanfriendly.parse_size(sys.stdin.read(), binary=True))') 554 | restore_lv_total_size_int=$(restic stats --json $short_id | jq '.total_size') 555 | restore_lv_total_size=$( echo $restore_lv_total_size_int | numfmt --to=iec) 556 | 557 | echo "[INFO] LV Name: ${restore_lv_name}" 558 | echo "[INFO] LV's original size: ${restore_lv_org_size}, ${restore_lv_org_size_int}" 559 | echo "[INFO] LV's total required size: ${restore_lv_total_size}, ${restore_lv_total_size_int}" 560 | 561 | cecho $pink "What size do you want the new LV?" 562 | read -p "[${restore_lv_org_size}]" restore_lv_size 563 | restore_lv_size=${restore_lv_size:-${restore_lv_org_size}} 564 | echo "[INFO] LV Size: $restore_lv_size" 565 | 566 | # Check if a similar lv is present 567 | if [ $(lvs --noheading -o lv_path ${vg} | grep "${restore_lv_name}") ] 568 | then 569 | cecho $red "There is already an LV with the name ${restore_lv_name} on ${vg}." 570 | cecho $red "Please rename or remove the LV manually!" 571 | failed 572 | exit 1 573 | fi 574 | 575 | # Create the new LV 576 | echo "Creating LV ${restore_lv_name}, ${restore_lv_size} on ${vg}" 577 | sleep 2 578 | lvcreate -n ${restore_lv_name} -L ${restore_lv_size} ${vg} ${pv} 579 | 580 | restore_lv_path=$(lvs --noheading -o lv_path | grep -P "/${restore_lv_name}( |$)" | tr -d ' ') 581 | restore_lv_mountpoint="/mnt/${restore_lv_name}_snapshot" 582 | echo "[INFO] LV PATH: $restore_lv_path" 583 | echo "[INFO] LV MOUNTPOINT: $restore_lv_mountpoint" 584 | 585 | # Format Disk 586 | mkfs.ext4 $restore_lv_path 587 | 588 | # Create the snapshot mount directory 589 | if [ ! -d ${restore_lv_mountpoint} ] 590 | then 591 | mkdir ${restore_lv_mountpoint} 592 | else 593 | cecho $red "The mountpoint ${restore_lv_mountpoint} exists." 594 | cecho $red "Please check and remove it manually!" 595 | exit 1 596 | fi 597 | 598 | # Protect the mount-point 599 | chmod go-rwx ${restore_lv_mountpoint} 600 | 601 | # Mount the volume 602 | mount ${restore_lv_path} ${restore_lv_mountpoint} 603 | 604 | echo 605 | cecho $green "====================" 606 | cecho $green "STARTING THE RESTORE" 607 | echo 608 | sleep 5 609 | restic restore $short_id --include ${restore_lv_mountpoint} --target / | \ 610 | tee -a ${LOGDIR}/lvm-restic-file-level-restore.log 611 | 612 | # Unmount the volume & delete the mount-point 613 | umount ${restore_lv_mountpoint} 614 | rmdir ${restore_lv_mountpoint} 615 | } 616 | 617 | restore () { 618 | # Check if restore was started in a screen session 619 | if [ -z ${STY+x} ] 620 | then 621 | echo 622 | cecho $red "This is NOT a screen session." 623 | cecho $red "It is highly recommended to run the restore in a screen session!" 624 | command -v screen >/dev/null 2>&1 || { cecho $red "Consider installing and using screen"; } 625 | echo 626 | sleep 10 627 | else 628 | cecho $pink "This is a screen session named '$STY'" 629 | fi 630 | 631 | echo 632 | cecho $pink "=============================" 633 | cecho $pink "STARTING RESTORE PREPARATIONS" 634 | 635 | if [ "${LV_TO_RESTORE}" ] 636 | then 637 | echo 638 | cecho $pink "Please select the Volume Group, where the Logical Volume(s) should be restored to:" 639 | select vg in $(vgs --noheading -o vg_name | tr -d ' ') 640 | do 641 | [ $vg ] && break 642 | done 643 | echo 644 | 645 | if [ $(pvs --noheading -o pv_name,vg_name | grep $vg | wc -l) -gt 0 ] 646 | then 647 | cecho $pink "$vg has more than one physical volume associated." 648 | cecho $pink "Please select the pv you want to restore to" 649 | echo 650 | echo " PV VG Fmt Attr PSize PFree" 651 | pvs --noheading | grep $vg 652 | echo 653 | select pv in $(pvs --noheading -o pv_name,vg_name | grep $vg | awk '{print $1}') 654 | do 655 | [ $pv ] && break 656 | done 657 | else 658 | pv="" 659 | fi 660 | 661 | if [ -f "${LV_TO_RESTORE}" ] 662 | then 663 | # Read the file provided and backup each LV 664 | grep -v '^#' ${LV_TO_RESTORE} | while read -r line 665 | do 666 | restore_lv_name=$line 667 | eval $cmd 668 | done 669 | else 670 | # Backup LV provided 671 | restore_lv_name=${LV_TO_RESTORE} 672 | eval $cmd 673 | fi 674 | else 675 | echo "LV(s) to restore missing. Please specify [lv-name] or [path-to-list]." 676 | echo "Run [lvm-rescript help] for usage." 677 | exit 1 678 | fi 679 | } 680 | 681 | zabbix-requirements () { 682 | skip_zabbix=false 683 | if ! `systemctl is-active --quiet zabbix-agent2` 684 | then 685 | echo 686 | cecho $red "Zabbix-Agent-2 is not running. Will skip zabbix logging." 687 | skip_zabbix=true 688 | fi 689 | if ! `python3 -c 'import humanfriendly' >/dev/null 2>&1` 690 | then 691 | cecho $red "Could not import python3 humanfriendly!" 692 | cecho $red "Please install python3-humanfriendly." 693 | skip_zabbix=true 694 | fi 695 | if [ ! -f "/etc/zabbix/scripts/rescript-lvm-discovery.pl" ] 696 | then 697 | echo 698 | cecho $red "Zabbix Script rescript-lvm-discovery.pl missing. For instructions visit:" 699 | cecho $red "https://github.com/sebastian13/zabbix-templates/tree/master/rescript-restic-backup" 700 | skip_zabbix=true 701 | fi 702 | echo 703 | } 704 | 705 | zabbix-discovery () { 706 | if [ $skip_zabbix = false ] 707 | then 708 | cecho $yellow "[Running Zabbix Discovery]" 709 | export REPO="$repo" 710 | export LV_TO_BACKUP="$LV_TO_BACKUP" 711 | LVM_DISC=$(/etc/zabbix/scripts/rescript-lvm-discovery.pl) 712 | echo "$LVM_DISC" | python3 -m json.tool 713 | echo 714 | zabbix_sender --config /etc/zabbix/zabbix_agent2.conf --key "rescript.lv.discovery" --value "$LVM_DISC" \ 715 | || { echo "[Error] Sending to Zabbix failed. Will skip logging for now."; skip_zabbix=true; } 716 | echo 717 | else 718 | cecho $red "[Skipping Zabbix Discovery]" 719 | fi 720 | } 721 | 722 | log-backup () { 723 | if [ $skip_zabbix = false ] 724 | then 725 | set +e 726 | 727 | arr=() 728 | TIME=$(stat -c '%015Y' $RLOG) 729 | 730 | # Extract Added Bytes 731 | RLOG_ADDED=$(cat $RLOG | grep 'Added to the repo' | awk '{print $5,$6}' | \ 732 | python3 -c 'import sys; import humanfriendly; print (humanfriendly.parse_size(sys.stdin.read(), binary=True))' ) 733 | arr+=("- restic.backup.added.[$BACKUP_LV.$REPO] $TIME $RLOG_ADDED") 734 | echo "Bytes Added: $RLOG_ADDED" 735 | 736 | # Exctract Snapshot ID 737 | RLOG_SNAPSHOTID=$(cat $RLOG | grep '^snapshot .* saved$' | awk '{print $2}') 738 | arr+=("- restic.backup.snapshotid.[$BACKUP_LV.$REPO] $TIME $RLOG_SNAPSHOTID") 739 | echo "Snapshot ID: $RLOG_SNAPSHOTID" 740 | 741 | # Extract Processed Time 742 | RLOG_PROCESSED_TIME=$(cat $RLOG | grep '^processed.*files' | \ 743 | awk '{print $NF}' | \ 744 | awk -F':' '{print (NF>2 ? $(NF-2)*3600 : 0) + (NF>1 ? $(NF-1)*60 : 0) + $(NF)}' ) 745 | arr+=("- restic.backup.processedtime.[$BACKUP_LV.$REPO] $TIME $RLOG_PROCESSED_TIME") 746 | echo "Time Processed: $RLOG_PROCESSED_TIME" 747 | 748 | # Extract Processed Bytes 749 | RLOG_PROCESSED_BYTES=$(cat $RLOG | grep '^processed.*files' | \ 750 | awk '{print $4,$5}' | \ 751 | python3 -c 'import sys; import humanfriendly; print (humanfriendly.parse_size(sys.stdin.read(), binary=True))' ) 752 | arr+=("- restic.backup.processedbytes.[$BACKUP_LV.$REPO] $TIME $RLOG_PROCESSED_BYTES") 753 | echo "Bytes Processed: $RLOG_PROCESSED_TIME" 754 | 755 | cecho $yellow "[Sending everything to Zabbix]" 756 | # for ix in ${!arr[*]}; do printf "%s\n" "${arr[$ix]}"; done 757 | # echo 758 | send-to-zabbix () { 759 | for ix in ${!arr[*]}; do printf "%s\n" "${arr[$ix]}"; done | zabbix_sender --config /etc/zabbix/zabbix_agent2.conf --with-timestamps --input-file - 760 | } 761 | 762 | # Send Data 763 | # It might be the case that the Zabbix Server has not fully processed the discovery of new items yet. 764 | # If sending raises an error, the script starts a second try after one minute. 765 | send-to-zabbix || { cecho $red "[ERROR] Sending or processing of some items failed. Will wait one minute before trying again..."; sleep 60; send-to-zabbix; } 766 | echo 767 | 768 | set -e 769 | else 770 | cecho $red "[Skipping Sending Data to Zabbix]" 771 | fi 772 | } 773 | 774 | # ------------------------------------------------------- 775 | # Run Selected Commands 776 | # ------------------------------------------------------- 777 | cmd="$2" 778 | case "$cmd" in 779 | "") 780 | echo "Please specify a command." 781 | echo "Run [lvm-rescript help] for usage." 782 | exit 1 783 | ;; 784 | block-level-backup|block-level-gz-backup|file-level-backup) 785 | LV_TO_BACKUP=$3 786 | backup 787 | ;; 788 | block-level-restore|block-level-gz-restore|file-level-restore) 789 | LV_TO_RESTORE=$3 790 | restore 791 | ;; 792 | *) 793 | echo "Unknown Command: ${cmd}." 794 | echo "Run [lvm-rescript help] for usage." 795 | exit 1 796 | ;; 797 | esac 798 | 799 | # Remove temp. logfile 800 | rm -f $RLOG 801 | 802 | # Remove all remaining snapshots 803 | clean-all-snapshots 804 | all-done 805 | --------------------------------------------------------------------------------