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

Introduction

A Terraform Enterprise instance operates within a collective set of containers. Each individual container is launched with specific parameters and generates log messages into different locations. Terraform Enterprise, therefore, is equipped with a tool to perform the task of collecting the logs from each container as well as hardware and system information from the machine that Terraform Enterprise is running on.

Use Case

When Terraform Enterprise fails to perform normal operations, it is often necessary to review the application’s internal logging to determine the root cause. A support bundle is commonly recommended as a starting point to investigate the internal components due to the comprehensive information it gathers in order to provide the context of events and symptoms to system administrators and HashiCorp Support.

Procedure

Standalone Installation

Option 1 - Terminal console

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

2. Connect to terraform-enterpise container 

   ~$ docker exec -it terraform-enterprise bash

   Run tfectl command you will need to wait until the command finishes and the bundle is generated on your S3 bucket or on your mounted disk
   

   terraform-enterprise@xxx:/$ tfectl support bundle --all
   waiting for command to finish execution on node xxxxxx
   ...
   waiting for command to finish execution on node xxxxxx
   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 xxxxxx
   waiting for command to finish execution on node xxxxxx
   Support bundle uploaded successfully: node=xxxxxx object_key=terraform-enterprise/support-bundles/2024-12-17T10:14:44Z/xxxxxx/58ba01864476-support-bundle-2024-12-17T10:14:44Z.tar.gz 

3. Make sure that the size of the generated support bundle file is greater than 4kb, otherwise proceed to the article Terraform Enterprise Support Bundles Are Empty and perform the steps in the Solutions section to reduce the footprint of the support bundle. Once the actions have been taken, attempt to generate a new bundle with the command in the previous step.

4. If you are working with HashiCorp Support, upload the support bundle to the ticket by following the How To Add Bundles and Files to Zendesk Support Tickets guide.

Option 2 - UI Interface

1. Navigate to https://<TFE HOSTNAME>:8800/support.
2. Click Download Support Bundle to begin generating and downloading the support bundle. If the download times out, please consider using Option 1 (generating via a terminal session) or use the Terraform Enterprise Support Bundles Are Empty guide to reduce the footprint of the support bundle.
3. If you are working with HashiCorp Support, upload the support bundle to the ticket following the How To Add Bundles and Files to Zendesk Support Tickets guide.

Active/Active Installation

1. The only option available in the Active/Active installation is using the terminal console with the tfe-admin command, please follow the support bundle guide to generate the support bundle for Active/Active installation.
2. Make sure that the size of the generated support bundle file from each node is greater than 4kb, otherwise proceed to the article Terraform Enterprise Support Bundles Are Empty and perform the steps in the Solutions section to reduce the footprint of the support bundle on the affected nodes. Once the actions have been taken, attempt to generate a new bundle with the command in the previous step.
3. If you are working with HashiCorp Support, upload the support bundle to the ticket by following the How To Add Bundles and Files to Zendesk Support Tickets guide.