EnvParameterStore
This gem aims to inject secrets to ENV from AWS Systems Manager Parameter Store on production envionment.
Installation
Add this line to your application's Gemfile:
gem 'env_parameter_store'
And then execute:
$ bundle
Or install it yourself as:
$ gem install env_parameter_store
Usage
// .secret.json
{
"prefix": "/secrets/app/",
"parameters": [
"SECRET_KEY_BASE",
"DATABASE_PASSWORD"
]
}
after that, execute this.
EnvParameterStore.inject
If you're using Rails, env_parameter_store/rails
handles everything, which
is loaded automatically.
Above configuration try to inject below pairs to ENV:
-
SECRET_KEY_BASE
: parameter value from/secrets/app/SECRET_KEY_BASE
-
DATABASE_PASSWORD
: parameter value from/secrets/app/DATABASE_PASSWORD
Requirement
Application which try to fetch secrets from Parameter Store should have proper
permission of parameter. This gem uses GetParameters
, so next 2 actions are
enough in most cases.
ssm:GetParameters
kms:Decrypt
And you need to pass AWS_REGION
to specify which region env_parameter_store uses
Development
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/riseshia/env_parameter_store. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the EnvParameterStore project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.