fpauser-vlad 2.2.0

data/doco/migration.txt

@@ -0,0 +1,43 @@
+== Converting from Capistrano
+
+* 'set scm' is removed. Vlad.load :scm => :something if you don't use subversion.
+* 'task' blocks are renamed to 'remote_task'.
+* Most variables are the same. See variables.txt for details.
+* No +with_command+ / +sudo+ / +via+ wonkiness
+* Uses real ssh so env vars and the like are not a problem
+  - no +with_env+ as a result.
+* Vlad doesn't use ':no_release' or ':primary'.
+  - If you have a task that needs to run on only one host from a role,
+    you should declare a new role for that host:
+
+      role :master_db, "master.example.com"
+
+    ..and then override the role for the task you want to limit:
+
+      Rake::Task["mytask"].options[:roles] = :master_db
+
+* The 'host' method can be used to consolidate multiple 'role' calls.
+  - host "www.example.com", :app, :web, :db
+    specifies a host with three roles.
+* migrate_env is now migrate_args.
+* Vlad doesn't have before/after magic add-on tasks.
+
+== BEFORE:
+
+  set :application, "rubyholic"
+  set :domain,      "zenspider.textdriven.com"
+  set :repository,  "svn://svn.example.com/rubyholic/branches/stable"
+  set :deploy_to,   "/users/home/zenspider/domains/new.rubyholic.com"
+  
+  set :user,        "zenspider"
+  set :use_sudo,    false
+  
+  role :web, domain
+  role :app, domain
+  role :db,  domain, :primary => true
+
+== AFTER:
+
+  set :domain,      "zenspider.textdriven.com"
+  set :repository,  "svn://svn.example.com/rubyholic/branches/stable"
+  set :deploy_to,   "/users/home/zenspider/domains/new.rubyholic.com"

data/doco/perforce.txt

@@ -0,0 +1,5 @@
+# Using Perforce
+
+TODO: write real doco.
+
+Set up a .p4config file and put it in the client's scm directories.

data/doco/variables.txt

@@ -0,0 +1,79 @@
+
+== Core Variables
+
+repository::           REQUIRED: Repository path: e.g. http://repo.example.com/svn
+deploy_to::            REQUIRED: Deploy path on target machines. e.g. /var/www/app
+domain::               REQUIRED: Used for the common case of a single target
+                       server. e.g. example.com
+current_path::         The full path on the remote host that will be symlinked
+                       as 'current'. Defaults to "#{deploy_to}/current".
+current_release::      The full path to the current release's actual location.
+                       Defaults to "#{releases_path}/#{releases.last}".
+deploy_timestamped::   Create timestamped release directories instead of using
+                       revision numbers. Defaults to true.
+deploy_via::           Which SCM command should be used when deploying the app.
+                       Defaults to "export".
+latest_release::       The most recent release, which may not yet have been
+                       symlinked. Defaults to release_path.
+migrate_args::         Set this to change the RAILS_ENV that 'rake db:migrate'
+                       will run under. Defaults to "".
+migrate_target::       Set this if you need to specify a particular migration
+                       'VERSION' number. Defaults to "latest".
+rails_env::            Specifies the RAILS_ENV environment variable that will
+                       be used. Defaults to "production".
+rake_cmd::             Set this if you need to specify an alternate path to
+                       'rake'. Defaults to "rake".
+release_name::         Name of the release directory, if deploy_timestamped is
+                       true. Defaults to timestamp: "YYYYMMDDHHMMSS".
+release_path::         Path to this release, which may not have been created
+                       yet. Defaults to "#{releases_path}/#{release_name}".
+releases::             An array of all existing releases, oldest first.
+                       Defaults to latest release directory name.
+releases_path::        Full path to the 'releases' directory on the remote host.
+                       Defaults to "#{deploy_to}/releases".
+revision::             Revision to use for release. Defaults to 'head'.
+rsync_cmd::            Path to rsync command. Defaults to "rsync".
+rsync_flags::          Flags for rsync. Defaults to ['-azP', '--delete'].
+scm_path::             Path on the remote host that will be used as 'working
+                       space' for SCM tasks. Defaults to "#{deploy_to}/scm".
+shared_path::          Full path to remote 'shared' directory, symlinked into
+                       your app by default. Defaults to "#{deploy_to}/shared".
+ssh_cmd::              Path to ssh. Defaults to "ssh".
+ssh_flags::            Flags for ssh. Defaults to [].
+sudo_cmd::             Path to sudo command. Defaults to "sudo".
+sudo_flags::           Flogs for sudo. Defaults to ["-p Password:"].
+sudo_prompt::          Regexp for sudo password prompt. Defaults to /^Password:/.
+sudo_password::        Asks for password when referenced.
+umask::                Sets your umask value. Defaults to "02".
+
+== Apache Web Variables:
+
+web_command::          Command to execute when controlling the web server.
+                       Defaults to "apachectl".
+
+== Mongrel App Variables:
+
+mongrel_address::       Defaults to "127.0.0.1"
+mongrel_clean::         Defaults to false
+mongrel_command::       Defaults to 'mongrel_rails'
+mongrel_conf::          Defaults to "#{shared_path}/mongrel_cluster.conf"
+mongrel_config_script:: Defaults to nil
+mongrel_environment::   Defaults to "production"
+mongrel_group::         Defaults to nil
+mongrel_log_file::      Defaults to nil
+mongrel_pid_file::      Defaults to nil
+mongrel_port::          Defaults to 8000
+mongrel_prefix::        Defaults to nil
+mongrel_servers::       Defaults to 2
+mongrel_user::          Defaults to nil
+
+== Perforce SCM Variables:
+
+p4_cmd::                The perforce command to use. Defaults to "p4"
+source::                A perforce SCM worker instance.
+
+== Subversion SCM Variables:
+
+source::                A subversion SCM worker instance.
+svn_cmd::               The subversion command to use. Defaults to "svn"
+

