Sign inTry Free

Prerequisites

On this page

Kubernetes concepts

This tutorial assumes you have a basic knowledge of containers and Kubernetes concepts such as Objects, Pods, PersistentVolumes, and so on. In addition, some of the use cases for operators are mentioned in this tutorial, but you should read the CoreOS documentation for a more in-depth explanation of what they are and why they are useful.

kubectl

Follow these instructions to install kubectl on the host used to control and manage your cluster.

Host requirements

Cluster deployments must be on hosts that satisfy SingleStore’s hardware and software requirements. Specifically, the following requirements must be met on all hosts:

  • Red Hat OpenShift Container Platform 4.x+

  • Kubernetes versions 1.19 through 1.35

    Note

    For supported deployments on AWS, Azure, or GCP, please use SingleStore Helios.

    A Helm chart is available for deploying SingleStore clusters via a Kubernetes operator. Please note that the code in this repository is for experimental use only and is not fully tested, documented, or supported by SingleStore. Visit the SingleStore Forums for questions about, and support for, this repository.

  • Physical or virtual machines 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 General for more information.

    • Running Linux kernel 3.10 or later and either an xfs or ext4 filesystem

    • Each SingleStore Pod needs to be able to communicate with other SingleStore Pods in the same cluster over port 3306

    • The Kubernetes worker nodes/host systems must meet the specified system requirements as outlined in our System Requirements and Recommendations documentation.

Refer to Set System Requirements for more information on how to configure hosts with a Kubernetes DaemonSet.

Host recommendations

Consideration should be given to future expansion needs. SingleStore recommends that allowVolumeExpansion is set to true to enable future storage size increases. Refer to the Kubernetes documentation for more information.

Licensing on Kubernetes

SingleStore license units are calculated based on leaf node pod resource requests, not on the specifications of the underlying worker nodes. Refer to What are license units and how do they apply to my cluster for more information on calculating license units.

Only leaf nodes consume license units. Aggregator nodes, the Operator pod, and system-requirement DaemonSets do not count toward licensing.

Key Implications for Kubernetes

  • A dedicated worker node pool is not required for licensing purposes. Leaf pods can run on shared worker nodes without affecting license calculations.

  • License consumption depends solely on the resource requests defined in the MemsqlCluster custom resource.

  • When you scale leaf replicas horizontally, each additional leaf pod adds license units based on its own resource requests.

Example

A cluster with four leaf pods, each requesting 16 vCPUs, 128 GB RAM, and 500 GB disk cache:

  • Per leaf: max(16 ÷ 8, 128 ÷ 64, 500 ÷ 1000) = max(2, 2, 0.5) = 2 license units

  • Total: 4 × 2 = 8 license units

Docker Container Repository (Optional)

If your container registry is internal and you cannot access Docker Hub, you can pre-load the following images into your local container repository.

Operator Container

SingleStore Node Container

SingleStore Tools Container

Last modified:

Was this article helpful?

On this page

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

Try Out This Notebook to See What’s Possible in SingleStore

Get access to other groundbreaking datasets and engage with our community for expert advice.

Sign UpLog In