# Generate Cluster Reports

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](https://docs.singlestore.com/#N1778481389005.md) 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](https://docs.singlestore.com/#section-idm4515232593636832800426358497.md) for more information.

## Install SingleStore Toolbox

* *Red Hat Distribution*

  Run the following commands to install Toolbox.```shell
  sudo yum-config-manager --add-repo https://release.memsql.com/production/rpm/x86_64/repodata/memsql.repo && \
  sudo yum install -y singlestoredb-toolbox
  ```**Troubleshooting**If Toolbox cannot be installed using the steps above, verify that the SingleStore repo information is listed under `repolist`.```shell
  sudo yum repolist

  ``````output

  repo id            repo name            status
  memsql             MemSQL               125
  ```Verify that the `which` package is installed. This is used during the install process to identify the correct package type for your installation.```shell
  rpm -q which
  ```If `which` is not installed, you must install it before proceeding.```shell
  sudo yum install -y which
  ```After verifying the above, re-run the commands to install Toolbox.

* *Debian Distribution*

  1. SingleStore packages are signed to ensure integrity, so the GPG key needs to be added to this host. When done, verify that the SingleStore signing key has been added using `apt-key` list.
     ```shell
     wget -O - 'https://release.memsql.com/release-aug2018.gpg' 2>/dev/null | sudo apt-key add - && apt-key list
     ```
     **Without using `apt-key`**:
     ```shell
     wget -q -O - 'https://release.memsql.com/release-aug2018.gpg' | sudo tee /etc/apt/trusted.gpg.d/memsql.asc 1>/dev/null
     ```

  2. For Debian versions earlier than 10, verify you have `apt-transport-https` installed.
     ```shell
     apt-cache policy apt-transport-https
     ```
     If `apt-transport-https` is not installed, you must install it before proceeding.
     ```shell
     sudo apt -y install apt-transport-https
     ```

  3. Add the SingleStore repository to retrieve its packages.
     ```shell
     echo "deb [arch=amd64] https://release.memsql.com/production/debian memsql main" | sudo tee /etc/apt/sources.list.d/memsql.list
     ```

  4. Run the following to install Toolbox.
     ```shell
     sudo apt update && sudo apt -y install singlestoredb-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.

```bash
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.```bash
> kubectl label deployment <operator> app.kubernetes.io/component=operator
> ```Refer to [sdb-report](https://docs.singlestore.com/db/v9.1/user-and-cluster-administration/cluster-management-with-tools/singlestore-toolbox/sdb-report.md) [collect-kube](https://docs.singlestore.com/db/v9.1/reference/singlestore-tools-reference/sdb-report-commands/collect-kube.md) 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`.

```bash
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.```bash
> kubectl label deployment <operator> app.kubernetes.io/component=operator
> ```Refer to [sdb-report](https://docs.singlestore.com/db/v9.1/user-and-cluster-administration/cluster-management-with-tools/singlestore-toolbox/sdb-report.md) [collect-kube](https://docs.singlestore.com/db/v9.1/reference/singlestore-tools-reference/sdb-report-commands/collect-kube.md) for more information.

***

Modified at: May 11, 2026

Source: [/db/v9.1/reference/singlestore-operator-reference/generate-cluster-reports/](https://docs.singlestore.com/db/v9.1/reference/singlestore-operator-reference/generate-cluster-reports/)

(An index of the documentation is available at /llms.txt)