pg-bkup/docs/index.md

title, layout, nav_order

title	layout	nav_order
Overview	home	1

About PG-BKUP

{:.no_toc}

PG-BKUP is a Docker container image designed to backup, restore, and migrate PostgreSQL databases. It supports a variety of storage options and ensures data security through GPG encryption.

Features

• Storage Options:

  • Local storage
  • AWS S3 or any S3-compatible object storage
  • FTP
  • SSH-compatible storage

• Data Security:

  • Backups can be encrypted using GPG to ensure confidentiality.

• Deployment Flexibility:

  • Available as the jkaninda/pg-bkup Docker image.
  • Deployable on Docker, Docker Swarm, and Kubernetes.
  • Supports recurring backups of PostgreSQL databases when deployed:
    • On Docker for automated backup schedules.
    • As a Job or CronJob on Kubernetes.

• Notifications:

  • Get real-time updates on backup success or failure via:
    • Telegram
    • Email

Use Cases

• Automated Recurring Backups: Schedule regular backups for PostgreSQL databases.
• Cross-Environment Migration: Easily migrate your PostgreSQL databases across different environments using supported storage options.
• Secure Backup Management: Protect your data with GPG encryption.

We are open to receiving stars, PRs, and issues!

{: .fs-6 .fw-300 }

---

{: .note } Code and documentation for v1 version on this branch.

---

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
      - TZ=Europe/Paris
    # pg-bkup container must be connected to the same network with your database
    networks:
       - web
networks:
  web:

Docker recurring backup

 docker run --rm --network network_name \
 -v $PWD/backup:/backup/ \
 -e "DB_HOST=hostname" \
 -e "DB_USERNAME=user" \
 -e "DB_PASSWORD=password" \
 jkaninda/pg-bkup backup -d dbName --cron-expression "@every 15m" #@midnight

See: https://jkaninda.github.io/pg-bkup/reference/#predefined-schedules

Kubernetes

apiVersion: batch/v1
kind: Job
metadata:
  name: backup-job
spec:
  ttlSecondsAfterFinished: 100
  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:
            - /bin/sh
            - -c
            - backup -d dbname
          resources:
            limits:
              memory: "128Mi"
              cpu: "500m"
          env:
            - name: DB_HOST
              value: "postgres"
            - name: DB_USERNAME
              value: "postgres"
            - name: DB_PASSWORD
              value: "password"
          volumeMounts:
            - mountPath: /backup
              name: backup
      volumes:
        - name: backup
          hostPath:
            path: /home/toto/backup # directory location on host
            type: Directory # this field is optional
      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.

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