Deploying Docker Compose

You can deploy Self-Hosted Databand with Docker Compose.

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

Follow these instructions to:

Requirements

Make sure that you meet the following system and software requirements before you install Databand with Docker Compose.
System requirements
Operating system
Recent Debian/Ubuntu/CentOS/RHEL(7) Linux
CPU
Minimum 4 CPU
Memory
Minimum 16GB
Disk
80+ GB
Database
  • databand must exist on the database instance.
  • You must have access from the server to the database instance.
  • You must have credentials for the databand database on your chosen database instance.
  • You must have a PostgreSQL instance
    • Either an internal or external PostgreSQL instance
    • Must be PostgreSQL 16.x or later.
  • You must have an internal Redis 6.x instance.

Internal PostgreSQL and Redis instances exist by default in docker-compose deployments. For production, use an external PostgreSQL instance. For more information about creating databases, see Storage for Databand metadata.

Software requirements
Note: By default, Databand is installed to the /opt/databand directory. You can override this path with the environment variable DATABAND_INSTALLATION_PATH. For example, if you want to install Databand into the current directory, set the environment variable as follows. export DATABAND_INSTALLATION_PATH=.

Installing Databand from tar.gz

For ease of use, install Databand under the root user. If you can't install it as the root user, make sure that you have permission to write to the /opt directory and to run docker and docker-compose.

Important: Make sure you run the installation scripts with root privileges.
  1. Download databand-<ver>.tar.gz from IBM Passport and unarchive it with the following command: 
    tar -xvf databand-<version>.tar.gz
  2. Go to the databand-/installation directory and run the following script to set up a basic configuration and prepare to run Databand. 
    cd databand-<ver>/installation
./databand-cmd.sh setup
  3. Load Docker images from the tar archive with: 
     ./databand-cmd.sh load-images
  4. Create secret keys by using: 
     ./databand-cmd.sh create-secrets
  5. Go to the /opt/databand directory. Choose whether you want to use an external or local database, and complete the relevant step:
    • If you want to use an external PostgreSQL database: Open custom.env and replace DBND__WEBSERVER__SQL_ALCHEMY_CONN with a Postgres connection string to an external database.
    • If you want to use a local PostgreSQL database: Open custom.env and set COMPOSE_FILE=docker-compose.yml:mods/local_pg.yml Don't change DBND__WEBSERVER__SQL_ALCHEMY_CONN.
  6. From the /opt/databand directory, run the Databand start script: 
    cd /opt/databand
./databand-cmd.sh start
  7. Optional: Run ./databand-cmd.sh status to validate that all the components are up and running.
  8. Create a Databand user by running ./databand-cmd.sh create-user and then following the interactive prompt.

You can now access the Databand UI using the http://$INSTANCE_IP:8080/ URL, and log in with the user that you created in step 8. For more information about creating users through 3rd-party authentication, see Authentication providers.

Upgrading Databand using the tar.gz file

Follow these steps to upgrade Databand to a new version:

  1. Download databand-<ver>.tar.gz and unarchive it with the following command:

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

  2. Go to the databand-<ver>/installation directory and run:

    ./databand-cmd.sh-upgrade-tar

  3. Optional: Run ./databand-cmd-sh to validate that all components are up and running.

You can now access UI using the http://$INSTANCE_IP:8080/ URL.

Accessing 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>:<service_port>.

The default local URL is http://localhost:8080.

  • webserver is accessible on http://localhost:8080 and points to the local directory.
  • Prometheus is available at http://localhost:9090.

Learn more