AppTower-ubistrano 1.0.2

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,110 @@
+Ubistrano
+=========
+
+Provision and deploy to an Ubuntu/God/Apache/Passenger stack using Capistrano.
+
+Goals
+-----
+
+* 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 deploy.rb file
+
+The stack
+---------
+
+* Apache
+* Git
+* MySQL
+* MySQLTuner
+* Perl
+* PHP
+* Postfix (relay)
+* Ruby
+* RubyGems
+* Passenger (mod\_rails)
+* God
+* Rails
+* Sinatra
+* Sphinx
+
+
+Getting started
+---------------
+
+### Install gem
+
+	gem install AppTower-ubistrano
+
+### Capify your project
+
+	capify .
+
+### Edit config/deploy.rb
+
+<pre>
+set :ubistrano, {
+  :application  => :my_app,
+  :platform     => :rails,  # :php, :rails, :sinatra
+  :repository   => 'git@github.com:user/my-app.git',
+  
+  :production => {
+    :domain => [ 'myapp.com', 'www.myapp.com' ],
+    :host   => '127.0.0.1'
+  },
+  
+  :staging => {
+    :domain => '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.
+
+Feel free to add standard options like :user to the stage groups.
+
+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.
+
+=================================================================================
+Have you already created the user defined in deploy.rb? (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 `cap` with `cap staging`.
+
+### Example
+
+	cap staging deploy:first

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+
+task :default => 'ubistrano.gemspec'
+
+file 'ubistrano.gemspec' => FileList['{example,lib,templates}/**','Rakefile'] do |f|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  parts = spec.split("  # = MANIFEST =\n")
+  fail 'bad spec' if parts.length != 3
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write...
+  parts[1] = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = parts.join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "Updated #{f.name}"
+end

data/changelog.rdoc

@@ -0,0 +1,25 @@
+
+Version 2.0.0
+  * Tested on Ubuntu 8.04 LTS Hardy
+  * Deploys PHP, Rails, and Sinatra apps
+  * Redux version with new stack
+  * Apache
+  * Git
+  * God
+  * MySQL
+  * Passenger (mod_rails)
+  * Rails
+  * Ruby Enterprise Edition
+  
+Version 1.1.0
+  * Tested on Debian Etch
+  * Git
+  * Nginx
+  * Mongrel cluster
+  * Monit
+  * MySQL
+  * PHP (Nginx w/ spawn-fcgi)
+  * Rails
+  * Ruby
+  * RubyGems
+  * Sphinx

data/example/deploy.rb

@@ -0,0 +1,17 @@
+set :ubistrano, {
+  :application  => :my_app,
+  :platform     => :rails,  # :php, :rails, :sinatra
+  :repository   => 'git@github.com:user/my-app.git',
+  
+  :production => {
+    :domain => [ 'myapp.com', 'www.myapp.com' ],
+    :host   => '127.0.0.1'
+  },
+  
+  :staging => {
+    :domain => 'staging.myapp.com',
+    :host   => '127.0.0.1'
+  }
+}
+
+require 'ubistrano'

data/lib/ubistrano.rb

@@ -0,0 +1,71 @@
+
+# Require helpers and recipes
+Dir["#{File.dirname(__FILE__)}/ubistrano/*.rb"].each { |f| require f }
+
+
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  # Reference ROOT when namespaces clash
+  ROOT = self
+  
+  # Default package versions
+  ubistrano[:versions] ||= {}
+  ubistrano[:versions].merge!(
+    :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 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
+  
+  # Set default capistrano values
+  set :db_user,   fetch(:db_user,   'app')
+  set :db_pass,   fetch(:db_pass,   '')
+  set :platform,  fetch(:platform,  :rails)
+  set :port,      fetch(:port,      22)
+  set :stage,     fetch(:stage,     :production)
+  set :use_sudo,  fetch(:use_sudo,  false)
+  set :user,      fetch(:user,      'deploy')
+  set :sources,   fetch(: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"
+  })
+  
+  # Rails plugins
+  set :app_helpers,     fetch(:app_helpers,     false)
+  set :rails_widget,    fetch(:rails_widget,    false)
+  set :ultrasphinx,     fetch(:ultrasphinx,     false)
+  set :thinking_sphinx, fetch(:thinking_sphinx, false)
+  set :attachment_fu,   fetch(:attachment_fu,   false)
+  set :asset_packager,  fetch(:asset_packager,  false)
+  after('deploy:update_code', 'rails:config:app_helpers')     if app_helpers
+  after('deploy:update_code', 'rails:config:asset_packager')  if asset_packager
+  after('deploy:update_code', 'rails:config:attachment_fu')   if attachment_fu
+  after('deploy:update_code', 'rails:config:rails_widget')    if rails_widget
+  after('deploy:update_code', 'rails:config:ultrasphinx')     if ultrasphinx
+  after('deploy:update_code', 'rails:config:thinking_sphinx') if thinking_sphinx
+    
+  # Git by default
+  set :scm,              :git
+  set :deploy_via,       :remote_cache
+  set :repository_cache, 'git_cache'
+  ssh_options[:paranoid] = false
+
+  # 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
+  
+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 => 'ubuntu'
+      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

data/lib/ubistrano/deploy.rb

@@ -0,0 +1,52 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :deploy do
+    desc "Restart application"
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run_each [
+        "mkdir #{current_path}/tmp",
+        "touch #{current_path}/tmp/restart.txt"
+      ]
+    end
+
+    desc "Start application"
+    task :start, :roles => :app do
+      apache.virtual_host.enable
+    end
+
+    desc "Stop application"
+    task :stop, :roles => :app do
+      apache.virtual_host.disable
+    end
+    
+    desc "Deploy for the first time"
+    task :first, :roles => :app do
+      sudo_each [
+        "mkdir -p #{base_dir}",
+        "chown -R #{user}:#{user} #{base_dir}"
+      ]
+      mysql.create.db
+      deploy.setup
+      deploy.update
+      apache.virtual_host.create
+      case platform
+      when :rails
+        rails.config.default
+        deploy.migrate
+      when :sinatra
+        sinatra.config.default
+        sinatra.install
+      end
+      deploy.start
+      apache.reload
+    end
+  
+    desc "Stop servers and destroy all files"
+    task :destroy, :roles => :app do
+      deploy.stop
+      sudo "rm -Rf #{deploy_to}"
+      mysql.destroy.db
+    end
+  end
+  
+end

data/lib/ubistrano/gems.rb

@@ -0,0 +1,29 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :gems do  
+    desc "List gems on remote server"
+    task :list, :roles => :app do
+      run_puts "gem list"
+    end
+    
+    desc "Update gems on remote server"
+    task :update, :roles => :app do
+      sudo_each [
+        "gem update --system",
+        "gem update"
+      ]
+    end
+    
+    desc "Install a remote gem"
+    task :install, :roles => :app do
+      gem_install ask('Enter the name of the gem to install:')
+    end
+    
+    desc "Uninstall a remote gem"
+    task :uninstall, :roles => :app do
+      gem_name = ask 'Enter the name of the gem to remove:'
+      sudo "gem uninstall #{gem_name}"
+    end
+  end
+
+end

data/lib/ubistrano/helpers.rb

@@ -0,0 +1,237 @@
+require 'erb'
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  # Install
+
+  def gem_install(name, options='')
+    sudo_puts "gem install #{name} #{options} --no-rdoc --no-ri -q"
+  end
+  
+  def install_source(source)
+    path, source = unpack_source source
+    yield path
+    sudo "rm -Rf #{source}"
+  end
+  
+  def make_install(path)
+    ";cd #{path} && ./configure && make && sudo make install"
+  end
+
+  def unpack_source(source)
+    url  = sources[source]
+    name = File.basename url
+    src  = "/home/#{user}/sources"
+    base = nil
+    [ 'tar.gz', 'tgz' ].each do |ext|
+      base = name[0..((ext.length + 2) * -1)] if name.include?(ext)
+    end
+    run_each [
+      "mkdir -p #{src}",
+      "cd #{src} && wget --quiet #{url}",
+      "tar -xzvf #{src}/#{name} -C #{src}"
+    ]
+    [ "#{src}/#{base}", src ]
+  end
+
+
+  # Files
+  
+  def add_line(file, *lines)
+    lines.each do |line|
+      sudo_each "echo \"#{line}\" | sudo tee -a #{file}"
+    end
+  end
+  
+  def change_line(file, from, to)
+    sudo_each "sed 's/#{from}/#{to}/' #{file}"
+  end
+  
+  def remove_line(file, *lines)
+    lines.each do |line|
+      change_line file, line, ''
+    end
+  end
+
+  def get_ssh_keys
+    keys = Dir[File.expand_path('~/.ssh/*.pub')].collect do |f|
+      File.open(f).collect { |line| line.strip.empty? ? nil : line.strip }.compact
+    end
+    keys.flatten.join("\n").strip
+  end
+
+  def upload_from_erb(destination, bind=nil, options={})
+    # options[ :chown  => owner of file (default: deploy user),
+    #          :chmod  => 0644 etc
+    #          :folder => 'postfix' etc,
+    #          :name   => name of template if differs from destination ]
+    if destination.respond_to?(:uniq)
+      destination.each { |d| upload_from_erb d, bind, options }
+    else
+      template = File.basename destination
+      template = template[1..-1] if template[0..0] == '.'
+      folder   = options[:folder] ? options[:folder] + '/' : ''
+      template = File.expand_path("../../templates/#{folder}#{options[:name]||template}.erb", File.dirname(__FILE__))
+      template = File.read template
+      sudo "touch #{destination}"
+      sudo "chown #{user} #{destination}"
+      put ERB.new(template).result(bind || binding), destination
+      sudo("chown #{options[:chown]} #{destination}") if options[:chown]
+      sudo("chmod #{options[:chmod]} #{destination}") if options[:chmod]
+    end
+  end
+
+
+  # MySQL
+
+  def mysql_run(sql)
+    if sql.respond_to?(:uniq)
+      sql.each { |s| mysql_run s }
+    else
+      run "echo \"#{sql}\" | #{mysql_call}"
+    end
+  end
+
+  def mysql_call
+    @mysql_root_password = @mysql_root_password || ask("Password for mysql root:")
+    "mysql -u root --password=#{@mysql_root_password}"
+  end
+
+
+  # Questions
+
+  def ask(question, default='')
+    question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+    answer = Capistrano::CLI.ui.ask(space(question)).strip
+    answer.empty? ? default : answer
+  end
+
+  def yes(question)
+    question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+    question += ' (y/n)'
+    ask(question).downcase.include? 'y'
+  end
+  
+  def space(str)
+    "\n#{'=' * 90}\n#{str}"
+  end
+
+
+  # Runners
+
+  def run_each(*args, &block)
+    cmd  = args[0]
+    sudo = args[1]
+    if cmd.respond_to?(:uniq)
+      cmd.each  { |c| run_each c, sudo, &block }
+    elsif sudo
+      puts space("sudo #{cmd}")
+      sudo(cmd) { |ch, st, data| block.call(data) if block }
+    else
+      puts space(cmd)
+      run(cmd)  { |ch, st, data| block.call(data) if block }
+    end
+  end
+
+  def sudo_each(cmds, &block)
+    run_each cmds, true, &block
+  end
+
+  def run_puts(cmds, &block)
+    run_each(cmds) { |data| puts data }
+  end
+
+  def sudo_puts(cmds, &block)
+    sudo_each(cmds) { |data| puts data }
+  end
+
+
+  # Messages
+
+  def msg(type)
+    case type
+    when :about_templates
+"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."
+    when :aptitude_default
+"Do you want me to run aptitude update, upgrade, and install build-essential?
+If not, instructions for doing it manually will be displayed."
+    when :aptitude_instructions
+"Please run these manually:
+  sudo aptitude update
+  sudo aptitude upgrade
+  sudo aptitude build-essential"
+    when :create_keys
+"May I generate an rsa ssh key pair in your ~/.ssh folder?"
+    when :create_server_keys
+"May I generate an rsa ssh key pair in the server's ~/.ssh folder?
+The public key will be displayed."
+    when :god
+"May I install God?" 
+    when :god_apache
+"Would you like God to monitor apache?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/apache.god.erb"
+    when :god_mysql
+"Would you like God to monitor mysql?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/mysql.god.erb"
+    when :god_apache
+"Would you like God to monitor sshd?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/sshd.god.erb"
+    when :have_keys
+"Do you have rsa key pairs installed on your system? (see ~/.ssh/id_rsa)"
+    when :iptables
+"May I update your server's iptables, limiting access to SSH, HTTP, HTTPS, and ping only?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/iptables.rules.erb"
+    when :logrotate
+"May I add a logrotate entry for this application?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/log/rotate.conf.erb"
+    when :mysqltuner
+"Would you like to install MySQLTuner and receive instructions for running it?"
+    when :mysqltuner_instructions
+"Please ssh to your server and run `sudo mysqltuner`.
+Continue?"
+    when :passenger
+"Please run `sudo passenger-install-apache2-module` manually.
+The apache config file is found at /etc/apache2/apache2.conf.
+Reload apache?"
+    when :secure_mysql
+"It is highly recommended you run mysql_secure_installation manually.
+See http://dev.mysql.com/doc/refman/5.1/en/mysql-secure-installation.html
+Continue?"
+    when :ssh_keys_create
+"Create rsa ssh key pairs locally or remotely? (default: remote)"
+    when :ssh_keys_upload
+"Press enter to copy all public keys (~/.ssh/*.pub), or paste a key: "
+    when :sshd_config
+"May I update your server's sshd_config with the following settings?
+  Port #{port}
+  PermitRootLogin no
+  X11Forwarding no
+  UsePAM no
+  UseDNS no
+"
+    when :sudoers
+"May I add sudo-without-password privileges for the deploy user?
+I will have to edit /etc/sudoers."
+    when :ubuntu_restart
+"Would you like to restart the server now?"
+    when :ubuntu_finished
+"That's it! Glad you made it.
+
+Use `cap deploy:first` to set up your PHP, Rails, or Sinatra app.
+Use `cap deploy` for all subsequent deploys.
+
+"
+    when :upload_keys
+"May I copy all of your public keys in ~/.ssh to the server's authorized_keys?"
+    when :visudo
+"Please run the following commands:
+ssh root@#{host}:#{port}
+adduser #{user}
+
+"
+    end
+  end
+  
+end