mirror of
https://github.com/jkaninda/mysql-bkup.git
synced 2025-12-06 05:29:41 +01:00
Jonas Kaninda
6ac8dcef9e
All checks were successful
Lint / Run on Ubuntu (push) Successful in 18m39s
298 lines
8.4 KiB
Markdown
298 lines
8.4 KiB
Markdown
# MYSQL-BKUP
|
||
|
||
**MYSQL-BKUP** is a Docker container image designed to **backup, restore, and migrate MySQL databases**.
|
||
It supports a variety of storage options and ensures data security through GPG encryption.
|
||
|
||
[](https://github.com/jkaninda/mysql-bkup/actions/workflows/tests.yml)
|
||
[](https://github.com/jkaninda/mysql-bkup/actions/workflows/release.yml)
|
||
[](https://goreportcard.com/report/github.com/jkaninda/mysql-bkup)
|
||
|
||
|
||
<a href="https://ko-fi.com/jkaninda"><img src="https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/5cbed8a4ae2b88347c06c923_BuyMeACoffee_blue.png" height="20" alt="buy ma a coffee"></a>
|
||
|
||
## Features
|
||
|
||
- **Storage Options:**
|
||
- Local storage
|
||
- AWS S3 or any S3-compatible object storage
|
||
- FTP
|
||
- SSH-compatible storage
|
||
- Azure Blob storage
|
||
|
||
- **Data Security:**
|
||
- Backups can be encrypted using **GPG** to ensure confidentiality.
|
||
|
||
- **Deployment Flexibility:**
|
||
- Available as the [jkaninda/mysql-bkup](https://hub.docker.com/r/jkaninda/mysql-bkup) Docker image.
|
||
- Deployable on **Docker**, **Docker Swarm**, and **Kubernetes**.
|
||
- Supports recurring backups of MySQL databases when deployed:
|
||
- On Docker for automated backup schedules.
|
||
- As a **Job** or **CronJob** on Kubernetes.
|
||
|
||
- **Notifications:**
|
||
- Get real-time updates on backup success or failure via:
|
||
- **Telegram**
|
||
- **Email**
|
||
|
||
## Use Cases
|
||
|
||
- **Automated Recurring Backups:** Schedule regular backups for MySQL databases.
|
||
- **Cross-Environment Migration:** Easily migrate MySQL databases across different environments using `migration` feature.
|
||
- **Secure Backup Management:** Protect your data with GPG encryption.
|
||
|
||
|
||
Successfully tested on:
|
||
- Docker
|
||
- Docker in Swarm mode
|
||
- Kubernetes
|
||
- OpenShift
|
||
|
||
## Documentation is found at <https://jkaninda.github.io/mysql-bkup>
|
||
|
||
|
||
## Links:
|
||
|
||
- [Docker Hub](https://hub.docker.com/r/jkaninda/mysql-bkup)
|
||
- [Github](https://github.com/jkaninda/mysql-bkup)
|
||
|
||
## PostgreSQL solution :
|
||
|
||
- [PostgreSQL](https://github.com/jkaninda/pg-bkup)
|
||
|
||
## Storage:
|
||
- Local
|
||
- AWS S3 or any S3 Alternatives for Object Storage
|
||
- SSH remote storage server
|
||
- FTP remote storage server
|
||
- Azure Blob storage
|
||
|
||
## Quickstart
|
||
|
||
### Simple Backup Using Docker CLI
|
||
|
||
To perform a one-time backup, bind your local volume to `/backup` in the container and run the `backup` command:
|
||
|
||
```shell
|
||
docker run --rm --network your_network_name \
|
||
-v $PWD/backup:/backup/ \
|
||
-e "DB_HOST=dbhost" \
|
||
-e "DB_PORT=3306" \
|
||
-e "DB_USERNAME=username" \
|
||
-e "DB_PASSWORD=password" \
|
||
jkaninda/mysql-bkup backup -d database_name
|
||
```
|
||
|
||
Alternatively, use an environment file (`--env-file`) for configuration:
|
||
|
||
```shell
|
||
docker run --rm --network your_network_name \
|
||
--env-file your-env-file \
|
||
-v $PWD/backup:/backup/ \
|
||
jkaninda/mysql-bkup backup -d database_name
|
||
```
|
||
|
||
### Backup All Databases
|
||
|
||
To back up all databases on the server, use the `--all-databases` or `-a` flag. By default, this creates individual backup files for each database.
|
||
|
||
```shell
|
||
docker run --rm --network your_network_name \
|
||
-v $PWD/backup:/backup/ \
|
||
-e "DB_HOST=dbhost" \
|
||
-e "DB_PORT=3306" \
|
||
-e "DB_USERNAME=username" \
|
||
-e "DB_PASSWORD=password" \
|
||
jkaninda/mysql-bkup backup --all-databases --disable-compression
|
||
```
|
||
|
||
> **Note:** Use the `--all-in-one` or `-A` flag to combine backups into a single file.
|
||
|
||
---
|
||
|
||
### Simple Restore Using Docker CLI
|
||
|
||
To restore a database, bind your local volume to `/backup` and run the `restore` command:
|
||
|
||
```shell
|
||
docker run --rm --network your_network_name \
|
||
-v $PWD/backup:/backup/ \
|
||
-e "DB_HOST=dbhost" \
|
||
-e "DB_PORT=3306" \
|
||
-e "DB_USERNAME=username" \
|
||
-e "DB_PASSWORD=password" \
|
||
jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz
|
||
```
|
||
|
||
---
|
||
|
||
### Backup with Docker Compose
|
||
|
||
Below is an example of a `docker-compose.yml` file for running a one-time backup:
|
||
|
||
```yaml
|
||
services:
|
||
pg-bkup:
|
||
# In production, pin your image tag to a specific release version instead of `latest`.
|
||
# See available releases: https://github.com/jkaninda/mysql-bkup/releases
|
||
image: jkaninda/mysql-bkup
|
||
container_name: mysql-bkup
|
||
command: backup
|
||
volumes:
|
||
- ./backup:/backup
|
||
environment:
|
||
- DB_PORT=3306
|
||
- DB_HOST=mysql
|
||
- DB_NAME=foo
|
||
- DB_USERNAME=bar
|
||
- DB_PASSWORD=password
|
||
- TZ=Europe/Paris
|
||
networks:
|
||
- web
|
||
|
||
networks:
|
||
web:
|
||
```
|
||
|
||
---
|
||
|
||
### Recurring Backups with Docker
|
||
|
||
You can schedule recurring backups using the `--cron-expression` or `-e` flag:
|
||
|
||
```shell
|
||
docker run --rm --network network_name \
|
||
-v $PWD/backup:/backup/ \
|
||
-e "DB_HOST=hostname" \
|
||
-e "DB_USERNAME=user" \
|
||
-e "DB_PASSWORD=password" \
|
||
jkaninda/mysql-bkup backup -d dbName --cron-expression "@every 15m"
|
||
```
|
||
|
||
For predefined schedules, refer to the [documentation](https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules).
|
||
|
||
---
|
||
|
||
## Deploy on Kubernetes
|
||
|
||
For Kubernetes, you can deploy `mysql-bkup` as a Job or CronJob. Below are examples for both.
|
||
|
||
### Kubernetes Backup Job
|
||
|
||
This example defines a one-time backup job:
|
||
|
||
```yaml
|
||
apiVersion: batch/v1
|
||
kind: Job
|
||
metadata:
|
||
name: backup-job
|
||
spec:
|
||
ttlSecondsAfterFinished: 100
|
||
template:
|
||
spec:
|
||
containers:
|
||
- name: mysql-bkup
|
||
# Pin the image tag to a specific release version in production.
|
||
# See available releases: https://github.com/jkaninda/mysql-bkup/releases
|
||
image: jkaninda/mysql-bkup
|
||
command:
|
||
- /bin/sh
|
||
- -c
|
||
- backup -d dbname
|
||
resources:
|
||
limits:
|
||
memory: "128Mi"
|
||
cpu: "500m"
|
||
env:
|
||
- name: DB_HOST
|
||
value: "mysql"
|
||
- name: DB_USERNAME
|
||
value: "user"
|
||
- name: DB_PASSWORD
|
||
value: "password"
|
||
volumeMounts:
|
||
- mountPath: /backup
|
||
name: backup
|
||
volumes:
|
||
- name: backup
|
||
hostPath:
|
||
path: /home/toto/backup # Directory location on the host
|
||
type: Directory # Optional field
|
||
restartPolicy: Never
|
||
```
|
||
|
||
### Kubernetes CronJob for Scheduled Backups
|
||
|
||
For scheduled backups, use a `CronJob`:
|
||
|
||
```yaml
|
||
apiVersion: batch/v1
|
||
kind: CronJob
|
||
metadata:
|
||
name: pg-bkup-cronjob
|
||
spec:
|
||
schedule: "0 2 * * *" # Runs daily at 2 AM
|
||
jobTemplate:
|
||
spec:
|
||
template:
|
||
spec:
|
||
containers:
|
||
- name: pg-bkup
|
||
image: jkaninda/mysql-bkup
|
||
command:
|
||
- /bin/sh
|
||
- -c
|
||
- backup -d dbname
|
||
env:
|
||
- name: DB_HOST
|
||
value: "mysql"
|
||
- name: DB_USERNAME
|
||
value: "user"
|
||
- name: DB_PASSWORD
|
||
value: "password"
|
||
volumeMounts:
|
||
- mountPath: /backup
|
||
name: backup
|
||
volumes:
|
||
- name: backup
|
||
hostPath:
|
||
path: /home/toto/backup
|
||
type: Directory
|
||
restartPolicy: OnFailure
|
||
```
|
||
|
||
---
|
||
## Available image registries
|
||
|
||
This Docker image is published to both Docker Hub and the GitHub container registry.
|
||
Depending on your preferences and needs, you can reference both `jkaninda/mysql-bkup` as well as `ghcr.io/jkaninda/mysql-bkup`:
|
||
|
||
```
|
||
docker pull jkaninda/mysql-bkup
|
||
docker pull ghcr.io/jkaninda/mysql-bkup
|
||
```
|
||
|
||
Documentation references Docker Hub, but all examples will work using ghcr.io just as well.
|
||
|
||
## References
|
||
|
||
We created this image as a simpler and more lightweight alternative to existing solutions. Here’s why:
|
||
|
||
- **Lightweight:** Written in Go, the image is optimized for performance and minimal resource usage.
|
||
- **Multi-Architecture Support:** Supports `arm64` and `arm/v7` architectures.
|
||
- **Docker Swarm Support:** Fully compatible with Docker in Swarm mode.
|
||
- **Kubernetes Support:** Designed to work seamlessly with Kubernetes.
|
||
|
||
|
||
## License
|
||
|
||
This project is licensed under the MIT License. See the LICENSE file for details.
|
||
|
||
## Authors
|
||
|
||
**Jonas Kaninda**
|
||
- <https://github.com/jkaninda>
|
||
|
||
## Copyright
|
||
|
||
Copyright (c) [2023] [Jonas Kaninda]
|