Support bundles

Support bundles provide diagnostic information about your cluster that can help troubleshoot issues.

Generate support bundles via KOTS admin console Copied

From the KOTS admin console, click Troubleshoot to generate a support bundle for diagnostics and troubleshooting. An ITRS representative will work with you if you have an issue with your ITRS Analytics setup.

Generate support bundles via command line Copied

To generate a support bundle using the support-bundle plugin, do the following:

  1. Download and install the support-bundle binary.

    curl -L https://github.com/replicatedhq/troubleshoot/releases/latest/download/support-bundle_linux_amd64.tar.gz | tar xzvf -
    sudo mv ./support-bundle /usr/local/bin/kubectl-support_bundle
    
  2. Run the following command to start generating the support bundle using cluster specs.

    kubectl support-bundle --load-cluster-specs
    
  3. Once the tool starts, it presents a CLI-based GUI interface, similar to the screenshot below, where you can view the results of various pre-flight checks performed on the cluster.

    Log in screen

  4. Press q to exit the CLI interface. Upon exit, you’ll see a message confirming the bundle creation.

    A support bundle was generated and saved at support-bundle-2025-03-27T11_28_42.tar.gz. Please send this file to your software vendor for support.
    

Tip

Send the generated .tar.gz file to ITRS Support for diagnostic purposes. It contains logs, configuration data, and results of various cluster checks.

Network security tool warnings Copied

Support bundles will report the presence of a number of network security tools detected on your machine. The current list of tools that may be identified include the following:

The flagged tools can be found in <bundle dir>/host-collectors/run-host/ps-detect-antivirus-and-security-tools.txt.

It is recommended to disable these tools on the machine before installation, as they may interfere with Kubernetes operations. To disable the network security tools you are using, refer to instructions from your software provider. You may disregard the warning if you have already confirmed that these tools won’t cause any interference with Kubernetes.

["ITRS Analytics"] ["Troubleshooting"]

Was this topic helpful?