jkaninda/mysql-bkup
1
1
Fork 0
mirror of https://github.com/jkaninda/mysql-bkup.git synced 2025-12-06 21:49:40 +01:00
Code Issues Actions Projects Releases Wiki Activity

Merge pull request #185 from jkaninda/docs
Some checks failed
Deploy Documenation site to GitHub Pages / build (push) Failing after 9m27s
Details
Deploy Documenation site to GitHub Pages / deploy (push) Has been skipped
Details
Lint / Run on Ubuntu (push) Successful in 18m44s
Details
Tests / test (push) Failing after 20s
Details

Browse Source 
doc: update deployment examples
This commit is contained in:
Jonas Kaninda
2025-03-16 11:50:32 +01:00
committed by GitHub
parent 6bcc5d6bd4 6ac8dcef9e
commit ba7c096bf3
2 changed files with 215 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
README.md
View File

@@ -65,52 +65,75 @@ Successfully tested on:
- SSH remote storage server - SSH remote storage server
- FTP remote storage server - FTP remote storage server
- Azure Blob storage - Azure Blob storage
## Quickstart ## Quickstart
### Simple backup using Docker CLI ### Simple Backup Using Docker CLI
To run a one time backup, bind your local volume to `/backup` in the container and run the `backup` command: To perform a one-time backup, bind your local volume to `/backup` in the container and run the `backup` command:
```shell ```shell
docker run --rm --network your_network_name \ docker run --rm --network your_network_name \
-v $PWD/backup:/backup/ \ -v $PWD/backup:/backup/ \
-e "DB_HOST=dbhost" \ -e "DB_HOST=dbhost" \
-e "DB_PORT=3306" \ -e "DB_PORT=3306" \
-e "DB_USERNAME=username" \ -e "DB_USERNAME=username" \
-e "DB_PASSWORD=password" \ -e "DB_PASSWORD=password" \
jkaninda/mysql-bkup backup -d database_name jkaninda/mysql-bkup backup -d database_name
``` ```
Alternatively, pass a `--env-file` in order to use a full config as described below. Alternatively, use an environment file (`--env-file`) for configuration:
```yaml
docker run --rm --network your_network_name \
--env-file your-env-file \
-v $PWD/backup:/backup/ \
jkaninda/mysql-bkup backup -d database_name
```
### Simple restore using Docker CLI
To restore a database, bind your local volume to `/backup` in the container and run the `restore` command:
```shell ```shell
docker run --rm --network your_network_name \ docker run --rm --network your_network_name \
-v $PWD/backup:/backup/ \ --env-file your-env-file \
-e "DB_HOST=dbhost" \ -v $PWD/backup:/backup/ \
-e "DB_PORT=3306" \ jkaninda/mysql-bkup backup -d database_name
-e "DB_USERNAME=username" \
-e "DB_PASSWORD=password" \
jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz
``` ```
### Simple backup in docker compose file
### 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 ```yaml
services: services:
mysql-bkup: pg-bkup:
# In production, it is advised to lock your image tag to a proper # In production, pin your image tag to a specific release version instead of `latest`.
# release version instead of using `latest`. # See available releases: https://github.com/jkaninda/mysql-bkup/releases
# Check https://github.com/jkaninda/mysql-bkup/releases
# for a list of available releases.
image: jkaninda/mysql-bkup image: jkaninda/mysql-bkup
container_name: mysql-bkup container_name: mysql-bkup
command: backup command: backup
@@ -123,29 +146,39 @@ services:
- DB_USERNAME=bar - DB_USERNAME=bar
- DB_PASSWORD=password - DB_PASSWORD=password
- TZ=Europe/Paris - TZ=Europe/Paris
# mysql-bkup container must be connected to the same network with your database
networks: networks:
- web - web
networks: networks:
web: web:
``` ```
### Docker recurring backup
---
### Recurring Backups with Docker
You can schedule recurring backups using the `--cron-expression` or `-e` flag:
```shell ```shell
docker run --rm --network network_name \ docker run --rm --network network_name \
-v $PWD/backup:/backup/ \ -v $PWD/backup:/backup/ \
-e "DB_HOST=hostname" \ -e "DB_HOST=hostname" \
-e "DB_USERNAME=user" \ -e "DB_USERNAME=user" \
-e "DB_PASSWORD=password" \ -e "DB_PASSWORD=password" \
jkaninda/mysql-bkup backup -d dbName --cron-expression "@every 15m" #@midnight jkaninda/mysql-bkup backup -d dbName --cron-expression "@every 15m"
``` ```
See: https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules
For predefined schedules, refer to the [documentation](https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules).
---
## Deploy on Kubernetes ## Deploy on Kubernetes
For Kubernetes, you don't need to run it in scheduled mode. You can deploy it as Job or CronJob. For Kubernetes, you can deploy `mysql-bkup` as a Job or CronJob. Below are examples for both.
### Simple Kubernetes backup Job : ### Kubernetes Backup Job
This example defines a one-time backup job:
```yaml ```yaml
apiVersion: batch/v1 apiVersion: batch/v1
@@ -158,10 +191,8 @@ spec:
spec: spec:
containers: containers:
- name: mysql-bkup - name: mysql-bkup
# In production, it is advised to lock your image tag to a proper # Pin the image tag to a specific release version in production.
# release version instead of using `latest`. # See available releases: https://github.com/jkaninda/mysql-bkup/releases
# Check https://github.com/jkaninda/mysql-bkup/releases
# for a list of available releases.
image: jkaninda/mysql-bkup image: jkaninda/mysql-bkup
command: command:
- /bin/sh - /bin/sh
@@ -184,10 +215,52 @@ spec:
volumes: volumes:
- name: backup - name: backup
hostPath: hostPath:
path: /home/toto/backup # directory location on host path: /home/toto/backup # Directory location on the host
type: Directory # this field is optional type: Directory # Optional field
restartPolicy: Never 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 ## Available image registries
This Docker image is published to both Docker Hub and the GitHub container registry. This Docker image is published to both Docker Hub and the GitHub container registry.

