From 33b1acf7c089a79b98a7b08e78002b3652f317c9 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sun, 4 Aug 2024 11:42:07 +0200 Subject: [PATCH] docs: add Kubernetes restore example --- docs/how-tos/backup-to-ssh.md | 10 +++---- docs/how-tos/restore-from-s3.md | 50 ++++++++++++++++++++++++++++++++ docs/how-tos/restore-from-ssh.md | 48 ++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+), 5 deletions(-) diff --git a/docs/how-tos/backup-to-ssh.md b/docs/how-tos/backup-to-ssh.md index 1581ee4..f8d4f80 100644 --- a/docs/how-tos/backup-to-ssh.md +++ b/docs/how-tos/backup-to-ssh.md @@ -32,7 +32,7 @@ services: environment: - DB_PORT=3306 - DB_HOST=mysql - - DB_NAME=database + #- DB_NAME=database - DB_USERNAME=username - DB_PASSWORD=password ## SSH config @@ -69,7 +69,7 @@ services: command: - /bin/sh - -c - - mysql-bkup backup -d database --storage s3 --mode scheduled --period "0 1 * * *" + - mysql-bkup backup -d database --storage ssh --mode scheduled --period "0 1 * * *" volumes: - ./id_ed25519:/tmp/id_ed25519" environment: @@ -117,7 +117,7 @@ spec: command: - /bin/sh - -c - - mysql-bkup backup -s s3 --path /custom_path + - mysql-bkup backup -s ssh env: - name: DB_PORT value: "3306" @@ -141,6 +141,6 @@ spec: - name: AWS_ACCESS_KEY value: "xxxx" - name: SSH_IDENTIFY_FILE - value: "/home/jkaninda/backups" - restartPolicy: OnFailure + value: "/tmp/id_ed25519" + restartPolicy: Never ``` \ No newline at end of file diff --git a/docs/how-tos/restore-from-s3.md b/docs/how-tos/restore-from-s3.md index 4c10f14..ed63819 100644 --- a/docs/how-tos/restore-from-s3.md +++ b/docs/how-tos/restore-from-s3.md @@ -48,4 +48,54 @@ services: - web networks: web: +``` + +## Restore on Kubernetes + + +### Simple Kubernetes CronJob usage: + +```yaml +apiVersion: batch/v1 +kind: CronJob +metadata: + name: bkup-job +spec: + schedule: "0 1 * * *" + jobTemplate: + spec: + template: + spec: + containers: + - name: mysql-bkup + image: jkaninda/mysql-bkup + command: + - /bin/sh + - -c + - mysql-bkup restore -s s3 --path /custom_path -f store_20231219_022941.sql.gz + env: + - name: DB_PORT + value: "3306" + - name: DB_HOST + value: "" + - name: DB_NAME + value: "" + - name: DB_USERNAME + value: "" + # Please use secret! + - name: DB_PASSWORD + value: "" + - name: AWS_S3_ENDPOINT + value: "https://s3.amazonaws.com" + - name: AWS_S3_BUCKET_NAME + value: "xxx" + - name: AWS_REGION + value: "us-west-2" + - name: AWS_ACCESS_KEY + value: "xxxx" + - name: AWS_SECRET_KEY + value: "xxxx" + - name: AWS_DISABLE_SSL + value: "false" + restartPolicy: OnFailure ``` \ No newline at end of file diff --git a/docs/how-tos/restore-from-ssh.md b/docs/how-tos/restore-from-ssh.md index f2b7a25..9c4dd10 100644 --- a/docs/how-tos/restore-from-ssh.md +++ b/docs/how-tos/restore-from-ssh.md @@ -47,4 +47,52 @@ services: - web networks: web: +``` +## Restore on Kubernetes + +Simple Kubernetes CronJob usage: + +```yaml +apiVersion: batch/v1 +kind: CronJob +metadata: + name: bkup-job +spec: + schedule: "0 1 * * *" + jobTemplate: + spec: + template: + spec: + containers: + - name: mysql-bkup + image: jkaninda/mysql-bkup + command: + - /bin/sh + - -c + - mysql-bkup restore -s ssh -f store_20231219_022941.sql.gz + env: + - name: DB_PORT + value: "3306" + - name: DB_HOST + value: "" + - name: DB_NAME + value: "" + - name: DB_USERNAME + value: "" + # Please use secret! + - name: DB_PASSWORD + value: "" + - name: SSH_HOST_NAME + value: "" + - name: SSH_PORT + value: "22" + - name: SSH_USER + value: "xxx" + - name: SSH_REMOTE_PATH + value: "/home/jkaninda/backups" + - name: AWS_ACCESS_KEY + value: "xxxx" + - name: SSH_IDENTIFY_FILE + value: "/tmp/id_ed25519" + restartPolicy: Never ``` \ No newline at end of file