deprec 1.9.3 → 2.0.0

data/README

@@ -0,0 +1,152 @@
+------------------------------------------
+deprec - Deployment Recipes for Capistrano
+------------------------------------------
+
+== Introduction
+
+The deprec [1] gem is a set of tasks for Capistrano [2]. These tasks provide
+for the installation, configuration and control of system services on servers
+running Ubuntu linux. Deprec was created in 2006 by Mike Bailey to setup an
+environment for running Ruby on Rails web applications on Ubuntu servers. Since
+then its uses have grown to installing Xen virtualization, mail, monitoring, high
+availability IP failover and other services.
+
+The tasks are run at the command line on your workstation and connect to 
+remote servers via ssh to run commands and copy out files.
+
+Deprec-2.x is a complete rewrite of the project that achieves the following:
+
+- support for Capistrano 2
+- generated config files are stored locally to enable editing and version control
+- support for more services (heartbeat, nagios, nginx, ntp, postfix, etc) 
+- multiple Rails deployment options (Passenger+Apache, Mongrel+Apache/Nginx)
+- creation of a standard base set of task names
+- tasks are cleanly separated into namespaced units (one file per service)
+- interactive prompting for missing config values
+
+Deprec and Capistrano are written in the Ruby programming language [3] however 
+no knowledge of Ruby is required to use it. Users should be able to write 
+new tasks and modify existing options without prior knowledge of Ruby.
+
+
+== Installation
+
+Deprec can be obtained from rubyforge[4] and installed using rubygems[5].
+
+	sudo gem install deprec  # installs deprec and dependancies 
+	cap depify .			 # creates ~/.caprc which you may edit
+	cap -T					 # should list lots of deprec tasks
+
+The .caprc file is loaded every time you use Capistrano. It in turn loads 
+the deprec tasks so you always have them available. Editing the .caprc file 
+in your home directory allows you to specify the location of your ssh key
+and enable some other useful options (documented in the comments). You can
+also put tasks here that you want access to, regardless of the current working
+directory.
+
+
+== Getting a Ruby on Rails app running on a fresh Ubuntu server
+
+This is still what brings people to deprec. You can install a full Rails stack
+and get multiple apps running on it in much less time than it would take to 
+do it manually (e.g. an hour vs. a weekend).
+
+Get your app running on a fresh Ubuntu (7.10, 8.04) server with these commands:
+
+    cd your_rails_app
+    depify . 
+    # Edit config/deploy.rb
+    cap deprec:rails:install_stack
+
+	# WARNING! Don't run the following command if you are using a shared 
+	# database server that has already been installed.
+	cap deprec:db:install 
+
+    cap deploy:setup 
+    cap deploy 
+    cap deploy:migrate
+
+Recorded times for complete install on Ubuntu hardy server (7.10 amd64)
+
+	* Passenger+REE+Apache        : 14m29s
+	* Passenger+ruby-1.8.7+Apache : 17m51s
+	* nginx+mongrel               : 16m25s
+	
+Note you can choose combinations of:
+	
+	* Ruby Enterprise Edition or ruby-1.8.7
+	* Passenger or mongrel (passenger requires you choose to the apache option)
+	* Apache or nginx
+
+You can find documentation on the deprec site. http://www.deprec.org/
+
+
+== Installing other things
+
+I plan to document other things I use deprec for on http://www.deprec.org/. 
+Feel free to poke around and see what's there. I use deprec to provision and 
+manage servers so you might find some things in there I haven't documented. Lucky you.
+
+
+== Disclaimer
+
+The tasks run commands that may make changes to your workstation and remote server. 
+You are advised to read the source and use at your own risk.
+
+
+== Credits
+
+Deprec is written and maintained by Mike Bailey <mike@bailey.net.au>. 
+More about me here: [http://mike.bailey.net.au/]
+
+Deprec was inspired and uses the brilliantly executed Capistrano. Thanks Jamis!
+This gem includes a modified copy of Neil Wilson's very useful vmbuilder_plugins gem.
+
+
+== Thanks
+
+Deprec wouldn't be what it is without the contributions of many people, a few of whom are listed here:
+
+  Square Circle Triangle: commissioned work that has included in the project.
+  Eric Harris-Braun: great testing, bug reports and suggestions
+  Gus Gollings: helped restore www.deprec.org
+  Craig Ambrose: testing, documentation and beer
+
+  github forks of note:
+    isaac
+    paulreimer
+    jasherai
+    saimonmoore
+    zippy
+
+
+== License
+
+Deprec is licenced under the GPL. This means that you can use it in commercial 
+or open source applications. More details found here:
+http://www.gnu.org/licenses/gpl.html
+
+deprec - deployment recipes for capistrano
+Copyright (C) 2006-2008 Mike Bailey
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+
+[1] http://www.deprec.org/
+[2] http://www.capify.org/
+[3] http://www.ruby-lang.org/en/
+[4] http://rubyforge.org/
+[5] http://rubygems.org/
+[6] http://www.sct.com.au/

data/THANKS

@@ -0,0 +1,17 @@
+Big thanks go to the following people. Apologies to any I have missed! - Mike
+
+20080226 Chris Turner for an excellent HOWTO http://crackthenut.cracklabs.com/deprec2-your-slice-from-windows/
+20080206 Eric Harris-Braun for some great testing, bug reports and suggestions.
+20071004 Gus Gollings for helping restore www.deprec.org
+
+Seen on github http://github.com/mbailey/deprec/network
+
+isaac
+jasherai    Pritesh    		  (London)
+zippy       Eric Harris-Braun (NY) <eric@harris-braun.com>  http://eric.harris-braun.com
+kovacs      Michael Kovacs    (SF) <michael@mkovacs.com>    http://javathehutt.blogspot.com
+robc        Rob Caporetto     (Melbourne)  rcaporetto@gmail.com  http://www.rob-caporetto.com
+
+
+
+

data/bin/depify

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to depify, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capify."
+end
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+
+caprc = unindent(<<-FILE)
+  # .caprc - Capistrano configs (added by deprec gem [www.deprec.org])
+  #
+  # Include settings that you want active whenever you use Capistrano
+  # You can over ride these for particular projects by putting entries
+  # into Capfile or deploy.rb for those projects
+  #
+  # Uncomment any of the following entries to enable them.
+  #
+  # Include deprec - deployment recipes for Capistrano (www.deprec.org)
+  #
+  require 'deprec'
+
+FILE
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+    Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+    Dir['config/*/recipes.rb'].each { |plugin| load(plugin) }
+    load 'config/deploy'
+  FILE
+
+  "config/deploy.rb" => unindent(<<-FILE),
+    require 'deprec'
+  
+    set :application, "set your application name here"
+    set :domain, "set domain name project will be served on here"
+    set :repository,  "git://github.com/\#{user}/\#{application}.git"
+    
+    # If you aren't using Subversion to manage your source code, specify
+    # your SCM below:
+    set :scm, :git
+   
+    set :ruby_vm_type,      :ree
+    set :web_server_type,   :apache
+    set :app_server_type,   :passenger
+    set :db_server_type,    :mysql
+    
+    # set :packages_for_project, %w(libmagick9-dev imagemagick libfreeimage3) # list of packages to be installed
+    # set :gems_for_project, %w(rmagick mini_magick image_science) # list of gems to be installed
+    
+    # Update these if you're not running everything on one host.
+    role :app, domain
+    role :web, domain
+    role :db,  domain, :primary => true
+
+    # If you aren't deploying to /opt/apps/\#{application} on the target
+    # servers (which is the deprec default), you can specify the actual location
+    # via the :deploy_to variable:
+    # set :deploy_to, "/opt/apps/\#{application}"
+    
+    namespace :deploy do
+      task :restart, :roles => :app, :except => { :no_release => true } do
+        top.deprec.app.restart
+      end
+    end
+    
+  FILE
+}
+
+def create_file(file, content)
+  if !File.exists?(File.dirname(file))
+    puts "[add] creating directory `#{File.dirname(file)}'"
+    Dir.mkdir(File.dirname(file))
+  end
+  if File.exists?(file)
+    warn "[skip] `#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+  else
+    puts "[add] writing `#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+create_file(File.join(ENV['HOME'], '.caprc'), caprc)
+
+base = ARGV.shift
+config_dir = File.join(base,'config')
+if File.directory?(config_dir)
+  files.each do |file, content|
+    create_file(File.join(base, file), content)
+  end
+else
+  warn "[warn] directory `#{config_dir}' does not exist"
+  warn "[skip] '#{base}/Capfile'"
+  warn "[skip] '#{base}/config/deploy.rb'"
+end
+
+puts "[done] depified!"

