Generate a Mission Control support bundle
You can generate a Mission Control support bundle to assist with troubleshooting issues. The system automatically redacts sensitive information from your support bundle, such as passwords and tokens using built-in redactors. After you generate a support bundle, you can share it with IBM Support for troubleshooting assistance.
Use the CLI to create a support bundle
-
Make sure
kubectlis installed and configured with access to your cluster. -
Install the
support-bundlekubectl plugin using one of the following methods:-
Download the binary directly from the troubleshoot.sh releases.
-
Use Homebrew:
brew tap replicatedhq/replicated brew install support-bundle
-
-
Create a support bundle:
- Online clusters
-
If your server has internet access, run the following command to create a support bundle that is saved to your local machine:
kubectl support-bundle LOCATION/kots-support-bundle-spec.yamlReplace
LOCATIONwith the path to thekots-support-bundle-spec.yamlfile. - Airgapped clusters
-
If your server doesn’t have direct internet access, do the following:
-
Download the default
kots.iosupport bundle specification. -
Upload the
kots-support-bundle-spec.yamlfile to the air-gapped server. -
Use the uploaded spec file to create a support bundle that is saved to your local machine:
kubectl support-bundle LOCATION/kots-support-bundle-spec.yamlReplace
LOCATIONwith the path to thekots-support-bundle-spec.yamlfile.
-
-
Find the generated support bundle, and then move it to a secure location.
The support bundle is saved it your local machine in the current directory with a timestamped filename in the format
support-bundle-YYYY-MM-DDThh_mm_ss.tar.gz.mv support-bundle-TIMESTAMP.tar.gz TARGET_LOCATION -
Share the generated support bundle with IBM Support for assistance.
Use the diagnostic collector
Use the open source diagnostic collector for Apache Cassandra® to collect diagnostic information from your Mission Control environment.
The diagnostic collector collects diagnostic support bundles from each node in your Mission Control cluster.
For complete diagnostic collector documentation, see the DataStax GitHub repository. For troubleshooting information, see Troubleshooting.
-
Prepare the dependencies:
-
A running Mission Control cluster with healthy pods
-
make -
kubectlconfigured with access to your cluster -
Permission to access pods in the target namespace
-
-
Download the latest collector release.
-
Set your cluster details:
export CLUSTER_NAME="CLUSTER_NAME"Replace
CLUSTER_NAMEwith the Mission Control cluster name. -
Navigate to the extracted collector directory:
cd ds-collector -
Find the correct pod name and namespace:
Find all podskubectl get pods -A | grep -i cassandraSearch in a specific namespacekubectl get pods -n POD_NAMESPACE | grep -i cassandraReplace
POD_NAMESPACEwith the namespace where your pod runs. -
Verify that the pod exists and get its full details:
kubectl get pod POD_NAME -n POD_NAMESPACE -o wideReplace the following:
-
POD_NAME: The name of the pod -
POD_NAMESPACE: The namespace of the podLook for a pod with a`Running` status, and note both the pod name and namespace.
The pod must be in
Runningstatus for the diagnostic collector to work properly. If the pod showsInit:ImagePullBackOffor other error states, resolve the pod issues before proceeding.
-
-
Configure the collector for Kubernetes mode:
-
Create a working configuration file from the
collector.conf.intemplate:cp collector.conf.in collector.conf -
Modify the copied template in
collector.conffor your environment. -
Enable Kubernetes mode:
sed -i.bak 's/#use_k8s="true"/use_k8s="true"/' collector.conf -
Update the namespace, replacing
POD_NAMESPACEwith the actual namespace where your pod runs.The
k8s_namespacesetting incollector.confmust match the actual namespace where your pod runs.sed -i.bak 's/#k8s_namespace="default"/k8s_namespace="POD_NAMESPACE"/' collector.conf -
Enable sudo:
sed -i.bak 's/#skipSudo="true"/skipSudo="true"/' collector.conf
-
-
Verify the configuration:
./ds-collector -T -f collector.conf -n POD_NAME -
Generate the support bundle
./ds-collector -X -f collector.conf -n POD_NAMEThe collector does the following to generate the support bundle:
-
Connects to your Mission Control cluster using
kubectl. -
Collects diagnostic information from all nodes in the cluster.
-
Generates a support bundle in the current directory or the configured base directory. The default is
/tmp/datastax. -
Names the bundle with a timestamp and your cluster name.
-
-
Verify that the support bundle was created by checking the output directory (default
/tmp/datastax):result of datastax_collector from POD_NAME processing artifact ARTIFACT_NAME.tar.gzThe collector names the artifacts with timestamps and cluster information, following the pattern
artifacts.tar.gz. -
Share the generated support bundle with IBM Support for assistance.