brightbox 0.25 → 2.0.1

data/lib/brightbox/recipes/callbacks.rb

@@ -0,0 +1,48 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+# Hook tasks into the standard deployment system
+
+after "deploy:setup",
+  "deploy:shared:local:setup",
+  "configure:logrotation",
+  "configure:monit",
+  "configure:mongrel",
+  "configure:apache",
+  "configure:nginx"
+
+after "deploy:cold",
+  "deploy:monit:reload"
+
+after "deploy:finalize_update",
+  "deploy:shared:local:symlink",
+  "gems:install"
+
+after "deploy:update",
+  "deploy:cleanup"
+
+before "deploy:migrate",
+  "db:check:config",
+  "db:create"
+
+after "deploy:start",
+  "deploy:web:reload_if_new"
+
+after "deploy:restart",
+  "deploy:web:reload_if_new"

data/lib/brightbox/recipes/configure.rb

@@ -0,0 +1,178 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+
+def monit_setup
+  "/usr/bin/railsapp-monit"
+end
+depend :remote, :command, monit_setup
+
+def apache_setup
+  "/usr/bin/railsapp-apache"
+end
+depend :remote, :command, apache_setup
+
+def nginx_setup
+  "/usr/bin/railsapp-nginx"
+end
+depend :remote, :command, nginx_setup
+
+def mongrel_setup
+  "/usr/bin/railsapp-mongrel"
+end
+depend :remote, :command, mongrel_setup
+
+def logrotate_setup
+  "/usr/bin/railsapp-logrotate"
+end
+depend :remote, :command, logrotate_setup
+
+def mysql_setup
+  "/usr/bin/railsapp-check"
+end
+depend :remote, :command, mysql_setup
+
+namespace :configure do
+
+[:nginx, :apache].each do |webserver|
+  desc %Q{
+  [internal]Create #{webserver.to_s} config. Creates a load balancing virtual host \
+  configuration based upon your specified settings
+
+    :application      Name of the application
+    :domain           Domain name which will point to the application
+    :domain_aliases   Comma separated list of aliased for the main domain
+    :mongrel_host     Name of application layer host (default localhost)
+    :mongrel_port     Start port of the mongrel cluster (default 8000)
+    :mongrel_servers  Number of servers on app host (default 2)
+    :ssl_certificate  Create SSL configuration with certificate
+    :ssl_key          Name of private key to use with certificate
+
+  }
+  task webserver, :roles => :web, :except => {:no_release => true} do
+    sudo on_one_line( <<-END
+        #{send(webserver.to_s + "_setup")}
+        -n #{application}
+        -d #{domain}
+        #{'-a '+domain_aliases if domain_aliases}
+        -w #{File.join(current_path, 'public')}
+        -h #{mongrel_host}
+        -p #{mongrel_port}
+        -s #{mongrel_servers}
+        #{'-c '+ssl_certificate if ssl_certificate} 
+        #{'-k '+ssl_key if ssl_key}
+    END
+        )
+  end
+end
+
+  desc %Q{
+  [internal]Create Mongrel config. Creates a set of mongrels running \
+  on the specified ports of the application server(s).
+
+    :application      Name of the application
+    :mongrel_host     Name of application layer host (default localhost)
+    :mongrel_port     Start port of the mongrel cluster (default 8000)
+    :mongrel_servers  Number of servers on app host (default 2)
+    :mongrel_pid_file The name of the file containing the mongrel PID 
+
+  }
+  task :mongrel, :roles => :app, :except => {:no_release => true} do
+    sudo on_one_line( <<-END
+        #{mongrel_setup}
+        -n #{application}
+        -r #{current_path}
+        -p #{mongrel_port}
+        -s #{mongrel_servers}
+        -h #{mongrel_host}
+        -C #{mongrel_config_file}
+        -P #{mongrel_pid_file}
+    END
+        )
+  end
+
+  desc %Q{
+  [internal]Create Monit config. Build a monit configuraton file \
+  to look after this application
+
+    :application      Name of the application
+    :mongrel_host     Name of application layer host (default localhost)
+    :mongrel_port     Start port of the mongrel cluster (default 8000)
+    :mongrel_servers  Number of servers on app host (default 2)
+
+  }
+  task :monit, :except => {:no_release => true} do
+    sudo on_one_line( <<-END
+        #{monit_setup}
+        -n #{application}
+        -u #{user}
+        -r #{current_path}
+        -h #{mongrel_host}
+        -p #{mongrel_port}
+        -s #{mongrel_servers}
+        -C #{mongrel_config_file}
+        -P #{mongrel_pid_file}
+    END
+        )
+  end
+
+  desc %Q{
+  [internal]Create logrotation config. Build a logrotate configuraton file \
+  so that logrotate will look after the log files.
+
+    :application      Name of the application
+    :log_max_size     Rotate when log reaches this size
+    :log_keep         Number of compressed logs to keep
+
+  }
+  task :logrotation, :roles => :app, :except => {:no_release => true} do
+    sudo on_one_line( <<-END
+        #{logrotate_setup}
+        -n #{application}
+        -l #{log_dir}
+        -s #{log_max_size}
+        -k #{log_keep}
+    END
+        )
+  end
+
+  desc %Q{
+  [internal]Run the check command if this application hasn't been
+  deployed yet
+  }
+  task :check, :except => {:no_release => true} do
+    begin
+      deploy.check unless releases.length > 0
+    rescue
+      puts "Error detected. Have you run 'cap deploy:setup'?"
+      raise
+    ensure
+      reset! :releases
+    end
+  end
+
+  desc %Q{
+  [internal]Check the current database.yml file and update the 
+  details from the .my.cnf file on the server if it exists.
+  }
+  task :mysql, :roles => :db, :only => {:primary => true} do
+    try_sudo "#{mysql_setup} -n #{application} #{latest_release}/config/database.yml"
+  end
+
+end

