Skip to main content

Quick Start

This Quick Start guide provides the essential steps to deploy the Business Intelligence platform using an existing Grafana LGTM (Loki, Grafana, Tempo, Mimir) stack and production data.

Quick Start Overview
Quick Start Overview
Grafana 11

The Business Engine requires Grafana 11 and maintains compatibility with the latest Grafana version.

Docker Compose Configuration​

Configure a docker-compose.yml file with the following containers:

  • Timescale: Manages Business Engine configuration data (use an existing Timescale database or Timescale Cloud if available)
  • Business Engine: Connects to Grafana via a service account token, leveraging HTTP APIs to fetch configurations, evaluate alert rules, and execute actions
services:
  timescale:
    image: timescale/timescaledb:latest-pg14
    restart: always
    environment:
      POSTGRES_PASSWORD: postgres
    ports:
      - 5432:5432

  engine:
    depends_on:
      - timescale
    image: ghcr.io/volkovlabs/business-engine:3.3.0
    # env_file: .env  # Uncomment to use an external .env file
    environment:
      DATABASE_HOST: timescale
      DATABASE_PORT: 5432
      DATABASE_DB: postgres
      DATABASE_USERNAME: postgres
      DATABASE_PASSWORD: postgres
      # GRAFANA_URL: https://MY-ACCOUNT.grafana.net  # Replace with your Grafana URL
      # GRAFANA_TOKEN: SERVICE-ACCOUNT-TOKEN  # Replace with your service account token
    ports:
      - 3001:3001 # Business Engine API
      - 3002:3002 # Business Engine Scheduler

Starting the Platform​

Follow these steps to launch the platform:

  1. Log in to your Grafana instance (Cloud, OSS, or Enterprise)
  2. Create a service account with Viewer or Editor permissions
  3. (Optional) Update GRAFANA_URL and GRAFANA_TOKEN in docker-compose.yml:
    Update GRAFANA_URL and GRAFANA_TOKEN in docker-compose.yml
    Update GRAFANA_URL and GRAFANA_TOKEN in docker-compose.yml
  4. Start the Business Engine and Timescale containers: 
    docker compose up -d
  5. Download Business Studio from the Release Notes, then install and launch it
  6. In Business Studio, add the Business Engine to configure your Grafana instance, actions, and alert rules:
    Alert Rules Configured via Business Studio
    Alert Rules Configured via Business Studio

Stopping the Platform​

To stop and remove all containers:

docker compose down