Environmentalization example

Detailed example that illustrates different aspects of the environmentalization capability supported by the YAML configuration.

1 minute read

This example illustrates the following aspects of the environmentalization:

Injection of integer, long, and string types.
Partial strings (URL field).
System environment variable with and without default value.
Encrypted passwords.
Conservation of other environmentalization methods.
An unresolved placeholder.

In the following example snippet, we assume that ES_DB_PASSWORD is set with a value encrypted by a passphrase and ES_DB_HOST is not set.

# A YAML Entity
---
type: DbConnection
fields:
   name: MySQL
   maxIdle: '{{db.maxIdle}}'
   maxWait: '{{foo}}'
   url: jdbc:mysql://{{db.host}}:3306/DefaultDb
   password: '{{db.password}}'
   username: '{{db.username}}'
   maxActive: ${env.dbMaxActive}
   timezoneAware: ${environment.IS_TIMEZONE_AWARE}

# value.yaml
db:
  maxIdle: 1
  username: scott
  password: '{{env "ES_DB_PASSWORD"}}'
  host: '{{env "ES_DB_HOST" "staging.db.acme.com"}}'

# Processed result (in-memory at load time)
---
type: DbConnection
fields:
   name: MySQL
   maxIdle: 1
   maxIdle: '{{foo}}'                    # <--- error
   url: jdbc:mysql://staging.db.acme.com:3306/DefaultDb
   password: Zm9pdWRiZm9pdWRiZm9pdXNkbmaXM=
   username: scott
   maxActive: ${env.dbMaxActive}
   timezoneAware: ${environment.IS_TIMEZONE_AWARE}

Last modified August 31, 2022: 7.7 Aug 22 Merge Develop branch into master branch (#2417) (9285a8b3)