ubistrano 1.2.7

data/lib/ubistrano/deploy.rb

@@ -0,0 +1,67 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :deploy do
+    desc "Restart application"
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      case platform
+      when :rails, :sinatra
+        run_each "touch #{current_path}/tmp/restart.txt"
+      end
+    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
+      deploy.setup
+      case platform
+      when :php
+        deploy.update
+      when :rails
+        rails.config.default
+        deploy.update
+        deploy.migrate
+      when :sinatra
+        sinatra.config.default
+        deploy.update
+      end
+      apache.virtual_host.create
+      deploy.start
+      apache.reload
+      puts space(msg(:logrotate_suggest))
+    end
+  
+    desc "Stop servers and destroy all files"
+    task :destroy, :roles => :app do
+      sudo_each "rm -Rf #{deploy_to}"
+      mysql.destroy.db
+      apache.virtual_host.destroy
+    end
+    
+    namespace :web do
+      task :disable do
+        pub = "#{deploy_to}/current/public"
+        sudo_each "mv #{pub}/maintenance.html #{pub}/index.html"
+      end
+      
+      task :enable do
+        pub = "#{deploy_to}/current/public"
+        sudo_each "mv #{pub}/index.html #{pub}/maintenance.html"
+      end
+    end
+  end
+  
+end

data/lib/ubistrano/ec2.rb

