Generate Cluster Reports
On this page
As of version 1.
Note
Toolbox must be installed on the same Linux host that has Kube API access to the cluster.
The instructions for installing Toolbox are provided below.
Install SingleStoreDB Toolbox
Red Hat Distribution
Run the following commands to install Toolbox.
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
.
sudo yum repolist
repo id repo name status
memsql MemSQL 125
Verify that the which
package is installed.
rpm -q which
If which
is not installed, you must install it before proceeding.
sudo yum install -y which
After verifying the above, re-run the commands to install Toolbox.
Debian Distribution
-
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.wget -O - 'https://release.memsql.com/release-aug2018.gpg' 2>/dev/null | sudo apt-key add - && apt-key list -
Verify you have
apt-transport-https
installed.apt-cache policy apt-transport-httpsIf
apt-transport-https
is not installed, you must install it before proceeding.sudo apt -y install apt-transport-https -
Add the SingleStore repository to retrieve its packages.
echo "deb [arch=amd64] https://release.memsql.com/production/debian memsql main" | sudo tee /etc/apt/sources.list.d/memsql.list -
Run the following to install Toolbox.
sudo apt update && sudo apt -y install singlestoredb-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 thesdb-report
binary available, such as via asinglestore/tools
image).Generally, this works just like kubectl
does, with no installation required.
To generate a cluster report, run the following command.kubectl get singlestore
.
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.
kubectl label deployment <operator> app.kubernetes.io/component=operator
Refer to sdb-report collect-kube for more information.
Last modified: September 18, 2023