data/lib/brightbox/recipes/database.rb

@@ -0,0 +1,40 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+
+namespace :db do
+
+  desc %Q{
+  [internal]Create the database if it doesn't exist
+  }
+  task :create, :roles => :db, :only => { :primary => true } do
+    run rake_task("db:create")
+  end
+
+  namespace :check do
+    desc %Q{
+    [internal]Check the database configuration to make sure that
+    it conforms to the Brightbox standard
+    }
+    task :config, :roles => :db, :only => {:primary => true} do
+      run rake_task("db:check:config")
+    end
+  end
+
+end

data/lib/brightbox/recipes/deploy.rb

@@ -0,0 +1,81 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+# Override standard tasks that don't do what we want
+
+namespace :deploy do
+
+  def mongrel_command
+    "/usr/bin/mongrel_rails"
+  end
+  depend :remote, :command, mongrel_command
+
+  def monit_command
+    "/usr/sbin/monit"
+  end
+  depend :remote, :command, monit_command
+
+  #Override start, stop and restart so that they use Monit to restart the
+  #application servers
+  %W(start stop restart status).each do |event|
+    desc "Ask mongrel to #{event} your application."
+    task event, :roles => :app, :except => {:no_release => true } do
+      try_sudo "#{mongrel_command} cluster::#{event} -C #{mongrel_config_file} --clean"
+    end
+  end
+
+  namespace :web do
+
+    desc %Q{
+      Reload the apache webserver
+    }
+    task :reload, :roles => :web, :except => {:no_release => true } do
+      sudo "/usr/sbin/invoke-rc.d apache2 reload"
+    end
+
+    desc %Q{
+    [internal]reload web server if first release
+    }
+    task :reload_if_new, :roles => :web, :except => {:no_release => true} do
+      reset! :releases
+      reload if releases.length == 1
+    end
+
+  end
+
+  namespace :monit do
+
+    desc %Q{
+      Reload monit
+    }
+    task :reload do
+      sudo "#{monit_command} reload"
+    end
+
+  end
+
+  desc %Q{Setup the directories and deploy the initial version of the
+  application
+  }
+  task :initial do
+    setup
+    cold
+  end
+
+end

data/lib/brightbox/recipes/gems.rb

@@ -0,0 +1,30 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+
+namespace :gems do
+
+  desc %Q{
+  [internal]Run the gems install task in the application.
+  }
+  task :install, :roles => :app do
+    sudo rake_task("gems:install")
+  end
+
+end

data/lib/brightbox/recipes/helpers.rb

@@ -0,0 +1,33 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+def rake_task(taskname)
+  rake = fetch(:rake, "rake")
+  rails_env = fetch(:rails_env, "production")
+  rake_env = fetch(:rake_env, "")
+  directory = current_release 
+
+  "cd #{directory}; #{rake} RAILS_ENV=#{rails_env} #{rake_env} #{taskname}"
+end
+
+def on_one_line(cmd_list)
+  cmd_list.gsub!(/\n/m, ' ')
+end
+
+

data/lib/brightbox/recipes/shared_local.rb

@@ -0,0 +1,68 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+# Manage the local shared area
+
+namespace :deploy do
+  namespace :shared do
+    namespace :local do
+
+      desc %Q(
+      [internal] Creates shared directories. This is called by the setup 
+      routine to create the directory structure within the shared area. It
+      references two arrays.
+
+       :local_shared_files - the list of files that should be shared
+       between releases.
+       :local_shared_dirs  - the list of directories that should be
+       shared between releases.
+      )
+      task :setup, :except => {:no_release => true} do
+        dirs = local_shared_files.collect do |file|
+          File.join(shared_path, File.dirname(file))
+        end
+        dirs += local_shared_dirs.collect do |dir|
+          File.join(shared_path, dir)
+        end
+        try_sudo "umask 02 && mkdir -p #{dirs.join(' ')}" unless dirs.empty?
+      end
+    
+      desc %Q{
+      [internal] Sets up the symlinks between the latest release and all
+      the shared items described in :local_shared_dirs and
+      :local_shared_files
+      }
+      task :symlink, :except => {:no_release => true} do
+        resources = local_shared_dirs+local_shared_files
+        run %Q{
+          cd #{latest_release} &&
+          rm -rf #{resources.join(' ')} 
+        }
+        links = resources.collect do |resource|
+          "ln -sf #{File.join(shared_path,resource)} #{File.join(latest_release, resource)}"
+        end.join(" && ")
+        run links unless links.empty?
+      end
+
+    end
+  end
+end
+
+
+