ubistrano 1.2.7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 AppTower
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,162 @@
+Ubistrano
+=========
+
+Provision and deploy to an Ubuntu/God/Apache/Passenger stack using Capistrano and EC2.
+
+Goals
+-----
+
+* Create an Ubuntu Hardy EC2 instance in one command (<code>cap ec2</code>)
+* Provision a solid Ubuntu Hardy application server in one command (<code>cap ubuntu</code>)
+* Deploy PHP, Rails, and Sinatra apps
+* Be descriptive about what is going on and allow the user to opt out
+* Simplify the <code>deploy.rb</code> file
+
+The stack
+---------
+
+* Apache
+* EC2 (optional)
+* Git
+* MySQL
+* MySQLTuner
+* Perl
+* PHP
+* Postfix (relay)
+* Ruby
+* RubyGems
+* Passenger (mod\_rails)
+* God
+* Rails
+* Sinatra
+* Sphinx
+
+
+Getting started
+---------------
+
+### Install gem
+
+	gem install winton-ubistrano
+
+### Ubify your project
+
+<pre>
+cd your_project
+ubify .
+</pre>
+
+* Runs <code>capify</code>
+* Creates <code>config/deploy.example.rb</code>
+* Adds <code>config/deploy.rb</code> to your project's <code>.gitignore</code>
+
+### Copy config/deploy.example.rb to config/deploy.rb
+
+It should look like this:
+
+<pre>
+set :ubistrano, {
+  :application => :my_app,
+  :platform    => :rails,  # :php, :rails, :sinatra
+  :repository  => 'git@github.com:user/my-app.git',
+
+  :ec2 => {
+    :access_key => '',
+    :secret_key => ''
+  },
+
+  :mysql => {
+    :root_password => '',
+    :app_password  => ''
+    # Ubistrano creates a mysql user for each app
+  },
+
+  :production => {
+    :domains => [ 'myapp.com', 'www.myapp.com' ],
+    :ssl     => [ 'myapp.com' ],
+    :host    => '127.0.0.1'
+  },
+
+  :staging => {
+    :domains => [ 'staging.myapp.com' ],
+    :host    => '127.0.0.1'
+  }
+}
+
+require 'ubistrano'
+</pre>
+
+Ubistrano uses the same Capistrano options you've come to love, but provides defaults and a few extra options as well.
+
+Edit deploy.rb to the best of your ability. If setting up an EC2 instance, be sure to provide your AWS keys. Your IP address will be provided later. Provide passwords even if they haven't been created yet.
+
+Feel free to move any options into or out of the stage groups.
+
+Create your EC2 instance
+------------------------
+
+### From your app directory
+
+<pre>
+cap ec2
+</pre>
+
+### Example output
+
+<pre>
+================================================================================
+Press enter for Ubuntu Hardy or enter an AMI image id:
+</pre>
+
+Set up your Ubuntu Hardy server
+-------------------------------
+
+### From your app directory
+
+<pre>
+cap ubuntu
+</pre>
+
+### Example output
+
+<pre>
+================================================================================
+Let's set up an Ubuntu server! (Tested with 8.04 LTS Hardy)
+
+With each task, Ubistrano will describe what it is doing, and wait for a yes/no.
+
+================================================================================
+Please ssh into your server (use -i only for EC2):
+  ssh root@174.129.232.34 -i ~/.ssh/id_rsa-studicious
+
+Edit your sudoers file:
+  visudo
+
+Add the following line:
+  deploy ALL=NOPASSWD: ALL
+
+Continue? (y/n)
+</pre>
+
+Deploy your app
+---------------
+
+All apps should have a <code>public</code> directory.
+
+### First deploy
+
+	cap deploy:first
+	
+### Subsequent deploys
+
+	cap deploy
+
+
+Deploy to staging
+-----------------
+
+Use any capistrano task, but replace <code>cap</code> with <code>cap staging</code>.
+
+### Example
+
+	cap staging deploy:first

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'gemspec'
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+desc "Package gem"
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end

