lib/recipes/centos/README lib/recipes/centos/centos.rb lib/recipes/centos/imagemagick.rb lib/recipes/centos/memcached.rb lib/recipes/centos/mongrel_cluster.rb lib/recipes/centos/monit.rb lib/recipes/centos/mysql.rb lib/recipes/centos/nginx.rb lib/recipes/centos/ruby.rb lib/recipes/centos/sphinx.rb lib/templates/centos/setup_for_web.sh lib/templates/ruby/fix_openssl.sh @@ -1,3 +1,9 @@ +== 0.1.5 ? + +* Moving centos specific recipes into separate namespace +* Plugin: script.make_install +* Documentation and explicitly fetching vars (for install tasks), showing useful error messages + == 0.1.4 2008-02-07 * Using capistrano's plugin architecture instead of hacking around History.txt @@ -23,53 +23,51 @@ lib/capigen/recipes.yml lib/capigen/version.rb lib/profiles/centos-sick.rb lib/recipes/README -lib/recipes/centos.rb +lib/recipes/centos/README +lib/recipes/centos/centos.rb +lib/recipes/centos/imagemagick.rb +lib/recipes/centos/memcached.rb +lib/recipes/centos/mongrel_cluster.rb +lib/recipes/centos/monit.rb +lib/recipes/centos/mysql.rb +lib/recipes/centos/nginx.rb +lib/recipes/centos/ruby.rb +lib/recipes/centos/sphinx.rb lib/recipes/deploy.rb lib/recipes/gems.rb -lib/recipes/imagemagick.rb lib/recipes/install.rb lib/recipes/memcached.rb lib/recipes/mongrel_cluster.rb -lib/recipes/monit.rb lib/recipes/mysql.rb lib/recipes/nginx.rb lib/recipes/packages.rb lib/recipes/rails.rb -lib/recipes/ruby.rb lib/recipes/sphinx.rb lib/templates/capistrano/Capfile lib/templates/capistrano/deploy.rb.erb -lib/templates/centos/setup.sh +lib/templates/centos/setup_for_web.sh lib/templates/centos/sudoers -lib/templates/imagemagick/install.sh -lib/templates/memcached/install.sh lib/templates/memcached/memcached.initd.centos.erb lib/templates/memcached/memcached.monitrc.erb lib/templates/mongrel/mongrel_cluster.initd.erb lib/templates/mongrel/mongrel_cluster.monitrc.erb lib/templates/mongrel/mongrel_cluster.yml.erb lib/templates/monit/cert.sh -lib/templates/monit/install.sh lib/templates/monit/monit.cnf lib/templates/monit/monit.initd.centos.erb lib/templates/monit/monitrc.erb lib/templates/monit/patch_inittab.sh -lib/templates/mysql/install.sh.erb lib/templates/mysql/install_db.sql.erb lib/templates/mysql/mysql.monitrc.erb -lib/templates/nginx/install.sh.erb lib/templates/nginx/nginx.conf.erb lib/templates/nginx/nginx.initd.erb lib/templates/nginx/nginx.monitrc.erb lib/templates/nginx/nginx_vhost.conf.erb lib/templates/rails/database.yml.erb -lib/templates/ruby/ruby_install.sh -lib/templates/ruby/rubygems_install.sh -lib/templates/sphinx/install.sh.erb +lib/templates/ruby/fix_openssl.sh lib/templates/sphinx/sphinx.conf.erb lib/templates/sphinx/sphinx.monitrc.erb lib/templates/sphinx/sphinx_app.initd.centos.erb -lib/templates/sphinx/sphinx_app.initd.erb script/destroy script/generate script/txt2html Manifest.txt @@ -1,16 +1,27 @@ = Capigen -Capistrano recipes and templates. +Capistrano plugins, recipes and templates. == Install recipes -To install an application, use the install recipes; cap nginx:install +To install an application, use the install recipes. For example: + + cap nginx:install + +Recipes may have settings that are required, or defaults that can be overriden. These are usually set in "profiles". To install a group of applications based on a "profile": cap install -_You may need to comment out "Defaults requiretty" in /etc/sudoders on the image before capistrano recipes will work._ +<em>You may need to comment out "Defaults requiretty" in /etc/sudoders on the image before capistrano recipes will work.</em> + + +== Profiles + +Profiles store lists of recipes to run, and settings for those recipes. + +Profiles are capistrano configuration like a Capfile or deploy.rb. See capigen/lib/profiles for more info. == Generating a Capfile @@ -26,7 +37,7 @@ If this is the first time you've deployed you'll need to run: cap deploy:setup -Otherwise, your deploy options: +Otherwise, your standard deploy options: cap deploy README.txt @@ -6,8 +6,8 @@ HighLine.track_eof = false $:.unshift File.dirname(__FILE__) -module Capigen - module Plugins +module Capigen # :nodoc: + module Plugins # :nodoc: end end lib/capigen.rb @@ -1,7 +1,16 @@ -# Patch to add ability to clear sessions +# Patch to add ability to clear sessions/connections. module Capistrano::Configuration::Connections - # Set the user to something new (but save the old user; reset_user will set it back) + # Set the user to something new (but save the old user; reset_user will set it back). + # Takes care of invalidating current connections. Will force a re-login. + # + # ==== Options + # +new_user+:: User to become + # + # ==== Examples + # set_user("nginx") + # # Do something as user nginx + # def set_user(new_user) backup_user = fetch(:user) @@ -12,14 +21,33 @@ module Capistrano::Configuration::Connections clear_sessions end - # Reset the old user + # Reset to the old user. + # Takes care of invalidating current connections. Will force a re-login. + # + # ==== Examples + # # User is "root" + # set_user("nginx") + # # Do something as user nginx + # reset_user + # # User is now root + # def reset_user set :user, @backup_user @backup_user = nil clear_sessions end - # Yields the previous user + # Yields the previous user. + # + # ==== Options + # +new_user+:: User to become + # + # ==== Examples + # new_user("nginx") do |old_user| + # # Do something as user nginx + # end + # # Now as user old_user + # def with_user(new_user, &block) begin set_user(new_user) @@ -31,7 +59,8 @@ module Capistrano::Configuration::Connections clear_sessions end - # Close all open session + # Close all open sessions. + # Will force user to re-login. def clear_sessions sessions.each do |key, session| logger.info "Closing: #{key}" @@ -41,7 +70,8 @@ module Capistrano::Configuration::Connections reset_password end - # Reset the password + # Reset the password. + # Display the current user that is asking for the password. def reset_password set :password, Proc.new { Capistrano::CLI.password_prompt("Password (for #{user}): ") lib/capigen/cap_ext/connections.rb @@ -1,10 +1,15 @@ -module Capistrano - class ExtensionProxy #:nodoc: - - # Allow include modules in plugins - def include(mod) - self.class.send(:include, mod) - end - +class Capistrano::ExtensionProxy + + # Allow ability to include modules in plugins. + # + # ==== Options + # +mod+:: Module + # + # ==== Examples + # include Capigen::Plugins::Yum + # + def include(mod) + self.class.send(:include, mod) end + end \ No newline at end of file lib/capigen/cap_ext/extension_proxy.rb @@ -1,7 +1,9 @@ require 'yaml' require 'highline' -# Configuration +# Application configuration for helping generate Capfile and deploy.rb. +# This isn't used for recipes or profiles. +# class Capigen::Config attr_accessor :application, :user, :deploy_to, :web_host @@ -14,11 +16,24 @@ class Capigen::Config def initialize end - # Expose the binding + # Expose the binding. def get_binding binding end + # Ask for property. + # + # ==== Options + # +message+:: Prompt + # +property+:: Property + # +options+:: Options + # - :default, Default value, defaults to nil + # - :answer_type, Highline answer type, defaults to String + # - :auto_apply, If true and property is set don't ask for it + # + # ==== Examples + # ask("Database port: ", "db_port", { :default => 3306, :answer_type => Integer }) + # def ask(message, property, options = {}, &block) # Options default = options[:default] || nil @@ -39,16 +54,22 @@ class Capigen::Config end end + # For property, set to value if blank. def set_default(property, value) v = send(property.to_sym) send("#{property}=", value) if v.blank? end - + + # Save to yaml. def save(path) File.open(path, "w") { |f| f.puts self.to_yaml } end - # Build config from asking + # Build config from asking. + # + # ==== Options + # +auto_apply+:: For values, if set, then don't ask for it + # def ask_all(auto_apply = false) options = { :auto_apply => auto_apply } lib/capigen/config.rb @@ -1,14 +1,10 @@ require 'erb' require 'yaml' -# == Recipe helpers -# -# * Loads the configuration -# * Generates files from templates -# +# Capigen base capistrano plugin module Capigen::Plugins::Base - # Project root (for rails) + # Project root def root if respond_to?(:fetch) return fetch(:project_root) lib/capigen/plugins/base.rb @@ -1,13 +1,13 @@ module Capigen::Plugins::Gem - # Installl a gem. + # Install a gem. # # ==== Options # +gems+:: List of gem names, or a single gem # - # ==== Examples - # install("raspell") - # install([ "raspell", "foo" ]) + # ==== Examples (in capistrano task) + # gemc.install("raspell") + # gemc.install([ "raspell", "foo" ]) # def install(gems) # If a single object, wrap in array lib/capigen/plugins/gem.rb @@ -1,9 +1,16 @@ module Capigen::Plugins::Package - # Setup packager + # Setup packager. # # ==== Options - # +packager+:: Packager type (:yum) + # +packager_type+:: Packager type (:yum) + # + # ==== Examples (in capistrano task) + # package.type = :yum + # package.install [ "aspell", "foo" ] + # package.remove [ "aspell", "foo" ] + # package.update [ "aspell", "foo" ] + # package.clean # def type=(packager_type) case packager_type.to_sym lib/capigen/plugins/package.rb @@ -2,10 +2,20 @@ module Capigen::Plugins::Profiles ProfileDir = File.dirname(__FILE__) + "/../../profiles" + # Load all profile recipes with prefix. + # + # ==== Options + # +prefix+:: Prefix to filter/search on + # def recipes(prefix = "") Dir[ProfileDir + "/#{prefix}*.rb"].collect { |file| File.basename(file).gsub(File.extname(file), "") } end + # Choose a profile (via command line). + # + # ==== Options + # +prefix+:: Prefix to filter/search on + # def choose(prefix = "") profile = HighLine.new.choose(*recipes(prefix)) do |menu| menu.header = "Choose recipe profile" @@ -14,17 +24,45 @@ module Capigen::Plugins::Profiles "#{ProfileDir}/#{profile}.rb" end - # More helpful fetch - def get(var) + # Fetch the profile, see local gem Capfile for implementation details. + def ask + fetch(:profile) + end + + # Fetch and raise useful error if value is not set. + # + # ===== Options + # +var+:: Variable to fetch + # +message+:: Raise custom message (like usage info) + # + def get(var, message = nil) begin result = fetch(var.to_sym) rescue - puts <<-EOS + if message.blank? + message = <<-EOS + + Please set :#{var} variable in your Capfile or profile. - Please set :#{var} variable in your Capfile or profile. + EOS + end - EOS - raise "Please set :#{var} in your Capfile or profile." + raise "\n#{message}" + end + result + end + + # Fetch and return default if value not set. + # + # ==== Options + # +var+:: Variable to fetch + # +default+:: Result to return if variable not set + # + def get_or_default(var, default) + begin + result = fetch(var.to_sym) + rescue + result = default end result end lib/capigen/plugins/profiles.rb @@ -1,20 +1,65 @@ module Capigen::Plugins::Script - # Install (sh) script + # Configure, make, make install. # # ==== Options - # +script+:: Name of file (relative to templates dir) - # +files_to_put+:: List of files to upload [ { :file => "foo/bar.txt", :dest "/tmp/bar.txt" }, ... ] + # +name+:: Name for app + # +options+:: Options + # - +build_dest+:: Place to build from, ex. /usr/src, defaults to /tmp/name + # - +url+:: URL to download package from + # - +configure_options+:: Options for ./configure + # - +unpack_dir+:: Directory that is unpacked from tgz (if not matching the file name) # - def install(script, files_to_put = [], override_binding = nil) + # ==== Examples (in capistrano task) + # script.make_install("nginx", { :url => "http://sysoev.ru/nginx/nginx-0.5.35.tar.gz", ... }) + # + def make_install(name, options) + install(name, options) do + configure_options = options[:configure_options] || "" + sudo "echo 'Configuring #{name}...' && ./configure #{configure_options} > configure.log" + sudo "echo 'Compiling #{name}...' && make > make.log" + sudo "echo 'Installing #{name}...' && make install > make_install.log" + end + end + + # Download, unpack and yield. + # + # ==== Options + # +name+:: Name for app + # +options+:: Options + # - +build_dest+:: Place to build from, ex. /usr/src, defaults to /tmp/name + # - +url+:: URL to download package from + # + # ==== Examples (in capistrano task) + # script.make("rubygems", { :url => :url => "http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz" }) do + # sudo "ruby setup.rb" + # end + # + def install(name, options, &block) + build_dest = options[:build_dest] + build_dest ||= "/tmp/#{name}" + url = options[:url] + dependencies = options[:dependencies] - files_to_put = [ files_to_put ] if files_to_put.is_a?(Hash) + package.install(dependencies) if dependencies - files_to_put.each do |file_info| - data = template.load(file_info[:file], override_binding || binding) - put data, file_info[:dest] - end + unpack(url, build_dest, options[:clean], options[:unpack_dir]) do + yield if block_given? + end + end + + # Run (sh) script. If script has .erb extension it will evaluate it. + # + # ==== Options + # +script+:: Name of sh file (relative to templates dir) + # +override_binding++:: Binding to override, otherwise defaults to current (task) context + # + # ==== Examples + # script.sh("ruby/openssl_fix.sh") + # + def sh(script, override_binding = nil) + if File.extname(script) == ".erb" name = script[0...script.length-4] dest = "/tmp/#{name}" @@ -34,6 +79,33 @@ module Capigen::Plugins::Script sudo "rm -rf #{File.dirname(dest)}" end + # Download and unpack URL. + # + # ==== Options + # +url+:: URL to download + # +dest+:: Destination directory + # +clean+:: If true will remove the unpacked directory + # +unpack_dir+:: Directory that is unpacked from tgz (if not matching the file name) + # + # ==== Examples + # script.unpack("http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz", "/tmp/rubygems") do + # sudo "ruby setup.rb" + # end + # + def unpack(url, dest, clean = true, unpack_dir = nil, &block) + file = url.split("/").last + unpack_dir ||= file.gsub(/\.tar\.gz|tgz/, "") + + sudo "mkdir -p #{dest} && cd #{dest} && wget -nv #{url}" + sudo "tar xzf #{file} && cd #{unpack_dir}" + + if block_given? + yield + sudo "rm -f #{dest}/#{file}" + sudo "rm -rf #{unpack_dir}" if clean + end + end + end Capistrano.plugin :script, Capigen::Plugins::Script \ No newline at end of file lib/capigen/plugins/script.rb @@ -1,11 +1,17 @@ module Capigen::Plugins::Templates - # Root of templates path + # Get the absolute base templates path. def gem_templates_root File.expand_path(File.dirname(__FILE__) + "/../../templates") end - # Get full template path + # Get full template path from relative path. + # + # Something like <tt>monit/monit.cnf => /usr/lib/..../capigen/lib/templates/monit/monit.cnf</tt>. + # + # ==== Options + # +template_path+:: Relative path + # def gem_template_path(template_path) File.join(gem_templates_root, template_path) end @@ -14,7 +20,11 @@ module Capigen::Plugins::Templates # # ==== Options # +path+:: If starts with '/', absolute path, otherwise relative path to templates dir - # +binding+:: Binding + # +override_binding+:: Binding to override, otherwise uses current (task) binding + # + # ==== Examples + # template.load("memcached/memcached.monitrc.erb") + # put template.load("memcached/memcached.monitrc.erb"), "/tmp/memcached.monitrc" # def load(path, override_binding = nil) template_paths = [ path, gem_template_path(path) ] @@ -41,7 +51,17 @@ module Capigen::Plugins::Templates data end - # Load template from project + # Load template from project. + # If extension is erb will be evaluated with binding. + # + # ==== Options + # +path+:: If starts with '/', absolute path, otherwise relative path to templates dir + # +override_binding+:: Binding to override, otherwise uses current (task) binding + # + # ==== Examples + # template.project("config/templates/sphinx.conf.erb") + # put template.project("config/templates/sphinx.conf.erb"), "#{shared_path}/config/sphinx.conf" + # def project(path, override_binding = nil) load(project_root + "/" + path, override_binding || binding) end @@ -50,7 +70,14 @@ module Capigen::Plugins::Templates # # ==== Options # +template_path+:: Path to template relative to templates path + # +binding+:: Binding + # +dest_path+:: Local destination path to write to + # +overwrite+:: Force overwrite + # +verbose+:: Verbose output # + # ==== Examples + # template.write("config/templates/sphinx.conf.erb", binding, "config/sphinx.conf") + # def write(template_path, binding, dest_path, overwrite = false, verbose = true) # This is gnarly! relative_dest_path = Pathname.new(File.expand_path(dest_path)).relative_path_from(Pathname.new(File.expand_path("."))) lib/capigen/plugins/templates.rb @@ -6,7 +6,7 @@ module Capigen::Plugins::Wget # # ==== Options # +uri+:: URI to get - # +remote_dest_dir+:: Remote destination directory + # +remote_dest_dir+:: Remote destination directory, defaults to /tmp # def uri(uri, remote_dest_dir = "/tmp") lib/capigen/plugins/wget.rb @@ -1,18 +1,54 @@ # Packages must respond to update, remove, install and clean module Capigen::Plugins::Yum - # Update all installed packages + # Update all installed packages. + # + # ==== Options + # +packages+:: Packages to update, or empty to update all + # + # ==== Examples + # yum.update + # yum.update([ "aspell" ]) + # + # Also can use package plugin with package.type = :yum, and then: + # package.update + # package.update([ "aspell" ]) + # def update(packages = []) sudo "yum -y update #{packages.join(" ")}" end # Remove via yum. + # + # ==== Options + # +packages+:: Packages to remove + # + # ==== Examples + # yum.remove + # yum.remove([ "aspell" ]) + # + # Also can use package plugin with package.type = :yum, and then: + # package.remove + # package.remove([ "aspell" ]) + # def remove(packages) sudo "yum -y remove #{packages.join(" ")}" end # Install via yum. - # If package already exists, it will be updated (unless update_existing = false). + # + # ==== Options + # +packages+:: Packages to install, either String (for single package) or Array + # +update_existing+:: If package exists, where to yum update it, defaults to true + # + # ==== Examples + # yum.install + # yum.install([ "aspell" ]) + # + # Also can use package plugin with package.type = :yum, and then: + # package.install + # package.install([ "aspell" ]) + # def install(packages, update_existing = true) # If a single object, wrap in array @@ -34,7 +70,14 @@ module Capigen::Plugins::Yum sudo "yum -y install #{packages.join(" ")}" unless packages.blank? end - # Clean yum + # Clean yum. + # + # ==== Examples + # yum.clean + # + # Also can use package plugin with package.type = :yum, and then: + # package.clean + # def clean sudo "yum -y clean all" end lib/capigen/plugins/yum.rb @@ -2,7 +2,7 @@ module Capigen #:nodoc: module VERSION #:nodoc: MAJOR = 0 MINOR = 1 - TINY = 4 + TINY = 5 STRING = [MAJOR, MINOR, TINY].join('.') end lib/capigen/version.rb @@ -2,17 +2,17 @@ set :namespace, "centos" set :description, "Install based on default centos 5.1 image" set :recipes, [ - "centos:setup", + "centos:setup_for_web", "packages:install", - "ruby:install", - "nginx:install", + "centos:ruby:install", + "centos:nginx:install", "nginx:install_monit", - "mysql:install", + "centos:mysql:install", "mysql:install_monit", - "sphinx:install", - "monit:install", - "imagemagick:install", - "memcached:install", + "centos:sphinx:install", + "centos:monit:install", + "centos:imagemagick:install", + "centos:memcached:install", "memcached:install_monit", "gems:install", "centos:cleanup" @@ -22,6 +22,7 @@ set :recipes, [ # Settings for recipes # +# For packages:install set :packages, { :type => "yum", :remove => [ "openoffice.org-*", "ImageMagick" ], @@ -29,16 +30,10 @@ set :packages, { "gcc", "kernel-devel", "libevent-devel", "libxml2-devel", "openssl", "openssl-devel", "aspell", "aspell-devel", "aspell-en", "aspell-es", - "zlib", "zlib-devel", - "gcc-c++", - "pcre-devel", - "mysql", "mysql-devel", "mysql-server", - "flex", "byacc", - "libjpeg-devel", "libpng-devel", "glib2-devel", "fontconfig-devel", "libwmf-devel", "freetype-devel", - "libtiff-devel" ] } +# For gem:install set :gem_list, [ "rake", "mysql -- --with-mysql-include=/usr/include/mysql --with-mysql-lib=/usr/lib/mysql --with-mysql-config", @@ -49,25 +44,25 @@ set :gem_list, [ "json" ] -# Monit +# For monit:install set :monit_port, 2812 # Capistrano::CLI.ui.ask('Monit port: ') set :monit_password, Proc.new { Capistrano::CLI.ui.ask('Monit admin password (to set): ') } -# For nginx +# For nginx:install set :nginx_bin_path, "/sbin/nginx" set :nginx_conf_path, "/etc/nginx/nginx.conf" set :nginx_pid_path, "/var/run/nginx.pid" set :nginx_prefix_path, "/var/nginx" -# Mysql +# For mysql:install set :mysql_admin_password, Proc.new { Capistrano::CLI.ui.ask('Mysql admin password (to set): ') } set :mysql_pid_path, "/var/run/mysqld/mysqld.pid" set :db_port, 3306 # Capistrano::CLI.ui.ask('Mysql port: ') -# Sphinx +# For sphinx:install set :sphinx_prefix, "/usr/local/sphinx" -# Memcached +# For memcached:install set :memcached_pid_path, "/var/run/memcached.pid" set :memcached_memory, 64 set :memcached_port, 11211 lib/profiles/centos-sick.rb @@ -1,12 +1,5 @@ = Recipes - -Install tasks are one time tasks (per image). - -Setup tasks are one time tasks (per application). - -Update code tasks are called after each deploy (per application). - - -The bootstrap/patch.rb is not a recipe but is to include Capigen helpers for use within recipes. - -Scripts and templates are in ./templates \ No newline at end of file +* Install tasks are one time tasks (per OS). +* Setup tasks are one time tasks (per application). +* Update code tasks are called after each deploy (per application). +* Scripts and templates are in capigen/lib/templates. \ No newline at end of file lib/recipes/README @@ -1,5 +1,6 @@ # Override default deploy tasks here (using Monit). -# If not using monit, use service start/stop, #sudo "/sbin/service mongrel_cluster_#{application} restart" +# If not using monit, use service start/stop: +# sudo "/sbin/service mongrel_cluster_#{application} restart" namespace :deploy do task :restart, :roles => :web do lib/recipes/deploy.rb @@ -2,7 +2,17 @@ namespace :gems do desc "Install gems" task :install do - gem_list = profile.get(:gem_list) + gem_list = profile.get(:gem_list, <<-EOS) + + To use this recipe, set the :gem_list variable (in a profile, Capfile or deploy.rb), for example: + + set :gem_list, [ + "rake", + "mysql -- --with-mysql-include=/usr/include/mysql --with-mysql-lib=/usr/lib/mysql --with-mysql-config", + "raspell" + ] + + EOS gemc.install(gem_list) end lib/recipes/gems.rb @@ -2,7 +2,7 @@ namespace :install do task :default do # Choose profile, and load capistrano settings - fetch(:profile) + profile.ask # These run after install task and install all the apps recipes.each do |task_name| lib/recipes/install.rb @@ -1,10 +1,5 @@ namespace :memcached do - desc "Install memcached" - task :install do - script.install("memcached/install.sh", :file => "memcached/memcached.initd.centos.erb", :dest => "/tmp/memcached.initd") - end - desc "Install memcached monit hooks" task :install_monit do put template.load("memcached/memcached.monitrc.erb", binding), "/tmp/memcached.monitrc" lib/recipes/memcached.rb @@ -1,27 +1,6 @@ # Create init script namespace :mongrel_cluster do - - after "mongrel_cluster:setup", "mongrel_cluster:setup_monit" - - desc "Create mongrel cluster" - task :setup do - run "mkdir -p #{shared_path}/config" - - # Mongrel cluster config needs its own config directory - mongrel_config_path = "#{shared_path}/config/mongrel" - run "mkdir -p #{mongrel_config_path}" - - pid_path = "#{shared_path}/pids" - - put template.load("mongrel/mongrel_cluster.initd.erb", binding), "/tmp/mongrel_cluster_#{application}.initd" - put template.load("mongrel/mongrel_cluster.yml.erb", binding), "#{mongrel_config_path}/mongrel_cluster.yml" - - # Setup the mongrel_cluster init script - sudo "install -o root /tmp/mongrel_cluster_#{application}.initd /etc/init.d/mongrel_cluster_#{application}" - - sudo "/sbin/chkconfig --level 345 mongrel_cluster_#{application} on" - end - + desc "Create monit configuration for mongrel cluster" task :setup_monit do lib/recipes/mongrel_cluster.rb @@ -1,19 +1,29 @@ # Mysql recipes namespace :mysql do - desc "Install mysql" - task :install do - script.install("mysql/install.sh.erb") - end - desc "Install mysql monit hooks" task :install_monit do + + # Settings + mysql_pid_path = profile.get_or_default(:mysql_pid_path, "/var/run/mysqld/mysqld.pid") + db_port = profile.get_or_default(:db_port, 3306) + put template.load("mysql/mysql.monitrc.erb", binding), "/tmp/mysql.monitrc" sudo "install -o root /tmp/mysql.monitrc /etc/monit/mysql.monitrc" end desc "Create database user, and database with appropriate permissions" task :setup do + + # Settings + db_name = profile.get(:db_name) + db_user = profile.get(:db_user) + db_pass = profile.get(:db_pass) + web_host = profile.get(:web_host) + db_host = profile.get(:db_host) + mysql_admin_password = profile.get_or_default(:mysql_admin_password, + Proc.new { Capistrano::CLI.ui.ask('Mysql admin password: ') }) + # Add localhost to grant locations locations_for_grant = [ "localhost", web_host, db_host ] lib/recipes/mysql.rb @@ -4,20 +4,12 @@ namespace :nginx do # Callbacks after "nginx:setup", "nginx:restart" - desc "Install nginx, conf, initscript, nginx user and service" - task :install do - # Dependencies: "pcre-devel", "openssl", "openssl-devel" - - files = [ - { :file => "nginx/nginx.initd.erb", :dest => "/tmp/nginx.initd" }, - { :file => "nginx/nginx.conf.erb", :dest => "/tmp/nginx.conf" } - ] - - script.install("nginx/install.sh.erb", files, binding) - end - desc "Install nginx monit hooks" task :install_monit do + + # Settings + nginx_pid_path = profile.get_or_default(:nginx_pid_path, "/var/run/nginx.pid") + put template.load("nginx/nginx.monitrc.erb", binding), "/tmp/nginx.monitrc" sudo "install -o root /tmp/nginx.monitrc /etc/monit/nginx.monitrc" end lib/recipes/nginx.rb @@ -1,9 +1,20 @@ namespace :packages do + desc "Packages to install" task :install do # Settings - packages = profile.get(:packages) + packages = profile.get(:packages, <<-EOS) + + To use this recipe, set the :packages variable (in a profile, Capfile or deploy.rb), for example: + + set :packages, { + :type => "yum", + :remove => [ "openoffice.org-*", "ImageMagick" ], + :add => [ "gcc", "kernel-devel", "libevent-devel", "libxml2-devel" ] + } + + EOS packages_to_remove = packages[:remove] packages_to_add = packages[:add] lib/recipes/packages.rb @@ -1,30 +1,6 @@ # Sphinx recipes namespace :sphinx do - after "sphinx:setup", "sphinx:setup_monit" - - desc "Install sphinx" - task :install do - # Dependencies: gcc-c++ - script.install("sphinx/install.sh.erb") - end - - desc "Setup sphinx for application" - task :setup do - - sphinx_bin_path = "#{sphinx_prefix}/bin" - sphinx_conf_path = "#{shared_path}/config/sphinx.conf" - sphinx_pid_path = "#{shared_path}/pids/searchd.pid" - - put template.load("sphinx/sphinx_app.initd.centos.erb"), "/tmp/sphinx.initd" - - sudo "install -o root /tmp/sphinx.initd /etc/init.d/sphinx_#{application}" - - sudo "/sbin/chkconfig --level 345 sphinx_#{application} on" - - run "mkdir -p #{shared_path}/var/index" - end - desc "Create monit configuration for sphinx" task :setup_monit do sphinx_pid_path = "#{shared_path}/pids/searchd.pid" lib/recipes/sphinx.rb @@ -5,7 +5,7 @@ <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> - capigen + Capistrano plugins, recipes and templates </title> <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script> <style> @@ -30,10 +30,10 @@ <body> <div id="main"> - <h1>capigen</h1> + <h1>Capistrano plugins, recipes and templates</h1> <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/capigen"; return false'> <p>Get Version</p> - <a href="http://rubyforge.org/projects/capigen" class="numbers">0.1.4</a> + <a href="http://rubyforge.org/projects/capigen" class="numbers">0.1.5</a> </div> <h1>→ ‘capigen’</h1> @@ -41,6 +41,9 @@ <h2>What</h2> + <p>Capistrano plugins, recipes and templates.</p> + + <h2>Installing</h2> @@ -50,16 +53,84 @@ <h2>The basics</h2> + <p>Capigen has recipes for:</p> + + + <ul> + <li>Installing applications, via yum or manual building with make.</li> + <li>Common deployment setup and update_code tasks, such as symlinking in database.yml and more advanced recipes such as sphinx configuration.</li> + <li><span class="caps">ERB</span> templates for application configuration files, init scripts, monit configuration, etc.</li> + <li>And more…</li> + </ul> + + <h2>Demonstration of usage</h2> - <h2>Forum</h2> + <h3>Install recipes</h3> - <p><a href="http://groups.google.com/group/capigen">http://groups.google.com/group/capigen</a></p> + <p>To install an application, use the install recipes. For example:</p> + + + <pre><code>cap nginx:install</code></pre> + + + <p>Recipes may have settings that are required, or defaults that can be overriden. These are usually set in “profiles”.</p> + + + <p>To install a group of applications based on a <a href="</p">profile</a>> + + + <pre><code>cap install</code></pre> + + + <p><em>You may need to comment out “Defaults requiretty” in /etc/sudoders on the image before capistrano recipes will work.</em></p> + + + <h3>Profiles</h3> + + + <p>Profiles store lists of recipes to run, and settings for those recipes.</p> + + + <p>Profiles are capistrano configuration like a Capfile or deploy.rb. See capigen/lib/profiles for more info.</p> - <p><span class="caps">TODO</span> – create Google Group – capigen</p> + <h3>Generating a Capfile and deploy.rb</h3> + + + <p>From a rails project:</p> + + + <pre><code>rake capigen</code></pre> + + + <h3>Deploying (application)</h3> + + + <p>If this is the first time you’ve deployed you’ll need to run:</p> + + + <pre><code>cap deploy:setup</code></pre> + + + <p>Otherwise, your standard deploy options:</p> + + + <pre><code>cap deploy</code></pre> + + + <pre><code>cap deploy:migrations (deploys and does migration)</code></pre> + + + <pre><code>cap deploy:migrate (only does migration on existing deployment)</code></pre> + + + <h2>Forum</h2> + + + <p><a href="http://groups.google.com/group/capigen">http://groups.google.com/group/capigen</a></p> <h2>How to submit patches</h2> @@ -68,7 +139,7 @@ <p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p> - <p>The trunk repository is <code>svn://rubyforge.org/var/svn/capigen/trunk</code> for anonymous access.</p> + <p>The trunk repository is <code>http://svn.ducktyper.com/var/svn/capigen/trunk</code> for anonymous access.</p> <h2>License</h2> @@ -80,9 +151,9 @@ <h2>Contact</h2> - <p>Comments are welcome. Send an email to <a href="mailto:FIXME">Gabriel Handford</a> email via the <a href="http://groups.google.com/group/capigen">forum</a></p> + <p>Comments are welcome. Send an email to <a href="mailto:gabrielh@gmail.com">Gabriel Handford</a> via the <a href="http://groups.google.com/group/capigen">forum</a></p> <p class="coda"> - <a href="FIXME email">Gabriel Handford</a>, 6th February 2008<br> + <a href="FIXME email">Gabriel Handford</a>, 18th February 2008<br> Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </p> </div> website/index.html @@ -1,10 +1,11 @@ -h1. capigen +h1. Capistrano plugins, recipes and templates h1. → 'capigen' h2. What +Capistrano plugins, recipes and templates. h2. Installing @@ -12,22 +13,70 @@ h2. Installing h2. The basics +Capigen has recipes for: + +* Installing applications, via package manager or manually building with make. +* Common deployment setup and update_code tasks, such as symlinking in database.yml and more advanced recipes such as sphinx configuration. +* ERB templates for application configuration files, init scripts, monit configuration, etc. +* And more... + h2. Demonstration of usage +h3. Install recipes + +To install an application, use the install recipes. For example: + + cap nginx:install + +Recipes may have settings that are required, or defaults that can be overriden. These are usually set in "profiles". + +To install a group of applications based on a profile: + + cap install + +<em>You may need to comment out "Defaults requiretty" in /etc/sudoders on the image before capistrano recipes will work.</em> + + +h3. Profiles + +Profiles store lists of recipes to run, and settings for those recipes. + +Profiles are capistrano configuration like a Capfile or deploy.rb. See capigen/lib/profiles for more info. + + +h3. Generating a Capfile and deploy.rb + +From a rails project: + + rake capigen + + +h3. Deploying (application) + +If this is the first time you've deployed you'll need to run: + + cap deploy:setup + +Otherwise, your standard deploy options: + + cap deploy + + cap deploy:migrations (deploys and does migration) + + cap deploy:migrate (only does migration on existing deployment) + h2. Forum "http://groups.google.com/group/capigen":http://groups.google.com/group/capigen -TODO - create Google Group - capigen - h2. How to submit patches Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. -The trunk repository is <code>svn://rubyforge.org/var/svn/capigen/trunk</code> for anonymous access. +The trunk repository is <code>http://svn.ducktyper.com/var/svn/capigen/trunk</code> for anonymous access. h2. License @@ -35,5 +84,5 @@ This code is free to use under the terms of the MIT license. h2. Contact -Comments are welcome. Send an email to "Gabriel Handford":mailto:FIXME email via the "forum":http://groups.google.com/group/capigen +Comments are welcome. Send an email to "Gabriel Handford":mailto:gabrielh@gmail.com via the "forum":http://groups.google.com/group/capigen website/index.txt lib/recipes/centos.rb lib/recipes/imagemagick.rb lib/recipes/monit.rb lib/recipes/ruby.rb lib/templates/centos/setup.sh lib/templates/imagemagick/install.sh lib/templates/memcached/install.sh lib/templates/monit/install.sh lib/templates/mysql/install.sh.erb lib/templates/nginx/install.sh.erb lib/templates/ruby/ruby_install.sh lib/templates/ruby/rubygems_install.sh lib/templates/sphinx/install.sh.erb lib/templates/sphinx/sphinx_app.initd.erb bbbd4dd6b6cf716f8696d645e1e14b64db55a1a3 Gabriel Handford gabrielh@gmail.com http://github.com/gabriel/capitate/commit/736968290ee9388458f2403df344464922ac0cef 736968290ee9388458f2403df344464922ac0cef

2008-02-18T14:15:10-08:00

Major refactoring. git-svn-id: http://svn.ducktyper.com/capigen/trunk@76 03f83d6c-b416-495f-9003-0924d19d01a8 9723020d678d4060d71dd17222cc6e3b7c4f467e Gabriel Handford gabrielh@gmail.com