andyverprauskus-vlad 1.2.0.2

data/History.txt

@@ -0,0 +1,49 @@
+== 1.1.1 / 2008-01-14
+
+* 5 major enhancements:
+  * Support for Rake 0.8. Should still work for Rake 0.7.
+  * Added git support (contributed by Garry Dolley).
+    * Reviewed for accuracy by Evan Phoenix.
+  * Added lighttpd.rb
+  * Added automatic client setup for perforce.
+  * Added mercurial SCM support patch. Closes ticket 13475.
+* 6 minor enhancements:
+  * Added #put method that wraps up Tempfile/rsync pattern.
+  * Added automatic p4 client setup for perforce.
+  * Added vladdemo.sh
+  * Moved everything over to put.
+  * Moved generic app setup to core from mongrel.
+  * Parameterized 'head' into 'revision' variable (with head as default).
+* 1 bug fix
+  * Fixed cleanup to actually properly clean up.
+
+== 1.1.0 / 2007-09-12
+
+* 3 major enhancements:
+  * Vlad.load now takes a hash of recipe overrides, eg: Vlad.load :web => :nginx.
+    See rdoc for defaults.
+  * Removed vlad_tasks.rb and split into vlad/apache.rb, vlad/mongrel.rb,
+    and vlad/core.rb.
+  * The flog ratio between capistrano+deps / vlad+deps is pi (or, damn close)!
+* 12 minor enhancements:
+  * Added $TRACE to make it more available and cleaner to read.
+  * Added :svn_cmd variable.
+  * Added Rake.clear_tasks *str_or_regexp
+  * Added debug and mana_from_heaven tasks to Rakefile.
+  * Added more documentation.
+  * Added :rsync_cmd and :rsync_flags.
+  * Added :ssh_cmd and :ssh_flags.
+  * Added variable expansion to vlad:debug task.
+  * Removed :scm variable. Now a Vlad.load component/flavor/need-a-word-here.
+  * Removed :application var. Use it if you want it. We don't require it.
+  * Renamed :p4cmd to :p4_cmd.
+  * Renamed :rake var to :rake_cmd.
+* 2 (important) bug fixes:
+  * HUGE: Fixed sudo hang bug #13072.  Fix suggested by Chris Van Pelt.
+  * HUGE: Vlad.load calls user config last, allowing variable overrides.
+    ACK! Sorry!
+
+== 1.0.0 / 2007-08-04
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+considerations.txt
+doco/faq.txt
+doco/getting_started.txt
+doco/migration.txt
+doco/perforce.txt
+doco/variables.txt
+lib/rake_remote_task.rb
+lib/vlad.rb
+lib/vlad/apache.rb
+lib/vlad/core.rb
+lib/vlad/git.rb
+lib/vlad/lighttpd.rb
+lib/vlad/mercurial.rb
+lib/vlad/mongrel.rb
+lib/vlad/perforce.rb
+lib/vlad/subversion.rb
+test/test_rake_remote_task.rb
+test/test_vlad.rb
+test/test_vlad_git.rb
+test/test_vlad_mercurial.rb
+test/test_vlad_perforce.rb
+test/test_vlad_subversion.rb
+test/vlad_test_case.rb
+vladdemo.sh

data/README.txt

@@ -0,0 +1,78 @@
+Vlad the Deployer
+    by the Ruby Hit Squad
+    http://rubyhitsquad.com/
+    http://rubyforge.org/projects/hitsquad/
+
+== DESCRIPTION:
+
+Vlad the Deployer is pragmatic application deployment automation,
+without mercy. Much like Capistrano, but with 1/10th the
+complexity. Vlad integrates seamlessly with Rake, and uses familiar
+and standard tools like ssh and rsync.
+
+Impale your application on the heartless spike of the Deployer.
+
+== FEATURES/PROBLEMS:
+
+* Full deployment automation stack.
+* Turnkey deployment for mongrel+apache+svn.
+* Supports single server deployment with just 3 variables defined.
+* Built on rake. Easy. Engine is small.
+* Very few dependencies. All simple.
+* Uses ssh with your ssh settings already in place.
+* Uses rsync for efficient transfers.
+* Run remote commands on one or more servers.
+* Mix and match local and remote tasks.
+* Compatible with all of your tab completion shell script rake-tastic goodness.
+* Ships with tests that actually pass in 0.028 seconds!
+* Does NOT support Windows right now (we think). Coming soon in 1.2.
+
+== SYNOPSIS:
+
+    % rake vlad:setup   # first time only
+    % rake vlad:update
+    % rake vlad:migrate # optional
+    % rake vlad:start
+
+== REQUIREMENTS:
+
+* Rake
+* Hoe
+* Rubyforge
+* open4
+
+== INSTALL:
+
+* sudo gem install -y vlad
+
+== SPECIAL THANKS:
+
+* First, of course, to Capistrano. For coming up with the idea and
+  providing a lot of meat for the recipes.
+* Scott Baron for coming up with one of the best project names evar.
+* Bradley Taylor for giving us permission to use RailsMachine recipes sans-LGPL.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Ryan Davis and the rest of the Ruby Hit Squad
+
+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/Rakefile