data/bin/ubify

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+UBISTRANO = File.expand_path("../", File.dirname(__FILE__))
+TO = File.expand_path("#{ARGV.join(' ')}", FileUtils.pwd)
+
+# Capify
+`capify #{TO}`
+
+# Copy config/deploy.example.rb
+FileUtils.cp "#{UBISTRANO}/example/deploy.rb", "#{TO}/config/deploy.example.rb"
+
+# Add config/deploy.rb to .gitignore
+File.open("#{TO}/.gitignore", 'a') { |f| f.write("\nconfig/deploy.rb\n") }

data/changelog.markdown

@@ -0,0 +1,54 @@
+Version 1.2.7
+-------------
+
+* More work on Sinatra tasks
+* God init.d updates
+* Better Rakefile
+
+Version 1.2.6
+-------------
+
+* Sinatra projects should have their own config.ru present, getting rid of sinatra:install
+
+Version 1.2.5
+-------------
+
+* Removing unnecessary tmp/restart.txt touch for PHP apps
+* Fixed some of the mysql:backup tasks
+
+Version 1.2.4
+-------------
+
+* Complete EC2/Ubuntu Hardy provision and deploy tested with Rails and Sinatra
+
+Version 1.2.3
+-------------
+
+* Added bin/ubify which executes capify in addition to copying config/deploy.example.rb and adding config/deploy.rb to the project's .gitignore
+* Added mysql option in deploy.rb
+* Minor ubuntu:install fixes
+
+Version 1.2.2
+-------------
+
+* Hardened cap ec2 -> cap ubuntu -> cap ubuntu:install
+* There should be nothing to cause the user to stop and restart the tasks
+
+Version 1.2.0
+-------------
+
+* New EC2 tasks
+* EC2 setup and `cap ubuntu` provision tested
+
+Version 1.1.0
+-------------
+
+* Sinatra apps deploying properly
+* PHP and Rails apps should be deploying properly
+* `cap ubuntu` flow hardened
+
+Version 1.0.3
+-------------
+
+* `cap ubuntu` tested on Ubuntu 8.04 LTS Hardy
+* App deploying not at all tested

data/example/deploy.rb

@@ -0,0 +1,29 @@
+set :ubistrano, {
+  :application => :my_app,
+  :platform    => :rails,  # :php, :rails, :sinatra
+  :repository  => 'git@github.com:user/my-app.git',
+  
+  :ec2 => {
+    :access_key => '',
+    :secret_key => ''
+  },
+  
+  :mysql => {
+    :root_password => '',
+    :app_password  => ''
+    # Ubistrano creates a mysql user for each app
+  },
+  
+  :production => {
+    :domains => [ 'myapp.com', 'www.myapp.com' ],
+    :ssl     => [ 'myapp.com' ],
+    :host    => '127.0.0.1'
+  },
+  
+  :staging => {
+    :domains => [ 'staging.myapp.com' ],
+    :host    => '127.0.0.1'
+  }
+}
+
+require 'ubistrano'

data/gemspec.rb

@@ -0,0 +1,19 @@
+GEM_NAME = 'ubistrano'
+GEM_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.summary = "Provision and deploy to an Ubuntu/God/Apache/Passenger stack using Capistrano"
+  # == CONFIGURE ==
+  s.add_dependency('amazon-ec2', '=0.4.5')
+  s.executables << 'ubify'
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "1.2.7"
+end

data/lib/ubistrano.rb

