Sign inTry Free

Generate Cluster Reports

On this page

As of version 1.9.7, SingleStore Toolbox supports generating cluster reports via the Kube API for Kubernetes.

Note

Toolbox must be installed on the same Linux host that has Kube API access to the cluster. This is a requirement as the Kube config is first used to make the connection, and then generate and pull the report.

The instructions for installing Toolbox are provided below.

To generate cluster reports, the sdb-report binary is required, which is part of SingleStore Toolbox. You can obtain this binary in one of two ways:

  1. Install SingleStore Toolbox. Refer to Install SingleStore Toolbox for installation instructions.

  2. Use the singlestore/tools Docker image.

Note

Select the method based on where you plan to run the report collection. Refer to Generate a Cluster Report for more information.

Install SingleStore Toolbox

Generate a Cluster Report

There are two methods to run the sdb-report collect-kube command to generate a cluster report.

Method 1: External (Using Kubeconfig)

Run the following command from any host where you can execute kubectl commands. This method uses a kubeconfig file for authentication.

  • The sdb-report binary from Toolbox or a Docker image.

  • The Kubeconfig file can be specified using the KUBECONFIG environment variable or the --config-file flag.

  • The kubectl command which has access to the cluster.

sdb-report collect-kube --namespace <namespace> --cluster-name <cluster-name>

To generate a cluster report, run the following command. The name of the cluster can be found by running kubectl get singlestore.

Note

If the Operator logs are missing, run the following command.

kubectl label deployment <operator> app.kubernetes.io/component=operator

Refer to sdb-report collect-kube for more information.

Method 2: In-Cluster (From Within a Pod)

Run the following command from within a Kubernetes Pod using in-cluster configuration. This method does not require configuration files.

  • A Pod with the sdb-report binary available (for example, using the singlestore/tools Docker image)

  • A service account with the required permissions for Kubernetes API calls (such as listing Pods)

Note

The SingleStore node image does not include the sdb-report binary. To use this method, use a Pod with the singlestore/tools image or copy the binary into a node Pod using kubectl cp.

sdb-report collect-kube --namespace <namespace> --cluster-name <cluster-name>

To generate a cluster report, run the following command. The name of the cluster can be found by running kubectl get singlestore.

Note

If the Operator logs are missing, run the following command.

kubectl label deployment <operator> app.kubernetes.io/component=operator

Refer to sdb-report collect-kube for more information.

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