Introduction
When Terraform Enterprise fails to perform normal operations, you may need to review the application’s internal logging to determine the root cause. HashiCorp Support commonly recommends generating a support bundle as a starting point for investigations. A support bundle gathers comprehensive information about the internal components to provide necessary context about events and symptoms to system administrators.
Prerequisites
- Administrative access to the Terraform Enterprise container's command line.
Procedure
This procedure outlines the steps to generate and locate a support bundle for Terraform Enterprise.
Step 1: Generate the Support Bundle
- Gain access to the Terraform Enterprise container command line by following the instructions for your container management system in Accessing the Terraform Enterprise CLI.
-
Run the
tfectl support bundlecommand to generate the bundle. The--allflag gathers information from all available components.$ tfectl support bundle --all
Step 2: Locate the Support Bundle
The location of the generated support bundle depends on your Terraform Enterprise installation type.
For Mounted Disk Installations
Terraform Enterprise generates support bundles in the /run/terraform-enterprise/support-bundles directory inside the container.
For External Services, Active/Active, and Kubernetes Installations
Terraform Enterprise uploads support bundles to the same object storage bucket where Terraform state files are stored. Each run of the command uploads the bundle to a directory named with a JobID, which is a timestamp in RFC3339 format (bucket/node/timestamp).
For multi-node installations, ensure you package and send all associated bundles. The directory structure will resemble the following example.
support-bundles
└── 2020-11-10T02:03:05Z
├── 10.0.0.5
│ └── 10.0.0.5-support-bundle-timestamp.tar.gz
└── 10.0.0.6
└── 10.0.0.6-support-bundle-timestamp.tar.gzAdditional Information
- Further details are available in the Support Bundle Generation documentation.