How to import the Terraform Enterprise console settings on a restored instance (Replicated Install)

Expected Outcome

The new Terraform Enterprise instance that is restored will contain the same console UI settings as the old Terraform Enterprise instance. 

Use Case

When doing a restore on a new Terraform Enterprise instance, there may be a need to import the Terraform Enterprise console settings from the old server to the new one.   The console settings are the configurations found in the https://<tfe-url:8800/settings and https://<tfe-url>:8800/console/settings in the UI.  These settings can also be exported using thereplicatedctl command including the --hiddenflag.  The --hiddenflag is required as the output will include necessary hidden password values such as the encryption password.  

NOTE:
The enc_passwd password is used to encrypt and decrypt the internally-managed Vault unseal key and root token. Not required only when opting out of internally-managed Vault.

Procedure

1. ssh  or rdp to the old TFE instance.
2. Export current TFE settings to a .json file by running this command: replicatedctl app-config export --hidden > ptfe-settings.json. Next, copy the ptfe-settings.json file to the new TFE instance.
3. ssh or rdp to the new TFE instance if not connected.
4. Run replicatedctl app-config import < /path/to/ptfe-settings.json.
5. Stop the Replicated process: replicatedctl app stop.
6. Ensure the Replicated process has stopped: replicatedctl app status.
7. Restart the Replicated process: replicatedctl app start.
8. Verify the TFE settings were imported by running replicatedctl app-config export on the new instance. Additionally, you can check the UI to qualify if the settings were imported successfully.

Additional Information

Please contact HashiCorp Support to request further assistance.