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

Expected Outcome

The new, restored Terraform Enterprise instance will have the same console UI settings as the original instance.

Use Case

When you restore a backup to a new Terraform Enterprise instance, you may need to import the console settings from the original server to the new one. The console settings are the configurations found in the UI at https://<TFE_HOSTNAME>:8800/settings.

You can export these settings, including necessary hidden values like the encryption password, using the replicatedctl command with the --hidden flag.

Note: The enc_passwd password is used to encrypt and decrypt the internally-managed Vault unseal key and root token. This is not required if you opt out of using the internally-managed Vault.

Procedure

Follow these steps to export the console settings from the original server and import them to the new server. Importing settings requires an application restart.

1. Connect to the original Terraform Enterprise instance using SSH or a similar remote protocol.

2. Export the current settings to a .json file. The --hidden flag is required to include sensitive values like the encryption password.

   $ replicatedctl app-config export --hidden > ptfe-settings.json

3. Copy the ptfe-settings.json file to the new Terraform Enterprise instance.
4. Connect to the new Terraform Enterprise instance.

5. Import the settings from the JSON file.

   $ replicatedctl app-config import < /path/to/ptfe-settings.json

6. Stop the Replicated services to apply the new settings.

   $ replicatedctl app stop

7. Confirm that the services have stopped.

   $ replicatedctl app status

8. Restart the Replicated services.

   $ replicatedctl app start

9. Verify that the settings were imported successfully. You can export the configuration again on the new instance to compare, or check the UI to confirm the settings are correct.

   $ replicatedctl app-config export