How to Generate a Support Bundle in Terraform Enterprise (Replicated Install)

Introduction

A Terraform Enterprise instance operates within a collection of containers, each generating log messages in different locations. Terraform Enterprise includes a tool to collect logs from each container, along with hardware and system information from the host machine, into a single support bundle.

Use Case

When Terraform Enterprise fails to perform normal operations, reviewing the application’s internal logging is often necessary to determine the root cause. A support bundle provides comprehensive information about the context of events and symptoms, serving as a critical starting point for troubleshooting by system administrators.

Procedure

This guide provides instructions for generating a support bundle for both Standalone and Active/Active installations of Terraform Enterprise.

For Standalone Installations

You can generate a support bundle for a standalone installation using the terminal or the admin console UI.

Method 1: Using the Terminal

1. Open a terminal session and connect to the Terraform Enterprise host machine using SSH.

2. Connect to the terraform-enterprise container.

   $ docker exec -it terraform-enterprise bash

3. Run the tfectl command to generate the support bundle. The command creates the bundle and uploads it to your configured storage backend, such as an S3 bucket or a mounted disk.

   $ tfectl support bundle --all

   Example Output:

   waiting for command to finish execution on node ...
   Support bundle generated successfully: file=/run/terraform-enterprise/support-bundles/e3d45f32-c87e-5987-203c-ad746114e81b/hcdiag-2024-12-17T101444Z.tar.gz 
   Uploading support bundle: filename=/run/terraform-enterprise/support-bundles/e3d45f32-c87e-5987-203c-ad746114e81b/hcdiag-2024-12-17T101444Z.tar.gz 
   waiting for command to finish execution on node ...
   Support bundle uploaded successfully: object_key=terraform-enterprise/support-bundles/2024-12-17T10:14:44Z/node-id/58ba01864476-support-bundle-2024-12-17T10:14:44Z.tar.gz

4. Verify that the generated support bundle file is larger than 4KB. If the bundle is empty or too small, refer to the troubleshooting guide for Terraform Enterprise Support Bundles Are Empty to reduce the bundle's footprint before regenerating it.

Method 2: Using the Admin Console UI

1. Navigate to the admin console at https://<TFE_HOSTNAME>:8800/support.
2. Click Download Support Bundle to generate and download the bundle.
3. If the download times out, use Method 1 by generating the bundle from the terminal. If the bundle is too small, refer to the troubleshooting guide for Terraform Enterprise Support Bundles Are Empty to reduce its footprint.

For Active/Active Installations

1. For Active/Active installations, you must generate the support bundle using the tfe-admin command from the terminal. Follow the official Active/Active support bundle documentation for detailed steps.
2. Verify that the generated support bundle file from each node is larger than 4KB. If a bundle is empty or too small, refer to the troubleshooting guide for Terraform Enterprise Support Bundles Are Empty to reduce the bundle's footprint on the affected nodes before regenerating it.