Run the Container min read


The SingleStore DB cluster-in-a-box image contains two nodes: A master aggregator node that runs SQL queries and aggregates the results, and a single leaf node, which is responsible for storing and processing data. These two nodes form the most basic cluster.

Start the Container

  1. Export your license key into an environment variable named LICENSE_KEY. If your license key is not shown in the code block below, you can copy it from the SingleStore Customer Portal.

    Linux/macOS

    export LICENSE_KEY=[YOUR LICENSE KEY]
    
    export ROOT_PASSWORD=[YOUR ROOT PASSWORD]
    

    Windows

    $env:LICENSE_KEY = "[YOUR LICENSE KEY]"
    
    $env:ROOT_PASSWORD = "[YOUR ROOT PASSWORD]"
    
  2. Initialize the cluster using docker run. Note: If you want to preserve data across an upgrade of the Docker container, put -v singlestore-ciab-data:/var/lib/memsql before singlestore/cluster-in-a-box in the command below.

    Linux/macOS

    docker run -i --init \
        --name singlestore-ciab \
        -e LICENSE_KEY=$LICENSE_KEY \
        -e ROOT_PASSWORD=$ROOT_PASSWORD \
        -p 3306:3306 -p 8080:8080 \
        singlestore/cluster-in-a-box
    

    Windows

    docker run -i --init `
        --name singlestore-ciab `
        -e LICENSE_KEY=$env:LICENSE_KEY `
        -e ROOT_PASSWORD=$env:ROOT_PASSWORD `
        -p 3306:3306 -p 8080:8080 `
        singlestore/cluster-in-a-box
    

    If initialization fails, you will need to remove the container before retrying.

    docker rm singlestore-ciab
    
  3. Start the container.

    docker start singlestore-ciab
    

Now that you have SingleStore DB up and running, learn how to connect to your cluster in the next step.