SingleStore DB

Deploy SingleStore DB


The user that deploys SingleStore DB via the UI must also be able to SSH into each host in the cluster without using a password.

As of SingleStore DB Toolbox 1.6, SingleStore DB can be deployed via browser-based UI. This option describes how to deploy SingleStore DB using this UI. Please review the SingleStore DB Prerequisites prior to deploying SingleStore DB.

In order to use the UI, the user (and the user account that will deploy SingleStore DB) must:

  • Be able to install SingleStore DB and SingleStore DB Toolbox 1.6 using RPM or Debian packages, or via tarball.

  • Deploy a standard SingleStore DB configuration. Advanced options, such as those available with a cluster deployment via a YAML file, are also available in the UI.

Start the UI

Run the following command to start the UI.

Package-based Deployments

  1. Run the following on the command line.

    sdb-deploy ui

Tarball-based Deployments

  1. Change to the directory where the SingleStore DB Toolbox was uncompressed.

  2. Run the following command.

    ./sdb-deploy ui

This command will display a link with a secure token that you can use to deploy SingleStore DB via the UI.

For additional options that can be used with sdb-deploy ui, refer to the associated reference page.

Access the UI

Copy and paste this link into a Chrome or Firefox browser to access the UI.

Note: You may need to modify the URL by changing localhost to a hostname or IP address depending on how and where you installed SingleStore Tools. The hostname or IP address must be that of the main deployment host, which is typically the Master Aggregator.

Select a Deployment Method

Select the deployment method that best fits your requirements.

Deploy a Cluster Using the UI

Follow installation instructions in the UI to deploy SingleStore DB.

For offline deployments, provide the location of the singlestoredb-server file on the main deployment host when prompted.

Create a YAML File Using the UI and Deploy a Cluster

In lieu of deploying a cluster immediately, a cluster can be configured using the UI and the configuration saved to a YAML file. The YAML file can then be used to deploy a cluster by copying the YAML file to the Master Aggregator and running one of the following:

For sudo deployments, run the following command.

sdb-deploy setup-cluster --cluster-file </path/to/cluster-file>

For non-sudo (tarball-based) deployments, run the following command from the directory in which the singlestoredb-toolbox tarball file was uncompressed.

./sdb-deploy setup-cluster --cluster-file </path/to/cluster-file>


You may use the UI to create a "base" cluster configuration YAML file that can be saved and further customized prior to deploying a cluster, or create a YAML file by hand. Refer to Deploy SingleStore DB Using a YAML File for the YAML file format and example cluster configuration files.

  • Message: unknown command "ui" for "sdb-deploy"

    Solution: Confirm that SingleStore DB Toolbox v1.6 or later has been installed on the main deployment host.

  • Message: sdb-deploy ui is not currently supported by SingleStore DB.

    Solution: The installed version of SingleStore DB Toolbox does not support deploying SingleStore DB via the UI. Please select another deployment option.

  • Message: Registered hosts detected. SingleStore DB Toolbox supports managing only one cluster per instance. To view them, run 'sdb-toolbox-config list-hosts'. To remove them, run 'sdb-toolbox-config unregister-host'

    Solution: SingleStore DB Toolbox can only manage a single instance of SingleStore DB.