Restarting Terraform Enterprise (Replicated Install)

Steps

Introduction

Replicated is the service that manages the Terraform Enterprise application in a Replicated-based installation. It provides a command-line tool, replicatedctl, to control various aspects of both the Replicated service and Terraform Enterprise.

In certain situations, you may need to restart the Terraform Enterprise application. This guide provides the procedure to stop, start, and monitor the service using replicatedctl.

Procedure

Follow these steps to restart the Terraform Enterprise application.

1. Check the current application status.

   Use the replicatedctl app status command to view detailed information on the status of Terraform Enterprise. This displays the current State of the application and its DesiredState.

   $ replicatedctl app status
   [
     {
       "AppID": "76519cce25564f315111cf0030829e3d",
       "Sequence": 421,
       "PatchSequence": 0,
       "State": "started",
       "DesiredState": "started",
       "Error": "",
       "IsCancellable": false,
       "IsTransitioning": false
     }
   ]

2. Stop the Terraform Enterprise application.

   Use the replicatedctl app stop command. This is equivalent to clicking the "Stop Now" button in the Replicated console on port 8800.

   $ replicatedctl app stop
   App is stopping

3. Verify the application is stopped.

   During the shutdown process, the application State transitions to stopped. You can monitor this by running replicatedctl app status again.

   $ replicatedctl app status
   [
     {
       "AppID": "76519cce25564f315111cf0030829e3d",
       "Sequence": 421,
       "PatchSequence": 0,
       "State": "stopped",
       "DesiredState": "stopped",
       "Error": "",
       "IsCancellable": true,
       "IsTransitioning": true
     }
   ]

4. Start the Terraform Enterprise application.

   Once you have verified that the application state is stopped, issue the replicatedctl app start command. This is equivalent to clicking the "Start Now" button in the Replicated console.

   $ replicatedctl app start
   App is starting

5. Confirm the application has restarted.

   Monitor the State of the application by running replicatedctl app status. Once the application has fully started, the State value will return to started.

   $ replicatedctl app status
   [
     {
       "AppID": "76519cce25564f315111cf0030829e3d",
       "Sequence": 421,
       "PatchSequence": 0,
       "State": "started",
       "DesiredState": "started",
       "Error": "",
       "IsCancellable": false,
       "IsTransitioning": false
     }
   ]

Additional Information

For more details on managing Terraform Enterprise, please refer to the official documentation on administrative tools and commands.