SingleStoreDB Toolbox Installation
Install SingleStoreDB Toolbox
Select a distribution type or method of installation from the options below.
Online Installation
For online installations where you can access the SingleStore YUM repository, run the following steps.
Note: These steps are also provided in the self-managed deployment guides.
Add the SingleStore repository to your repository list.
sudo yum-config-manager --add-repo https://release.memsql.com/production/rpm/x86_64/repodata/memsql.repo
Verify that the SingleStore repo information is listed under
repolist.sudo yum repolist
Verify you have the
whichpackage installed. This is used during the install process to identify the correct package type for your installation.rpm -q which
If
whichis not installed, you must install it before proceeding. If you cannot installwhich, you will have to specify the correct package during the deployment phase covered in the respective deployment guide.sudo yum install -y which
To install Toolbox, run the following:
sudo yum install -y singlestoredb-toolbox
Offline Installation
For clusters that must be deployed in an environment without Internet access, download the following SingleStore packages onto a device with access to the main deployment machine.
For offline installations, you only need to copy and install singlestoredb-toolbox onto the main deployment machine as the sdb-deploy tool in singlestoredb-toolbox will be used to install the singlestoredb-server package onto each host in your cluster.
sudo rpm -ivh /tmp/singlestoredb-toolbox-<version>.x86_64.rpm
Online Installation
For online installations where you can access the SingleStore APT repository, run the following steps.
Note: These steps are also provided in the self-managed deployment guides.
SingleStore packages are signed to ensure integrity, so the GPG key needs to be added to this machine. When done, verify that the SingleStore signing key has been added using
apt-key list.wget -O - 'https://release.memsql.com/release-aug2018.gpg' 2>/dev/null | sudo apt-key add - && apt-key list
Verify you have
apt-transport-httpsinstalled.apt-cache policy apt-transport-https
If
apt-transport-httpsis not installed, you must install it before proceeding.user-shell sudo apt -y install apt-transport-httpsAdd the SingleStore repository to retrieve its packages.
echo "deb [arch=amd64] https://release.memsql.com/production/debian memsql main" | sudo tee /etc/apt/sources.list.d/memsql.list
To install Toolbox, run the following:
sudo apt update && sudo apt -y install singlestoredb-toolbox
Offline Installation
For clusters that must be deployed in an environment without Internet access, download the following SingleStore packages onto a device with access to the main deployment machine.
sudo dpkg -i /tmp/singlestoredb-toolbox_<version>_amd64.deb
Download SingleStoreDB Files
Download the following SingleStore tarball files onto a device with access to the main deployment host.
Transfer SingleStoreDB Files
Transfer the singlestoredb-toolbox and singlestoredb-server tarball files into a dedicated singlestore directory that has been configured so that non-sudo users can access on the main deployment host, such as /home/<user>/singlestore or /opt/singlestore.
Unpack SingleStoreDB Files
Note: For the remainder of this document, <version>-<commit-hash> will be written simply as <version>.
Unpack singlestoredb-toolbox into the singlestore directory.
tar xzvf singlestoredb-toolbox-<version>.tar.gz
You do not need to unpack the singlestoredb-server file in this step. It will be installed as part of deployment, which is shown in the next step.
Upgrade SingleStoreDB Toolbox
Important
Note that upgrading SingleStoreDB Toolbox does not automatically upgrade the database engine. To upgrade the database engine, see Upgrade SingleStoreDB.
To upgrade the database engine to version 8.1, see Upgrade to SingleStoreDB 8.1
To upgrade the tools in the singlestoredb-toolbox package, follow the same basic steps that you would perform to update any RPM package.
Important
The singlestoredb-server package should be updated through the sdb-deploy upgrade command. This command will install, update, and then restart nodes in your cluster (or rollback the installation process, if necessary).
Online
sudo yum update -y singlestoredb-toolbox
Offline
sudo rpm -Uvh /tmp/singlestoredb-toolbox-<version>.x86_64.rpm
To upgrade the tools in the singlestoredb-toolbox package, follow the same basic steps that you would perform to update any Debian package.
Important
The singlestoredb-server package should be updated through the sdb-deploy upgrade command. This command will install, update, and then restart nodes in your cluster (or rollback the installation process, if necessary).
Online
sudo apt update && sudo apt install -y singlestoredb-toolbox
Offline
sudo dpkg -i /tmp/singlestoredb-toolbox_<version>_amd64.deb
To upgrade the SingleStoreDB Toolbox tarball, you need to replace the currently installed SingleStoreDB Toolbox binaries with new binaries. Using symbolic links is one way to achieve this action and the instructions are as follows.
Navigate to the directory that contains the unpacked SingleStoreDB Toolbox tarball and create a symbolic link pointing to the SingleStoreDB Toolbox currently installed. Name this symlink
singlestoredb-toolbox.ln -s singlestoredb-toolbox-<version>-<commit-hash> singlestoredb-toolbox
Run
ls -lto verify that the symlink is created.Obtain the latest version of
singlestoredb-toolboxusing the following command.curl https://release.memsql.com/production/index/memsqltoolbox/latest.json
The JSON you receive contains a relative path to the
memsql-toolbox-tarfile in the following format."Path": "production/tar/x86_64/singlestoredb-toolbox-<version>-<commit-hash>.x86_64.tar.gz"
Use
wgetto download the file by copying, pasting, and appending the path (minus the quotes) to https://release.memsql.com/. Example is shown below.wget https://release.memsql.com/production/tar/x86_64/singlestoredb-toolbox-<version>-<commit-hash>.x86_64.tar.gz
As an alternative to steps 2 and 3, you can download the latest version of SingleStoreDB Toolbox tarball file using the following link.
Transfer the tarball file to the main deployment host where the earlier version of the SingleStore DBToolbox is available.
Unpack the SingleStoreDB Toolbox file by running the following command.
tar xzvf singlestoredb-toolbox-<version>-<commit-hash>.tar.gz
Now the directory contains both versions of SingleStoreDB Toolbox.
Remove the
singlestoredb-toolboxsymlink by running the following command.rm singlestoredb-toolbox
Recreate the symlink by pointing it to the new version of SingleStoreDB Toolbox downloaded and unpacked in steps 2 and 4.
ln -s singlestoredb-toolbox-<version>-<commit-hash>/ singlestoredb-toolbox
The upgrade is complete and you can verify the cluster status by running the commands in the new SingleStoreDB Toolbox directory. If you encounter any issues and need to downgrade, you can simply point the symlink back to the old version for SingleStoreDB Toolbox.
After successful validation, you can remove the old version of SingleStoreDB Toolbox by running the following command.
rm -rf singlestoredb-toolbox-<version>-<commit-hash>
Note
Using symbolic links is optional in the SingleStoreDB Toolbox tarball upgrade. To perform the upgrade, you need to replace the old SingleStoreDB Toolbox binaries with new binaries with or without symbolic links.
As an alternative to using symbolic links for the upgrade, you can update the PATH environment variable with the path to the folder where the new version of SingleStoreDB Toolbox tarball is unpacked, as shown below.
export PATH=<Folder-with-new-binaries>/singlestoredb-toolbox-<version>-<commit-hash>/:$PATH
Uninstall SingleStoreDB Toolbox
You can either uninstall Toolbox as a standalone task or remove it while uninstalling SingleStoreDB. If you want to completely uninstall SingleStoreDB and its related tools packages, first uninstall SingleStoreDB from your nodes by using the sdb-deploy uninstall command. This will remove the singlestoredb-server package for that version of SingleStoreDB (all versions of SingleStoreDB can be uninstalled using the --all-versions flag).
Important
The remove command and -e flag will only remove the binaries in the package and not remove any configuration files.
As part of the removal process, or to simply remove Toolbox, perform the following operation:
Online
sudo yum remove singlestoredb-toolbox
Offline
sudo rpm -e singlestoredb-toolbox
You can either uninstall Toolbox as a standalone task or remove it while uninstalling SingleStoreDB. If you want to completely uninstall SingleStoreDB and its related tools packages, first uninstall SingleStoreDB from your nodes by using the sdb-deploy uninstall command. This will remove the singlestoredb-server package for that version of SingleStoreDB (all versions of SingleStoreDB can be uninstalled using the --all-versions flag).
As part of the removal process, or to simply remove Toolbox, perform the following operation:
Important
The purge command and -P flag will remove the binaries in the package as well as any configuration files. If you want to keep the configuration files, use the remove command or -r flag instead.
Online
sudo apt purge singlestoredb-toolbox
Offline
sudo dpkg -P /tmp/singlestoredb-toolbox_<version>_amd64.deb