This repository has been archived by the owner on Dec 16, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Update README #1
Open
aviav
wants to merge
1
commit into
tf:master
Choose a base branch
from
aviav:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,11 +3,12 @@ | |
[![Gem Version](https://badge.fury.io/rb/ey_secrets.svg)](http://badge.fury.io/rb/ey_secrets) | ||
[![Build Status](https://travis-ci.org/tf/ey_secrets.svg?branch=master)](https://travis-ci.org/tf/ey_secrets) | ||
|
||
Manage sensible configuration files accross Engine Yard instances. | ||
Manage sensitive configuration files across Engine Yard instances | ||
within a dedicated config app. | ||
|
||
## Installation | ||
|
||
Add this line to your application's Gemfile: | ||
Add this line to your config app's Gemfile: | ||
|
||
gem 'ey_secrets' | ||
|
||
|
@@ -21,21 +22,34 @@ Or install it yourself as: | |
|
||
## Usage | ||
|
||
The repository is expected to contain one folder per Engine Yard | ||
environment, each containing files with `.env` extension. For example: | ||
The config app which is used for storing sensitive data is expected to | ||
be hosted within the same parent directory on the same git server as | ||
the software which uses the sensitive data. The sensitive data repo is | ||
expected to carry the name $APP_NAME_config.git if the software repo | ||
is named $APP_NAME.git. For example, if sensitive data can be found at | ||
`[email protected]:companyrepo/software_config.git`, ey_secrets | ||
expects to find the app repo at | ||
`[email protected]:companyrepo/software.git`. You can instead provide | ||
the app's name on Engine Yard using the `-a` option. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's not present the naming scheme as a requirement. Instead let's just have the example be explicit and use |
||
|
||
The config repo is also expected to contain one folder per Engine Yard | ||
environment, each containing files specific to that environment. For | ||
example: | ||
|
||
staging/ | ||
secrets.env | ||
config.yml | ||
production/ | ||
secrets.env | ||
config.yml | ||
|
||
After commiting and pushing changes inside the config repository, run: | ||
After committing and pushing changes inside the config repository, run: | ||
|
||
$ cd my_project | ||
$ eysecrets update -e production | ||
Now all files of the form `production/*.env` are copied | ||
to `/data/<app_name>/shared/config` on all instances of the production | ||
|
||
Now all files of the form `production/*` are copied to | ||
`/data/<app_name>/shared/config` on all instances of the production | ||
environment. The command also restarts passenger and the monit group | ||
`<app_name>_resque`. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean "dedicated config repository"?