https://github.com/thomascogez/dump-and-dumper
A simple cli tool to streamline backup process of containerized databases
https://github.com/thomascogez/dump-and-dumper
backup cli docker posgresql s3-bucket
Last synced: 5 months ago
JSON representation
A simple cli tool to streamline backup process of containerized databases
- Host: GitHub
- URL: https://github.com/thomascogez/dump-and-dumper
- Owner: Thomascogez
- Created: 2022-06-23T07:41:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-30T10:36:09.000Z (almost 3 years ago)
- Last Synced: 2025-04-08T05:49:58.074Z (11 months ago)
- Topics: backup, cli, docker, posgresql, s3-bucket
- Language: Go
- Homepage:
- Size: 170 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Dump & dumper
Dump & dumper 1.0.0 currently support only _postgress_ database
# Install
Using *Homebrew*
```sh
brew tap Thomascogez/thomascogez
```
Then
```sh
brew install dump-and-dumper
```
# Usage
Add labels to the containers you want to dump
The above labels are currently available
| label | description |
| ----------------- | -------------------------------------------------- |
| dump-and-dumper.enabled | Use to determined if the container should be dump |
| dump-and-dumper.user | The database user to use during the dump process |
| dump-and-dumper.type | The database type (for now only "pg" is available) |
> docker-compose example
```yml
version: '3.0'
services:
pg_dump_1:
image: postgres:latest
environment:
POSTGRES_PASSWORD: test
POSTGRES_DB: test
labels:
- 'dump-and-dumper.enabled=true'
- 'dump-and-dumper.user=postgres'
- 'dump-and-dumper.type=pg'
```
Then start or restart your docker containers
After that you can run the dump command using desired s3 options
The above flags are available
| flag | description |
| ----------------- | ---------------------------------- |
| --s3-endpoint | Set the endpoint of your s3 bucket |
| --s3-bucket | Set the targeted bucket name |
| --s3-secretKeyId | Set the secret key id |
| --s3-secretKey | Set the secret key |
```sh
dump-and-dumper dump --s3-endpoint=S3_ENDPOINT --s3-bucket=BUCKET_NAME --s3-secretKeyId=SECRET_KEY_ID --s3-secretKey=SECRET_KEY --s3-region=REGION
```
# Success callback/notify
dump-and-dumper have also the ability to notify you after a successfull dump.
> For now only https://ntfy.sh/ is available
to use it simple add the flag ```--ntfy-endpoint=``` where the value is your ntfy topic endpoint