124
docs/quickstart/index.md
View File

@@ -10,11 +10,11 @@ This guide provides quick examples for running backups using Docker CLI, Docker
--- ---
## Simple Backup Using Docker CLI ### Simple Backup Using Docker CLI
To run a one-time backup, bind your local volume to `/backup` in the container and execute the `backup` command: To perform a one-time backup, bind your local volume to `/backup` in the container and run the `backup` command:
```bash ```shell
docker run --rm --network your_network_name \ docker run --rm --network your_network_name \
-v $PWD/backup:/backup/ \ -v $PWD/backup:/backup/ \
-e "DB_HOST=dbhost" \ -e "DB_HOST=dbhost" \
@@ -24,41 +24,58 @@ docker run --rm --network your_network_name \
jkaninda/mysql-bkup backup -d database_name jkaninda/mysql-bkup backup -d database_name
``` ```
### Using an Environment File Alternatively, use an environment file (`--env-file`) for configuration:
Alternatively, you can use an `--env-file` to pass a full configuration: ```shell
```bash
docker run --rm --network your_network_name \ docker run --rm --network your_network_name \
--env-file your-env-file \ --env-file your-env-file \
-v $PWD/backup:/backup/ \ -v $PWD/backup:/backup/ \
jkaninda/mysql-bkup backup -d database_name jkaninda/mysql-bkup backup -d database_name
``` ```
### Simple restore using Docker CLI ### Backup All Databases
To restore a database, bind your local volume to `/backup` in the container and run the `restore` command: 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 ```shell
docker run --rm --network your_network_name \ docker run --rm --network your_network_name \
-v $PWD/backup:/backup/ \ -v $PWD/backup:/backup/ \
-e "DB_HOST=dbhost" \ -e "DB_HOST=dbhost" \
-e "DB_PORT=3306" \ -e "DB_PORT=3306" \
-e "DB_USERNAME=username" \ -e "DB_USERNAME=username" \
-e "DB_PASSWORD=password" \ -e "DB_PASSWORD=password" \
jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz 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 Backup Using Docker Compose ### Simple Restore Using Docker CLI
Below is an example `docker-compose.yml` configuration for running a backup: 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 ```yaml
services: services:
mysql-bkup: pg-bkup:
# In production, lock the image tag to a specific release version. # In production, pin your image tag to a specific release version instead of `latest`.
# Check https://github.com/jkaninda/mysql-bkup/releases for available releases. # See available releases: https://github.com/jkaninda/mysql-bkup/releases
image: jkaninda/mysql-bkup image: jkaninda/mysql-bkup
container_name: mysql-bkup container_name: mysql-bkup
command: backup command: backup
@@ -71,7 +88,6 @@ services:
- DB_USERNAME=bar - DB_USERNAME=bar
- DB_PASSWORD=password - DB_PASSWORD=password
- TZ=Europe/Paris - TZ=Europe/Paris
# Ensure the mysql-bkup container is connected to the same network as your database.
networks: networks:
- web - web
@@ -81,11 +97,11 @@ networks:
--- ---
## Recurring Backup with Docker ### Recurring Backups with Docker
To schedule recurring backups, use the `--cron-expression` flag: You can schedule recurring backups using the `--cron-expression` or `-e` flag:
```bash ```shell
docker run --rm --network network_name \ docker run --rm --network network_name \
-v $PWD/backup:/backup/ \ -v $PWD/backup:/backup/ \
-e "DB_HOST=hostname" \ -e "DB_HOST=hostname" \
@@ -98,9 +114,13 @@ For predefined schedules, refer to the [documentation](https://jkaninda.github.i
--- ---
## Backup Using Kubernetes ## Deploy on Kubernetes
Below is an example Kubernetes `Job` configuration for running a backup: 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 ```yaml
apiVersion: batch/v1 apiVersion: batch/v1
@@ -113,8 +133,8 @@ spec:
spec: spec:
containers: containers:
- name: mysql-bkup - name: mysql-bkup
# In production, lock the image tag to a specific release version. # Pin the image tag to a specific release version in production.
# Check https://github.com/jkaninda/mysql-bkup/releases for available releases. # See available releases: https://github.com/jkaninda/mysql-bkup/releases
image: jkaninda/mysql-bkup image: jkaninda/mysql-bkup
command: command:
- /bin/sh - /bin/sh
@@ -128,7 +148,7 @@ spec:
- name: DB_HOST - name: DB_HOST
value: "mysql" value: "mysql"
- name: DB_USERNAME - name: DB_USERNAME
value: "postgres" value: "user"
- name: DB_PASSWORD - name: DB_PASSWORD
value: "password" value: "password"
volumeMounts: volumeMounts:
@@ -137,11 +157,51 @@ spec:
volumes: volumes:
- name: backup - name: backup
hostPath: hostPath:
path: /home/toto/backup # Directory location on the host path: /home/toto/backup # Directory location on the host
type: Directory # Optional field type: Directory # Optional field
restartPolicy: Never 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
```
--- ---
## Key Notes ## Key Notes