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 download a support bundle, you can share it with DataStax Support for troubleshooting assistance.

For KOTS-based installations, you can use the included KOTS Admin Console to analyze Mission Control issues and review suggested remediation.

For Helm and KOTS installations, you can use the CLI to generate a support bundle. You can download a support bundle to share with your account team at DataStax after generating it.

Create a support bundle

KOTS Admin Console
Command Line Interface (CLI)

For KOTS-based installations, you can use the KOTS Admin Console to create a support bundle.

In the KOTS Admin Console, select the Troubleshoot tab.
Click Analyze to start analyzing Mission Control.

Mission Control uses the support bundle plugin to analyze your Mission Control installation and produce a support bundle.

No data leaves the cluster. Support bundles are generated internally to your Mission Control environment. The system never sends data across the internet or to anyone else.

After the analysis is complete, the Support bundle analysis section displays the detected issues and suggested remediation. For more information, see Support bundle analysis.
Review the detected issues and suggested remediation.
To download the support bundle, click Download bundle. You can send the bundle to DataStax support for assistance.

You can use these instructions for both Helm and KOTS installations.

Create a support bundle using one of the following methods, depending on your environment:

Default kots.io spec
Air gap
Mission Control installed
Mission Control not installed

If you use the default kots.io specification, run the following command to create a support bundle:

kubectl support-bundle https://kots.io

If you are on an air-gapped server, do the following:

On a computer with internet access, run the following command to download the default kots.io specification:
```
curl -o spec.yaml https://kots.io -H 'User-agent:Replicated_Troubleshoot/v1beta1'
```
Upload the spec.yaml file to the air-gapped server.
Create a support bundle using the uploaded spec.yaml file:
```
kubectl support-bundle LOCATION/spec.yaml
```
Replace LOCATION with the path to the spec.yaml file.

If the Admin Console is running and Mission Control is installed, then run the following command to create a support bundle.

This bundle includes any customization specific to Mission Control from the support-bundle.yaml manifest file.

kubectl support-bundle http://SERVER_ADDRESS:8800/api/v1/troubleshoot/mission-control

Replace SERVER_ADDRESS with the address of the Admin Console.

If Mission Control is not installed but the Admin Console is running, then run the following command to create a support bundle.

This bundle includes customizations from the Admin Console.

kubectl support-bundle http://SERVER_ADDRESS:8800/api/v1/troubleshoot

Replace SERVER_ADDRESS with the address of the Admin Console.

The support bundle generates and saves to your local machine. The command line displays the location of the support bundle.

Sample results

Support bundle analysis results saved to
Users/username/support-bundle-resources/support-bundle-**YYYY-MM-DD**.tar.gz

Move the support bundle to a secure location:

mv support-bundle-YYYY-MM-DD.tar.gz TARGET_LOCATION

Replace TARGET_LOCATION with the path to your target location, for example, Downloads.

If required, you can send the generated support bundle to DataStax support for assistance.

Support bundle analysis

For KOTS-based installations, you can use the KOTS Admin Console to analyze Mission Control issues and review suggested remediation. The Support bundle analysis section displays the detected issues and suggested remediation. The system bases the analysis on the collected data in the support bundle. The analysis section shows three tabs:

Analysis insights: Displays the detected issues and suggested remediation.
File inspector: Displays the collected files in the support bundle in JSON format.
Redactor report: Displays the redacted information in the support bundle.

Generate a host support bundle

For Kubernetes installer provisioned clusters, also known as embedded clusters, you can generate a host support bundle to assist with troubleshooting a cluster that is down. DataStax provides you with a host support bundle YAML file that you run with a command to generate the host support bundle.

Typically, you don’t need root access to run the host collectors and analyzers. However, depending on what is being collected, you might need to run the support-bundle binary with elevated permissions. For example, if you run the filesystemPerformance host collector against /var/lib/etcd and the user running the binary does not have permissions on this directory, the collection process fails.

To generate a host support bundle, do the following:

Install the support-bundle plugin.
Save the host support bundle YAML file from DataStax on the host. For air gap environments, download the file and copy it to the air gap machine.
Run the following command on the host to generate a host support bundle:
```
./support-bundle --interactive=false LOCATION/FILENAME.yaml
```
Replace the following:
- LOCATION: The path to the host support bundle YAML file
- FILENAME: The name of the host support bundle YAML file from DataStax
Share the host support bundle with DataStax support.
Repeat these steps for each node because there is no method to generate host support bundles on remote hosts. If you have a multi-node Kubernetes cluster, then you must run the support-bundle binary on each node and generate a host support bundle for each node.

Generate a Mission Control support bundle

Create a support bundle

Support bundle analysis

Generate a host support bundle

Was this helpful?

Give Feedback