Dependency Configuration Examples

Starter snippets to paste into a Component's Helm values to give your application a database password or a secret from Parameter Store.

Starter snippets you can paste into a Component's Helm values to give your
application a database password or a secret from AWS Systems Manager Parameter
Store. Each example is a working minimum, not a full reference — the field
reference for each dependency engine is on its own page, listed in
Application Dependencies.

All dependency configuration goes under the dependency key in the Component's
Helm values, in SVIEW. You do not put the secret value itself anywhere in the
configuration — only a pointer to where the platform should read it from.

Inject a database password

Use this when the database is a Component already provisioned on the platform.

dependency:
  db:
    type: rds-postgres
    keys:
      - secretKey: password
        envKey: POSTGRESDB_PASSWORD
        instance: db

To inject the username and hostname as well, add one entry per credential under
keys. For what each field means and the optional overrides, see
Inject Database Credentials; for the full
attachment workflow, see
Attach a Database to Your Application.

Inject a value from Parameter Store

Use this when you want to keep a variable or secret in AWS Systems Manager
Parameter Store
and have it appear in the pod as an environment variable.

dependency:
  ssm:
    json: "false"
    keys:
      - name: SOME_KEY
        ssmKeys:
          - SOME_KEY
        json: "false"

The parameter must exist at the path built from your application's stage,
environment, namespace and instance, and is easiest to create through
Secrets Manager; for the path format and what each field
means, see
Inject Secrets from Parameter Store.

Verify it worked

  1. Save the Component and wait for the deployment to finish in SVIEW.
  2. Open the Logs tab for the application and confirm it started without a
    missing-variable or authentication error.

If the pod fails to start, the usual cause is that the parameter does not exist
at the expected path, or the name in envKey does not match what the
application actually reads. See
Secret Not Found or Not Reaching Your Application
for the full checks.

Related articles

Still stuck? Raise a request and include the Component name, the environment,
and the error from the Logs tab.


Did this page help you?