Warning This repository is deprecated in favor of the internal build system, more details here
This repository contains our official deployment Docker images for various products.
If you are interested in contributing, please read CONTRIBUTING.md
.
Image | SingleStore Packages Installed |
---|---|
ciab | singlestoredb-server, singlestoredb-studio, singlestoredb-toolbox |
tools | singlestoredb-toolbox |
Warning The "Cluster in a Box" Docker image is deprecated in favor of the new SingleStoreDB Dev Image which you can find here: https://github.com/singlestore-labs/singlestoredb-dev-image
To initialize a new cluster in a box:
docker run -i --init \
--name singlestore-ciab \
-e ROOT_PASSWORD=${ROOT_PASSWORD} \
-p 3306:3306 -p 8080:8080 \
singlestore/cluster-in-a-box
If you want to specify a license key, you can run:
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
To manage your cluster in a box:
To start the container:
docker start singlestore-ciab
To read logs from the container:
docker logs singlestore-ciab
To stop the container (must be started):
docker stop singlestore-ciab
To restart the container (must be started):
docker restart singlestore-ciab
To remove the container (all data will be deleted):
docker rm singlestore-ciab
If you want to automatically run SQL commands when creating a Cluster in a Box container, you can mount a SQL file into the Docker container like so:
docker run -i --init \
--name singlestore-ciab \
-e ROOT_PASSWORD=${ROOT_PASSWORD} \
-v /PATH/TO/INIT.SQL:/init.sql \
-p 3306:3306 -p 8080:8080 \
singlestore/cluster-in-a-box
Replace /PATH/TO/INIT.SQL
with a valid path on your machine to the SQL file
you want to run when initializing Cluster in a Box.
The HTTP API and External Functions features can be enabled when you create the container via passing environment variables.
HTTP API:
Add the following flags to your docker run
command:
-e HTTP_API=ON -p 9000:9000
By default, the HTTP API runs on port 9000. If you want to use a different port you can instead run:
-e HTTP_API=ON -e HTTP_API_PORT=$PORT -p $PORT:$PORT
External Functions:
Add the following flag to your docker run
command:
-e EXTERNAL_FUNCTIONS=ON