Link modules to external systems

Modules can display custom HTTP links on their page in the dashboard — one-click access to the things you reach for while operating a service: the live service URL, the AWS console, an external monitoring dashboard, a runbook, or anything else with a URL.

Where links come from

Links are declared in the module’s definition, so every instance of a module gets them automatically. Each link has two fields:

Field	Description
`name`	Display name shown in the dashboard.
`href`	The URL. Accepts template expressions like `<< output.xxx >>`, so it can reference values that only exist after the stack applies.

Because href is templateable, links resolve per module instance. A link built from a stack output — a load balancer DNS name, a CloudFront domain, a function URL — points at that instance’s own resource, so the staging instance links to staging and the production instance links to production. For example, rvn-aws-static links to the site’s primary domain: the first domain alias when aliases are configured, otherwise the default cloudfront.net domain.

For module authors

Declare links in the ui.links array of your module definition. See UILink in the definition schema and template expressions for the values you can interpolate into href.

⌘I

Introduction

Concepts

Config as code

Migrate

Modules

Pipelines

Guides

Troubleshooting

Module definitions

Link modules to external systems

Where links come from

For module authors

​Where links come from

​For module authors

Where links come from

For module authors