Skip to content

Commit

Permalink
Update README to reflect changes
Browse files Browse the repository at this point in the history
  • Loading branch information
surenm committed Aug 19, 2014
1 parent 161639a commit 7c58ca4
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Bokuto - A bokken (木剣, bok(u), "wood", and ken, "sword") (or commonly as bokutō 木刀 in Japan) is a Japanese wooden sword used for training

A gem to help deploy rails applications to AWS OpsWorks.
A gem to help deploy rails applications to AWS OpsWorks. Its Japanese name is inspired from Heroku since the goal is to make Bokuto a capistrano library to make opsworks deploys as close to heroku as possible.

Credits: This project is inspired from and is developed over hcliu/capistrano-opsworks.

## Installation

Expand Down Expand Up @@ -58,41 +60,55 @@ Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }
```

In the appropriate stage deploy file, add your OpsWorks details

```ruby
#############################
# /config/deploy/staging.rb #
# /config/deploy/production.rb #
#############################

set :stage, :staging
set :stage, :production

set :access_key_id, '<aws_access_key_id>'
set :secret_access_key, '<aws_secret_access_key>'
set :stack_id, '<opsworks_stack_id>'
set :app_id, '<opsworks_app_id>'
set :opsworks_custom_json, '<opsworks_custom_json>'
set :app_name, '<opsworks_app_name>'

# You can pass a has of Custom Json for a opsworks deploy
# Can be anything from here http://docs.aws.amazon.com/opsworks/latest/userguide/attributes-json-deploy.html#attributes-json-deploy-app-scm
set :custom_deploy_args, {
deploy: {
}
}
```

Check the task list using

$ bundle exec cap -T

Check if you are all set to deploy using bokken.
Check if you are all set to deploy using bokuto.

$ bundle exec cap staging deploy:check
$ bundle exec cap production deploy:check

Deploy your app (you'll get a deployment_id back if it worked)

$ bundle exec cap staging deploy
$ bundle exec cap production deploy

Deploy your app at a specific git revision (say test)

$ bundle exec cap production deploy -s branch=test

Deploy if your IAM credentials are properly set up:
The following command should return your IAM user name if its properly setup

Check the history of your app deployments

$ bundle exec cap staging bokuto:history
$ bundle exec cap production bokuto:history

## Contributing

1. Fork it
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 new Pull Request
5. Create new Pull Request

0 comments on commit 7c58ca4

Please sign in to comment.