@@ -0,0 +1,51 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$: << 'lib'
+require 'vlad'
+
+Hoe.new('vlad', Vlad::VERSION) do |p|
+  p.rubyforge_name = 'hitsquad'
+  p.author = ["Ryan Davis", "Eric Hodel", "Wilson Bilkovich"]
+  p.email = "ryand-ruby@zenspider.com"
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/).map { |s| s.strip }[2..-1]
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.summary = p.paragraphs_of('README.txt', 2).join
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << 'rake'
+  p.extra_deps << 'open4'
+end
+
+desc "quick little hack to see what the state of the nation looks like"
+task :debug do
+  Vlad.load :config => "lib/vlad/subversion.rb"
+  set :code_repo, "code repo path"
+  set :deploy_to,  "deploy path"
+  set :domain,     "server domain"
+
+  Rake::Task['vlad:debug'].invoke
+end
+
+task :flog do
+  sh 'flog -s lib'
+end
+
+task :flog_full do
+  sh 'flog -a lib'
+end
+
+task :mana_from_heaven do
+  # vlad = vlad + rake + open4
+  # rake sans-contrib = 2035.98356718206
+  vlad  = `flog -s lib`.to_f + 2350.30744806517 + 502.363818023761
+  cap   = 11480.3919695285
+  ratio = cap / vlad
+  target = cap / Math::PI
+
+  puts "%14.8f = %s" % [vlad, "vlad"]
+  puts "%14.8f = %s" % [ratio, "ratio"]
+  puts "%14.8f = %s" % [target - vlad, "needed delta"]
+end
+
+# vim: syntax=Ruby

data/considerations.txt

@@ -0,0 +1,91 @@
+* might we want per connection values?
+
+* :except => {:no_release => true}
+
+  It is common to configure tasks to 'announce' deployments in IRC, Campfire,
+  etc.  If you have 6 app servers, you don't want to see 6 announcements.  In
+  Capistrano, this is handled via the :no_release => true flag.  Various tasks
+  only execute on the 'release' servers.
+
+  An easier way to meet this would be to introduce a :release role in the
+  default setup
+
+    role :release, "app1.example.com"
+    
+    remote_task :announce_in_irc, :roles => :release ...
+
+  Drawback: Yet another thing to change when you migrate a project from cap to
+  vlad
+
+* 'dynamic deployments'
+
+    role :app, "app1.example.com"
+    role :app, "app2.example.com"
+
+  Let's say that app1 and app2 need slightly different monit configurations.
+
+  In Capistrano, you might approach this by making two additional roles, and 
+  splitting your 'push a monit config' task into two. This sucks.
+
+  Vlad makes the 'execution context' of a task available. In Vlad, you would:
+
+    remote_task :update_monit, :roles => :app
+      rsync "templates/#{target_host}.monitrc", "/etc/monitrc"
+    end
+
+* fine-grained tasks
+
+    remote_task :update
+    remote_task :symlink
+    remote_task :migrate
+    remote_task :deploy => [:update, :symlink, :migrate, :restart]
+
+  Let's assume that this is a multi-server config with shared deploy path.
+  The user wants to do only a single checkout. If we make "update" be one big
+  task body that includes the update, symlink, and migrate steps,
+  it is difficult for the user to override the roles for the particular steps
+  they need to change.
+
+  If we break these into separate tasks, they can say:
+
+    Rake::Task["migrate"].options[:roles] = :master_db
+
+  and the migrations will only run on the master db
+
+* sudo / via how? and if we call it via I will stab ppl. "user" is sufficient.
+
+* handling 'use_sudo'
+
+  1. Check for this inside the 'run' command, and preface the command
+     with 'sudo' if necessary
+
+  2. Default this to 'false' in the reset method, and check for it
+     in the default tasks that we provide:
+       if use_sudo then
+         sudo "blah"
+       else
+         run "blah"
+       end
+
+  Option 2 has fewer moving parts, but clutters up the tasks that care about
+  this.
+
+* Dependencies
+
+  Task dependencies aren't settable when creating a Rake::RemoteTask.
+
+* Apache configuration
+
+  Pull in railsmachine/rails/recipes/apache.rb's apache configuration.  Needs
+  erb to work.
+
+* I really like tasks with naming <cmd>_<role> (eg setup_app,
+  start_web). We could easily make the front end remote_task command
+  look for such a convention and apply the :role => x automatically.
+
+* from bousquet: get a couple of server environment recipes that prepare your
+  machine that would be the golden ticket:
+
+    rake vlad:prepare TYPE=accelerator | ubuntu | osx | osxserver | site5 | ...
+
+  and have people maintaining those setups who depend on them

