Introduction min read


Use this guide to install the singlestoredb-toolbox and memsql-server packages and migrate from MemSQL Ops to the SingleStore management tools for cluster management. The migration tool automates most of the migration process.

SingleStore Tools allow you to perform cluster management operations for setup, configuration, and diagnostics. Operations are done through CLI commands which can be easily scripted for use in a variety of deployment environments and scenarios.

Most of the tools are part of the singlestoredb-toolbox package. However, the lower-level management tool, memsqlctl, is part of the memsql-server package (which includes the SingleStore DB engine).

Along with these packages, SingleStore also offers a client application through the singlestore-client package to connect to your cluster and run queries.

Info

While the /home/<user>/memsql directory is used through this guide to hold the necessary migration files and demonstrate the associated migration commands, this directory can be substituted with any directory that a non-sudo user has access to.

Prerequisites

Alert

This guide assumes that your cluster is running MemSQL v7.0 or later, which can be verified via memsql-ops memsql-list.

If your cluster is running an earlier version of MemSQL, it will be upgraded to MemSQL v7.0 as part of this migration.

In addition, this guide assumes:

  • The cluster components were installed via tarball
  • The user that created the cluster does not have sudo privileges
  • The user performing the migration does not have sudo privileges
  • A root password has been set on all nodes in the cluster (Learn how to set root password)
  • The cluster is managed by MemSQL Ops v7.0 or later, which can be verified via memsql-ops agent-list (Learn how to upgrade)
  • Toolbox v1.3.0 or later, which can be verified via sdb-toolbox-config version and memsql-toolbox-config version (Learn how to upgrade)

Ports

Ensure that the following ports are open for use:

Port Type For
22 Inbound/Outbound SSH / SFTP
80 Inbound/Outbound MemSQL Ops
443 Inbound/Outbound SingleStore repository connection
3306 Inbound/Outbound SingleStore DB (default)

Secure-Shell Access

The installing user must be able to log into each host via ssh.

Terminology

Host

A host is a physical or virtual machine.

Node

In SingleStore DB parlance, a node is a SingleStore DB database component of type aggregator or leaf.