This is an example application to illustrate 3 ways to manage secrets in the Serverless Framework applications:
- Environment variables + AWS KMS
- AWS SSM
- Serverless Framework’s secrets management capabilities
To deploy this project you’ll need the following:
- An AWS account.
- AWS CLI installed locally.
- API credentials for your AWS account configured in your AWS CLI locally by running
aws configure
. - Serverless Framework installed locally via
npm install serverless -g
, for other installation options see this page. - To test the Serverless Framework Secrets you’ll need a free or paid account with Serverless Framework, visit this page to sign up. After you’ve signed up run
sls login
to authenticate your local machine and to be able to deploy an application that uses Serverless Framework Secrets.
Once all pre-requisite items are ready, follow these steps to deploy this example project:
- Run
npm install
to install all the necessary dependencies. - Run
npm run
deploy to deploy the stack.
After you’ve finished working with this example remember to remove all resources to make sure you’re not getting billed for unused AWS infrastructure.
Run npm run remove
to remove all resources.