How To Run

Generating a Support Bundle

This content is associated with a legacy version of the Replicated product. For the current Replicated product documentation, see

How to run the Support Bundle

The collection components Replicated Troubleshoot utility are distributed in a Docker container that’s publicly available at

Running from the Admin Console

For a server that’s running Replicated, the Admin Console has a “Support” tab. On this page, a server admin can click “Download Support Bundle” to collect and download the support bundle locally.

Support Tab in Admin Console

When downloading a support bundle from the Admin Console, the most released Collectors will define what’s included in the bundle. For a full description of how the support bundle determines the set of collectors to use, read our page on promoting collectors.

Running in Docker

Sometimes, it might not be possible to access the Admin Console to download the support bundle. In this scenario, a support bundle can be collected by running a container with the replicated/support-bundle image. Custom collectors can still be included.

The command to generate a support bundle with custom collectors from the command line is specific to each application and release channel. To get the command for an application, open the “Upload a support bundle” option:

Upload Support Bundle

And then select “My customer can’t create a support bundle”.

Docker Run Support Bundle

On this screen, select the application and release channel that contains the collector definitions. This command will use the most recently release version of the troubleshoot spec in that channel.

When this command completes, a supportbundle.tar.gz file will exist in the current directory. The generated support bundle can be uploaded to for analysis.

docker run -it --rm \
    --volume $PWD:/out \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --net host --pid host \
    replicated/support-bundle generate