Skip to main content

Database Lab tutorial for Amazon RDS

Database Lab is used to boost software development and testing processes via enabling ultra-fast provisioning of databases of any size.

Terraform Module released 🎉

Try out Database Lab installation using Terraform Module, it's simpler and automates a bunch of manual steps. Continue with the current tutorial for more customizability and granual control.

In this tutorial, we are going to set up a Database Lab Engine for an existing PostgreSQL DB instance on Amazon RDS. If you don't have an RDS instance and want to have one to follow the steps in this tutorial, read the official RDS documentation. Database Lab Engine will be installed on an AWS EC2 instance with Ubuntu 18.04 or 20.04, and add an EBS volume to store PostgreSQL data directory. The data will be automatically retrieved from the RDS database.

Compared to RDS clones, Database Lab clones are ultra-fast (RDS cloning is "thick": it takes many minutes, and, depending on the database size, additional dozens of minutes or even hours to warm up, see "Lazy load") and do not require additional storage and instance. A single Database Lab instance can be used by dozens of engineers simultaneously working with dozens of thin clones located on a single instance and single storage vole. RDS Aurora clones are "thin" by nature, which is great for development and testing. However, they also require additional instances, meaning significant extra costs. Database Lab clones are high-speed ("thin"), budget-saving ("local"), and can be used for a source database located anywhere.

Steps:

  1. Prepare an EC2 instance with an additional EBS volume to store data, install Docker to run containers, and ZFS to enable copy-on-write for thin cloning
  2. Configure and launch the Database Lab Engine
  3. Start using Database Lab API and client CLI to clone Postgres database in seconds

Step 1. Prepare an EC2 instance with additional volume, Docker, and ZFS#

Prepare an instance#

Create an EC2 instance with Ubuntu 18.04 or 20.04, and add an EBS volume to store data. You can find detailed instructions on how to create an AWS EC2 instance here.

(optional) Ports need to be open in the Security Group being used#

You will need to open the following ports (inbound rules in your Security Group):

  • 22: to connect to the instance using SSH
  • 2345: to work with Database Lab Engine API (can be changed in the Database Lab Engine configuration file)
  • 6000-6100: to connect to PostgreSQL clones (this is the default port range used in the Database Lab Engine configuration file, and can be changed if needed)
caution

For real-life use, it is not a good idea to open ports to the public. Instead, it is recommended to use VPN or SSH port forwarding to access both Database Lab API and PostgreSQL clones, or to enforce encryption for all connections using NGINX with SSL and configuring SSL in PostgreSQL configuration.

Additionally, to be able to install software, allow access to external resources using HTTP/HTTPS (edit the outbound rules in your Security Group):

  • 80 for HTTP
  • 443 for HTTPS

Here is how the inbound and outbound rules in your Security Group may look like:

EC2 security group inbound

EC2 security group outbound

Install Docker#

If needed, you can find the detailed installation guides for Docker here.

Install dependencies:

sudo apt-get update && sudo apt-get install -y \  apt-transport-https \  ca-certificates \  curl \  gnupg-agent \  software-properties-common

Install Docker:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository \  "deb [arch=amd64] https://download.docker.com/linux/ubuntu \  $(lsb_release -cs) \  stable"
sudo apt-get update && sudo apt-get install -y \  docker-ce \  docker-ce-cli \  containerd.io

Set $DBLAB_DISK#

Further, we will need environment variable $DBLAB_DISK. It must contain the device name that corresponds to the disk where all the Database Lab Engine data will be stored.

To understand what needs to be specified in $DBLAB_DISK in your case, check the output of lsblk:

sudo lsblk

Some examples:

  • AWS local ephemeral NVMe disks; EBS volumes for instances built on the Nitro system:

    $ sudo lsblkNAME    MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT...xvda    202:0    0     8G  0 disk└─xvda1 202:1    0     8G  0 part /nvme0n1 259:0    0   777G  0 disk
$ export DBLAB_DISK="/dev/nvme0n1"

  • AWS EBS volumes for older (pre-Nitro) EC2 instances:

    $ sudo lsblkNAME    MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT...xvda    202:0    0    8G  0 disk└─xvda1 202:1    0    8G  0 part /xvdb    202:16   0  777G  0 disk
$ export DBLAB_DISK="/dev/xvdb"

Install and prepare ZFS#

Install ZFS:

sudo apt-get install -y zfsutils-linux

Create a new ZFS storage pool (make sure $DBLAB_DISK has the correct value, see the previous step!):

