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 --hidden
flag. The --hidden
flag 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
Follow these steps to export the console settings from the old server and import them to the new server.
Note: To import settings to the new Terraform Enterprise instance, a restart will be required.
Note: To import settings to the new Terraform Enterprise instance, a restart will be required.
ssh
orrdp
to the old TFE instance.- Export current TFE settings to a
.json
file by running this command:replicatedctl app-config export --hidden > ptfe-settings.json
. Next, copy theptfe-settings.json
file to the new TFE instance. ssh
orrdp
to the new TFE instance if not connected.- Run
replicatedctl app-config import < /path/to/ptfe-settings.json
. - Stop the Replicated process:
replicatedctl app stop
. - Ensure the Replicated process has stopped:
replicatedctl app status
. - Restart the Replicated process:
replicatedctl app start
. - 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.