Restarting Terraform Enterprise (Replicated Install)

Steps

Introduction

Replicated manages the Terraform Enterprise application in a Replicated‑based installation and provides the replicatedctl command‑line tool for controlling both Replicated and Terraform Enterprise.

When a restart is required, this guide shows how to stop, start, and monitor the application using replicatedctl.

Procedure

Follow these steps to restart the Terraform Enterprise application.

1. Check the current application status.

   Run the replicatedctl app status command to view detailed status information, including the State and DesiredState of the application.

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

2. Stop the Terraform Enterprise application.

   Execute the replicatedctl app stop command (equivalent to the “Stop Now” button in the Replicated console on port 8800).

   $ replicatedctl app stop
   App is stopping

3. Verify the application has stopped.

   During shutdown, the State transitions to stopped. 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.

   After confirming the stopped state, issue the replicatedctl app start command (equivalent to the “Start Now” button in the Replicated console).

   $ replicatedctl app start
   App is starting

5. Confirm the application has restarted.

   Monitor the State by running replicatedctl app status. Once fully started, the State returns to started.

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

Additional Information

For comprehensive guidance on Terraform Enterprise administrative tools and commands, see the “Managing Terraform Enterprise” section of the official documentation.