Edit

Getting Started docker compose

This document describes how to run StreamsDB localy with Docker Compose. It runs FoundationDB, StreamsDB, graphql api gateway and the administrative web ui.

Prerequizites

Composition

The following docker-compose.yml file defines the composition of these services that are required for StreamsDB to run, including an administrative ui.

version: '3'
services:
  # foundation db storage layer
  fdb:
    image: foundationdb/foundationdb:6.1.10
    environment:
      - FDB_COORDINATOR:fdb
  
  # initialization job for foundationdb
  init:
    image: foundationdb/foundationdb:6.1.10
    command:
      [ "/bin/bash", "-c", 
        "source /var/fdb/scripts/create_cluster_file.bash; 
         FDB_COORDINATOR=fdb create_cluster_file; 
         if [[ $$(fdbcli --exec 'configure new single ssd') == *'Database already exists'* ]];
         then true;
         else false;
         fi" ]
    environment:
      - FDB_COORDINATOR:fdb
    depends_on:
      - fdb
    restart: on-failure

  # streamsdb node
  sdb:
    image: streamsdb/sdb:master
    environment:
      FDB_COORDINATOR: fdb
      LOG: debug
    links:
      - fdb
    ports:
      - 6000:6000
    restart: unless-stopped

  # graphql api
  graphql:
    image: streamsdb/sdbgql:master
    environment:
      PORT: 3000
      SDB_HOST: sdb://sdb:6000?insecure=1&block=1
      HEALTH: "false"
      LOG: debug
    links:
      - sdb
    restart: unless-stopped

  # administration web ui
  admin:
    image: streamsdb/admin:master
    environment:
      PORT: 3000
      API: "http://graphql:3000"
    links:
      - graphql
    ports:
      - 4000:3000
    restart: unless-stopped

Start

Execute the following command to download all images and start the containers, make sure you execute this command in the same directory as the docker-compose.yml file we just created in the previous step:

docker-compose up -d

Create a database

Use sdbcli to create a new database (replace <database_name> with the name of your choice):

export SDB_HOST="sdb://localhost:6000/?insecure=1"
sdbcli create-database <database_name>

Admin

Open a browser and see the admin ui at: localhost:4000

Connect from your application

To connect from your application to the local streamsdb, use the following connection string (replace <database_name> with the name of your choice):

sdb://localhost:6000/<database_name>?insecure=1

For more information about connection strings, see connection string reference.

Discard containers and state

To stop and remove the containers including the state:

docker-compose down -v
← .NETConnection String →