sudo zpool create -f \  -O compression=on \  -O atime=off \  -O recordsize=128k \  -O logbias=throughput \  -m /var/lib/dblab/dblab_pool \  dblab_pool \  "${DBLAB_DISK}"

And check the result using zfs list and lsblk, it has to be like this:

$ sudo zfs listNAME         USED  AVAIL  REFER  MOUNTPOINTdblab_pool   106K  777G    24K  /var/lib/dblab/dblab_pool
$ sudo lsblkNAME      MAJ:MIN  RM  SIZE RO TYPE MOUNTPOINT...xvda        202:0  0     8G  0 disk└─xvda1     202:1  0     8G  0 part /nvme0n1     259:0  0   777G  0 disk├─nvme0n1p1 259:3  0   777G  0 part└─nvme0n1p9 259:4  0     8M  0 part

Step 2. Configure and launch the Database Lab Engine#

caution

To make your work with Database Lab API secure, do not open Database Lab API and Postgres clone ports to the public and instead use VPN or SSH port forwarding. It is also a good idea to encrypt all the traffic: for Postgres clones, set up SSL in the configuration files; and for Database Lab API, install, and configure NGINX with a self-signed SSL certificate. See the How to Secure Database Lab Engine.

We have two options to connect to the RDS database: password-based, and IAM-based. The former is always available, while the latter is more secure and recommended, but it is available only if you specified it in Database Authentication Options when creating your RDS instance (it is not selected by default). To see if the IAM-based option is available for already created RDS instance, open the "Configuration" tab and check if "IAM db authentication" is Enabled.

Options:

  • IAM database authentication. This option can be used only if Password and IAM database authentication was specified during the creation of the RDS instance, it requires AWS user credentials and does not require the master password, use this option for granular control of the access to your database.
  • Password authentication (master password). This option can always be used. It requires specifying of database master password in the Database Lab Engine configuration file or in PGPASSWORD environment variable.

For the sake of simplicity, we will use the password-based authentication in this tutorial. If you want to use IAM database authentication, read how to enable it here.

Option 1: Password authentication#

tip

You need to know the master password. If you lost the password it can be reset.

Configure Database Lab Engine#

Copy the contents of configuration example config.example.logical_generic.yml from the Database Lab repository to ~/.dblab/engine/configs/server.yml:

mkdir -p ~/.dblab/engine/configs
curl https://gitlab.com/postgres-ai/database-lab/-/raw/2.5.0/configs/config.example.logical_generic.yml \  --output ~/.dblab/engine/configs/server.yml

Then open ~/.dblab/engine/configs/server.yml and edit the following options:

  • Set secure server:verificationToken, it will be used to authorize API requests to the Database Lab Engine
  • Set connection options in retrieval:spec:logicalDump:options:source:connection:
    • dbname: database name to connect to
    • host: database server host
    • port: database server port
    • username: database user name
    • password: database master password (can be also set as PGPASSWORD environment variable and passed to the container using --env option of docker run)
  • If your Postgres major version is not 13 (default), set the proper version in Postgres Docker image tag:
    • databaseContainer:dockerImage

Run Database Lab Engine#

Run Database Lab Engine:

sudo docker run \  --name dblab_server \  --label dblab_control \  --privileged \  --publish 2345:2345 \  --volume /var/run/docker.sock:/var/run/docker.sock \  --volume /var/lib/dblab:/var/lib/dblab/:rshared \  --volume /var/lib/dblab/dblab_pool/dump:/var/lib/dblab/dblab_pool/dump \  --volume ~/.dblab/engine/configs:/home/dblab/configs:ro \  --volume ~/.dblab/engine/meta:/home/dblab/meta \  --volume /sys/kernel/debug:/sys/kernel/debug:rw \  --volume /lib/modules:/lib/modules:ro \  --volume /proc:/host_proc:ro \  --env DOCKER_API_VERSION=1.39 \  --detach \  --restart on-failure \  postgresai/dblab-server:2.5.0

How to check the Database Lab Engine logs#

sudo docker logs dblab_server -f

Need to start over? Here is how to clean up#

If something went south and you need to make another attempt at the steps in this tutorial, use the following steps to clean up:

# Stop and remove all Docker containerssudo docker ps -aq | xargs --no-run-if-empty sudo docker rm -f
# Remove all Docker imagessudo docker images -q | xargs --no-run-if-empty sudo docker rmi
# Clean up the data directorysudo rm -rf /var/lib/dblab/dblab_pool/data/*
# Remove dump directorysudo umount /var/lib/dblab/dblab_pool/dumpsudo rm -rf /var/lib/dblab/dblab_pool/dump
# To start from the very beginning: destroy ZFS storage poolsudo zpool destroy dblab_pool

