Installing Databand in a Docker Container

DevEnv

This file describes how to run databand environment using Docker-compose.

This Docker-compose spins up a fully-charged databand installation with "real" databases and monitoring stack. Makefile is used to simplify the deployment with the relevant Docker-compose instruments (run make to see the full list of options). By default, basic deployment includes Postgres database.

Preparing for the Installation

Before installing Databand, prepare your server for the installation. Review the described system requirements and then install the required software. You will also need to obtain the required keys from the Databand team (use your dedicated Slack channel or email ([email protected]).
See Docker Compose Prerequisites for more details.

System Requirements

• Operating system: any Debian-based Linux OS. Ubuntu 20.4 is recommended.
• CPU: minimum 4 CPU
• Memory: minimum 16GB
• Disk: 80 GB+
• DB: Postgres 10.5+

Get/Update Databand Deployment Scripts

1. Clone the databand-deploy repository to the /opt/databand_deploy folder or use the existing one:

   • Run git clone https://gitlab.com/databand/databand-deploy.git.
   • When prompted, enter your GitLab username and password.

2. Check out the latest version: git checkout release/v0.XX (change XX to the latest version)

3. Run the following command to log in to the Databand's Docker registry:

docker login -u <GitLab Username> -p <GitLab Access Token> registry.gitlab.com

Launch the Databand service

Go to the /opt/databand_deploy directory, and run make up-databand to start Databand.

make up-databand

The Docker-compose spins up a fully-charged Databand installation with a ready-to-use database and monitoring stack. This installation is configured using the .env file.

How to Upgrade Databand to the Latest Version

🚧

Downtime

Docker-compose deployment upgrades lead to downtime. Perform it with caution.

1. On the Databand server machine, go to the Databand deployment directory.
2. Follow "Get/Update Databand Deployment Scripts" instructions from the section above.
3. Run make upgrade-databand. The following commands will be performed under the hood:
   3.1. make pull to fetch new images.
   3.2. make up-migrate to perform DB migration.
   3.3. make stop-databand to stop all containers.
   3.4. make up-databand, to get Databand running again.

Congratulations! Databand is now successfully updated to the latest version.

Custom Version

Docker images are defined in the .env file:

To stop Databand, run docker-compose down.

To Access Databand Services

When Databand is successfully installed, you can access its services from your browser by using the following URL:
HTTP://<server_where_databand_is_installed>:.

By default it's http://localhost:8080

• Login: databand
• Password: databand

• webserver is accessible on http://localhost:8080 and points to local dir
• prometheus is available at http://localhost:9090
• alertmanager is available at http://localhost:9093
• grafana is available at http://localhost:3000. Login/password: databand/databand

Airflow Monitor

Launch the monitor module in order to start syncing your Airflow data into the Databand system:
sudo docker-compose up airflow-sync-monitor

Grafana

By default, a static Grafana dashboard is configured to be mounted with:
/usr/share/grafana/public/dashboards/dbnd_scripted_dashboards.js

In order to use latest Grafana dashboard:

• Use wget http://<dbnd_webserver>/app/statics/grafana-scripted-dashboards/dbnd_scripted_dashboards.js -O ./config/grafana/dashboards/scripted/dbnd_scripted_dashboards.js
• Uncomment the relevant ${GRAFANA_DASHBOARD_LOCATION} in custom.env