Cloudbreak Database

By default, Cloudbreak uses a built-in PostgreSQL database to persist data.

For production environments, we suggest that you use an external database, an RDS served by your cloud provider.

If you choose to use the default database, you should know that Cloudbreak deployer includes features for dumping and restoring built-in databases.

Dump and Restore Database

Cloudbreak deployer uses Docker for the underlying infrastructure and uses Docker volume for storing data. There are two separate volumes:

You can override default live data volume any time by extending your Profile with the following variable:

export COMMON_DB_VOL="my-live-data-volume"

To create database dumps by executing the following commands:

cbd db dump common cbdb
cbd db dump common uaadb
cbd db dump common periscopedb

To list existing dumps, execute the cbd db list-dumps command.

Each kind of database dump (cbdb, uaadb, periscopedb) has a link to the latest dump on the cbreak_dump volume. During the restore process, Cloudbreak deployer restores from latest dump.

To check which dump is the latest, execute:

docker run --rm -v cbreak_dump:/dump -it alpine ls -lsa /dump/cbdb/latest

If you want to restore an older dump, you have to link it as the latest.

To remove the existing common volume, stop all the related Cloudbreak containers with cbd kill command, and then remove the volume:

docker volume rm common

To restore databases from dumps, execute:

cbd db restore-volume-from-dump common cbdb
cbd db restore-volume-from-dump common uaadb
cbd db restore-volume-from-dump common periscopedb

You can easily save your dumps to the host machine by using the following commands:

docker run --rm -v cbreak_dump:/dump -it alpine cat /dump/cbdb/latest/dump.sql > cbdb.sql
docker run --rm -v cbreak_dump:/dump -it alpine cat /dump/uaadb/latest/dump.sql > uaadb.sql
docker run --rm -v cbreak_dump:/dump -it alpine cat /dump/periscopedb/latest/dump.sql > periscopedb.sql
Edit on GitHub