Oops: The Opsworks Postal Service

Oops handles the creation and deployment of rails applications to Amazon's Opsworks (http://aws.amazon.com/opsworks/).

It provides rake tasks to bundle your application, along with all of its assets, into a .zip that is uploaded to s3. That artifact is then used to deploy your application. This saves production boxes from running asset precompiles and avoids git checkouts on your running servers.

Installation

Add this line to your application's Gemfile:

gem 'oops'

And then execute:

$ bundle

Or install it yourself as:

$ gem install oops

Usage

Variables are passed into ops using both environment variables and rake arguements.

To create a build: AWS_ACCESS_KEY_ID=MY_ACCESS_KEY AWS_SECRET_ACCESS_KEY=MY_SECRET_KEY DEPLOY_BUCKET=oops-deploy PACKAGE_FOLDER=opsbuilds bundle exec rake oops:build You can set ASSET_ENV in case you need to compile assets for a different environment than production (for instance if you're compiling assets for your staging environment).

To upload a build: AWS_ACCESS_KEY_ID=MY_ACCESS_KEY AWS_SECRET_ACCESS_KEY=MY_SECRET_KEY DEPLOY_BUCKET=oops-deploy PACKAGE_FOLDER=opsbuilds bundle exec rake oops:upload

To deploy a build: AWS_ACCESS_KEY_ID=MY_ACCESS_KEY AWS_SECRET_ACCESS_KEY=MY_SECRET_KEY DEPLOY_BUCKET=oops-deploy PACKAGE_FOLDER=opsbuilds bundle exec rake oops:deploy[my_application_name,my_stack_name]

By default, these tasks will all deploy what is in your current HEAD, but can also be passed an optional ref to deploy a specific revision.

OpsWorks Permissions

It is good practice to configure a specific IAM user for deployments. For more details see the Security and Permissions section of the AWS OpsWorks User Guide

Actions needed for oops to run are:

opsworks:DescribeStacks
opsworks:DescribeApps
opsworks:DescribeDeployments
opsworks:UpdateApp
opsworks:DescribeInstances
opsworks:CreateDeployment

Deploy Hooks

For notifcations and other things there are deploy hooks. For notifications to hipchat for instance create a lib/tasks/oops-extensions.rake file in your project with the following content:

namespace :oops do
  task :notify_hipchat_start do
    hipchat_room.send('OOPS', "Starting deploy #{build_hash[0..7]}")
  end
  task :notify_hipchat_failed do
    hipchat_room.send('OOPS', "Deploy #{build_hash[0..7]} failed", :color => 'red')
  end
  task :notify_hipchat_finished do
    hipchat_room.send('OOPS', "Deploy #{build_hash[0..7]} completed", :color => 'green')
  end
  task :deploy_start => :notify_hipchat_start
  task :deploy_failed => :notify_hipchat_failed
  task :deploy_finished => :notify_hipchat_finished

  def hipchat_room
    @hipchat_room ||= HipChat::Client.new(<your-api-key>)[<your-room-name>]
  end
end

Make sure to replace <your-api-key> and <your-room-name>.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

doorkeeper / oops