Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/technicalguru/backup
A Perl-based backup/archiving solution for Linux machines
https://github.com/technicalguru/backup
backup docker inux kubernetes mysql perl
Last synced: 17 days ago
JSON representation
A Perl-based backup/archiving solution for Linux machines
- Host: GitHub
- URL: https://github.com/technicalguru/backup
- Owner: technicalguru
- License: lgpl-3.0
- Created: 2018-09-14T20:55:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T15:06:30.000Z (about 1 year ago)
- Last Synced: 2024-10-28T00:32:40.794Z (2 months ago)
- Topics: backup, docker, inux, kubernetes, mysql, perl
- Language: Perl
- Size: 107 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
# backup
A Perl-based backup/archiving solution for Linux machines.
I have been an administrator of Linux machines for many years. Since then I had been using my
own little backup script that also fulfills archiving purposes. This GitHub project makes
my work available to everyone and basically is a complete rewrite of the original code. The
new version can now be enhanced easily by new types of backups (as it was required for some
Kubernetes and Docker databases) as well as by new types of compression, notification or
transfers to remote backup locations.
Features:
* full modular design
* Comes with modules for:
* Filesystem backups
* GlusterFS filesystems
* MySQL database backups
* MySQL database backups from Kubernetes services
* MySQL database backups from Docker containers
* FTP transfer to remote backup location
* SCP transfer to remote backup location
* extendable by custom backup modules
* GZIP compression of backup files (other types can be plugged in)
* supports hourly, daily, weekly and monthly backups
* keeps archived versions of backups
* notification by email (other types can be plugged in) when errors occur
# Status and Known Issues
Backup is stable. The current version is 2.0. Please notice that these modules are deprecated in 2.0:
* MySQL module for Kubernetes
The MySQL module has been reworked. Please check your configuration when upgrading from 1.x. The changes
are not compatible.
# Installation and Configuration
* Prerequisites:
* Perl 5.22 or above
* `cpan install: JSON`
* `cpan install: JSON::Parse`
* `cpan install: Number::Format`
* `git clone https://github.com/technicalguru/backup`
* Create /etc/backup/main.json from example. Follow the [Configuration guide](CONFIGURATION.md).
# Testing your backup
* Create backup and log directory (will not be created in test mode)
* `backup.pl --dry-run --type=daily`
# Running a backup
* `backup.pl`
* For cronjob: create a shell file, e.g.
```bash
#!/bin/bash
/usr/local/backup/backup.pl
```
* Define the backup job in ```/etc/crontab```, e.g.:
```crontab
0 * * * * root /usr/local/backup/backup.sh >/var/log/backup/cronjob.log 2>&1
```
# Command Line Options
* `--dry-run` - perform a dry run, do not change anything (will set log level to verbose)
* `--verbose` - set log level to verbose.
* `--type=(hourly|daily|weekly|monthly|mobile)` - perform the given type of backup
* `--config-file=path` - use the given JSON file as config (Default: /etc/backup/main.json)
* `--help` - show the usage help text
# Writing your own Backup Module
see [```ExampleModule.pm```](examples/ExampleModule.pm)