GuidesAPI ReferenceDiscussions
GuidesBlogPlatform

IBM Data Observability Stand Alone Deployment

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

This page describes how to install your Databand environment using Docker-compose.

This docker-compose spins up a fully-charged Databand installation.

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])

System Requirements

  • Operating system: Ubuntu 20.04
  • CPU: 4 CPU
  • Memory: 16GB
  • Disk: 80GB

Prerequisites

Database:

  • PostgreSQL
  • Version: 12
  • Databand DB created on PostgreSQL instance

Docker installation

Docker-compose installation

  • Version: 1.25.3
  • Note: You must install this version of docker-compose, instead of using the version that was installed along with docker in the previous step. Using that version of docker-compose would not function as needed, and you would not be able to run Databand.
  • This version of docker-compose can be installed by running the following commands:
    • sudo curl -L https://github.com/docker/compose/releases/download/1.25.3/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
    • sudo chmod +x /usr/local/bin/docker-compose

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

11361136

Passport Advantage

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!

cd databand-<ver>/installation

./databand-cmd.sh setup

Now, a new directory has been created which contains the configuration files you need to run your very own, fully-fledged, Databand application:

cd /opt/databand

Configuring and running Databand

After installing Databand, you can now start configuring it to your will, by editing the custom.env file.

For this initial installation, it is most important the change DBND__WEBSERVER__SQL_ALCHEMY_CONN inside of custom.env. To do this, start editing the file, and change DBND__WEBSERVER__SQL_ALCHEMY_CONN from its default value to the appropriate value, according to your database connection details and the following template:

vim custom.env

DBND__WEBSERVER__SQL_ALCHEMY_CONN=dialect+driver://username:[email protected]:port/database

Please refrain from directly changing the .env file located inside /opt/databand, and instead make all your changes inside custom.env

Continue changing and configuration options as you like, and when you are ready to start Databand’s application, proceed to the next step.

Using Databand

./databand-cmd.sh start

This will run Databand in detached mode so that it won’t close down when you close your terminal or otherwise end the connection to the server. You can also validate that Databand is up and running by executing:

./databand-cmd.sh validate

Now that Databand is running, you can create a Databand user, which you will be able to use to log in to the system:

./databand-cmd.sh create-user

Due to the aforementioned start script running Databand in detached mode, closing the shell won’t stop Databand. To do that, you must run the command:

./databand-cmd.sh stop

Upgrade Databand Service

To upgrade to a newer version of Databand, download it from Passport Advantage.

Now that you have the brand new version of Databand downloaded to your machine, go ahead and unarchive it with the following command:

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

Next, go to the newly created databand-<ver>/installation, and run:

./databand-cmd.sh upgrade

Now the newest version of Databand should be installed, and you can start Databand normally.

After upgrading Databand to a newer version and starting it from the terminal, it is highly recommended to validate that everything is working as expected, by running

./databand-cmd.sh validate

Access Databand Service

After Databand is successfully started, you can access its services from your browser by using the following URL: HTTP://<server_where_databand_is_installed>:<service port>

These are the default ports that Databand uses:

External ports

In case your system is behind a NAT, the following ingress ports should be opened:

  • TCP 8080
    • To allow UI Access
    • To allow data tracking
  • TCP 9090
    • Prometheus Access
  • TCP 3000
    • Grafana Access

Did this page help you?