How to manage Database Lab Engine

Set up and start a Database Lab Engine instance

Define config file ~/.dblab/server.yml (see config examples here) and run the following command:

sudo docker run \
--name dblab_server \
--label dblab_control \
--privileged \
--publish 2345:2345 \
--restart on-failure \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume /var/lib/dblab:/var/lib/dblab:rshared \
--volume ~/.dblab/server.yml:/home/dblab/configs/config.yml \
--detach \
postgresai/dblab-server:latest

Reconfigure Database Lab Engine

Update the configuration file ~/.dblab/server.yml.

Restart container:

sudo docker restart dblab_server

⚠ Note that once docker restart is executed, all existing clones will be lost.

Upgrade Database Lab Engine

Stop and remove the container using sudo docker stop dblab_server and sudo docker rm dblab_server After that, launch a new container.

⚠ Note the upgrade removes all running clones

Observe Database Lab Engine logs

To enable debugging mode, set option debug to true (see example). Next, follow the reconfiguration guidelines to apply the change.

To observe container's logs, run:

sudo docker logs dblab_server -f

Check Database Lab Engine status

To check the status of the running container, perform the request GET /healthz.

For example using curl:

curl -XGET 'https://dblab.domain.com/healthz'

If the instance is configured properly, you will get the response with status code HTTP/1.1 200 OK and a body similar to the following:

{
"version":"0.3.1-20200428-1333"
}