Skip to main content

Generating Support Bundles for KOTS Installations

This topic describes how to generate support bundles for applications installed with Replicated KOTS.

Generate a Bundle from the Admin Console​

The Replicated KOTS Admin Console includes a Troubleshoot page where you can generate a support bundle and review remediation suggestions for troubleshooting. You can also download the support bundle from the Admin Console.

To generate a support bundle in the KOTS Admin Console:

  1. Log in to the Admin Console and go to the Troubleshoot tab.

  2. Click Analyze to start analyzing the application. Or, copy the command provided to generate a bundle from the CLI.

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

    note

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

  3. (Optional) If enabled for your online installation, you might also see a Send bundle to vendor button available. Clicking this button will send the support bundle directly to your vendor. Replicated recommendeds following up with your vendor to let them know the bundle has been provided.

    Send bundle to vendor screen

    View a larger version of this image

  4. (Optional) Click Download bundle to download the support bundle. You can send the bundle to your vendor for assistance.

Generate a Bundle Using the CLI​

You can generate a support bundle using the support-bundle CLI instead of the Admin Console. For example, you might need to generate a bundle from the CLI if the Admin Console is not available. Or perhaps you need to use a more recent version of the support-bundle plugin than what is embedded in the Admin Console.

Prerequisite: Install the Plugin​

The support-bundle plugin (a kubectl plugin) is required to generate support bundles from the command line.

You can install the support-bundle plugin using krew or install it manually from the release archives.

note

For Replicated Embedded Cluster and Replicated kURL installations, the support-bundle plugin is automatically installed on all of the control plane nodes. You can skip this prerequisite.

Install or Upgrade using krew​

To install the support-bundle plugin using krew, do one of the following:

  • If krew is not installed already, run the following command to install krew and the support-bundle plugin at the same time:

    curl https://krew.sh/support-bundle | bash

  • If krew is installed already, run the following command to install the plug-in:

    kubectl krew install support-bundle

  • To upgrade your existing support-bundle plugin using krew:

    kubectl krew upgrade support-bundle

Install Manually​

If you do not want to install the plugin using krew or want an easier way to install the plugin in an air gap environment, you can install the plugin manually from the release archives.

To install the support-bundle plugin manually:

  1. Run the following command to download and unarchive the latest release, and move the plugin to your $PATH:

    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
    note

    If you do not have root access, or choose not to add the support-bundle plugin to your path, you can run the binary directly from where you unzipped it by executing ./support-bundle. If you choose not to put the plugin into your $PATH, then replace all instances of kubectl support-bundle in these instructions with ./support-bundle or with the absolute path to the binary.

  2. (Optional) Run the following command to test that the installation is working:

    kubectl support-bundle --help

Generate a Bundle​

Run the following command to generate a bundle:

kubectl support-bundle --load-cluster-specs

The --load-cluster-specs flag automatically discovers all support bundle specs that are defined in Secrets or ConfigMaps in the cluster. For more information, see Discover Cluster Specs in the Troubleshoot documentation.

For a complete list of options with the kubectl support-bundle command, run kubectl support-bundle --help. For more information, see Collecting a Support Bundle in the Troubleshoot documentation.