@@ -0,0 +1,83 @@
+
+gem 'amazon-ec2', '=0.4.5'
+require 'EC2'
+require 'pp'
+
+# Require helpers and recipes
+Dir["#{File.dirname(__FILE__)}/ubistrano/*.rb"].each { |f| require f }
+
+
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  # Default capistrano/ubistrano values
+  set :ubistrano, {
+    :base_dir             => '/var/www',
+    :deploy_via           => :remote_cache,
+    :domains              => [],
+    :mysql_root_password  => '',
+    :mysql_app_password   => '',
+    :platform             => :rails,
+    :plugins              => {},
+    :port                 => 22,
+    :repository_cache     => 'git_cache',
+    :scm                  => :git,
+    :ssl                  => [],
+    :stage                => :production,
+    :use_sudo             => false,
+    :user                 => 'deploy',
+    :versions             => {}
+  }.merge(ubistrano)
+  
+  # Default plugins
+  ubistrano[:plugins] = {
+    :app_helpers     => false,
+    :asset_packager  => false,
+    :attachment_fu   => false,
+    :rails_widget    => false,
+    :thinking_sphinx => false
+  }.merge(ubistrano[:plugins])
+  
+  # Default versions
+  ubistrano[:versions] = {
+    :git            => '1.6.0.4',
+    :mysecureshell  => '1.1',
+    :rails          => '2.2.2',
+    :ruby           => '1.8.7-p72',
+    :rubygems       => '1.3.1',
+    :sphinx         => '0.9.8.1'
+  }.merge(ubistrano[:versions])
+  
+  # Merge ubistrano hash with capistrano
+  ubistrano.each do |key, value|
+    value.respond_to?(:keys) ?
+      value.each { |k, v| set "#{key}_#{k}".intern, v } :
+      set(key, value)
+  end
+  
+  # Default sources
+  set :sources, {
+    :git           => "http://kernel.org/pub/software/scm/git/git-#{versions_git}.tar.gz",
+    :mysecureshell => "http://internap.dl.sourceforge.net/sourceforge/mysecureshell/MySecureShell-#{versions_mysecureshell}_source.tgz",
+    :mysqltuner    => "http://mysqltuner.com/mysqltuner.pl",
+    :ruby          => "ftp://ftp.ruby-lang.org/pub/ruby/#{versions_ruby.split('.')[0..1].join('.')}/ruby-#{versions_ruby}.tar.gz",
+    :rubygems      => "http://rubyforge.org/frs/download.php/45905/rubygems-#{versions_rubygems}.tgz",
+    :sphinx        => "http://www.sphinxsearch.com/downloads/sphinx-#{versions_sphinx}.tar.gz"
+  }.merge(fetch(:sources, {}))
+  
+  # Events
+  on :before, 'setup_stage', :except => [ :staging, :testing ] # Executed before every task
+  after('deploy:update_code', 'rails:config:to_app'  )        if platform == :rails
+  after('deploy:update_code', 'sinatra:config:to_app')        if platform == :sinatra
+  after('deploy:update_code', 'rails:config:app_helpers')     if plugins_app_helpers
+  after('deploy:update_code', 'rails:config:asset_packager')  if plugins_asset_packager
+  after('deploy:update_code', 'rails:config:attachment_fu')   if plugins_attachment_fu
+  after('deploy:update_code', 'rails:config:rails_widget')    if plugins_rails_widget
+  after('deploy:update_code', 'rails:config:thinking_sphinx') if plugins_thinking_sphinx
+  
+  # Other options
+  ssh_options[:paranoid] = false
+  
+  # Reference ROOT when namespaces clash
+  ROOT = self
+  
+end

data/lib/ubistrano/apache.rb

@@ -0,0 +1,38 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :apache do
+    desc "Reload apache settings"
+    task :reload, :roles => :web do
+      sudo_puts "/etc/init.d/apache2 reload"
+    end
+    
+    desc "Restart apache"
+    task :restart, :roles => :web do
+      sudo_puts "/etc/init.d/apache2 restart"
+    end
+    
+    namespace :virtual_host do
+      desc "Create a new virtual host"
+      task :create, :roles => :web do
+        upload_from_erb "/etc/apache2/sites-available/#{application}_#{stage}", binding, :name => 'virtual_host', :folder => 'apache'
+      end
+      
+      desc "Enable a virtual host"
+      task :enable, :roles => :web do
+        sudo_puts "a2ensite #{application}_#{stage}"
+      end
+      
+      desc "Destroy a virtual host"
+      task :destroy, :roles => :web do
+        apache.virtual_host.disable
+        sudo_each "rm /etc/apache2/sites-available/#{application}_#{stage}"
+      end
+      
+      desc "Disable a virtual host"
+      task :disable, :roles => :web do
+        sudo_puts "a2dissite #{application}_#{stage}"
+      end
+    end
+  end
+
+end