Introduction
Terraform Enterprise v202404-2 for Replicated deployments introduces a new implementation of the Replicated Admin commands (tfe-admin). In this version and later, the tfe-admin command (sourced from /etc/replicated.alias) uses the new Terraform Enterprise admin CLI, tfectl. Previously, admin commands were executed in a dedicated container named tfe-admin, which has now been removed.
While most commands are unaffected, a few notable differences may require modifications to existing workflows. This article outlines the details of this change, which commands are affected, and what actions are required to accommodate this change.
Prerequisites
- Terraform Enterprise version v202404-2 or newer
- Replicated deployment method
Required Actions
Depending on the commands you use, a few modifications to existing workflows may be necessary.
app-config Command
The tfectl utility does not have the capability to modify Replicated application configuration settings, which are displayed by replicatedctl app-config export.
As a replacement for the previous tfe-admin app-config set command, you must now use the following replicatedctl command on each node to make a configuration change.
$ replicatedctl app-config set <key> --value <value>
For the configuration changes to take effect, you must restart the Terraform Enterprise application on each node. Refer to the updated documentation for details on updating configuration in Active/Active Replicated deployments.
support-bundle Command
The tfe-admin support-bundle command previously generated a bundle from all nodes in an Active/Active deployment by default. To generate a bundle from all nodes now, you must provide the --all flag.
$ tfe-admin support-bundle --all
Command Reference
The table below provides a mapping of the old tfe-admin commands to their new tfectl equivalents for your reference.
tfe-admin Command |
tfectl Equivalent |
|---|---|
db-backup |
db backup |
db-restore |
db restore |
db-reindex |
db reindex |
retrieve-iact |
admin token |
health-check |
app status |
support-bundle |
support bundle |
node-drain |
node drain |
list-nodes |
node list |
app-config |
app config |
rotate-encryption-password |
app rotate-encryption-password |
license-info |
app license |
background-migration-status-required |
db migration-status --required-only |
background-migration-status-all |
db migration-status |
To see details on the usage of the tfectl utility, pass the --help option to the tfe-admin command to display usage information.