Step 3. Start cloning!#

Option 1: GUI (Database Lab Platform)#

To use the GUI, you need to sign up for Database Lab Platform.

Add Database Lab Engine to the Platform#

  1. On the Database Lab instances page of your organization click the Add instance button. Database Lab Engine / Database Lab instances
  2. On the Add instance page fill in the following:
    • Project: choose any project name, it will be created automatically
    • Verification token: specify the same verification token that you've used in the Database Lab Engine configuration file
    • URL: Database Lab API server (EC2 instance public IP or hostname, specify port if needed, e.g. https://my-domain.com/dblab-engine/ or http://30.100.100.1:2345)

Database Lab Engine / Add instance

  1. Click the Verify URL button to check the availability of the Engine. Ignore the warning about insecure connection – in this Tutorial, we have skipped some security-related steps.
  2. Click the Add button to add the instance to the Platform.

Create a clone#

  1. Go to the Database Lab instance page.
  2. Click the Create clone button. Database Lab engine page / Create clone
  3. Fill the ID field with a meaningful name.
  4. (optional) By default, the latest data snapshot (closest to production state) will be used to provision a clone. You can choose another snapshot if any.
  5. Fill database credentials. Remember the password (it will not be available later, Database Lab Platform does not store it!) – you will need to use it to connect to the clone.
  6. Click the Create clone button and wait for a clone to be provisioned. The process should take only a few seconds. Database Lab engine clone creation page
  7. You will be redirected to the Database Lab clone page. Database Lab engine clone page

Connect to a clone#

  1. From the Database Lab clone page under section Connection info, copy the psql connection string field contents by clicking the Copy button. Database Lab clone page / psql connection string
  2. Here we assume that you have psql installed on your working machine. In the terminal, type psql and paste the psql connection string field contents. Change the database name DBNAME parameter, you can always use postgres for the initial connection.
  3. Run the command and type the password you've set during the clone creation.
  4. Test established connection by listing tables in the database using \d. Terminal / psql

Option 2: CLI#

Install Database Lab client CLI#

CLI can be used on any machine, you just need to be able to reach the Database Lab Engine API (port 2345 by default). In this tutorial, we will install and use CLI locally on the EC2 instance.

curl https://gitlab.com/postgres-ai/database-lab/-/raw/master/scripts/cli_install.sh | bashsudo mv ~/.dblab/dblab /usr/local/bin/dblab

Initialize CLI configuration:

dblab init \  --environment-id=tutorial \  --url=http://localhost:2345 \  --token=secret_token \  --insecure

Check the configuration by fetching the status of the instance:

dblab instance status

Create a clone#

dblab clone create \  --username dblab_user_1 \  --password secret_password \  --id my_first_clone

After a second or two, if everything is configured correctly, you will see that the clone is ready to be used. It should look like this:

{    "id": "botcmi54uvgmo17htcl0",    "snapshot": {        "id": "[email protected]",        "createdAt": "2020-02-04 23:20:04 UTC",        "dataStateAt": "2020-02-04 23:20:04 UTC"    },    "protected": false,    "deleteAt": "",    "createdAt": "2020-02-05 14:03:52 UTC",    "status": {        "code": "OK",        "message": "Clone is ready to accept Postgres connections."    },    "db": {        "connStr": "host=111.222.000.123 port=6000 user=dblab_user_1",        "host": "111.222.000.123",        "port": "6000",        "username": "dblab_user_1",        "password": ""    },    "metadata": {        "cloneDiffSize": 479232,        "cloningTime": 2.892935211,        "maxIdleMinutes": 0    },    "project": ""}

Connect to a clone#

Install psql:

sudo apt-get install postgresql-client

Now you can work with this clone using any PostgreSQL client, for example, psql. Use connection info (db section of the response of the dblab clone create command):

PGPASSWORD=secret_password psql \  "host=localhost port=6000 user=dblab_user_1 dbname=test"

Check the available table:

\d+

Now let's see how quickly we can reset the state of the clone. Delete some data or drop some table.

To reset, use the clone reset command (replace my_first_clone with the ID of your clone if you changed it). You can do it not leaving psql -- for that, use the \! command:

\! dblab clone reset my_first_clone

Check the status of the clone:

\! dblab clone status my_first_clone

Notice how fast the resetting was, just a few seconds! 💥

Reconnect to the clone:

\c

Now check the database objects you've dropped or partially deleted – everything should be the same as when we started.

For more, see the full client CLI reference.

Have questions?

Reach out to our team, we'll be happy to help! Use the Intercom widget located at the right bottom corner.