Skip to content

Commit

Permalink
readme updates; remove celluloid for now
Browse files Browse the repository at this point in the history
  • Loading branch information
danryan committed Sep 3, 2012
1 parent a8ef86e commit c167a27
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ gem 'json', :platform => :jruby
gem 'multi_json', '~> 1.3.6'
gem 'yajl-ruby'
gem 'active_attr', '~> 0.6.0'
gem 'celluloid'
# gem 'celluloid'
gem 'state_machine'

gem 'ruby-graphviz', require: 'graphviz'
Expand Down
1 change: 0 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,6 @@ DEPENDENCIES
bootstrap-sass
cabin (~> 0.4.4)
capybara (>= 1.1.2)
celluloid
coffee-rails (~> 3.2.1)
database_cleaner (>= 0.7.2)
email_spec (>= 1.2.1)
Expand Down
2 changes: 1 addition & 1 deletion Procfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
web: bundle exec unicorn -p $PORT
#sidekiq: bundle exec sidekiq
ruote: bundle exec rake ruote:run_worker
worker: bundle exec rake ruote:run_worker
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,58 @@ See [Targets in the wiki](https://github.com/danryan/mastermind/wiki/Targets)

Mastermind uses PostgreSQL to store jobs and process definitions, Redis as a queue for workflow processes, and Ruote as the underlying "operating system" for workflow execution.

# Configuration

Mastermind uses the following environment variables for configuration:

## Mastermind settings

* `MASTERMIND_NOISY` - Whether workflow debug info should be emitted to the logs. Default is `false`.
* `MASTERMIND_LOG_LEVEL`="info" - The Mastermind log level. Default is `info`.

## AWS participants

* `AWS_ACCESS_KEY_ID` - AWS access key id
* `AWS_SECRET_ACCESS_KEY` - AWS secret access key

## Campfire participant

* `CAMPFIRE_ROOM` - Campfire room ID
* `CAMPFIRE_ACCOUNT` - Campfire account name
* `CAMPFIRE_TOKEN` - Campfire API token

## Chef participants
* `CHEF_SERVER_URL` - Chef server URL. Remember to include the port if applicable.
* `CHEF_CLIENT_NAME` - Chef client name
* `CHEF_CLIENT_KEY` - Chef client key (the key itself, not the path). Example: `cat /Users/admin/.chef/admin.pem`

# Deployment

## Heroku

```bash
heroku create -s cedar
heroku addons:add heroku-postgresql:dev
heroku pg:promote HEROKU_POSTGRESQL_DEV_NAME
heroku addons:add redistogo
heroku config:set GRAPHITE_URL=[...]
heroku config:set GRAPHITE_AUTH=[...]
heroku config:set CAMPFIRE_ACCOUNT=[...]
heroku config:set CAMPFIRE_ROOM=[...]
heroku config:set CAMPFIRE_TOKEN=[...]
heroku config:set PAGERDUTY_API_KEY=[...]
git push heroku master
heroku run rake db:migrate
heroku scale web=1
heroku scale worker=1
```

# API

Mastermind provides a REST-ish JSON API for job and definition management. Please see the [API wiki](https://github.com/danryan/mastermind/wiki/API) for details.

# API Client

```ruby
raise NotImplementedError, "Documentation coming soon!"
```
Expand Down
1 change: 1 addition & 0 deletions config/application.rb
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class Application < Rails::Application
cabin = Cabin::Channel.new
cabin.subscribe(STDOUT)
config.logger = cabin
# config.logger.level = :debug
end

# Settings in config/environments/* take precedence over those specified here.
Expand Down
2 changes: 1 addition & 1 deletion config/initializers/celluloid.rb
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Celluloid.logger = Rails.logger
# Celluloid.logger = Rails.logger

0 comments on commit c167a27

Please sign in to comment.