data/docs/EXAMPLE-installing_tracks.txt

@@ -0,0 +1,41 @@
+#
+# Install tracks locally
+#
+git clone git://github.com/bsag/tracks.git
+cd tracks
+
+cp config/database.yml.tmpl config/database.yml
+cp config/site.yml.tmpl config/site.yml
+cp -r log.tmpl log -u 
+rake db:create
+rake db:migrate
+./script/server  # Test locally
+
+
+#
+# Install deprec
+#
+sudo gem install deprec
+cap deprec:users:passwd HOSTS=192.168.0.135 USER=root # Change root password
+cap deprec:users:add 	HOSTS=192.168.0.135 USER=root # Add personal account
+
+
+#
+# Create deploy.rb file for tracks
+#
+depify .
+curl -o config/deploy.rb http://mbailey.github.com/deprec/deploy.rb-tracks
+# Edit config/deploy.rb specifying the domain name to serve the app on.	
+
+
+#
+# Install on remote server
+# 
+
+cap deprec:rails:install_stack
+cap deprec:db:install
+cap deploy:setup 
+cap deploy 
+cap deploy:migrate
+
+# Tracks is now running on your server. Enjoy!

data/docs/README.nagios

@@ -0,0 +1,22 @@
+deprec: Install and configure Nagios on Ubuntu 7.10 (gutsy), 8.04 (hardy)
+=========================================================================
+										 
+* Quickstart
+
+	# You need the following item defined in config/deploy.rb (or ~/.caprc)
+	role :nagios, 'monitor.blah.com'
+		
+	# Run the following on your workstation
+	export HOSTS=nagios.domain.name # replace with desired domain
+	cap deprec:apache:install
+	cap deprec:nagios:install
+	cap deprec:nagios_plugins:install
+	cap deprec:nagios:config_gen
+	cap deprec:nagios:htpass          # create web logins
+	cap deprec:nagios:config
+	cap deprec:apache:restart
+
+
+* The detail
+
+TBC

