» Using the Configuration Designer

Terraform Enterprise (TFE)'s private module registry includes a configuration designer, which can help you spend less time writing boilerplate code in a module-centric Terraform workflow.

The configuration designer is sort of like interactive documentation for your private modules, or very advanced autocompletion. It results in the same Terraform code you would have written in your text editor, but saves time by automatically discovering variables and searching module and workspace outputs for reusable values.

» Workflow Summary

The configuration designer lets you outline a configuration for a new workspace by choosing any number of private modules. It then lists those modules' variables as a fillable HTML form, with a helper interface for finding interpolatable values.

Once you finish, the designer returns the text of a main.tf configuration, which you must copy and paste to create a new VCS repo for workspaces. The designer does not automatically create any repos or workspaces; it's only a shortcut for writing Terraform code faster.

» Accessing the Configuration Designer

Navigate to the modules list with the top-level "Modules" button, then click the "+ Design Configuration" button in the upper right.

TFE screenshot: the design configuration button

This brings you to the "Select Modules" page.

» Adding Modules

TFE screenshot: the select modules page

The left side of the "Select Modules" page has a filterable and searchable list of your organization's private modules. Choose any number of modules you want to add to your configuration.

When you click a module's "Add Module" button, it appears in the "Selected Modules" list on the right side of the page.

» Setting Versions

By default, selecting a module adds its most recent version to the configuration. You can specify a different version by clicking the module's version number in the "Selected Modules" list on the right, which reveals a drop-down menu of available versions.

TFE screenshot: setting a module version with the drop-down

» Setting Variables

When you finish selecting modules, click the "Next »" button in the upper right to go to the "Set Variables" page.

TFE screenshot: the set variables page

The left side of this page lists your chosen modules, and the right side lists all variables for the currently selected module. You can freely switch between modules without losing your work; click a module's "Configure" button to switch to its variable list.

Each variable is labeled as required or optional. Once you've set a value for all of a module's required variables, its "Configure" button changes to a green "Configured ✔️" button; when all modules are configured, you can use the "Next" button in the upper right to display the finished configuration.

» Interpolation Searching

Variable values can be literal strings, or can interpolate other values. When you start typing an interpolation token (${), the designer displays a help message. As you continue typing, it searches the available outputs in your other selected modules, as well as workspace-level outputs from other workspaces. You can select one of these search results, or type a full name if you need to reference a value TFE doesn't know about.

TFE screenshot: interpolation help

» Deferring Variables

Some variables should be set by the author of a configuration (as static or interpolated values), but others should be set by the configuration's user. If you want to delegate a module variable to users, you can select its "Deferred" checkbox, which ties its value to a new top-level Terraform variable with no default value. Anyone creating a workspace from your configuration will have to provide a value for that variable.

» The Output Configuration

When you've finished setting variables, click the "Next" button to view the completed output of the configuration designer.

TFE screenshot: configuration designer output

This page has a large textarea that contains a Terraform configuration. You must copy and paste this code into your text editor, save it as the main.tf file in a new directory, and commit it to version control to enable creating TFE workspaces with the configuration. You can also make arbitrary changes to the code, like adding non-module resources or public Terraform Registry modules.

After you click "Next" again and click "Done," TFE will discard the configuration you've created. Text from previous configuration designer runs is not preserved within TFE.