newsource-config-module

Config Module

This repository is a Node.js Module to encapsulate logic related to handling loading of configuration from external sources

Setup

Run one of the following commands in the root directory of your project

#!shell

npm install newsource-config-module --save

Usage

Usage of the module as follows

const configParser = require('newsource-config-module');
const config = {
   mySql: {
      host: "${env:MYSQL_HOST}",
      password: "${ssm:/path/to/mysql/password"}
   }
};
const parsedConfig = await configParser.parseConfig(config);
console.log(`MySQL host: ${parsedConfig.mySql.host} and password: ${parsedConfig.mySql.password}`);

Parameter Store Usage Tracking

There is custom logic that looks for the following 3 environment variables. If these variables are found, this module will add 3 tags to the retrieved parameters in parameter store. It will populate last-accessed-date with a timestamp in UTC, environment with the contents of NODE_ENV and will populate last-accessed-by with the contents of the APP_NAME environment variable. (Note: because tag keys must be unique, these values will be overwritten if there are multiple apps retrieving the same parameter). This functionality is meant to be used in downstream environments only.

NODE_ENV=dev
APP_NAME=my-custom-app
TAG_PARAM_STORE_USAGE=true

Versioning

If you want to sync your Git commit with the version of your module

#!shell

git tag [major].[minor].[patch]
git push origin master --tags

NPM version

Use npm publish to publish new version of the module (after modifying package.json and pushing a tag to git)