data/lib/vlad.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'thread'
+require 'rake/remote_task'
+
+$TESTING ||= false
+
+##
+# Vlad the Deployer - Pragmatic application deployment automation,
+# without mercy.
+#
+# Please read doco/getting_started.txt or http://rubyhitsquad.com/
+#
+# === Basic scenario:
+#
+# 1. rake vlad:setup   (first time only)
+# 2. rake vlad:update
+# 3. rake vlad:migrate (optional)
+# 4. rake vlad:start
+
+module Vlad
+
+  ##
+  # This is the version of Vlad you are running.
+  VERSION = '2.2.0'
+
+  ##
+  # Loads tasks file +tasks_file+ and various recipe styles as a hash
+  # of category/style pairs. Recipes default to:
+  #
+  #     :app    => :passenger
+  #     :config => 'config/deploy.rb'
+  #     :core   => :core
+  #     :scm    => :subversion
+  #     :web    => :apache
+  #
+  # You can override individual values and/or set to nil to
+  # deactivate. :config will get loaded last to ensure that user
+  # variables override default values.
+  #
+  # And by all means, feel free to skip this entirely if it doesn't
+  # fit for you. All it does is a fancy-pants require. Require
+  # whatever files you need as you see fit straight from your
+  # Rakefile. YAY for simple and clean!
+
+  def self.load options = {}
+    options = {:config => options} if String === options
+    order = [:core, :type, :app, :config, :scm, :web]
+    order += options.keys - order
+
+    recipes = {
+      :app    => :passenger,
+      :type   => :rails,
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :subversion,
+      :web    => :apache,
+    }.merge(options)
+
+    order.each do |flavor|
+      recipe = recipes[flavor]
+      next if recipe.nil? or flavor == :config
+      require "vlad/#{recipe}"
+    end
+
+    Kernel.load recipes[:config]
+    Kernel.load "config/deploy_#{ENV['to']}.rb" if ENV['to']
+  end
+end
+
+class String #:nodoc:
+  def cleanup
+    if ENV['FULL'] then
+      gsub(/\s+/, ' ').strip
+    else
+      self[/\A.*?\./]
+    end
+  end
+end

data/lib/vlad/apache.rb

