Generating Support Bundles

For Helm and KOTS installations, support bundles can be generated using these CLI commands.

note

For KOTS, using the admin console and additional CLI options are available. For more information, see Generating Support Bundles in the KOTS documentation.

Prerequisite

For existing clusters, do a first-time installation or upgrade the support-bundle plugin (a kubectl plugin) before you generate a support bundle using the CLI. The plugin is required to generate a support bundle.

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

note

If your application was installed using a Replicated kURL script, then kubectl and the support-bundle plugin is already present 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 gapped 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

The following methods are supported for Helm installations and for KOTS version 1.94.2 and later.

Support bundles are generated from one or more support bundle specifications. Specification locations include YAML manifest files in the cluster, URLs, and Secrets or ConfigMap objects embedded in a Kubernetes cluster. For more information, see Collecting a Support Bundle and Discover Cluster Specs in the Troubleshoot documentation.

The following examples show some possible CLI commands to generate a support bundle for one or more specifications and locations:

• Automatically discover specifications in the cluster that are contained in Secrets or ConfigMaps:

  kubectl support-bundle --load-cluster-specs

• Automatically discover specifications found in the cluster that match a custom label:

  kubectl support-bundle --load-cluster-specs -l LABEL

  Replace LABEL with the label name.

• Using one or more files:

  kubectl support-bundle ./PATH_TO_FILE1 ./PATH_TO_FILE2 ./PATH_TO_FILE3

  Replace PATH_TO_FILE with the path and YAML file name for each file.

• Using a URL and a specification in the cluster:

  kubectl support-bundle URL \
  ./PATH_TO_FILE 

  Replace:

  • URL with the online specification location provided by your vendor
  • PATH_TO_FILE with the path and YAML file name

Generate a Bundle when a Helm Installation Fails

If a Helm installation fails and you want to collect a support bundle to assist with diagnostics, you can use a Replicated default specification to generate the support bundle.

Run the following command:

kubectl support-bundle https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/in-cluster/default.yaml