Generate a Mission Control support bundle

The Admin Console that is installed as part of Mission Control provides a Troubleshoot tab where you can generate an analysis and review remediation suggestions for troubleshooting Mission Control. You can also download a support bundle to share with your account team at DataStax.

Create a Support Bundle using the Admin Console

  1. From the Admin Console, select the Troubleshoot tab.

  2. Click Analyze to start analyzing Mission Control.

    The analysis executes the support bundle plugin. After the analysis completes, the bundle is available on the Troubleshoot tab in the Admin Console. Any known issues that are detected are highlighted with possible remediation suggestions.

    No data leaves the cluster. Data is never sent across the internet or to anyone else.

  3. Optional: Click Download bundle to download the support bundle. You can send the bundle to DataStax support for assistance.

Create a Support Bundle using the Command Line Interface (CLI)

Create a support bundle using one of the following methods, depending on your environment or situation.

With the Default kots.io Specification​

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

kubectl support-bundle https://kots.io

On an Air Gap Server​

If you are on an air-gapped server, perform the following steps to create a support bundle:

  1. Run this 'curl' command from a computer with internet access to download the default kots.io specification:

    curl -o spec.yaml https://kots.io -H 'User-agent:Replicated_Troubleshoot/v1beta1'
  2. Upload the spec.yaml file to the air-gapped server.

  3. Run this kubectl command to create a support bundle using the uploaded spec.yaml file:

    kubectl support-bundle <location>spec.yaml

When the Admin Console and Mission Control are installed​

If the admin console is running and Mission Control is installed, then run the following command to create a support bundle that includes any customization specific to Mission Control from the support-bundle.yaml manifest file:

kubectl support-bundle http://<server-address>:8800/api/v1/troubleshoot/<app-slug>

When Mission Control is not installed​

If Mission Control is not installed but the Admin Console is running, then run the following command to create a support bundle with additional customization from the Admin Console:

kubectl support-bundle http://<server-address>:8800/api/v1/troubleshoot

Generate a Host Support Bundle​

For Kubernetes installer provisioned clusters (embedded clusters), you can generate a host support bundle to help troubleshoot 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.

Root access is typically not required 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:

  1. Install the support-bundle plugin. See Install the Support Bundle Plugin.

  2. 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.

  3. Run the following command on the host to generate a host support bundle:

    ./support-bundle --interactive=false <location>/<filename>.yaml

    Replace:

    <location> with the path to the host support bundle YAML file.

    <filename> with the name of the host support bundle YAML file from DataStax.

    Share the host support bundle with the DataStax account team.

  4. 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.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com