Problem
Generating a Terraform Enterprise support bundle results in a tarball that contains only a single README.md file.
Cause
There are several reasons why support bundle generation may fail:
- The Replicated version in use has a known bug that results in empty support bundles.
- The support bundle process times out while gathering log files.
- The system does not have enough disk space to complete bundle generation.
Solutions
Solution 1: Check the Replicated Version
Some previous versions of Replicated have known issues with support bundle generation. Use the following steps to verify the current Replicated version and upgrade if needed.
- Connect to the instance using SSH.
-
Run the following command to check the current version of Replicated.
$ replicated --version
- Check the Replicated release notes to verify whether the installed version was affected by a bug preventing support bundle generation.
- If the current version is affected or outdated, refer to the Upgrading Replicated guide for upgrade steps.
- Attempt to generate a new support bundle.
Solution 2: Address Process Timeouts
A process timeout is often caused by a large system journal file. The following steps detail how to check and reduce the journal file size.
- Connect to the instance using SSH.
-
Check the journal's disk usage with the following command.
$ journalctl --disk-usage
-
Reduce the journal file to the last 500MB with the following command.
$ journalctl --vacuum-size=500M
- Run the
--disk-usagecommand again to confirm the vacuum command worked as expected. - Attempt to generate a new support bundle.
Note: For a long-term solution, examine how logrotate is configured on the server to keep the journal size below 1GB.
Solution 3: Verify System Storage
Support bundle generation requires at least twice the storage space as the current size of the Docker container logs. If there is insufficient storage, these steps may help reclaim space.
- Connect to the instance using SSH.
-
Run the following command to determine how much disk space Docker is currently using.
$ docker system df
-
Run the following command to verify how much disk space is available. The Docker filesystem is generally found at
/var/lib/docker, so the relevant line of the output is whichever one contains this path.$ df -h
- If the available disk space is less than twice the amount Docker is using, you can clean up the Docker filesystem. Before proceeding, ensure both Terraform Enterprise and Replicated are running to prevent data loss.
-
Verify that the Terraform Enterprise application is running.
$ replicatedctl app status
-
Verify that all three parts of the Replicated application are running.
$ systemctl status replicated replicated-ui replicated-operator
-
After verifying the applications are running, use the following command to clean up the Docker filesystem.
$ docker system prune
- Repeat the
docker system dfanddf -hcommands to verify if there is now sufficient storage available. If this process did not free up enough space, you may need to extend the storage available on the system. - Attempt to generate a new support bundle.
Advanced Troubleshooting
Monitor Support Bundle Generation Logs
If support bundle generation continues to fail, you can inspect the process logs for more details.
- Connect to the instance using SSH.
-
Start the support bundle generation process.
$ replicatedctl support-bundle
-
While the process is running, use the following command to get the container ID. The ID is the 12-character alphanumeric string in the first column of the output.
$ docker ps | grep support-bundle
-
Using the ID from the previous step, monitor the logs.
$ docker logs -f <ID>