GuidesAPI ReferenceDiscussions
GuidesBlogPlatform

Docker Compose Deployment

How to install Databand on-premise by using Docker Compose.

This page describes how to run your Databand environment using docker-compose.

This docker-compose spins up a fully-charged Databand installation with ready-to-use a monitoring stack.

This instruction provide 2 ways to install Databand:

  1. If you download tar.gz archive from IBM Passport.
  2. If you have access to Databand git and docker registry.

=====================================================

System Requirements

=====================================================

  • Operating system: Debian/Ubuntu/CentOS/RHEL7 Linux. Ubuntu 20.4 is recommended.
  • CPU: minimum 4 CPU
  • Memory: minimum 16GB
  • Disk: 80 GB+
  • DB: Postgres 12.0+
  • Database databand should exist on DB instance

=====================================================

Preparing for the Installation

=====================================================

Before installing Databand, prepare your server for the installation. Review the described system requirements and then install the required software:

  • Docker
  • Docker Compose with version 1.25.3 or above
  • rsync
  • databand database should be created on PostgreSQL instance
  • make sure you have access from server to PostgreSQL instance
  • make sure you have credentials to databand database on PostgreSQL instance

By default, Databand will install to /opt/databand directory, you can override this path with env variable DATABAND_INSTALLATION_PATH. For example, if you want to install databand into current directory, set following env variable export DATABAND_INSTALLATION_PATH=.

Also you can override default docker registry(registry.gitlab.com/databand/databand-deploy) with the following env variable: DATABAND_DOCKER_REGISTRY.

=====================================================

Download from the Databand tar.gz file from Passport Advantage and install it

=====================================================

22062206

Passport

tar -xvf databand-<version>.tar.gz

This will extract the databand-<ver> directory, which contains everything you need to run to set Databand up.

Make sure you run the installation scripts with root privileges!

=====================================================

Install and Upgrade instruction for tar.gz archive

=====================================================

Install databand from tar.gz

We recommend to install Databand under root user. If you don't have ability to install it as root user, make sure that you have permission to write to /opt directory and execute docker, docker-compose.

  1. Download databand-.tar.gz and unarchive it with the following command:
tar -xvf databand-<ver>.tar.gz
  1. Go to databand-<ver>/installation directory and run ./databand-cmd.sh setup script to make basic configuration and prepare to run Databand.
  2. Load docker images from tar archive by running the following command: ./databand-cmd.sh load-images
  3. Use the following command to create secret keys: ./databand-cmd.sh create-secrets
  4. Go to the /opt/databanddirectory. Open custom.env(vi custom.env) file and replace DBND__WEBSERVER__SQL_ALCHEMY_CONN with postgres connection string to external DB.
  5. From the /opt/databand run ./databand-cmd.sh start to start databand.
  6. Optional you can run ./databand-cmd.sh status to validate that everything is up and running.
  7. Create new Databand user by running command ./databand-cmd.sh create-user, follow interective prompt.

Now you can access UI in the http://$INSTANCE_IP:8080/ URL, and login with user created in step 8.

Upgrade databand from tar.gz

To upgrade Databand to new version follow next steps:

  1. Download databand-.tar.gz and unarchive it with following command:
tar -xvf databand-<ver>.tar.gz
  1. Go to databand-<ver>/installation directory and run ./databand-cmd.sh upgrade-tar.
  2. Optional you can run ./databand-cmd.sh status to validate that everything is up and running.

Now you can access UI in the http://$INSTANCE_IP:8080/ URL.

=====================================================

Install and Upgrade instruction with docker registry login and git access

=====================================================

Install databand with docker registry login and git access

We recommend to install Databand under root user. If you don't have ability to install it as root user, make sure that you have permission to write to /opt directory and execute docker, docker-compose.

  1. Clone databand-deploy git repository:
git clone https://gitlab.com/databand/databand-deploy.git
  • when prompted, enter your GitLab username and password.
  • go to databand-deploy directory and checkout to the right branch(provided by Databand team): git checkout release/v1.XX
  1. Login to the docker registry with provided credentials:
docker login -u <GitLab Username> -p <GitLab Access Token> registry.gitlab.com
  1. Go to databand-deploy/databand and run following command to pull docker images: ./databand-cmd.sh pull
  2. Use the following command ./databand-cmd.sh setup to make basic configuration and prepare to run Databand.
  3. Use the following command to create secret keys: ./databand-cmd.sh create-secrets
  4. Go to the /opt/databand directory. Open custom.env(vi custom.env) file and replace DBND__WEBSERVER__SQL_ALCHEMY_CONN with postgres connection string to external DB.
  5. From the /opt/databand run ./databand-cmd.sh start to start databand.
  6. Optional you can run ./databand-cmd.sh status to validate that everything is up and running.
  7. Create new Databand user by running command ./databand-cmd.sh create-user, follow interective prompt.

Now you can access UI in the http://$INSTANCE_IP:8080/ URL, and login with user created in step 8.

Upgrade databand with docker registry login and git access

To upgrade Databand to new version follow next steps:

  1. If you don't have databand-deploy directory locally and don't login to docker registry, follow 1 and 2 steps from installtion guide. If you have it, go to the databand-deploy directory, execute git pull and checkout to new version:
git checkout release/v1.XX
  1. From the databand-deploy/databand run ./databand-cmd.sh upgrade-pull.
  2. Optional you can run ./databand-cmd.sh status to validate that everything is up and running.

Now you can access UI in the http://$INSTANCE_IP:8080/ URL.

=====================================================

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

Databand doesn't create user and password. You should create it during installation.

User creation

Databand doesn't create any users during installation. You can create user by running script ./databand create-user or connect Databand to 3rd party Auth providers. Currently we support 3 party Auth providers:

  • Okta
  • Gitlab
  • Github

If you want to use 3rd Auth provider, copy configurations from .env(# Auth settings section) file to /opt/databand/custom.env and restart Databand with ./databand-cmd.sh:

# Auth settings
DBND__AB_AUTH__EXTERNAL_JWT_PUBLIC_KEY=
# DBND__AB_AUTH__OAUTH2_PROVIDERS='["okta","gitlab"]'
# When you provide oAuth provider, [] should be in '' - '["okta"]'
# Without oAuth provider it should be without '' - []
DBND__AB_AUTH__OAUTH2_PROVIDERS=[]

## Okta
DBND__AB_AUTH__OKTA_KEY=
DBND__AB_AUTH__OKTA_SECRET=
DBND__AB_AUTH__OKTA_BASE_URL=

## Gitbub
DBND__AB_AUTH__GITHUB_KEY=
DBND__AB_AUTH__GITHUB_SECRET=

# Gitlab
DBND__AB_AUTH__GITLAB_KEY=
DBND__AB_AUTH__GITLAB_SECRET=

What’s Next

After installing Databand, perform all post-installation configuration tasks.