Skip to content

Connections and secrets

A connection is one system and how to reach it: a database’s host and password, a Slack bot token, a Google service account key, an S3 bucket and its access key. Monitors, jobs, flow steps and notification channels name connections instead of holding credentials themselves.

Manage them on Connections. The page groups the catalog by what each integration is for, and badges show what a connection can be used for: Notifications, Webhooks (incoming alerts), Checks, Jobs and Flow actions. Every type and field is in Connection types.

Everyone in the organization can see that a connection exists. Only Owners and Admins add or change one, and nobody sees a secret again after it is saved.

When you add a connection with secret fields, Secrets offers two choices.

Store in SREInsights, encrypted (the default)

Section titled “Store in SREInsights, encrypted (the default)”
  • Each secret is encrypted with AES-256-GCM under your organization’s own data key, which is itself wrapped by the instance’s master key.
  • The API never returns a secret. Edit forms show that a value is set, not what it is.
  • At run time, SREInsights decrypts the secrets one run needs and seals them to the runner’s own key, bound to that lease. Another runner can’t open them, and they can’t be replayed into another run. Runs waiting in the queue hold no secrets.

SREInsights never sees the secrets. You set them as environment variables on every runner that uses the connection, named after the connection and the field:

Terminal window
# A connection named "orders-db" with a password field
SREINSIGHTS_SECRET_ORDERS_DB_PASSWORD=…

The name is SREINSIGHTS_SECRET_, then the connection’s name in capitals with every other character as _, then the field name in capitals with words split by _ (accessToken becomes ACCESS_TOKEN). The form shows the exact names. Renaming the connection renames them. Switching an existing connection to this mode erases the copy stored in SREInsights.

This mode is for connections only runners use, such as a database a check reads. Hosted runners can’t use it, and channels can’t (SREInsights itself sends notifications).

Settings that aren’t secret may hold ${name} placeholders, such as a base URL https://${env}.acme.com. Whatever runs the connection fills them in:

  1. a flow step’s own connection variables,
  2. otherwise a saved flow value or a webhook trigger field with the same name,
  3. otherwise a monitor parameter of the same name.

A placeholder nobody fills fails the step and names it. Secrets can’t hold placeholders.

In an organization with clients, a connection either belongs to one client or is shared.

  • A client’s job or monitor may use that client’s connections and the shared ones, never another client’s.
  • A job’s destination must be the client’s own, so a client’s data is written only where that client’s is.
  • Work with no client uses shared connections only.

SREInsights checks this when you save, when you move a connection to another client, and again when a runner takes the run.

On your own instance, an operator can create a connection straight from an AWS Secrets Manager secret, so nobody sees or pastes its values: see sreinsights connections import in Operator commands.