data/docs/README.rails

@@ -0,0 +1,17 @@
+deprec: Install Ruby on Rails app on fresh Ubuntu 7.10 (gutsy), 8.04 (hardy)
+============================================================================
+
+* Quickstart
+
+cd your_rails_app
+depify . 
+# Edit config/deploy.rb
+cap deprec:rails:install_stack
+
+# WARNING! Don't run the following command if you are using a shared 
+# database server that has already been installed.
+cap deprec:db:install 
+
+cap deploy:setup 
+cap deploy 
+cap deploy:migrate

data/docs/config_gen_explained.txt

@@ -0,0 +1,39 @@
+== Configuration
+
+deprec2 has a two stage process for generating/deploying configuration files.
+Configuration files for web, app, db servers (and more) are generated from 
+templates and put under the config/ tree in your Rails apps source tree. 
+Alternatively you could create a non-rails-app tree to hold them. The second 
+stage is pushing the files out to the destination servers. This used to be a 
+one stage process in deprec1 however the change has been made so that:
+
+- all config files for a project can be kept under source control
+- you can make changes to config files that are not available through deprec
+
+Many of the settings in these config files are based on values in the projects 
+deploy.rb file. Others reflect defaults in deprec that you can override by adding 
+fields to deploy.rb. This means you may never need to edit the generated config 
+files directly. You can generate a set of config files with the following:
+
+	cap deprec:nginx:config_gen # generates config files for trac from templates
+	
+config_gen is re-runnable and will prompt you before overwriting a file. It will
+also show you what changes overwriting would make (in diff format) to help you
+decide whether you want it to do so.
+
+Changes to service configuration should never be made on the server. Deprec 
+acknowledges this by offering no assistance to people who want to copy config 
+files back from servers. But pushing the files out couldn't be simpler!
+
+	cap deprec:nginx:config # pushes out all config files for nginx
+
+deprec2 takes into consideration the fact that that some services are used to 
+host more than one application. For example, a webserver will often have one 
+main configuration and a number of virtual host configurations. Monit has a
+single config file (/etc/monitrc) but will also load other configs it finds in
+a certain directory (/etc/monit.d).
+
+When you deploy a Ruby on Rails app with deprec it drops configs for your project
+into the config/ directory for your project and symlinks them into a shared path
+on the server. This means you can install multiple apps on a remote server and 
+they shouldn't stop on each other. 

data/docs/{README.quickstart → deprec-1.x/deprec-1.x.quickstart}

@@ -1,3 +1,7 @@
+#
+# Old notes - YMMV
+#
+
 == deprec quickstart (with svn, trac and deployment to apache/mongrel/mysql)
 
 Here are instructions that will take a fresh install of Ubuntu Dapper (6.06.1 server), create a working rails app, create an SVN repository and trac installation for it and deploy it using apache, mongrel and mysql.
@@ -7,7 +11,6 @@ to log into the remote server manually. Capistrano does all the work.
 
 - Mike
 
-
 # Install deprec on workstation
 sudo gem install deprec --include-dependencies
 echo 'require "deprec/recipes"'               >> ~/.caprc

data/docs/{building_edge_capistrano.txt → deprec-1.x/notes.txt}

@@ -1,9 +1,12 @@
+# update timezone on gutsy
+# dpkg-reconfigure tzdata
+
+
+# Building Edge Capistrano
 You can build an edge gem by cd'ing to that directory and doing:
 
 1. svn info. Find the line that says "Revision:" and mark the revision number.
-
 2. rake PKG_BUILD=<rev> gem. Replace <rev> with the revision number.
-
 3. Look in the pkg subdirectory. Install that gem file via "gem install pkg/<gem file>"
 
-- Jamis
+- Jamis