Skip to content

Instantly share code, notes, and snippets.

@sleepiecappy

sleepiecappy/ENV.md

Last active February 15, 2019 17:33
Show Gist options
  • Save sleepiecappy/5bb87945a6a5c8397b5a79d52fed9c49 to your computer and use it in GitHub Desktop.
Save sleepiecappy/5bb87945a6a5c8397b5a79d52fed9c49 to your computer and use it in GitHub Desktop.
Download ZIP
Idea of Documentation for declaring environment configurations
Raw
ENV.md

Service: Blog

<< Description >>

Thrid Party Dependencies

Thrid party depedencies used by this service:

Service Protocol Documentation Env Vars
Payment HTTPs https://stripe.com/docs STRIPE_API_KEY
Comments HTTPs https://help/disqus.com/ DISQUS_API_KEY
Vault HTTPs https://www.vaultproject.io/docs/ VAULT_TOKEN, VAULT_ADDR

Environment

Details about the needed environment to deploy this application

Components and Runtimes

Component Version Documentation
Ruby MRI ~> 2.6 https://ruby-doc.org/core-2.6.1/
Postgres ~> 11.0 https://www.postgresql.org/docs/11/index.html

Environment Variables

Needed variables to be set.

Variable Default Value Description
STRIPE_API_KEY null Payment provider api key
DISQUS_API_KEY null Comment provider api key
VAULT_TOKEN null Vault Secret Token of this application
VAULT_ADDR null Vault Cluster Address

Configuration Provider: Vault

Configuration provided by Vault, internal code should be able to resolve based on the keys below

Key Description
blog/postgres Postgres credentials
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment