https://github.com/meltwater/aws-configuration-fetcher
A simple system for gathering configuration from both SSM and Secrets Manager in AWS
https://github.com/meltwater/aws-configuration-fetcher
Last synced: 5 months ago
JSON representation
A simple system for gathering configuration from both SSM and Secrets Manager in AWS
- Host: GitHub
- URL: https://github.com/meltwater/aws-configuration-fetcher
- Owner: meltwater
- License: mit
- Created: 2020-09-09T14:37:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T22:36:14.000Z (6 months ago)
- Last Synced: 2025-05-16T17:12:30.458Z (5 months ago)
- Language: JavaScript
- Size: 1.46 MB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# aws-configuration-fetcher
[](https://www.npmjs.com/package/@meltwater/aws-configuration-fetcher)
[](https://drone.meltwater.io/meltwater/aws-configuration-fetcher)
A simple system for fetching configuration from both SSM and Secrets Manager in AWS
## Installation
Add this as a dependency to your project using [npm] with
```
$ npm install @meltwater/aws-configuration-fetcher
```
or using [Yarn] with
```
$ yarn add @meltwater/aws-configuration-fetcher
```
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/
## Usage
The project exposes a class to help you define your configuration requests. This class is used in
conjunction with the ConfigurationRepository to retrieve the values for your configuration.
```javascript
import {
createConfigurationRepository,
ConfigurationRequest,
ConfigurationRequestTypes
} from '@meltwater/aws-configuration-fetcher'
const configurationRepository = createConfigurationRepository()
const configuration = configurationRepository.getConfiguration([
new ConfigurationRequest({
key: '/some/magical/parameter/path',
propertyName: 'someMagicalParameter',
type: ConfigurationRequestTypes.ssm
}),
new ConfigurationRequest({
key: 'something-super-secret',
propertyName: 'somethingSuperSecret',
type: ConfigurationRequestTypes.secret
})
])
console.log(configuration.someMagicalParameter)
console.log(configuration.somethingSuperSecret, 'Maybe I should not log this...')
```
### Adapting configuration values
The `ConfigurationRequest` also allows you to adapt a value being returned. This is helpful for
providing additional validation, or converting the value to a primitive other than string.
```javascript
import { createConfigurationRepository, ConfigurationRequest, ConfigurationRequestTypes } from '@meltwater/aws-configuration-fetcher'
const configurationRepository = createConfigurationRepository()
const configuration = configurationRepository.getConfiguration([
new ConfigurationRequest({
adapter: (value) => {
if(value.trim() === '') {
throw new Error('The magic has faded, because the parameter value was empty.')
}
return value
},
key: '/some/magical/parameter/path',
propertyName: 'someMagicalParameter',
type: ConfigurationRequestTypes.ssm
}),
new ConfigurationRequest({
adapter: (value) => parseInt(value)
key: 'something-super-secret',
propertyName: 'somethingSuperSecret',
type: ConfigurationRequestTypes.secret
})
])
```
## Api Documentation
We have provided a [full API spec](./docs) if you like that sorta thing!
## Development and Testing
### Quickstart
```
$ git clone https://github.com/meltwater/aws-configuration-fetcher.git serverless-nodejs
$ cd serverless-nodejs
$ nvm install
$ yarn install
```
Run each command below in a separate terminal window:
```
$ yarn run offline
$ yarn run test:watch
```
Primary development tasks are defined under `scripts` in `package.json` and available via
`yarn run`. View them with
```
$ yarn run
```
### Source code
The [source code] is hosted on GitHub. Clone the project with
```
$ git clone git@github.com:meltwater/aws-configuration-fetcher.git
```
[source code]: https://github.com/meltwater/aws-configuration-fetcher
### Requirements
You will need [Node.js] with [npm], [Yarn], and a [Node.js debugging] client.
Be sure that all commands run under the correct Node version, e.g., if using [nvm], install the
correct version with
```
$ nvm install
```
Set the active version for each shell session with
```
$ nvm use
```
Install the development dependencies with
```
$ yarn install
```
[node.js]: https://nodejs.org/
[node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
[npm]: https://www.npmjs.com/
[nvm]: https://github.com/creationix/nvm
#### Drone
_Drone should already be configured: this section is for reference only._
The following secrets must be set on [Drone]. These may be set manually or by running the script
`./.drone/secrets.sh`.
Note the Drone config path must be set to `.drone/config.yml` after the repo is activated.
##### npm
- `npm_token_ro`: npm token for installing packages.
- `npm_token_rw`: npm token for publishing packages.
- `npm_team`: npm team to grant read-only package access (format `org:team`, optional).
##### Slack
- `slack_webhook`: Slack webhook for build notifications.
##### Drone Promotion
When the drone build publishes a new package version it can trigger a promotion event on a Drone
repo.
- `drone_server`: Drone server.
- `drone_token`: Drone token.
##### AWS S3 Release
- `aws_assume_role_arn_staging`: The AWS role to assume for staging.
- `aws_assume_role_external_id_staging`: The external ID for the AWS role for staging.
- `aws_assume_role_arn_production`: The AWS role to assume for production.
- `aws_assume_role_external_id_production`: The external ID for the AWS role for production.
[drone]: https://drone.meltwater.io/
### Publishing
Use the [`npm version`][npm-version] command to release a new version. This will push a new git tag
which will trigger a CI publish job.
[npm-version]: https://docs.npmjs.com/cli/version
## Contributing
Please submit and comment on bug reports and feature requests.
To submit a patch:
1. Fork it (https://github.com/meltwater/aws-configuration-fetcher/fork).
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Make changes.
4. Commit your changes (`git commit -am 'Add some feature'`).
5. Push to the branch (`git push origin my-new-feature`).
6. Create a new Pull Request.
## License
This npm package is licensed under the MIT license.
## Warranty
This software is provided by the copyright holders and contributors "as is" and any express or
implied warranties, including, but not limited to, the implied warranties of merchantability and
fitness for a particular purpose are disclaimed. In no event shall the copyright holder or
contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential
damages (including, but not limited to, procurement of substitute goods or services; loss of use,
data, or profits; or business interruption) however caused and on any theory of liability, whether
in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of
the use of this software, even if advised of the possibility of such damage.