Skip to content

Latest commit

 

History

History
133 lines (98 loc) · 3.58 KB

README.md

File metadata and controls

133 lines (98 loc) · 3.58 KB
Raw

Relevance Rails

Yo dawg, I heard you like automation, so I automated your automation so you can autopilot while you autopilot!

Rails 3 projects with every fiddly bit convened rather than configured. Includes:

  • HAML and SCSS
  • RSpec 2 with Relevance config niceties
  • Factory Girl
  • Mocha configured for mocking
  • Capistrano deploy recipes
  • A VM deployment target under provision

Build Status

Getting Started

For new projects:

$ gem install relevance_rails
$ relevance_rails new <your new project>

For existing projects, first add to your Gemfile:

group :development, :test do
  gem 'relevance_rails'
end

After a bundle install, pull in our chef recipes into provision/:

# defaults to mysql
$ rails g provision_config app_name
# if using postgresql
$ rails g provision_config app_name postgresql

Provisioning on EC2

First create an aws config in ~/.relevance_rails/aws_config.yml. An example config looks like this:

aws_credentials:
  :aws_access_key_id: <your aws access key id>
  :aws_secret_access_key: <your aws secret access key>

server:
  creation_config:
    :flavor_id: <instance type, e.g. 'm1.large'>
    :image_id: <ami to bootstrap with. Must be some UBUNTU image. e.g. "ami-fd589594">
    :groups: <security group to place the new deployment in, e.g. "default">
    :key_name: <name of the public/private keypair to start instance with>
  private_key: |
    -----BEGIN RSA PRIVATE KEY-----
    Include the RSA private key here. This should correspond to the keypair indicated
    by :key_name above.
    -----END RSA PRIVATE KEY-----

Now just provision your instance:

$ rake provision:ec2 NAME=qa
...
Server IP: 1.1.1.1
# Pass IP from previous command as second argument
$ rails g deployment qa 1.1.1.1
$ cap qa deploy:setup deploy

Provisioning with Vagrant

From your app's root directory:

$ cd provision
# pull in vagrant and chef
$ bundle install
$ vagrant up

Vagrant instance should be up at 172.25.5.5.

Supported Ruby Versions

Currently both Ruby 1.9.x and REE 1.8.7 are supported via RVM. relevance_rails configures your Rails app (and Chef provisioning scripts) to require the version of Ruby you used to invoke the relevance_rails executable.

Supported Databases

Currently both MySQL and PostgreSQL are supported. By default relevance_rails configures your Rails app (and Chef provisioning scripts) to use MySQL. However, if you use the standard --database=postgresql Rails option, relevance_rails will use PostgreSQL.

Maintainer Notes

When QAing or doing local development of this gem, the gem must be built and installed locally.

In order to test deployment, use the example below to package the relevance_rails gem:

# Given a relevance_rails app "app" lives in "~/src/app"
# And the relevance_rails source lives in "~/src/relevance_rails"
~/src/relevance_rails $ gem build relevance_rails.gemspec
~/src/relevance_rails $ cd ~/src/app
~/src/app $ gem install ../relevance_rails/relevance_rails-0.0.7.gem
~/src/app $ bundle package
~/src/app $ git commit -m "Package gems" vendor/cache

Caveats

Currently we only support Ruby 1.9.x, REE 1.8.7, Rails 3.2, MySQL, and PostgreSQL installed on Ubuntu.

Improvements

Fork, do your work, and issue a pull request.

Issues

Open a github issue and I'll look at it next Friday.