PostgreSQL Backup

PostgreSQL Backup is a Docker container image that can be used to backup and restore Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage. It also supports encrypting your backups using GPG.

The jkaninda/pg-bkup Docker image can be deployed on Docker, Docker Swarm and Kubernetes. It handles recurring backups of postgres database on Docker and can be deployed as CronJob on Kubernetes using local, AWS S3 or SSH compatible storage.

It also supports encrypting your backups using GPG.

Successfully tested on:

• Docker
• Docker in Swarm mode
• Kubernetes
• OpenShift

Documentation is found at https://jkaninda.github.io/pg-bkup

Links:

• Docker Hub
• Github

MySQL solution :

• MySQL

Storage:

• Local
• AWS S3 or any S3 Alternatives for Object Storage
• SSH remote server

Quickstart

Simple backup using Docker CLI

To run a one time backup, bind your local volume to /backup in the container and run the backup command:

 docker run --rm --network your_network_name \
 -v $PWD/backup:/backup/ \
 -e "DB_HOST=dbhost" \
 -e "DB_USERNAME=username" \
 -e "DB_PASSWORD=password" \
 jkaninda/pg-bkup backup -d database_name

Alternatively, pass a --env-file in order to use a full config as described below.

 docker run --rm --network your_network_name \
 --env-file your-env-file \
 -v $PWD/backup:/backup/ \
 jkaninda/pg-bkup backup -d database_name

Simple backup in docker compose file

services:
  pg-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/pg-bkup/releases
    # for a list of available releases.
    image: jkaninda/pg-bkup
    container_name: pg-bkup
    command: backup
    volumes:
      - ./backup:/backup
    environment:
      - DB_PORT=5432
      - DB_HOST=postgres
      - DB_NAME=foo
      - DB_USERNAME=bar
      - DB_PASSWORD=password
    # pg-bkup container must be connected to the same network with your database
    networks:
       - web
networks:
  web:

Deploy on Kubernetes

For Kubernetes, you don't need to run it in scheduled mode. You can deploy it as Job or CronJob.

Simple Kubernetes backup Job :

apiVersion: batch/v1
kind: Job
metadata:
  name: backup
spec:
  template:
    spec:
      containers:
      - name: pg-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/pg-bkup/releases
        # for a list of available releases.
        image: jkaninda/pg-bkup
        command:
        - bkup
        - backup
        resources:
          limits:
            memory: "128Mi"
            cpu: "500m"
        env:
          - name: DB_PORT
            value: "5432"
          - name: DB_HOST
            value: ""
          - name: DB_NAME
            value: "dbname"
          - name: DB_USERNAME
            value: "postgres"
          # Please use secret!
          - name: DB_PASSWORD
            value: ""
      restartPolicy: Never

Available image registries

This Docker image is published to both Docker Hub and the GitHub container registry. Depending on your preferences and needs, you can reference both jkaninda/pg-bkup as well as ghcr.io/jkaninda/pg-bkup:

docker pull jkaninda/pg-bkup
docker pull ghcr.io/jkaninda/pg-bkup

Documentation references Docker Hub, but all examples will work using ghcr.io just as well.

Supported Engines

This image is developed and tested against the Docker CE engine and Kubernetes exclusively. While it may work against different implementations, there are no guarantees about support for non-Docker engines.

References

We decided to publish this image as a simpler and more lightweight alternative because of the following requirements:

• The original image is based on ubuntu and requires additional tools, making it heavy.
• This image is written in Go.
• arm64 and arm/v7 architectures are supported.
• Docker in Swarm mode is supported.
• Kubernetes is supported.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Authors

Jonas Kaninda

• https://github.com/jkaninda

Copyright

Copyright (c) [2023] [Jonas Kaninda]