-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
380a3ff
commit 4938f63
Showing
2 changed files
with
67 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Backup-Zen | ||
Backup-Zen is a Database Backup Solution Using Helm | ||
|
||
[Github Repo](https://github.com/rezachalak/backup-zen) | ||
[Installation](https://github.com/rezachalak/backup-zen#using-helm) | ||
[Web Site](https://rezachalak.github.io/backup-zen/) | ||
[Documentation](https://artifacthub.io/packages/helm/bzen/backup-zen) | ||
<!-- [Mailing List]() --> | ||
[Bug Reports](https://github.com/rezachalak/backup-zen/issues) | ||
<!-- [Donate]() --> | ||
<!-- [Scripting API]() --> | ||
|
||
## Main features | ||
- Deploy on K8s using Helm | ||
- Specify the type of database: MySQL, PostgreSQL, and MongoDB | ||
- Set backup strategy: oneByOne or adminUser | ||
- Determine whether to deploy on Object Storage (S3 and MinIO are supported) or not | ||
- Give Notifications on MSTeams for Fail/Success backup and upload | ||
- Retention period: days and weeks to keep, and specify the desired day of the week for performing backups | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
- A kubernetes cluster | ||
- Read access to database | ||
- Helm and kubectl installed and configured | ||
|
||
### Using Helm | ||
|
||
[Helm](https://helm.sh) must be installed to use the charts. Please refer to | ||
Helm's [documentation](https://helm.sh/docs) to get started. | ||
|
||
Once Helm has been set up correctly, add the repo as follows: | ||
|
||
helm repo add bzen https://rezachalak.github.io/backup-zen/ | ||
|
||
If you had already added this repo earlier, run `helm repo update` to retrieve | ||
the latest versions of the packages. You can then run `helm search repo | ||
bzen` to see the charts. | ||
|
||
To install the backup-zen chart: | ||
|
||
helm install my-backup-zen bzen/backup-zen | ||
|
||
To uninstall the chart: | ||
|
||
helm delete my-backup-zen | ||
|
||
### Change Log | ||
|
||
March 7th, 2023: MongoDB backup eligibilty added | ||
|
||
April 23th, 2023: MongoDB some typo fixed and some improvements has made in variable naming | ||
|
||
April 23th, 2023:MySQL backup eligibilty added | ||
|
||
April 23th, 2023:PostgreSQL backup eligibilty added | ||
|
||
August 10th, 2023: Dockerfile of postgres backup-zen client added | ||
|
||
August 12th, 2023: Helm chart of postgres backup-zen added | ||
|
||
October 21th, 2023: First release of helm ( version 0.1.0 ) | ||
|
||
### Licence | ||
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](https://github.com/rezachalak/db-backup/blob/main/LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
apiVersion: v1 | ||
description: BackupZen is a solution for backing up and uploading various database types, leveraging the power of K8s cronjobs. | ||
name: backup-zen | ||
version: 0.1.1 | ||
version: 0.1.2 | ||
appVersion: 1.0.0 | ||
kubeVersion: ">= 1.20.0" |