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.
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.
- 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+
databand-deployrepository to the
/opt/databand_deployfolder or use the existing one:
git clone https://gitlab.com/databand/databand-deploy.git.
- When prompted, enter your GitLab username and password.
Check out the latest version:
git checkout release/v0.XX(change XX to the latest version)
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
Go to the
/opt/databand_deploy directory, and run
make up-databand to start 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
Docker-compose deployment upgrades lead to downtime. Perform it with caution.
- On the Databand server machine, go to the Databand deployment directory.
- Follow "Get/Update Databand Deployment Scripts" instructions from the section above.
make upgrade-databand. The following commands will be performed under the hood:
make pullto fetch new images.
make up-migrateto perform DB migration.
make stop-databandto stop all containers.
make up-databand, to get Databand running again.
Congratulations! Databand is now successfully updated to the latest version.
Docker images are defined in the
To stop Databand, run
When Databand is successfully installed, you can access its services from your browser by using the following URL:
By default it's
- Login: databand
- Password: databand
webserveris accessible on http://localhost:8080 and points to local dir
prometheusis available at http://localhost:9090
alertmanageris available at http://localhost:9093
grafanais available at http://localhost:3000. Login/password:
Launch the monitor module in order to start syncing your Airflow data into the Databand system:
sudo docker-compose up airflow-sync-monitor
By default, a static Grafana dashboard is configured to be mounted with:
In order to use latest Grafana dashboard:
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
Updated 5 days ago
After installing Databand, perform all post-installation configuration tasks.