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.

Install SingleStore Toolbox

Generate a Cluster Report

There are two ways of running the collect-kube command to generate a cluster report:

Run from anywhere using a kubeconfig file, which can be specified either from the KUBECONFIG environment variable or by the --config-file flag.
Run from inside a Pod. Known as an in-cluster configuration, this method doesn't require any configuration files. The service account should be configured properly to allow Kubernetes API calls, such as listing Pods.

Note that the image for the Pod that runs sdb-report collect-kube must have the sdb-report binary available, such as via a singlestore/tools image). Generally, this works just like kubectl does, with no installation required.

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

Shell

sdb-report collect-kube --namespace <name-space> --cluster-name <name-used-for-the-cluster>

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

Shell

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

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

Last modified: November 2, 2023

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.

(Optional) Run the following command to view the associated signature files.
Shell
```
curl undefined
```
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.
  Shell
```
curl -O undefined
```

After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

Shell

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