Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs for basic setup #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs for basic setup #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d70f3d2
more verbose docs
May 2, 2016
1b74d9d
flesh out config file examples
May 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 40 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,58 @@ See the [wiki](https://github.com/mapzen/opzworks/wiki) for more detailed inform

## Third party requirements:

Aside from a recent version of ruby:

* git
* Ruby 2.3 or greater
* Git
* [ChefDK](https://downloads.chef.io/chef-dk/)

## Installation

Install for use on the command line (requires ruby and rubygems): `gem install opzworks`

If you don't want to install opzworks globally you can run `gem install --user-install opzworks`. On a Mac this will install things in `${HOME}/.gem/ruby/2.3.0/bin` and you will need to invoke opzworks explicitly or update your `${PATH}` environment variable.

Then run `opzworks --help`

To use the gem in a project, add `gem 'opzworks'` to your Gemfile, and then execute: `bundle`

To build locally from this repository: `rake install`

## Config files

You will also need to ensure that you have the following config files:

### AWS

opzworks expects to be able to find a file at `${HOME}/.aws/credentials`. This is a standard `ini` style config file that looks like this (adjusted to your specifics):

```
[default]
aws_access_key_id = YOUR-AWS-KEY
aws_secret_access_key = YOUR-AWS-SECRET
region = us-east-1
output = json
```

If that lokos kind of like [the AWS way of managing your (AWS) credentials](http://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs) that's because it is.

_Actually you also need to have a `${HOME}/.aws/config` file because computers, I guess, so I just symlink them:_

```
ln -s ${HOME}/.aws/credentials ${HOME}/.aws/config
```

### Opsworks

opzworks expects to be able to find a file at `${HOME}/.opzworks/config`. This is a standard `ini` style config file that looks like this (adjusted to your specifics):

```
[default]
ssh-user-name = USERNAME
berks-github-org = mapzen
berks-s3-bucket = mapzen-opsworks
berks-repository-path = /PATH/TO/BERKS-Y-THINGS
```

## Commands

#### ssh
Expand Down