Project

etcenv

0.01
No commit activity in last 3 years
No release in over 3 years
etcenvsorah/etcenvHomepageDocumentationSource CodeBug TrackerWiki
Dump etcd keys into dotenv file or docker env file
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
56,472
Stars
19
Forks
3
Watchers
3
 Releases
Current version
0.6.0
Total releases
10
First release
2015-04-07
Latest release
2016-05-20
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
50%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-06-09
Reverse Dependencies
2

 Dependencies

Development

bundler
>= 0
rake
~> 10.0
rspec
>= 0

Runtime

etcd
>= 0.3.0
etcd-etcvault
>= 0
 Project Readme

Etcenv: Dump etcd keys into dotenv file or docker env file

Build Status

Installation

$ gem install etcenv

Simple Usage

Create directory and keys on etcd

etcdctl mkdir /my-app
etcdctl set /my-app/AWESOME_SERVICE_CREDENTIAL xxxxxx

Run etcenv

One-shot

This will output generated .env file to STDOUT.

$ etcenv /my-app
AWESOME_SERVICE_CREDENTIAL=xxxxxx

or

$ etcenv -o .env /my-app
$ cat .env
AWESOME_SERVICE_CREDENTIAL=xxxxxx

to save as file.

Continuously update

Etcenv also supports watching etcd server. In --watch mode, Etcenv updates dotenv file when value gets updated:

$ etcenv --watch -o .env /my-env

Also you can start it as daemon:

$ etcenv --watch --daemon /path/to/pidfile.pid -o .env /my-env

For docker

Use --docker flag to generate file for docker's --env-file option.

In docker mode, etcenv evaluates ${...} expansion like dotenv do.

Options

etcd options

  • --etcd: URL of etcd to connect to. Path in URL will be ignored.
  • --etcd-ca-file: Path to CA certificate file (PEM) of etcd server.
  • --etcd-cert-file: Path to client certificate file for etcd.
  • --etcd-key-file: Path to private key file of client certificate file for etcd.

Advanced usage

Include other directory's variables

Set directory path to .include. Directories can be specified multiple, separated by comma.

etcdctl mkdir /common
etcdctl set /common/COMMON_SECRET xxx
etcdctl set /my-app/.include /common

Also, you can omit path of parent directory:

etcdctl mkdir /envs/common
etcdctl set /envs/common/COMMON_SECRET xxx

etcdctl mkdir /envs/my-app
etcdctl set /envs/my-app/.include common
  • .include will be applied recursively (up to 10 times by default). If .include is looping, it'll be an error.
  • For multiple .include, value for same key may be overwritten.
    • If a includes b,c and b includes d, result for a will be: d, b, c, then a.

Development

After checking out the repo, run scripts/setup to install dependencies. Then, run scripts/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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/sorah/etcenv/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request