winton-ubistrano 1.2.2 → 1.2.3

data/README.markdown

@@ -1,20 +1,22 @@
 Ubistrano
 =========
 
-Provision and deploy to an Ubuntu/God/Apache/Passenger stack using Capistrano.
+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 deploy.rb file
+* Simplify the <code>deploy.rb</code> file
 
 The stack
 ---------
 
 * Apache
+* EC2 (optional)
 * Git
 * MySQL
 * MySQLTuner
@@ -37,11 +39,18 @@ Getting started
 
 	gem install winton-ubistrano
 
-### Capify your project
+### Ubify your project
 
-	capify .
+  cd your\_project
+	ubify .
 
-### Edit config/deploy.rb
+* 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, {
@@ -54,6 +63,10 @@ set :ubistrano, {
     :secret_key => ''
   },
 
+  :mysql => {
+    :password => ''
+  },
+
   :production => {
     :domains => [ 'myapp.com', 'www.myapp.com' ],
     :ssl     => [ 'myapp.com' ],
@@ -71,25 +84,50 @@ require 'ubistrano'
 
 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.
+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.
+
+Feel free to move any options into or out of the stage groups.
+
+Create your EC2 instance
+------------------------
+
+### From your app directory
+
+  cap ec2
+
+### 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>
+  cap ubuntu
 
 ### 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)
+================================================================================
+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
@@ -109,7 +147,7 @@ All apps should have a <code>public</code> directory.
 Deploy to staging
 -----------------
 
-Use any capistrano task, but replace `cap` with `cap staging`.
+Use any capistrano task, but replace <code>cap</code> with <code>cap staging</code>.
 
 ### Example
 

data/Rakefile

@@ -24,8 +24,8 @@ end
 
 # sudo rake install
 task :install do
-  `gem uninstall ubistrano`
+  `sudo gem uninstall ubistrano -x`
   `gem build ubistrano.gemspec`
-  `gem install ubistrano*.gem`
+  `sudo gem install ubistrano*.gem`
   `rm ubistrano*.gem`
 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

@@ -1,3 +1,10 @@
+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
 -------------
 

data/example/deploy.rb

@@ -8,6 +8,12 @@ set :ubistrano, {
     :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' ],

data/lib/ubistrano/deploy.rb

@@ -22,7 +22,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         "mkdir -p #{base_dir}",
         "chown -R #{user}:#{user} #{base_dir}"
       ]
-      mysql.create.db
+      mysql.create
       deploy.setup
       case platform
       when :php

data/lib/ubistrano/helpers.rb

@@ -98,8 +98,7 @@ Capistrano::Configuration.instance(:must_exist).load do
   end
 
   def mysql_call
-    @mysql_root_password = @mysql_root_password || ask("Password for mysql root:")
-    "mysql -u root --password=#{@mysql_root_password}"
+    "mysql -f -u root --password=#{mysql_root_password || ''}"
   end
 
 
@@ -197,6 +196,13 @@ See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/mysql.
     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"
@@ -209,7 +215,10 @@ See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/log/rotate.co
 "Please ssh to your server and run `sudo mysqltuner`.
 Continue?"
     when :passenger
-"Please run `sudo passenger-install-apache2-module` manually.
+"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
@@ -217,9 +226,13 @@ Reload apache?"
 
 Please run the second half of the install:
   cap ubuntu:install
+
 "
     when :secure_mysql
-"It is highly recommended you run mysql_secure_installation manually.
+"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

data/lib/ubistrano/mysql.rb

@@ -4,8 +4,8 @@ Capistrano::Configuration.instance(:must_exist).load do
     namespace :create do
       desc "Create database and user"
       task :default, :roles => :db do
-        mysql.create.db
         mysql.create.user
+        mysql.create.db
       end
       
       desc "Create database"
@@ -16,20 +16,11 @@ Capistrano::Configuration.instance(:must_exist).load do
       desc "Create database user"
       task :user, :roles => :db do
         mysql_run [
-          "CREATE USER '#{db_user}'@'localhost' IDENTIFIED BY '#{db_pass}'",
-          "GRANT ALL PRIVILEGES ON *.* TO '#{db_user}'@'localhost'"
+          "CREATE USER '#{application}'@'localhost' IDENTIFIED BY '#{mysql_password}'",
+          "GRANT ALL PRIVILEGES ON #{db_table}.* TO '#{application}'@'localhost'"
         ]
       end
     end
-    
-    namespace :update do
-      desc 'Update mysql root password'
-      task :root_password, :roles => :db do
-        old_pass = ask "Current root password? (default: none)"
-        new_pass = ask "New root password? (default: none)"
-        sudo "mysqladmin -u root #{old_pass.empty? ? '' : "--password=#{old_pass} "}password #{new_pass}"
-      end
-    end
   
     namespace :destroy do
       desc "Destroy database and user"
@@ -46,8 +37,8 @@ Capistrano::Configuration.instance(:must_exist).load do
       desc "Destroy database user"
       task :user, :roles => :db do
         mysql_run [
-          "REVOKE ALL PRIVILEGES, GRANT OPTION FROM '#{db_user}'@'localhost'",
-          "DROP USER '#{db_user}'@'localhost'"
+          "REVOKE ALL PRIVILEGES, GRANT OPTION FROM '#{application}'@'localhost'",
+          "DROP USER '#{application}'@'localhost'"
         ]
       end
     end
@@ -66,7 +57,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       
       desc "Restore remote database from backup"
       task :restore, :roles => :db do
-        run_each "bunzip2 < #{shared_path}/db_backups/#{backup_name}.bz2 | mysql -u #{db_user} --password=#{db_pass} #{db_table}"
+        run_each "bunzip2 < #{shared_path}/db_backups/#{backup_name}.bz2 | mysql -u #{application} --password=#{mysql_password} #{db_table}"
       end
       
       desc "Backup database to local"
@@ -80,7 +71,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       task :to_server, :roles => :db do
         run_each [
           "mkdir -p #{shared_path}/db_backups",
-          "mysqldump --add-drop-table -u #{db_user} -p#{db_pass} #{db_table}_production | bzip2 -c > #{shared_path}/db_backups/#{backup_name}.bz2"
+          "mysqldump --add-drop-table -u #{application} -p#{mysql_password} #{db_table}_production | bzip2 -c > #{shared_path}/db_backups/#{backup_name}.bz2"
         ]
       end
       

data/lib/ubistrano/ubuntu.rb

@@ -120,7 +120,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       task :apache, :roles => :web do
         if yes("May I install Apache?")
           sudo_puts [
-            'aptitude install apache2 apache2-mpm-prefork apache2-utils apache2.2-common libapr1 libaprutil1 ssl-cert -q -y',
+            'aptitude install apache2 apache2-mpm-prefork apache2-utils apache2.2-common libapr1 libaprutil1 ssl-cert apache2-prefork-dev -q -y',
             'a2enmod rewrite',
             'a2enmod ssl',
             'a2dissite default'
@@ -142,7 +142,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       task :mysql, :roles => :db do
         if yes("May I install MySQL?")
           sudo_puts 'aptitude install mysql-client-5.0 mysql-common mysql-server mysql-server-5.0 libmysqlclient15-dev libmysqlclient15off -q -y'
-          ROOT.mysql.create.user
+          sudo "mysqladmin -u root password #{mysql_root_password || ''}"
           exit unless yes(msg(:secure_mysql))
         end
       end
@@ -202,7 +202,6 @@ Capistrano::Configuration.instance(:must_exist).load do
           sudo_puts "aptitude install libopenssl-ruby -q -y"
           install_source(:ruby) do |path|
             sudo_puts make_install(path)
-            sudo_puts make_install(path) # install twice because openssl doesn't the first time
           end
         end
       end
@@ -220,7 +219,6 @@ Capistrano::Configuration.instance(:must_exist).load do
       desc 'Install Passenger'
       task :passenger, :roles => :app do
         if yes("May I install Passenger (mod_rails)?")
-          sudo_puts 'aptitude install apache2-prefork-dev -q -y'
           gem_install :passenger
           ROOT.apache.reload if yes(msg(:passenger))
         end
@@ -240,9 +238,9 @@ Capistrano::Configuration.instance(:must_exist).load do
           upload_from_erb('/usr/local/etc/god/mysql.god',  binding, :folder => 'ubuntu') if yes(msg(:god_mysql))
           upload_from_erb('/usr/local/etc/god/sshd.god',   binding, :folder => 'ubuntu') if yes(msg(:god_sshd))
           sudo_puts [
-            'update-rc.d god defaults',
-            '/etc/init.d/god start'
+            'update-rc.d god defaults'
           ]
+          exit unless yes(msg(:god_finished))
         end
       end
       

data/lib/ubistrano.rb

@@ -10,21 +10,21 @@ Capistrano::Configuration.instance(:must_exist).load do
   
   # Default capistrano/ubistrano values
   set :ubistrano, {
-    :base_dir         => '/var/www',
-    :db_user          => 'app',
-    :db_pass          => '',
-    :deploy_via       => :remote_cache,
-    :domains          => [],
-    :platform         => :rails,
-    :plugins          => {},
-    :port             => 22,
-    :repository_cache => 'git_cache',
-    :scm              => :git,
-    :ssl              => [],
-    :stage            => :production,
-    :use_sudo         => false,
-    :user             => 'deploy',
-    :versions         => {}
+    :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

data/templates/rails/database.yml.erb

@@ -1,8 +1,8 @@
 development: &defaults
   adapter: mysql
   database: <%= db_table %>
-  username: <%= db_user %>
-  password: <%= db_pass %>
+  username: <%= user %>
+  password: <%= mysql_password %>
   host: localhost
   socket: /var/run/mysqld/mysqld.sock
 

data/ubistrano.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = 'ubistrano'
-  s.version = '1.2.2'
+  s.version = '1.2.3'
   s.date    = '2008-02-22'
   
   s.summary     = "Provision and deploy to an Ubuntu/God/Apache/Passenger stack using Capistrano"
@@ -10,14 +10,16 @@ Gem::Specification.new do |s|
   s.email    = 'mail@wintoni.us'
   s.homepage = 'http://github.com/winton/ubistrano'
   
-  s.has_rdoc = false
   s.add_dependency 'amazon-ec2', '>= 0.3.2'
+  s.executables = ["ubify"]
+  s.has_rdoc = false
   
   # = MANIFEST =
   s.files = %w[
     MIT-LICENSE
     README.markdown
     Rakefile
+    bin/ubify
     changelog.markdown
     example/deploy.rb
     lib/ubistrano.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: winton-ubistrano
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors: 
 - Winton Welsh
@@ -24,8 +24,8 @@ dependencies:
     version: 
 description: Provision and deploy to an Ubuntu/God/Apache/Passenger stack using Capistrano
 email: mail@wintoni.us
-executables: []
-
+executables: 
+- ubify
 extensions: []
 
 extra_rdoc_files: []
@@ -34,6 +34,7 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
+- bin/ubify
 - changelog.markdown
 - example/deploy.rb
 - lib/ubistrano.rb