# CLI Deployment - Tarball ## Introduction Installing SingleStore on either bare metal or virtual machines can be done through the use of popular configuration management tools or through SingleStore’s management tools. In this guide, you will deploy a SingleStore cluster onto physical or virtual machines and connect to the cluster using a SQL client. A four-node cluster is the minimal recommended cluster size for showcasing SingleStore as a distributed database with high availability; however, you can use the procedures in this tutorial to scale out to additional nodes for increased performance over large data sets or to handle higher concurrency loads. To learn more about SingleStore’s design principles and topology concepts, see [Distributed Architecture](https://docs.singlestore.com/db/v9.1/introduction/distributed-architecture.md). > **📝 Note**: For supported deployments on AWS, Azure, or GCP, please use [SingleStore Helios](https://www.singlestore.com/pricing/). ## Prerequisites For this tutorial you will need: * One (for single-host cluster-in-a-box for development) or four physical or virtual machines (“hosts”) with the following: * The number of vCPUs, the amount of RAM, and the size of the persistent cache will vary based on the license version used to deploy SingleStore. Refer to [What are license units and how do they apply to my cluster?](https://docs.singlestore.com/db/v9.1/introduction/faqs/general.md) for more information. * Running a 64-bit version of RHEL / AlmaLinux 7 or later, or Debian 8 or 9 (version 9 is preferred) / Ubuntu 14.04 and later, with kernel 3.10 or later For SingleStore 8.1 or later, `glibc` 2.17 or later is also required. * Port 3306 open on all hosts for intra-cluster communication. Based on the deployment method, this default can be changed either from the command line or via cluster file. * Port 8080 open on the main deployment host for the cluster * A non-root user with sudo privileges available on all hosts in the cluster that be used to run SingleStore services and own the corresponding runtime state * SSH access to all hosts * Installing and using `ssh-agent` is recommended for SSH keys with passwords. Refer to [ssh-agent and ssh-add](https://cylab.be/blog/230/ssh-agent-and-ssh-add) and [Use ssh-agent to Manage Private Keys](https://www.linode.com/docs/guides/using-ssh-agent/) for more information. * If your environment does not support the use of `ssh-agent` , make sure the identity key used on the main deployment host can be used to log in to each host in the cluster. Refer to [How to Setup Passwordless SSH Login](https://linuxize.com/post/how-to-setup-passwordless-ssh-login/) for more information. * A connection to the Internet to download required packages If running this in a production environment, it is highly recommended that you follow our [host configuration recommendations](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/cluster-configuration/system-requirements-and-recommendations.md) for optimal cluster performance. ## Duplicate Hosts As of **SingleStore Toolbox 1.4.4**, a check for duplicate hosts is performed before SingleStore is deployed, and will display a message similar to the following if more than one host has the same SSH host key: ``` ✘ Host check failed.host 172.26.212.166 has the same ssh host keys as 172.16.212.165, toolbox doesn't support registering the same host twice ``` Confirm that all specified hosts are indeed different and aren’t using identical SSH host keys. Identical host keys can be present if you have instantiated your host instances from images (AMIs, snapshots, etc.) that contain existing host keys. When a host is cloned, the host key (typically stored in `/etc/ssh/ssh_host__key`) will also be cloned. As each cloned host will have the same host key, an SSH client cannot verify that it is connecting to the intended host. The script that deploys SingleStore will interpret a duplicate host key as an attempt to deploy to the same host twice, and the deployment will fail. The following steps demonstrate a potential remedy for the “duplicate hosts” message. Please note these steps may slightly differ depending on your Linux distribution and configuration. ```shell sudo root ls -al /etc/ssh/ rm /etc/ssh/ ssh-keygen -f /etc/ssh/ -N '' -t rsa1 ssh-keygen -f /etc/ssh/ -N '' -t rsa ssh-keygen -f /etc/ssh/ -N '' -t dsa ``` For more information about SSH host keys, including the equivalent steps for Ubuntu-based systems, refer to [Avoid Duplicating SSH Host Keys](https://blog.digitalocean.com/avoid-duplicate-ssh-host-keys/). As of **SingleStore Toolbox 1.5.3**, `sdb-deploy setup-cluster` supports an `--allow-duplicate-host-fingerprints` option that can be used to ignore duplicate SSH host keys. ## Network Configuration Depending on the host and its function in deployment, some or all of the following port settings should be enabled on hosts in your cluster. These routing and firewall settings must be configured to: * Allow database clients (e.g. your application) to connect to the SingleStore aggregators * Allow all nodes in the cluster to talk to each other over the SingleStore protocol (3306) * Allow you to connect to management and monitoring tools | Protocol | Default Port | Direction | Description | | -------- | ------------ | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | TCP | 22 | Inbound and Outbound | For host access. Required between nodes inSingleStoretool deployment scenarios. Also useful for remote administration and troubleshooting on the main deployment host. | | TCP | 443 | Outbound | To get public repo key for package verification. Required for nodes downloading SingleStore APT or YUM packages. | | TCP | 3306 | Inbound and Outbound | Default port used bySingleStore. Required on all nodes for intra-clustercommunication. Also required on aggregators for client connections. | The service port values are configurable if the default values cannot be used in your deployment environment. For more information on how to change them, see: * The cluster file template provided in this guide * The [SingleStore configuration file](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/engine-variables/memsql-cnf.md) * The [sdb-toolbox-config register-host](https://docs.singlestore.com/db/v9.1/reference/singlestore-tools-reference/sdb-toolbox-config-commands/register-host.md) command We also highly recommend configuring your firewall to prevent other hosts on the Internet from connecting to SingleStore. ## Install SingleStore Tools The first step in deploying your cluster is to download and install the SingleStore Tools on one of the hosts in your cluster. This host will be designated as the main deployment host for deploying SingleStore across your other hosts and setting up your cluster. These tools perform all major cluster operations including downloading the latest version of SingleStore onto your hosts, assigning and configuring nodes in your cluster, and other management operations. For the purpose of this guide, the main deployment host is the same as the designated Master Aggregator of the SingleStore cluster. ## Installation - Tarball ## Download SingleStore Files Download the `singlestoredb-toolbox`, `singlestore-client`, and `singlestoredb-server` files onto the main deployment host, or onto a device with access to the main deployment host. To display the latest production release of each file, use the following: ```shell curl https://release.memsql.com/production/index//latest.json ``` To display the latest release candidate of the `singlestoredb-server` file, use the following: ```shell curl https://release.memsql.com/rc/index/singlestoredbserver/latest.json ``` Replace `` with `memsqltoolbox`, `memsqlclient`, and `singlestoredbserver` to download the list of available file types. * To display the latest patch release of a major version, substitute the [desired major version](https://docs.singlestore.com/db/v9.1/release-notes.md) for `latest`. For example: `curl https://release.memsql.com/rc/index/singlestoredbserver/9.1.json` * To display a specific patch release of a major version, substitute the [desired patch release](https://docs.singlestore.com/db/v9.1/release-notes.md) for `latest`. For example: `curl https://release.memsql.com/rc/index/singlestoredbserver/9.1.1.json` The JSON you receive contains relative file paths in the following format: ``` "Path": "/tar/x86_64/--.x86_64.tar.gz" ``` Use `wget` or `curl` to download the file by copying, pasting, and appending the path (minus the quotes) to `https://release.memsql.com/`. For example: Production releases: ```shell wget https://release.memsql.com/production/tar/x86_64/--.x86_64.tar.gz ``` ```shell curl -O https://release.memsql.com/production/tar/x86_64/--.x86_64.tar.gz ``` Release candidates: ```shell wget https://release.memsql.com/rc/tar/x86_64/--.x86_64.tar.gz ``` ```shell curl -O https://release.memsql.com/rc/tar/x86_64/--.x86_64.tar.gz ``` **Alternatively**, download the following SingleStore tarball files onto a device with access to the main deployment host. | | | | | - | - | - | ## Transfer SingleStore Files Transfer the `singlestoredb-toolbox`, `singlestore-client`, 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 `/opt/singlestore`. ## Unpack SingleStore Files **Note**: For the remainder of this document, `-` will be written simply as ``. Unpack `singlestoredb-toolbox` and `singlestore-client` into the `singlestore` directory. ```shell tar xzvf singlestoredb-toolbox-.tar.gz && \ tar xzvf singlestore-client-.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. ## Deploy SingleStore ## Prerequisites > **⚠️ Warning**: Before deploying a SingleStore cluster in a production environment, please review and follow the [host configuration recommendations](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/cluster-configuration/system-requirements-and-recommendations.md). Failing to follow these recommendations will result in sub-optimal cluster performance.In addition, SingleStore recommends that each Master Aggregator and child aggregator reside on its own host when deploying SingleStore in a production environment. ## Notes on Users and Groups The user that deploys SingleStore via SingleStore Toolbox must be able to SSH to each host in the cluster. When `singlestoredb-server` is installed via an RPM or Debian package when deploying SingleStore, a `memsql` user and group are also created on each host in the cluster. This `memsql` user does not have a shell, and attempting to log in or SSH as this user will fail. The user that deploys SingleStore is added to the `memsql` group. This group allows most Toolbox commands to run without `sudo` privileges, and members of this group can perform many Toolbox operations without the need to escalate to `sudo`. Users who desire to run SingleStore Toolbox commands must be added to the `memsql` group on each host in the cluster. They must also be able to SSH to each host. Manually creating a `memsql` user and group is only recommended in a `sudo`-less environment when performing a tarball-based deployment of SingleStore. In order to run SingleStore Toolbox commands against a cluster, this manually-created `memsql` user must be configured so that it can SSH to each host in the cluster. ## Minimal Deployment SingleStore has been designed to be deployed with at least two nodes: * A Master Aggregator node that runs SQL queries and aggregates the results, and * A single leaf node, which is responsible for storing and processing data These two nodes can be deployed on a single host (via the `cluster-in-box` option), or on two hosts, with one SingleStore node on each host. While additional aggregators and nodes can be added and removed as required, a minimal deployment of SingleStore always consists of at least these two nodes. ## CLI Deployment - Tarball While the `/opt/singlestore` directory is used through this guide to hold the necessary deployment files and demonstrate the associated deployment commands, this directory can be substituted with any directory that a non-`sudo` user has access to. Run the following commands on the Master Aggregator host from the `singlestore` directory. 1. Change to the `singlestoredb-toolbox-` directory. ```shell cd singlestoredb-toolbox- ``` 2. Deploy SingleStore. The following command deploys a 4-node SingleStore cluster with a Master Aggregator node, a Child Aggregator node, and two leaf nodes. ```shell ./sdb-deploy setup-cluster -i \ --license \ --master-host \ --aggregator-hosts \ --leaf-hosts , \ --password \ --file-path "/path/to/singlestoredb-server--.x86_64.tar.gz" ``` **Note**: Creating a node with an empty root password may be convenient for testing purposes. While this is not recommended, you can specify a blank password via: `--password ""`. 3. Analyze your current cluster configuration using the `sdb-admin optimize` command. This command checks your current cluster configuration against a set of best practices and either makes changes to maximize performance or provides recommendations for you. For hosts with NUMA support, this command will bind the leaf nodes to specific NUMA nodes. ```shell ./sdb-admin optimize ``` ## Create the memsql.service File By creating the following `memsql.service` file and enabling the `memsql` service, all nodes on a host will be restarted after the host is rebooted. Performing the following steps on each host in the cluster. 1. Create a `memsql.service` file in the `/etc/systemd/system` directory. ```shell sudo vi /etc/systemd/system/memsql.service ``` 2. Using the following example, replace the directory in the `ExecStart` and `ExecStop` lines with the directory in which the `memsqlctl` file resides on the host. In this example, the directory is `/opt/singlestore/singlestoredb-server`. ``` [Unit] Description=SingleStore After=network.target [Service] Type=oneshot RemainAfterExit=yes ExecStart=/opt/singlestore/singlestoredb-server/memsqlctl start-node --yes --all ExecStop=/opt/singlestore/singlestoredb-server/memsqlctl stop-node --yes --all Slice=system-memsql.slice TasksMax = 128000 LimitNICE=-10 LimitNOFILE=1024000 LimitNPROC=128000 [Install] WantedBy=multi-user.target ``` 3. Ensure that this file is owned by `root`. ```shell sudo chown root:root /etc/systemd/system/memsql.service ``` 4. Set the requisite file permissions. ```shell sudo chmod 644 /etc/systemd/system/memsql.service ``` 5. Enable the `memsql` service to start all of the nodes on the host after the host is rebooted. ```shell sudo systemctl enable memsql.service ``` ```output Created symlink from /etc/systemd/system/multi-user.target.wants/memsql.service to /etc/systemd/system/memsql.service. ``` ## Additional Deployment Options > **📝 Note**: If this deployment method is not ideal for your target environment, you can choose one that fits your requirements from the [Deployment Options](https://docs.singlestore.com/db/v9.1/deploy.md). ## Connect to Your Cluster The `singlestore-client` package contains is a lightweight client application that allows you to run SQL queries against your database from a terminal window. After you have installed `singlestore-client`, use the `singlestore` application as you would use the `mysql` client to access your database. For more connection options, help is available through `singlestore --help`. ```shell singlestore -h -P -u -p ``` ```output Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 12 Server version: 5.7.32 SingleStoreDB source distribution (compatible; MySQL Enterprise & MySQL Commercial) Copyright (c) 2000, 2022, Oracle and/or its affiliates. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. singlestore> ``` Refer to [Connect to SingleStore](https://docs.singlestore.com/db/v9.1/connect-to-singlestore.md) for additional options for connecting to SingleStore. ## Next Steps After Deployment Now that you have installed SingleStore, check out the following resources to learn more about SingleStore: * [Optimizing Table Data Structures](https://docs.singlestore.com/db/v9.1/create-a-database/optimizing-table-data-structures.md): Learn the difference between rowstore and columnstore tables, when you should pick one over the other, how to pick a shard key, and so on. * [How to Load Data into SingleStore](https://docs.singlestore.com/db/v9.1/load-data.md): Describes the different options you have when ingesting data into a SingleStore cluster. * [How to Run Queries](https://docs.singlestore.com/db/v9.1/query-data/basic-query-examples.md): Provides example schema and queries to begin exploring the potential of SingleStore. * [Configure Monitoring](https://docs.singlestore.com/db/v9.1/user-and-cluster-administration/cluster-health-and-performance/configure-monitoring.md): SingleStore’s native monitoring solution is designed to capture and reveal cluster events over time. By analyzing this event data, you can identify trends and, if necessary, take action to remediate issues. * [Tools Reference](https://docs.singlestore.com/db/v9.1/reference/singlestore-tools-reference.md): Contains information about SingleStore Tools, including Toolbox and related commands. *** Modified at: September 18, 2023 Source: [/db/v9.1/deploy/linux/cli-offline-tarball/](https://docs.singlestore.com/db/v9.1/deploy/linux/cli-offline-tarball/) (An index of the documentation is available at /llms.txt)