Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 2.92 KB

README.md

File metadata and controls

60 lines (45 loc) · 2.92 KB
Raw

dump-ipfs

Code developed during the ETH Global Paris 2023 Hackathon

Dependencies

brew list kind || brew install kind
brew list kubectl || brew install kubectl
brew list helm || brew install helm

# x86
brew list datawire/blackbird/telepresence || brew install datawire/blackbird/telepresence
# ARM64
brew list datawire/blackbird/telepresence-arm64 || brew install datawire/blackbird/telepresence-arm64

Quick Start

For this example we will run the pg-backup-ipfs as a sidecar container for a Postgres database with "world data".

Ensure you have the necessary docker image built by running make docker-build.

To start the cluster run make dev-up. This will create a kind cluster. Then to deploy that database service together with the sidecar run make db-update.

To then shutdown run make dev-down.

Description

This project combines popular DBMS (for this hackathon, PostgreSQL), IPFS/Filecoin and AES encryption to deliver a backup agent that can run anywhere. It supports cron execution and multiple source databases. It can also be ran as a sidecar container in Kubernetes.

How its Made

It uses Web3 Storage as the gateway to IPFS/Filecoin. Using IPFS/Filecoin allowed us to create a trully decentralized solution to offer managed database backups as a service in our product. Another storage layer that we plan (might not be fully completed in the hackathon) is to include Delta support for enterprise-grade DB backups. It uses Kubernetes as part of its sidecar architecture. PostgreSQL is the first supported DBMS. Backups are encrypted and an hash of the used key is stored together with the backup log entry to allow for key rotation.

Architecture

The pg-backup-ipfs service can be run in multiple configurations. Most of them will be one of the following.

As an external service

You can run the pg-backup-ipfs as a standalone service that connects to multiple databases and backs them up. This is a simple configuration.

external

As a sidecar

If you are running, for example, your Postgres databases in Kubernetes, chances are that you are already familiar with the sidecar pattern. By running pg-backup-ipfs as a sidecar inside your Postgres Pod you can perform dumps in the same network space as the Postgres container. Bellow is an illustration on how this configuration would work.

sidecar

Key Rotation

This tool supports key rotation. Each entry in the dump_ipfs.backup_log table has a key_checksum field that helps identify the key that was used. This checksum is the md5 of the original encryption key.

In a Kubernetes setup you can rotate the Secret object.

Showcase

This project has been shown in the ETH Global Paris 2023 Hackathon. That presentation can be found here together with a demo video to show how it works.