data/doco/faq.txt

@@ -0,0 +1,75 @@
+== Rake & Recipes
+
+=== Q: Why is there no vlad:restart?
+=== A: It is cleaner!
+
+We don't want to have to think about what state we're in and where. So vlad:start does a restart if necessary. Restart is just "start again" after all... That is what start does.
+
+=== Q: Why are there no before_action and after_action hooks?
+=== A: Because we use rake!
+
+Rake don't need no stinkin' hooks! They're too clever. Last I checked before_after_before_start worked in cap... how? why? I dunno...
+
+To extend a task (adding something after), just define it again:
+
+  task :action1 do
+    puts "one fish, two fish"
+  end
+
+  task :action1 do
+    puts "red fish, blue fish"
+  end
+
+To prepend on a task, add a dependency:
+
+  task :action2 do
+    puts "red fish, blue fish"
+  end
+
+  task :myaction do
+    puts "one fish, two fish"
+  end
+
+  task :action2 => :myaction
+
+=== Q: How do I invoke another rule?
+=== A: The easiest way is via dependencies.
+
+  task :shazam! => [:action1, :action2]
+
+ The other way is to look it up and call invoke:
+
+  task :shazam! do
+    Rake::Task[:action1].invoke
+    Rake::Task[:action2].invoke
+  end
+
+(Or, cheat and call out to rake again: sh "rake action1")
+
+== Using SSH
+
+=== Q: Is there any way to set the ssh user?
+=== A: Yes, using ~/.ssh/config
+
+  Host example.com
+    User fluffy_bunny
+
+OR: Alternatively, you can do this within your recipes like so:
+
+  set :user, "fluffy_bunny"
+  set :domain, "#{user}@example.com"
+
+=== Q: Is there any way to speed up ssh connections?
+=== A: Yes, add to your Host entry in ~/.ssh/config:
+
+  ControlMaster auto
+  ControlPath ~/.ssh/master-%r@%h:%p
+
+=== Q: I'm tired of typing in my password!
+=== A: Me too!
+
+Put a password on your key, distribute your public key to the server and then use ssh-agent.
+
+Check out this tiny tutorial at LBL: A brief ssh-agent tutorial <http://upc.lbl.gov/docs/user/sshagent.html>
+
+If you're on a mac, use SSHKeychain, we love it. <http://www.sshkeychain.org/>

data/doco/getting_started.txt

@@ -0,0 +1,41 @@
+
+== Quick Start for a 1-Server Solution:
+
+=== Setup
+
+* Create a deploy file, usually in "config/deploy.rb":
+
+    set :application, "project"
+    set :domain, "example.com"
+    set :deploy_to, "/path/to/install"
+    set :code_repo, 'http://svn.example.com/project/branches/stable/'
+    
+This defaults to using 'svn export' from +code_repo+, and a single
+server for +app+, +db+, and +www+. If you need to tweak these things,
+refer to the variable documentation.
+
+* Add the following to your Rakefile:
+
+    begin
+      require 'vlad'
+      Vlad.load
+    rescue LoadError
+      # do nothing
+    end
+
+Vlad.load has a lot of flexibility. See the rdoc for full information.
+
+You don't need the begin/rescue/end block if you ensure that Vlad is
+installed on all your servers. To be lazy, you can install vlad via:
+
+    % rake vlad:invoke COMMAND='sudo gem install vlad -y'
+
+=== Initial Launch
+
+* Run <tt>rake vlad:setup vlad:update vlad:migrate vlad:start</tt>
+
+=== Subsequent Updates:
+
+* <tt>rake vlad:update vlad:migrate vlad:start</tt>
+
+Each step may be run separately.

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 :code_repo,   "svn://svn.example.com/rubyholic/branches/stable"
+  set :deploy_to,   "/users/home/zenspider/domains/new.rubyholic.com"