Install and manage add-ons in Terraform Developer Portal

Terraform Developer Portal add-ons let application developers install supporting infrastructure, such as databases, storage buckets, or caches, at any point in an application's lifecycle. After you install an add-on, you can rename it, update it to a new module version, or uninstall it.

Prerequisites

• An HCP Terraform organization on the Standard edition or higher to use HCP Terraform no-code modules and the private module registry. Refer to HCP Terraform pricing for plan details.
• An account in your HCP Terraform organization with permission to create workspaces.
• A Terraform Developer Portal add-on definition to deploy. Refer to Create and manage add-on definitions for more information.

Install an add-on

To install an add-on in an application, complete the following steps:

1. Sign in to HCP Terraform and select the organization where you want to install the add-on.
2. In the navigation menu, click Developer Portal.
3. Click Applications in the sidebar, then click on your application.
4. Click Available add-ons in the application sidebar.
5. Select the add-on to install. Click Install or Install another.

Terraform Developer Portal creates a new workspace for each installed add-on in the same project as the application you are installing it in. You can install multiple instances of each add-on.

Rename an installed add-on

To rename an installed add-on, complete the following steps:

1. Sign in to HCP Terraform and select the organization where you want to edit the installed add-on.
2. In the navigation menu, click Developer Portal.
3. Click Applications in the sidebar, then click on the application with the installed add-on you want to edit.
4. Click Installed add-ons in the left navigation panel.
5. Click the name of the add-on you want to rename.
6. Click the Manage dropdown, then choose Rename.
7. In the Add-on Name field, enter the desired name for your installed add-on.
8. Click Save.

Update an installed add-on

When you update the version of a no-code module that an add-on definition uses, each installed add-on displays an update notification. HCP Terraform does not update add-ons automatically. The add-on owner must respond to the notification. HCP Terraform prompts for values for any new input variables. Refer to Design no-code ready modules for more information.

If the new module version adds an input variable, update the add-on settings first. Provide a default value or allow the application developer to supply a value when installing the add-on.

To update an installed add-on, complete the following steps:

1. Sign in to HCP Terraform and select the organization where you want to update the installed add-on.
2. In the navigation menu, click Developer Portal.
3. Click Applications in the sidebar, then click on the application with the installed add-on you want to edit.
4. Click Installed add-ons in the left navigation panel, then click the name of the add-on you want to update.
5. Click View update.
6. Enter values for any new input variables.
7. Click Save configuration & start plan.
8. Click Go to run details.
9. Review the plan output, then click Confirm & apply to apply the update.

When you apply the update, Terraform Developer Portal automatically starts a plan run in HCP Terraform. If the plan completes successfully, HCP Terraform automatically starts an apply run to update the workspace.

Uninstall an add-on

Uninstalling an add-on deletes its HCP Terraform workspace and the resources it manages.

To uninstall an add-on, complete the following steps:

1. Sign in to HCP Terraform and select the organization where you want to delete the installed add-on.
2. In the navigation menu, click Developer Portal.
3. Click Applications in the sidebar, then click on the application with the installed add-on you want to delete.
4. Click Installed add-ons in the left navigation panel.
5. Click the ellipsis (...) button next to the add-on you want to remove, then click Uninstall.
6. Enter "UNINSTALL" in the Uninstall add-on? dialog, then click Uninstall.