From a7f7e57a0d7d9d0b0bc64fd630d60b98c6ea9ffc Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Mon, 9 Sep 2024 07:17:15 +0200 Subject: [PATCH] docs: update Kubernetes deployment --- README.md | 2 +- docs/how-tos/backup-to-s3.md | 2 +- docs/how-tos/backup-to-ssh.md | 2 +- docs/how-tos/deploy-on-kubernetes.md | 5 +---- docs/how-tos/restore-from-s3.md | 2 +- docs/how-tos/restore-from-ssh.md | 2 +- docs/index.md | 5 +++-- examples/k8s-job.yaml | 5 +---- 8 files changed, 10 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 583dd6f..218777a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It also supports __encrypting__ your backups using GPG. The [jkaninda/mysql-bkup](https://hub.docker.com/r/jkaninda/mysql-bkup) Docker image can be deployed on Docker, Docker Swarm and Kubernetes. It handles __recurring__ backups of postgres database on Docker and can be deployed as __CronJob on Kubernetes__ using local, AWS S3 or SSH compatible storage. -It also supports __encrypting__ your backups using GPG. +It also supports database __encryption__ using GPG. [![Build](https://github.com/jkaninda/mysql-bkup/actions/workflows/release.yml/badge.svg)](https://github.com/jkaninda/mysql-bkup/actions/workflows/release.yml) [![Go Report](https://goreportcard.com/badge/github.com/jkaninda/mysql-bkup)](https://goreportcard.com/report/github.com/jkaninda/mysql-bkup) diff --git a/docs/how-tos/backup-to-s3.md b/docs/how-tos/backup-to-s3.md index 6b0b7b8..9277a48 100644 --- a/docs/how-tos/backup-to-s3.md +++ b/docs/how-tos/backup-to-s3.md @@ -104,7 +104,7 @@ spec: command: - /bin/sh - -c - - mysql-bkup backup -s s3 --path /custom_path + - backup -s s3 --path /custom_path env: - name: DB_PORT value: "3306" diff --git a/docs/how-tos/backup-to-ssh.md b/docs/how-tos/backup-to-ssh.md index 8a88999..4f413f1 100644 --- a/docs/how-tos/backup-to-ssh.md +++ b/docs/how-tos/backup-to-ssh.md @@ -111,7 +111,7 @@ spec: command: - /bin/sh - -c - - mysql-bkup backup -s ssh + - backup -s ssh env: - name: DB_PORT value: "3306" diff --git a/docs/how-tos/deploy-on-kubernetes.md b/docs/how-tos/deploy-on-kubernetes.md index 923f3df..c0a1117 100644 --- a/docs/how-tos/deploy-on-kubernetes.md +++ b/docs/how-tos/deploy-on-kubernetes.md @@ -30,10 +30,7 @@ spec: command: - /bin/sh - -c - - bkup - - backup - - --storage - - s3 + - backup --storage s3 resources: limits: memory: "128Mi" diff --git a/docs/how-tos/restore-from-s3.md b/docs/how-tos/restore-from-s3.md index 16d6e4a..ccd5fac 100644 --- a/docs/how-tos/restore-from-s3.md +++ b/docs/how-tos/restore-from-s3.md @@ -65,7 +65,7 @@ spec: command: - /bin/sh - -c - - bkup restore -s s3 --path /custom_path -f store_20231219_022941.sql.gz + - restore -s s3 --path /custom_path -f store_20231219_022941.sql.gz env: - name: DB_PORT value: "3306" diff --git a/docs/how-tos/restore-from-ssh.md b/docs/how-tos/restore-from-ssh.md index 7c789b5..00d4bf0 100644 --- a/docs/how-tos/restore-from-ssh.md +++ b/docs/how-tos/restore-from-ssh.md @@ -63,7 +63,7 @@ spec: command: - /bin/sh - -c - - bkup restore -s ssh -f store_20231219_022941.sql.gz + - restore -s ssh -f store_20231219_022941.sql.gz env: - name: DB_PORT value: "3306" diff --git a/docs/index.md b/docs/index.md index d1a25db..7760b27 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ nav_order: 1 # About mysql-bkup {:.no_toc} -MySQL Backup is a Docker container image that can be used to backup and restore MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH remote storage. +MySQL Backup is a Docker container image that can be used to backup, restore and migrate MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH remote storage. It also supports __encrypting__ your backups using GPG. We are open to receiving stars, PRs, and issues! @@ -19,7 +19,8 @@ We are open to receiving stars, PRs, and issues! The [jkaninda/mysql-bkup](https://hub.docker.com/r/jkaninda/mysql-bkup) Docker image can be deployed on Docker, Docker Swarm and Kubernetes. It handles __recurring__ backups of postgres database on Docker and can be deployed as __CronJob on Kubernetes__ using local, AWS S3 or SSH compatible storage. -It also supports __encrypting__ your backups using GPG. +It also supports database __encryption__ using GPG. + {: .note } Code and documentation for `v1` version on [this branch][v1-branch]. diff --git a/examples/k8s-job.yaml b/examples/k8s-job.yaml index a2c388c..5d7f37f 100644 --- a/examples/k8s-job.yaml +++ b/examples/k8s-job.yaml @@ -15,10 +15,7 @@ spec: command: - /bin/sh - -c - - bkup - - backup - - --storage - - s3 + - backup --storage s3 resources: limits: memory: "128Mi"