Introduction

Use this guide to install the singlestoredb-toolbox and singlestoredb-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 singlestoredb-server package (which includes the SingleStore engine).

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

Note

While the /opt/singlestore 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

Warning

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 SingleStore 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

  • root password has been set on all nodes in the cluster Learn how to set root password.

  • The SingleStore cluster is managed by MemSQL Ops v7.0 or later, which can be verified via memsql-ops agent-list Learn how to upgrade.

  • SingleStore Toolbox v1.3.0 or later, which can be verified via sdb-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 (default)

Secure-Shell Access

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

Terminology

Host

host is a physical or virtual machine.

Node

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

Last modified: March 14, 2024

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined
  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined
  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
    cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
    --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
    --bundle undefined \
    --new-bundle-format -
    Verified OK