@@ -0,0 +1,37 @@
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Apache web server
+
+  set :web_command, "apachectl"
+
+  desc "(Re)Start the web servers"
+
+  remote_task :start_web, :roles => :web  do
+    run "#{web_command} restart"
+  end
+
+  desc "Stop the web servers"
+
+  remote_task :stop_web, :roles => :web  do
+    run "#{web_command} stop"
+  end
+
+  ##
+  # Everything HTTP.
+
+  desc "(Re)Start the web and app servers"
+
+  remote_task :start do
+    Rake::Task['vlad:start_app'].invoke
+    Rake::Task['vlad:start_web'].invoke
+  end
+
+  desc "Stop the web and app servers"
+
+  remote_task :stop do
+    Rake::Task['vlad:stop_app'].invoke
+    Rake::Task['vlad:stop_web'].invoke
+  end
+end

data/lib/vlad/core.rb

@@ -0,0 +1,195 @@
+require 'vlad'
+
+##
+# used by update, out here so we can ensure all threads have the same value
+def now
+  @now ||= Time.now.utc.strftime("%Y%m%d%H%M.%S")
+end
+
+namespace :vlad do
+  desc "Show the vlad setup.  This is all the default variables for vlad
+    tasks.".cleanup
+
+  task :debug do
+    require 'yaml'
+
+    # force them into values
+    Rake::RemoteTask.env.keys.each do |key|
+      next if key =~ /_release|releases|sudo_password/
+      Rake::RemoteTask.fetch key
+    end
+
+    puts "# Environment:"
+    puts
+    y Rake::RemoteTask.env
+    puts "# Roles:"
+    y Rake::RemoteTask.roles
+  end
+
+  desc "Setup your servers. Before you can use any of the deployment
+    tasks with your project, you will need to make sure all of your
+    servers have been prepared with 'rake vlad:setup'. It is safe to
+    run this task on servers that have already been set up; it will
+    not destroy any deployed revisions or data.".cleanup
+
+  task :setup do
+    Rake::Task['vlad:setup_app'].invoke
+  end
+
+  desc "Prepares application servers for deployment.".cleanup
+
+  remote_task :setup_app, :roles => :app do
+    dirs = [deploy_to, releases_path, scm_path, shared_path]
+    dirs += shared_paths.keys.map { |d| File.join(shared_path, d) }
+    dirs = dirs.join(' ')
+
+    commands = [
+      "umask #{umask}",
+      "mkdir -p #{dirs}"
+    ]
+    commands << "chown #{perm_owner} #{dirs}" if perm_owner
+    commands << "chgrp #{perm_group} #{dirs}" if perm_group
+
+    run commands.join(' && ')
+  end
+
+  desc "Updates your application server to the latest revision.  Syncs
+    a copy of the repository, exports it as the latest release, fixes
+    up your symlinks, symlinks the latest revision to current and logs
+    the update.".cleanup
+
+  remote_task :update, :roles => :app do
+    symlink = false
+    begin
+      commands = [
+        "umask #{umask}",
+        "cd #{scm_path}",
+        "#{source.checkout revision, scm_path}",
+        "#{source.export revision, release_path}",
+        "chmod -R g+w #{latest_release}",
+      ]
+      unless shared_paths.empty?
+        commands << "rm -rf #{shared_paths.values.map { |p| File.join(latest_release, p) }.join(' ')}"
+      end
+      unless mkdirs.empty?
+        dirs = mkdirs.map { |d| File.join(latest_release, d) }.join(' ')
+        commands << "mkdir -p #{dirs}"
+        commands << "chown -R #{perm_owner} #{dirs}" if perm_owner
+        commands << "chgrp -R #{perm_group} #{dirs}" if perm_group
+      end
+
+      commands << "chown -R #{perm_owner} #{latest_release}" if perm_owner
+      commands << "chgrp -R #{perm_group} #{latest_release}" if perm_group
+
+      run commands.join(" && ")
+      Rake::Task['vlad:update_symlinks'].invoke
+
+      symlink = true
+      commands = [
+        "umask #{umask}",
+        "rm -f #{current_path}",
+        "ln -s #{latest_release} #{current_path}",
+        "echo #{now} $USER #{revision} #{File.basename(release_path)} >> #{deploy_to}/revisions.log"
+      ]
+      commands << "chown #{perm_owner} #{deploy_to}/revisions.log" if perm_owner
+      commands << "chgrp #{perm_group} #{deploy_to}/revisions.log" if perm_group
+
+      run commands.join(' && ')
+    rescue => e
+      run "rm -f #{current_path} && ln -s #{previous_release} #{current_path}" if
+        symlink
+      run "rm -rf #{release_path}"
+      raise e
+    end
+  end
+
+  desc "Updates the symlinks for shared paths".cleanup
+
+  remote_task :update_symlinks, :roles => :app do
+    unless shared_paths.empty?
+      ops = shared_paths.map do |sp, rp|
+        "ln -s #{shared_path}/#{sp} #{latest_release}/#{rp}"
+      end
+      run ops.join(' && ') unless ops.empty?
+    end
+  end
+
+  desc "Invoke a single command on every remote server. This is useful for
+    performing one-off commands that may not require a full task to be written
+    for them.  Simply specify the command to execute via the COMMAND
+    environment variable.  To execute the command only on certain roles,
+    specify the ROLES environment variable as a comma-delimited list of role
+    names.
+
+      $ rake vlad:invoke COMMAND='uptime'".cleanup
+
+  remote_task :invoke do
+    command = ENV["COMMAND"]
+    abort "Please specify a command to execute on the remote servers (via the COMMAND environment variable)" unless command
+    run(command)
+  end
+
+  desc "Copy arbitrary files to the currently deployed version using
+    FILES=a,b,c. This is useful for updating files piecemeal when you
+    need to quickly deploy only a single file.
+
+    To use this task, specify the files and directories you want to copy as a
+    comma-delimited list in the FILES environment variable. All directories
+    will be processed recursively, with all files being pushed to the
+    deployment servers. Any file or directory starting with a '.' character
+    will be ignored.
+
+      $ rake vlad:upload FILES=templates,controller.rb".cleanup
+
+  remote_task :upload do
+    file_list = (ENV["FILES"] || "").split(",")
+
+    files = file_list.map do |f|
+      f = f.strip
+      File.directory?(f) ? Dir["#{f}/**/*"] : f
+    end.flatten
+
+    files = files.reject { |f| File.directory?(f) || File.basename(f)[0] == ?. }
+
+    abort "Please specify at least one file to update (via the FILES environment variable)" if files.empty?
+
+    files.each do |file|
+      rsync file, File.join(current_path, file)
+    end
+  end
+
+  desc "Rolls back to a previous version and restarts. This is handy if you
+    ever discover that you've deployed a lemon; 'rake vlad:rollback' and
+    you're right back where you were, on the previously deployed
+    version.".cleanup
+
+  remote_task :rollback do
+    if releases.length < 2 then
+      abort "could not rollback the code because there is no prior release"
+    else
+      run "rm -f #{current_path}; ln -s #{previous_release} #{current_path} && rm -rf #{current_release}"
+    end
+
+    Rake::Task['vlad:start'].invoke
+  end
+
+  desc "Clean up old releases. By default, the last 5 releases are kept on
+    each server (though you can change this with the keep_releases variable).
+    All other deployed revisions are removed from the servers.".cleanup
+
+  remote_task :cleanup do
+    max = keep_releases
+    if releases.length <= max then
+      puts "no old releases to clean up #{releases.length} <= #{max}"
+    else
+      puts "keeping #{max} of #{releases.length} deployed releases"
+
+      directories = (releases - releases.last(max)).map { |release|
+        File.join(releases_path, release)
+      }.join(" ")
+
+      run "rm -rf #{directories}"
+    end
+  end
+
+end # namespace vlad

data/lib/vlad/maintenance.rb

@@ -0,0 +1,20 @@
+require 'vlad'
+
+##
+# See the following documents for recipes:
+#
+# * http://clarkware.com/cgi/blosxom/2007/01/05/CustomMaintenancePages
+# * http://blog.nodeta.fi/2009/03/11/stopping-your-rails-application-with-phusion-passenger/
+#
+
+namespace :vlad do
+  namespace :maintenance do
+    remote_task :on, :roles => [:web] do
+      run "cp -f #{shared_path}/config/maintenance.html #{shared_path}/system/"
+    end
+
+    remote_task :off, :roles => [:web] do
+      run "rm -f #{shared_path}/system/maintenance.html"
+    end
+  end
+end