@@ -0,0 +1,113 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :ec2 do
+    desc "Set up a new EC2 instance and provision"
+    task :default, :roles => :web do
+      ec2.key_pair.install
+      ec2.instance.create
+      ec2.security.group.setup if yes("Set up the default security group? You only need to do this once.")
+      exit unless yes("Add the instance's IP address to config/deploy.rb. Continue?")
+      puts space(msg(:ec2_finished))
+    end
+    
+    namespace :instance do      
+      desc "Create a fresh Hardy instance"
+      task :create do
+        options = {
+          :image_id => ask('Press enter for Ubuntu Hardy or enter an AMI image id: ', 'ami-1c5db975'),
+          :key_name => "#{application}"
+        }
+        instance = ec2_api.run_instances(options).instancesSet.item[0]
+        instance_id = instance.instanceId
+        pp instance
+        ip = ec2_api.allocate_address.publicIp
+        ec2_api.associate_address(:instance_id => instance_id, :public_ip => ip)
+        puts "\nYour instance id is: #{instance_id}"
+        puts "Your IP address  is: #{ip}"
+      end
+      
+      desc "Restart an instance"
+      task :restart do
+        ec2.instances
+        pp ec2_api.reboot_instances(:instance_id => ask("Restart which instance ids?"))
+      end
+      
+      desc "Destroy an instance"
+      task :destroy do
+        ec2.instances
+        instance_id = ask("Terminate which instance ids?")
+        ec2_api.terminate_instances(:instance_id => instance_id)
+        ip = ec2_api.describe_addresses.addressesSet.item.select { |x| x.instanceId == instance_id }.first
+        ec2_api.release_address(:public_ip => ip.publicIp) if ip
+      end
+    end
+    
+    desc "List your EC2 instances"
+    task :instances do
+      pp ec2_api.describe_instances
+    end
+    
+    desc "List IPs for this EC2 account"
+    task :ips do
+      pp ec2_api.describe_addresses
+    end
+    
+    namespace :key_pair do
+      desc "Install key pair for SSH"
+      task :install do
+        begin
+          out = ec2_api.create_keypair(:key_name => application.to_s)
+          key = out.keyMaterial
+        rescue EC2::InvalidKeyPairDuplicate
+          ec2.key_pair.remove
+          ec2.key_pair.install
+        end
+        File.open(File.expand_path("~/.ssh/id_rsa-#{application}"), 'w') { |f| f.write key }
+      end
+
+      desc "Install key pair for SSH"
+      task :remove do
+        ec2_api.delete_keypair(:key_name => application.to_s)
+        `rm ~/.ssh/id_rsa-#{application}`
+      end
+    end
+    
+    namespace :security do
+      namespace :group do
+        desc "Open standard ports for default security group"
+        task :setup do
+          [ 22, 80, 443 ].each do |port|
+            ec2_api.authorize_security_group_ingress(
+              :group_name => 'default', :cidr_ip => '0.0.0.0/0', :from_port => port, :to_port => port, :ip_protocol => 'tcp'
+            )
+          end
+        end
+        
+        desc "Describe default security group"
+        task :describe do
+          pp ec2_api.describe_security_groups(:group_name => 'default')
+        end
+      end
+    end
+    
+    namespace :api_tools do
+      desc "Install ec2 api tools locally"
+      task :install, :roles => :web do
+        `cd ~ && curl http://s3.amazonaws.com/ec2-downloads/ec2-api-tools.zip -O`
+        `cd ~ && unzip ec2-api-tools.zip`
+        `cd ~ && rm ec2-api-tools.zip`
+        `mv ~/ec2-api-tools-* ~/.ec2`
+      end
+      
+      desc "Install ec2 api tools locally"
+      task :remove, :roles => :web do
+        `rm -Rf ~/.ec2`
+      end
+    end
+    
+    def ec2_api
+      @ec2_api ||= EC2::Base.new(:access_key_id => ec2_access_key, :secret_access_key => ec2_secret_key)
+    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,287 @@
+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 -i 's/#{from}/#{to}/' #{file}"
+  end
+  
+  def remove_line(file, *lines)
+    lines.each do |line|
+      change_line file, line, ''
+    end
+  end
+
+  def get_ssh_key(key)
+    key.gsub!('.pub', '')
+    key = File.expand_path("~/.ssh/#{key}")
+    key = Dir[key + '.pub', key].first
+    if key
+      keys = File.open(key).collect { |line| line.strip.empty? ? nil : line.strip }.compact
+      keys.join("\n")
+    else
+      nil
+    end
+  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 -f -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#{'=' * 80}\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 :add_user
+"Please ssh into your server (use -i only for EC2):
+  ssh root@#{host} -i ~/.ssh/id_rsa-#{application}
+
+Add your deploy user:
+  adduser #{user}
+
+Continue?"
+    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
+
+Continue?"
+    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 on the server?
+The public key will be displayed for adding to your GitHub account."
+    when :ec2_finished
+"All finished! Run the following commands:
+  sudo chmod 600 ~/.ssh/id_rsa-#{application}
+  cap ubuntu"
+    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_sshd
+"Would you like God to monitor sshd?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/sshd.god.erb"
+    when :god_finished
+"Please run the following commands:
+  ssh #{user}@#{host}
+  sudo /etc/init.d/god start
+  sudo /etc/init.d/god start
+
+Continue?"
+    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 :logrotate_suggest
+"All finished! Run `cap log:rotate` to add log rotating.
+"
+    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 the following commands:
+  ssh #{user}@#{host}
+  sudo passenger-install-apache2-module
+
+The apache config file is found at /etc/apache2/apache2.conf.
+Reload apache?"
+    when :run_ubuntu_install
+"Client and server configuration complete.
+
+Please run the second half of the install:
+  cap ubuntu:install
+
+"
+    when :secure_mysql
+"It is highly recommended you run mysql_secure_installation manually:
+  ssh #{user}@#{host}
+  mysql_secure_installation
+  
+See http://dev.mysql.com/doc/refman/5.1/en/mysql-secure-installation.html
+Continue?"
+    when :sinatra_install
+"Would you like to run install.rb (from your app) if it exists?"
+    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 :ssh_config
+"May I update your server's ssh_config with the following settings?
+  StrictHostKeyChecking no
+"
+    when :ubuntu_restart
+"Its probably a good idea to restart the server now.
+OK?"
+    when :ubuntu_restart_2
+"Please wait a little while for your server to restart.
+
+Continue?"
+    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
+"Would you like to upload a ssh key to the deploy user's authorized_keys?"
+    when :upload_keys_2
+"Please enter a key in ~/.ssh to copy to the the deploy user's authorized_keys."
+    when :visudo
+"Please ssh into your server (use -i only for EC2):
+  ssh root@#{host} -i ~/.ssh/id_rsa-#{application}
+
+Edit your sudoers file:
+  visudo
+
+Add the following line:
+  deploy ALL=NOPASSWD: ALL
+
+Continue?"
+    end
+  end
+  
+end