Skip to content

Commit 33b1acf

Browse files
committed
docs: add Kubernetes restore example
1 parent 9a4d02f commit 33b1acf

File tree

3 files changed

+103
-5
lines changed

3 files changed

+103
-5
lines changed

docs/how-tos/backup-to-ssh.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ services:
3232
environment:
3333
- DB_PORT=3306
3434
- DB_HOST=mysql
35-
- DB_NAME=database
35+
#- DB_NAME=database
3636
- DB_USERNAME=username
3737
- DB_PASSWORD=password
3838
## SSH config
@@ -69,7 +69,7 @@ services:
6969
command:
7070
- /bin/sh
7171
- -c
72-
- mysql-bkup backup -d database --storage s3 --mode scheduled --period "0 1 * * *"
72+
- mysql-bkup backup -d database --storage ssh --mode scheduled --period "0 1 * * *"
7373
volumes:
7474
- ./id_ed25519:/tmp/id_ed25519"
7575
environment:
@@ -117,7 +117,7 @@ spec:
117117
command:
118118
- /bin/sh
119119
- -c
120-
- mysql-bkup backup -s s3 --path /custom_path
120+
- mysql-bkup backup -s ssh
121121
env:
122122
- name: DB_PORT
123123
value: "3306"
@@ -141,6 +141,6 @@ spec:
141141
- name: AWS_ACCESS_KEY
142142
value: "xxxx"
143143
- name: SSH_IDENTIFY_FILE
144-
value: "/home/jkaninda/backups"
145-
restartPolicy: OnFailure
144+
value: "/tmp/id_ed25519"
145+
restartPolicy: Never
146146
```

docs/how-tos/restore-from-s3.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,54 @@ services:
4848
- web
4949
networks:
5050
web:
51+
```
52+
53+
## Restore on Kubernetes
54+
55+
56+
### Simple Kubernetes CronJob usage:
57+
58+
```yaml
59+
apiVersion: batch/v1
60+
kind: CronJob
61+
metadata:
62+
name: bkup-job
63+
spec:
64+
schedule: "0 1 * * *"
65+
jobTemplate:
66+
spec:
67+
template:
68+
spec:
69+
containers:
70+
- name: mysql-bkup
71+
image: jkaninda/mysql-bkup
72+
command:
73+
- /bin/sh
74+
- -c
75+
- mysql-bkup restore -s s3 --path /custom_path -f store_20231219_022941.sql.gz
76+
env:
77+
- name: DB_PORT
78+
value: "3306"
79+
- name: DB_HOST
80+
value: ""
81+
- name: DB_NAME
82+
value: ""
83+
- name: DB_USERNAME
84+
value: ""
85+
# Please use secret!
86+
- name: DB_PASSWORD
87+
value: ""
88+
- name: AWS_S3_ENDPOINT
89+
value: "https://s3.amazonaws.com"
90+
- name: AWS_S3_BUCKET_NAME
91+
value: "xxx"
92+
- name: AWS_REGION
93+
value: "us-west-2"
94+
- name: AWS_ACCESS_KEY
95+
value: "xxxx"
96+
- name: AWS_SECRET_KEY
97+
value: "xxxx"
98+
- name: AWS_DISABLE_SSL
99+
value: "false"
100+
restartPolicy: OnFailure
51101
```

docs/how-tos/restore-from-ssh.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,52 @@ services:
4747
- web
4848
networks:
4949
web:
50+
```
51+
## Restore on Kubernetes
52+
53+
Simple Kubernetes CronJob usage:
54+
55+
```yaml
56+
apiVersion: batch/v1
57+
kind: CronJob
58+
metadata:
59+
name: bkup-job
60+
spec:
61+
schedule: "0 1 * * *"
62+
jobTemplate:
63+
spec:
64+
template:
65+
spec:
66+
containers:
67+
- name: mysql-bkup
68+
image: jkaninda/mysql-bkup
69+
command:
70+
- /bin/sh
71+
- -c
72+
- mysql-bkup restore -s ssh -f store_20231219_022941.sql.gz
73+
env:
74+
- name: DB_PORT
75+
value: "3306"
76+
- name: DB_HOST
77+
value: ""
78+
- name: DB_NAME
79+
value: ""
80+
- name: DB_USERNAME
81+
value: ""
82+
# Please use secret!
83+
- name: DB_PASSWORD
84+
value: ""
85+
- name: SSH_HOST_NAME
86+
value: ""
87+
- name: SSH_PORT
88+
value: "22"
89+
- name: SSH_USER
90+
value: "xxx"
91+
- name: SSH_REMOTE_PATH
92+
value: "/home/jkaninda/backups"
93+
- name: AWS_ACCESS_KEY
94+
value: "xxxx"
95+
- name: SSH_IDENTIFY_FILE
96+
value: "/tmp/id_ed25519"
97+
restartPolicy: Never
5098
```

0 commit comments

Comments
 (0)