How To Track The Progress of a Terraform Enterprise Update

Introduction

When you perform a Terraform Enterprise upgrade, the user interface does not provide a detailed view of the update's progress. You can monitor the upgrade process using the Replicated CLI, which offers deeper insight into the running tasks.

Prerequisites

• Shell access to the Terraform Enterprise instance.
• Sufficient permissions to execute replicatedctl commands.

Procedure

Follow these steps to track the upgrade progress from the command line.

1. Begin the application upgrade by executing the replicatedctl app-release apply command.

   # /usr/local/bin/replicatedctl app-release apply

2. List the running tasks to locate the ID for the upgrade task. The task description will begin with upgrade_to_version.

   # replicatedctl task ls

   Example Output:

   TASK ID                                                 STATUS      DESCRIPTION
   upgrade_to_version_428300989d80405c633bd21c172dc030_619  queued      ##...
   upgrade_to_version_428300989d80405c633bd21c172dc030_610  executing   ##...
   f3eb870d71e78431051622b74457062e                        sleeping    ##...
   f08646caaf6142ac931c9271f6d7deed                        sleeping    ##...
   fe45e5da36e34f48a2ccdeae28b9f67f                        sleeping    ##...

3. Stream the progress of the upgrade task using the task ID you identified in the previous step.

   # replicatedctl task attach <task-id>

   Example Output:

   Waiting for all components to start

Additional Information

After the upgrade completes, you can use the watch replicatedctl app status command to check the application status and confirm the new version of Terraform Enterprise. You can also verify the version in the Terraform Enterprise UI.

For more information, refer to the Upgrading Terraform Enterprise documentation.