Skip to content

Thomascogez/dump-and-dumper

Repository files navigation

Dump & dumper

Dump & dumper

Dump & dumper is a simple cli tool written in go to ease the process of containerized database backup and upload result into a s3 bucket

Dump & dumper 1.0.0 currently support only postgress database

Install

Using Homebrew

brew tap Thomascogez/thomascogez

Then

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

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
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

About

A simple cli tool to streamline backup process of containerized databases

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages