Files
mysql-bkup/docs/how-tos/restore-from-s3.md

96 lines
2.5 KiB
Markdown
Raw Normal View History

---
title: Restore database from AWS S3
layout: default
parent: How Tos
2024-09-30 00:40:35 +02:00
nav_order: 6
---
# Restore database from S3 storage
2024-08-10 10:50:00 +02:00
To restore the database, you need to add `restore` command and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
{: .note }
It supports __.sql__ and __.sql.gz__ compressed file.
### Restore
```yml
services:
mysql-bkup:
# In production, it is advised to lock your image tag to a proper
# release version instead of using `latest`.
# Check https://github.com/jkaninda/mysql-bkup/releases
# for a list of available releases.
image: jkaninda/mysql-bkup
container_name: mysql-bkup
2024-08-10 10:50:00 +02:00
command: restore --storage s3 -d my-database -f store_20231219_022941.sql.gz --path /my-custom-path
volumes:
- ./backup:/backup
environment:
- DB_PORT=3306
- DB_HOST=mysql
- DB_NAME=database
- DB_USERNAME=username
- DB_PASSWORD=password
## AWS configurations
- AWS_S3_ENDPOINT=https://s3.amazonaws.com
- AWS_S3_BUCKET_NAME=backup
- AWS_REGION="us-west-2"
- AWS_ACCESS_KEY=xxxx
- AWS_SECRET_KEY=xxxxx
## In case you are using S3 alternative such as Minio and your Minio instance is not secured, you change it to true
- AWS_DISABLE_SSL="false"
# mysql-bkup container must be connected to the same network with your database
networks:
- web
networks:
web:
2024-08-04 11:42:07 +02:00
```
## Restore on Kubernetes
Simple Kubernetes restore Job:
2024-08-04 11:42:07 +02:00
```yaml
apiVersion: batch/v1
kind: Job
2024-08-04 11:42:07 +02:00
metadata:
name: restore-db
2024-08-04 11:42:07 +02:00
spec:
template:
2024-08-04 11:42:07 +02:00
spec:
containers:
- name: mysql-bkup
image: jkaninda/mysql-bkup
command:
2024-08-04 11:42:07 +02:00
- /bin/sh
- -c
2024-09-09 07:17:15 +02:00
- 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: Never
backoffLimit: 4
```