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

Update README.md

Browse Source
This commit is contained in:
Jonas Kaninda
2023-12-17 19:43:20 +01:00
parent a2e71f3c00
commit 8f3b89b426
1 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -17,9 +17,9 @@ MySQL Backup docker container image
| Options | Shorts | Usage | | Options | Shorts | Usage |
|---------------|--------|------------------------------------| |---------------|--------|------------------------------------|
| mysql_bkup | bkup | Command utility | | mysql_bkup | bkup | Command utility |
| --operation | -o | Set operation (default: backup) | | --operation | -o | Set operation, local or s3 (default: backup) |
| --destination | -d | Set destination (default: local) | | --destination | -d | Set destination (default: local) |
| --source | -s | Set source (default: local) | | --source | -s | Set source, local or s3 (default: local) |
| --file | -f | Set file name for restoration | | --file | -f | Set file name for restoration |
| --source | -s | Set source (default: local) | | --source | -s | Set source (default: local) |
| --database | -db | Set database name | | --database | -db | Set database name |
@@ -29,6 +29,16 @@ MySQL Backup docker container image
| --version | -V | Print version information and exit | | --version | -V | Print version information and exit |
## Backup database : ## Backup database :
Simple backup usage
```sh
bkup --operation backup
```
```sh
bkup -o backup
```
```yaml ```yaml
version: '3' version: '3'
services: services:
@@ -58,6 +68,15 @@ services:
``` ```
## Restore database : ## Restore database :
Simple database restore operation usage
```sh
bkup --operation restore --file database_20231217_115621.sql
```
```sh
bkup --o restore --f database_20231217_115621.sql
```
```yaml ```yaml
version: '3' version: '3'
services: services:
@@ -87,11 +106,17 @@ services:
- DB_PASSWORD=password - DB_PASSWORD=password
``` ```
## Run ## Run
```sh ```sh
docker-compose up -d docker-compose up -d
``` ```
## Backup to S3 ## Backup to S3
Simple S3 backup usage Simple S3 backup usage
```sh
bkup --operation backup --destination s3 -database mydatabase
```
```yaml ```yaml
mysql-bkup: mysql-bkup:
image: jkaninda/mysql-bkup:latest image: jkaninda/mysql-bkup:latest
@@ -119,7 +144,9 @@ Simple S3 backup usage
``` ```
## Run on Kubernetes ## Kubernetes CronJob
Simple Kubernetes CronJob usage:
```yaml ```yaml
apiVersion: batch/v1 apiVersion: batch/v1