Skip to content

Commit 39776a9

Browse files
committed
Release 4.0.0 - See CHANGELOG.md and README.md
1 parent d24cdc5 commit 39776a9

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CHANGELOG.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,63 @@
1+
## 4.0.0 2023-11-08 <dave at tiredofit dot ca>
2+
3+
This is the fourth major release to the DB Backup image which started as a basic MySQL backup service in early 2017. With each major release brings enhancements, bugfixes, removals along with breaking changes and this one is no different.
4+
5+
This release brings functionality requested by the community such as multiple host backup support by means of independent scheduler tasks,blackout periods, better resource usage, better security via file encryption, file permissions, and more verbosity via log files. , and also merges contributions from other developers.
6+
7+
Upgrading to this image should for the most part work for most users, but will involve event upgrading environment variables as the formathas changed significantly. Old variables should continue to work, however are unsupported and will be removed with the `4.3.0` release, whenever that will be.
8+
9+
A significant amount of development hours were put in to accomodate for feature requests by the community. If you are using this in a commercial setting or find this image valuable, please consider sponsoring my work for a period of time or engaging in a private support offering. More details at https://www.tiredofit.ca/sponsor
10+
11+
### Added
12+
13+
- Backup Multiple Hosts in same image all with different options (scheduling, compression, destination, cleanup) (Use `DBXX_option` variables)
14+
- Backup limits how many backup jobs run concurrently
15+
- Backup Scheduling now allows using a timestamp (e.g. `Dec 12 2023 03:00:00`) - credit benvia@github
16+
- Backup Scheduling now allows using a cron expression (e.g `00 03 * * *`)
17+
- Backup Blackout period to skip backing up during a period of time
18+
- Backup runs as dedicated user (no longer root)
19+
- Backup can have specific file permissions set upon completion (e.g. `700` or `rwx------`)
20+
- Backups can run with reduced priority mode to allow for fair scheduling across system
21+
- Backups - MySQL/MariaDB now has ability to backup events
22+
- Backups - Microsoft SQL server now has option to backup transaction logs
23+
- Backups - Postgres now backs up globals - credit oscarsiles@github
24+
- Backups with Azure synchronize storage before upload - credit eoehen@github
25+
- Encrypt backup file with a passphrase or a GPG Public Key ability
26+
- Log backup jobs to file along with log rotation
27+
- Notification support upon job failure via Email, Mattermost, Matrix, Rocketchat
28+
- Zabbix Metrics now auto discovers new jobs
29+
- Zabbix Metrics sends metrics relating to backed up filename, checksum hash, and the duration of backup/compression time, checksum time, encryption time
30+
- New Debug Capabilities
31+
32+
### Changed
33+
34+
- Reworked Documentation
35+
- Reworked all functions and renamed all variables
36+
- Many variables now use a prefix of `DEFAULT_` to operate on all backup jobs
37+
- Can be overridden per backup job by setting `DB_<option>` or to unset default variable `DB_<option>=unset`
38+
- Renamed variables and terms
39+
- `_DUMP_LOCATION` -> `_BACKUP_LOCATION`
40+
- `_DUMP_BEGIN` -> `_BACKUP_BEGIN`
41+
- `_DUMP_FREQ` -> `_BACKUP_INTERVAL`
42+
- `_DUMP_TARGET`` -> `_FILESYSTEM_PATH`
43+
- `_DUMP_ARCHIVE`` -> `_FILESYSTEM_PATH`
44+
- `EXTRA_DUMP_OPTS`` -> `_EXTRA_BACKUP_OPTS`
45+
- `TEMP_LOCATION`` -> `TEMP_PATH`
46+
- Backups - AWS CLI updated to 1.29.78
47+
- Backups - InfluxDB 2 Client version updated to 2.7.3
48+
- Backups - Microsoft SQL server now compresses files post initial backup
49+
- Backups - Manual backups handle aborting gracefully
50+
- Checksum routines now complete in half the time
51+
- Checksum variable now supports "NONE"
52+
- Zabbix metrics sending occurs in one process as opposed to singular
53+
- Cleanup Only cleanup files that match same backup name pattern
54+
- Cleanup/Archive uses relative path instead of absolute with creating_latest_symlink
55+
- A handful of code optimizations and cleanup
56+
57+
### Removed
58+
- `ENABLE_CHECKSUM` - has been wrapped into `_CHECKSUM=none`
59+
60+
161
## 3.12.0 2023-10-29 <alwynpan@github>
262

363
### Added

0 commit comments

Comments
 (0)