From 8f3b89b426968868317a96b2f2dcb2d2e50f5a25 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sun, 17 Dec 2023 19:43:20 +0100 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eb101ca..27a2a67 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,9 @@ MySQL Backup docker container image | Options | Shorts | Usage | |---------------|--------|------------------------------------| | 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) | -| --source | -s | Set source (default: local) | +| --source | -s | Set source, local or s3 (default: local) | | --file | -f | Set file name for restoration | | --source | -s | Set source (default: local) | | --database | -db | Set database name | @@ -29,6 +29,16 @@ MySQL Backup docker container image | --version | -V | Print version information and exit | ## Backup database : + +Simple backup usage + +```sh +bkup --operation backup +``` +```sh +bkup -o backup +``` + ```yaml version: '3' services: @@ -58,6 +68,15 @@ services: ``` ## 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 version: '3' services: @@ -87,11 +106,17 @@ services: - DB_PASSWORD=password ``` ## Run + ```sh docker-compose up -d ``` ## Backup to S3 + Simple S3 backup usage + +```sh +bkup --operation backup --destination s3 -database mydatabase +``` ```yaml mysql-bkup: image: jkaninda/mysql-bkup:latest @@ -119,7 +144,9 @@ Simple S3 backup usage ``` -## Run on Kubernetes +## Kubernetes CronJob + +Simple Kubernetes CronJob usage: ```yaml apiVersion: batch/v1