@@ -5,6 +5,8 @@ * Fixing backgroundjob init (BIN_PATH error) * Adding --log to backgroundjob init.d * Fixing sphinx monit start/stop/restart +* Adding task arguments to DSL +* Updating most of the documentation to pull from task args == 0.3.5 2008-05-08 History.txt @@ -6,11 +6,12 @@ README.txt Rakefile config/hoe.rb config/requirements.rb -docs/nginx.README lib/capitate.rb lib/capitate/cap_ext/connections.rb lib/capitate/cap_ext/docs.rb +lib/capitate/cap_ext/namespace.rb lib/capitate/cap_ext/run_via.rb +lib/capitate/cap_ext/task_definition.rb lib/capitate/cap_ext/variables.rb lib/capitate/plugins/base.rb lib/capitate/plugins/build.rb @@ -78,6 +79,7 @@ lib/templates/logrotated/conf.erb lib/templates/memcached/memcached.initd.centos.erb lib/templates/memcached/memcached.monitrc.erb lib/templates/memcached/memcached.yml.erb +lib/templates/merb/merb-no-http.monitrc.erb lib/templates/merb/merb.initd.centos.erb lib/templates/merb/merb.monitrc.erb lib/templates/mongrel/mongrel_cluster.initd.centos.erb @@ -112,11 +114,3 @@ test/test_helper.rb test/test_plugin_upload.rb test/test_recipes.rb test/test_templates.rb -website/index.html -website/index.txt -website/javascripts/code_highlighter.js -website/javascripts/rounded_corners_lite.inc.js -website/javascripts/ruby.js -website/stylesheets/screen.css -website/template.rhtml -website/template_recipe.rhtml Manifest.txt @@ -27,6 +27,8 @@ require "capitate/cap_ext/connections" require "capitate/cap_ext/variables" require "capitate/cap_ext/run_via" require "capitate/cap_ext/docs" +require "capitate/cap_ext/namespace" +require "capitate/cap_ext/task_definition" class Capistrano::Configuration include Capitate::CapExt::Variables @@ -35,6 +37,18 @@ class Capistrano::Configuration include Capitate::CapExt::Docs end +class Capistrano::TaskDefinition + include Capitate::CapExt::TaskDefinition +end + +class Capistrano::Configuration::Namespaces::Namespace + include Capitate::CapExt::Namespace +end + +module Capistrano::Configuration::Namespaces + include Capitate::CapExt::Namespace +end + #module Capistrano::Configuration::Connections; end require 'capitate/task_node' lib/capitate.rb @@ -172,7 +172,27 @@ class Capitate::TaskNode options = "" options = "<span class='options'>, #{task.options.inspect}</span>" unless task.options.blank? file.puts "h3(##{task.fully_qualified_name}). #{task.fully_qualified_name}#{options}\n\n" - file.puts "#{unindent(task.desc)}\n\n" + file.puts "#{unindent(task.desc)}\n\n" + if task.arguments + file.puts "h4. Parameters\n\n" + file.puts "<dl>\n" + task.arguments.each do |arg| + file.puts "<dt>#{arg[:name]}</dt>" + file.puts "<dd>#{unindent(arg[:desc])}</dd>" if arg.has_key?(:desc) + if arg.has_key?(:default_desc) + file.puts "<dd class='default'>Defaults to @#{arg[:default_desc]}@</dd>" + elsif arg.has_key?(:default) + file.puts "<dd class='default'>Defaults to @#{arg[:default].inspect}@</dd>" + end + + if arg.has_key?(:set) + file.puts "<dd class='default'>Defaults to @#{arg[:set].inspect}@ (cap setting)</dd>" + end + + file.puts "<dd class='example'>Example: @set :#{arg[:name]}, #{arg[:example]}@" if arg.has_key?(:example) + end + end + file.puts "</dl>\n\n" file.puts "</div>\n\n\n" end end lib/capitate/task_node.rb @@ -2,7 +2,7 @@ module Capitate #:nodoc: module VERSION #:nodoc: MAJOR = 0 MINOR = 3 - TINY = 5 + TINY = 6 STRING = [MAJOR, MINOR, TINY].join('.') end lib/capitate/version.rb @@ -4,45 +4,16 @@ namespace :active_record do Create (ActiveRecord) database yaml in shared path. Note: If both @:db_host@ and @:db_socket@ are used, @db_socket@ wins. - <dl> - <dt>db_name</dt> - <dd>Database name.</dd> - <dd>@set :db_name, "app_db_name"@</dd> - - <dt>db_user</dt> - <dd>Database user.</dd> - <dd>@set :db_user, "app_db_user"@</dd> - - <dt>db_pass</dt> - <dd>Database password.</dd> - <dd>@set :db_pass, "the_password"@</dd> - - <dt>db_host</dt> - <dd>Database host (can be nil, if you are using socket).</dd> - <dd class="default">Defaults to @nil@</dd> - - <dt>db_socket</dt> - <dd>Database socket (can be nil, if you are using host).</dd> - <dd class="default">Defaults to @nil@</dd> - <dd>@set :db_socket, "/var/lib/mysql/mysql.sock"@</dd> - - <dt>database_yml_template</dt> - <dd>Path to database yml erb template. - <dd class="default">Defaults to @rails/database.yml.erb@ (in this GEM)</dd> - </dl> - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:db_name, "Database name") + task_arg(:db_user, "Database user") + task_arg(:db_pass, "Database password") + task_arg(:db_host, "Database host", :default => nil) + task_arg(:db_socket, "Database socket", :default => nil) + task_arg(:database_yml_template, "Database yml template", :default => "rails/database.yml.erb") task :setup, :roles => :app do - # Settings - fetch(:db_name) - fetch(:db_user) - fetch(:db_pass) - fetch_or_default(:db_host, nil) - fetch_or_default(:db_socket, nil) - fetch_or_default(:database_yml_template, "rails/database.yml.erb") - unless db_host.blank? set :db_connect_type, "host" set :db_connect, db_host @@ -57,7 +28,7 @@ namespace :active_record do put template.load(database_yml_template), "#{shared_path}/config/database.yml" end - desc "Make symlink for database yaml" + desc "Make symlink for database yaml" task :update_code do run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml" end lib/recipes/active_record.rb @@ -6,29 +6,14 @@ namespace :backgroundrb do For pid path support, change backgroundrb script pid_file line to: pid_file = "\#{CONFIG_FILE[:backgroundrb][:pid_file]}" - - <dl> - <dt>backgroundrb_host</dt> - <dd>Backgroundrb host</dd> - <dd class="default">Defaults to @0.0.0.0@</dd> - <dt>backgroundrb_port</dt> - <dd>Backgroundrb port</dd> - <dd class="default">Defaults to @11006@</dd> - - <dt>backgroundrb_yml_template</dt> - <dd>Backgroundrb yml template</dd> - <dd class="default">Defaults to @backgroundrb/backgroundrb.yml.erb@ in this gem.</dd> - </dl> - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:backgroundrb_host, "Backgroundrb host", :default => "0.0.0.0") + task_arg(:backgroundrb_port, "Backgroundrb port", :default => 11006) + task_arg(:backgroundrb_pid_path, "Backgroundrb pid path", :default => Proc.new{"#{shared_path}/pids/backgroundrb.pid"}, :default_desc => "\#{shared_path}/pids/backgroundrb.pid") + task_arg(:backgroundrb_yml_template, "Backgroundrb yml template", :default => "backgroundrb/backgroundrb.yml.erb") task :setup do - fetch_or_default(:backgroundrb_host, "0.0.0.0") - fetch_or_default(:backgroundrb_port, 11006) - fetch_or_default(:backgroundrb_pid_path, "#{shared_path}/pids/backgroundrb.pid") - fetch_or_default(:backgroundrb_yml_template, "backgroundrb/backgroundrb.yml.erb") - utils.install_template(backgroundrb_yml_template, "#{shared_path}/config/backgroundrb.yml") end lib/recipes/backgroundrb.rb @@ -5,35 +5,15 @@ namespace :backgroundjob do desc <<-DESC Setup backgroundjob for application. - <dl> - <dt>backgroundjob_bin_path</dt> - <dd>Path to start. - <dd class="default">Defaults to: - <pre> - \#{current_path}/script/bj --forever --rails_env=production --rails_root=\#{current_path} \ - --redirect=\#{backgroundjob_log_path} --log=\#{backgroundjob_log_path} --pidfile=\#{backgroundjob_pid_path} --daemon - </pre> - </dd> - <dt>backgroundjob_pid_path</dt> - <dd>Path to backgroundjob pid file</dd> - <dd class="default">Defaults to @\#{shared_path}/pids/bj.pid@</dd> - - <dt>backgroundjob_log_path</dt> - <dd>Path to backgroundjob log file</dd> - <dd class="default">Defaults to @\#{shared_path}/logs/bj.log@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:backgroundjob_bin_path, "Path to backgroundjob", + :default => Proc.new{"#{current_path}/script/bj run --forever --rails_env=production --rails_root=#{current_path} --redirect=#{backgroundjob_log_path} --log=#{backgroundjob_log_path} --pidfile=#{backgroundjob_pid_path} --daemon"}, + :default_desc => "\#{current_path}/script/bj run --forever --rails_env=production --rails_root=\#{current_path} --redirect=\#{backgroundjob_log_path} --log=\#{backgroundjob_log_path} --pidfile=\#{backgroundjob_pid_path} --daemon") + task_arg(:backgroundjob_pid_path, "Path to backgroundjob pid file", :default => Proc.new{"#{shared_path}/pids/bj.pid"}, :default_desc => "\#{shared_path}/pids/bj.pid") + task_arg(:backgroundjob_log_path, "Path to backgroundjob log file", :default => Proc.new{"#{shared_path}/log/bj.log"}, :default_desc => "\#{shared_path}/log/bj.log") task :setup do - # Settings - fetch_or_default(:backgroundjob_pid_path, "#{shared_path}/pids/bj.pid") - fetch_or_default(:backgroundjob_log_path, "#{shared_path}/log/bj.log") - - default_bin_path = "#{current_path}/script/bj run --forever --rails_env=production --rails_root=#{current_path} \ ---redirect=#{backgroundjob_log_path} --log=#{backgroundjob_log_path} --pidfile=#{backgroundjob_pid_path} --daemon" - fetch_or_default(:backgroundjob_bin_path, default_bin_path) - # Install initscript utils.install_template("backgroundjob/backgroundjob.initd.centos.erb", "/etc/init.d/backgroundjob_#{application}") lib/recipes/centos/backgroundjob.rb @@ -5,22 +5,11 @@ namespace :backgroundrb do desc <<-DESC Setup backgroundrb for application. - <dl> - <dt>backgroundrb_bin_path</dt> - <dd>Path to start. - <dd class="default">Defaults to @\#{current_path}/script/backgroundrb -e production start@</dd> - <dt>backgroundrb_pid_path</dt> - <dd>Path to backgroundrb pid file</dd> - <dd class="default">Defaults to @\#{shared_path}/pids/backgroundrb.pid@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:backgroundrb_bin_path, "Path to backgroundrb bin", :default => Proc.new{"#{current_path}/script/backgroundrb -e production start"}, :default_desc => "\#{current_path}/script/backgroundrb -e production start") + task_arg(:backgroundrb_pid_path, "Path to backgroundrb pid file", :default => Proc.new{"#{shared_path}/pids/backgroundrb.pid"}, :default_desc => "\#{shared_path}/pids/backgroundrb.pid") task :setup do - - # Settings - fetch_or_default(:backgroundrb_bin_path, "#{current_path}/script/backgroundrb -e production start") - fetch_or_default(:backgroundrb_pid_path, "#{shared_path}/pids/backgroundrb.pid") - # Install initscript utils.install_template("backgroundrb/backgroundrb.initd.centos.erb", "/etc/init.d/backgroundrb_#{application}") lib/recipes/centos/backgroundrb.rb @@ -5,36 +5,14 @@ namespace :centos do desc <<-DESC Add user and set user password for application. Adds user to specified groups. - <dl> - <dt>user_add</dt> - <dd>User to add.</dd> - <dd>@set :user_add, "app_user"@</dd> - - <dt>groups</dt> - <dd>Groups for user to be in.</dd> - <dd class="default">Defaults to @nil@</dd> - <dd>@set :groups, "admin,foo"@</dd> - - <dt>home</dt> - <dd>Home directory for user.</dd> - <dd class="default">Defaults to @:deploy_to@ setting_</dd> - <dd>@set :home, "/var/www/apps/app_name"@</dd> - - <dt>home_readable</dt> - <dd>Whether home permissions are readable by all. Needed if using deploy dir as home.</dd> - <dd class="default">Defaults to @true@</dd> - <dd>@set :home_readable, true@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:user_add, "User to add") + task_arg(:groups, "Groups for user to be in", :default => nil, :example => "\"admin,foo,bar\"") + task_arg(:home, "Home directory for user", :set => :deploy_to) + task_arg(:home_readable, "Whether home permissions are readable by all. Needed if using deploy dir as home.", :default => true) task :add_user do - # Settings - fetch(:user_add) - fetch_or_default(:groups, nil) - fetch_or_default(:home, deploy_to) - fetch_or_default(:home_readable, true) - adduser_options = [] adduser_options << "-d #{home}" unless home.blank? adduser_options << "-G #{groups}" unless groups.blank? lib/recipes/centos/centos.rb @@ -2,8 +2,12 @@ namespace :imagemagick do namespace :centos do desc <<-DESC - Install imagemagick.\n - <dl><dt>imagemagick_build_options</dt><dd>Imagemagick build options</dd></dl> + Install imagemagick. + + "Source":#{link_to_source(__FILE__)} + DESC + task_arg(:imagemagick_build_options, <<-EOS) + Imagemagick build options <pre> <code class="ruby"> set :imagemagick_build_options, { @@ -12,13 +16,8 @@ namespace :imagemagick do } </code> </pre> - "Source":#{link_to_source(__FILE__)} - DESC - task :install do - - # Settings - fetch(:imagemagick_build_options) - + EOS + task :install do # Install dependencies yum.install([ "libjpeg-devel", "libpng-devel", "glib2-devel", "fontconfig-devel", "zlib-devel", "libwmf-devel", "freetype-devel", "libtiff-devel" ]) lib/recipes/centos/imagemagick.rb @@ -5,10 +5,13 @@ namespace :memcached do desc <<-DESC Install memcached. - <dl> - <dt>memcached_build_options</dt> - <dd>Memcached build options.</dd> - <dd> + "Source":#{link_to_source(__FILE__)} + DESC + task_arg(:memcached_pid_path, "Path to memcached pid file.", :default => "/var/run/memcached.pid") + task_arg(:memcached_port, "Memcached port", :default => 11211) + task_arg(:memcached_memory, "Memcached memory (in MB)") + task_arg(:memcached_build_options, <<-EOS) + Memcached build options <pre> <code class="ruby"> set :memcached_build_options, { @@ -17,66 +20,22 @@ namespace :memcached do } </code> </pre> - </dd> - - - <dt>memcached_memory</dt> - <dd>Memcached memory (in MB).</dd> - <dd>@set :memcached_memory, 64@</dd> - - <dt>memcached_pid_path*</dt> - <dd>Path to memcached pid file.</dd> - <dd class="default">Defaults to @/var/run/memcached.pid@</dd> - <dd>@set :memcached_pid_path, "/var/run/memcached.pid"@</dd> - - <dt>memcached_port</dt> - <dd>Memcached port<dd> - <dd class="default">Defaults to 11211.</dd> - <dd>@set :memcached_port, 11211@</dd> - - </dl> - "Source":#{link_to_source(__FILE__)} - DESC + EOS task :install do - - # Settings - fetch_or_default(:memcached_pid_path, "/var/run/memcached.pid") - fetch_or_default(:memcached_port, 11211) - fetch(:memcached_memory) - fetch(:memcached_build_options) - # Build build.make_install("memcached", memcached_build_options) - initscript end desc <<-DESC Install memcached initscript. - <dl> - <dt>memcached_memory</dt> - <dd>Memcached memory (in MB).</dd> - <dd>@set :memcached_memory, 64@</dd> - - <dt>memcached_pid_path*</dt> - <dd>Path to memcached pid file.</dd> - <dd class="default">Defaults to @/var/run/memcached.pid@</dd> - <dd>@set :memcached_pid_path, "/var/run/memcached.pid"@</dd> - - <dt>memcached_port</dt> - <dd>Memcached port<dd> - <dd class="default">Defaults to 11211.</dd> - <dd>@set :memcached_port, 11211@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC - task :initscript do - - fetch_or_default(:memcached_pid_path, "/var/run/memcached.pid") - fetch_or_default(:memcached_port, 11211) - fetch(:memcached_memory) - + task_arg(:memcached_pid_path, "Path to memcached pid file.", :default => "/var/run/memcached.pid") + task_arg(:memcached_port, "Memcached port", :default => 11211) + task_arg(:memcached_memory, "Memcached memory (in MB)") + task :initscript do utils.install_template("memcached/memcached.initd.centos.erb", "/etc/init.d/memcached") run_via "/sbin/chkconfig --level 345 memcached on" end lib/recipes/centos/memcached.rb @@ -4,42 +4,16 @@ namespace :merb do desc <<-DESC Setup merb. - <dl> - <dt>merb_command_path</dt> - <dd>The path for merb startup command</dd> - <dd class="default">Defaults to @merb@</dd> - - <dt>merb_nodes</dt> - <dd>Number of merb daemons to run</dd> - <dd>@set :merb_nodes, 3@</dd> - - <dt>merb_port</dt> - <dd>Starting port for merb nodes. If there are 3 merb nodes with port 9000, - then instances will be at 9000, 9001, and 9002</dd> - <dd>@set :merb_port, 9000@</dd> - - <dt>merb_root</dt> - <dd>Directory for merb root</dd> - <dd class="default">Defaults to @\#{current_path}@</dd> - - <dt>merb_pid_path</dt> - <dd>Path for merb pids</dd> - <dd class="default">Defaults to @\#{shared_path}/pids/merb.pid@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:merb_nodes, "Number of merb daemons to run") + task_arg(:merb_port, "Starting port for merb nodes. If there are 3 merb nodes with port 9000, then instances will be at 9000, 9001, and 9002") + task_arg(:merb_command_path, "The path for merb startup command", :default => "merb") + task_arg(:merb_pid_path, "Path for merb pids", :default => Proc.new{"#{shared_path}/pids/merb.pid"}, :default_desc => "\#{shared_path}/pids/merb.pid") + task_arg(:merb_root, "Directory for merb root", :set => :current_path) + task_arg(:merb_application, "Merb application name", :default => Proc.new{"merb_#{application}"}, :default_desc => "merb_\#{application}") + task_arg(:merb_initscript_name, "Initscript name", :default => Proc.new{"merb_#{application}"}, :default_desc => "merb_\#{application}") task :setup do - - # Settings - fetch(:merb_nodes) - fetch(:merb_port) - fetch_or_default(:merb_command_path, "merb") - fetch_or_default(:merb_pid_path, "#{shared_path}/pids/merb.pid") - fetch_or_default(:merb_root, current_path) - fetch_or_default(:merb_application, "merb_#{application}") - - fetch_or_default(:merb_initscript_name, "merb_#{application}") - utils.install_template("merb/merb.initd.centos.erb", "/etc/init.d/#{merb_initscript_name}") run_via "/sbin/chkconfig --level 345 #{merb_initscript_name} on" end lib/recipes/centos/merb.rb @@ -7,55 +7,21 @@ namespace :mongrel do desc <<-DESC Create mongrel cluster. - <dl> - <dt>mongrel_application</dt> - <dd>Name of mongrel application</dd> - <dd>@set :mongrel_application, "mongrel_cluster_\#{application}"@</dd> - - <dt>mongrel_size</dt><dd>Number of mongrels</dd> - <dd>@set :mongrel_size, 3@</dd> - - <dt>mongrel_port</dt><dd>Starting port for mongrels. If there are 3 mongrels with port 9000, - then instances will be at 9000, 9001, and 9002</dd> - <dd>@set :mongrel_port, 9000@</dd> - - <dt>mongrel_config_dir</dt> - <dd>Directory for mongrel config.</dd> - <dd class="default">Defaults to @\#{shared_path}/config/mongrel@</dd> - - <dt>mongrel_pid_dir</dt><dd>Directory for mongrel pids</dd> - <dd class="default">Defaults to @\#{shared_path}/pids@</dd> - - <dt>mongrel_config_script</dt><dd>Config script to load with mongrel</dd> - <dd class="default">Defaults to @nil@</dd> - <dd>@set :mongrel_config_script, "config/mongrel_handler.rb"@</dd> - - <dt>mongrel_cluster_command</dt> - <dd>Mongrel cluster command.</dd> - <dd class="default">Defaults to @mongrel_cluster_ctl@</dd> + "Source":#{link_to_source(__FILE__)} + DESC - <dt>mongrel_initscript_name</dt><dd>Mongrel initscript name.</dd> - <dd class="default">Defaults to @mongrel_cluster_\#{application}@</dd> + task_arg(:mongrel_application, "Name of mongrel application") + task_arg(:mongrel_size, "Number of mongrels") + task_arg(:mongrel_port, "Starting port for mongrels. If there are 3 mongrels with port 9000, then instances will be at 9000, 9001, and 9002") + task_arg(:mongrel_config_dir, "Directory for mongrel config", :default => Proc.new{"#{shared_path}/config/mongrel"}, :default_desc => "\#{shared_path}/config/mongrel") + task_arg(:mongrel_pid_dir, "Directory for mongrel pids", :default => Proc.new{"#{shared_path}/pids"}, :default_desc => "\#{shared_path}/pids") + task_arg(:mongrel_config_script, "Config script to load with mongrel", :default => nil) - <dt>mongrel_config_options</dt> - <dd>Config options appended to cluster yml.</dd> - <dd class="default">Defaults to @{}@</dd> + task_arg(:mongrel_cluster_command, "Mongrel cluster command", :default => "mongrel_cluster_ctl") + task_arg(:mongrel_initscript_name, "Mongrel initscript name", :default => Proc.new{"mongrel_cluster_#{application}"}, :default_desc => "mongrel_cluster_\#{application}") + task_arg(:mongrel_config_options, "Config options appended to cluster yml", :default => {}) - </dl> - "Source":#{link_to_source(__FILE__)} - DESC task :setup do - - # Settings - fetch(:mongrel_size) - fetch(:mongrel_port) - fetch_or_default(:mongrel_config_dir, "#{shared_path}/config/mongrel") - fetch_or_default(:mongrel_pid_dir, "#{shared_path}/pids") - fetch_or_default(:mongrel_config_script, nil) - - fetch_or_default(:mongrel_cluster_command, "mongrel_cluster_ctl") - fetch_or_default(:mongrel_initscript_name, "mongrel_cluster_#{application}") - fetch_or_default(:mongrel_config_options, {}) unless mongrel_config_script.blank? mongrel_config_options["config_script"] = mongrel_config_script @@ -72,13 +38,11 @@ namespace :mongrel do end desc "Mongrel cluster setup initscript for application" + task_arg(:mongrel_config_dir, "Directory for mongrel config", :default => Proc.new{"#{shared_path}/config/mongrel"}, :default_desc => "\#{shared_path}/config/mongrel") + task_arg(:mongrel_pid_dir, "Directory for mongrel pids", :default => Proc.new{"#{shared_path}/pids"}, :default_desc => "\#{shared_path}/pids") + task_arg(:mongrel_cluster_command, "Mongrel cluster command", :default => "mongrel_cluster_ctl") + task_arg(:mongrel_initscript_name, "Mongrel initscript name", :default => Proc.new{"mongrel_cluster_#{application}"}, :default_desc => "mongrel_cluster_\#{application}") task :initscript do - - fetch_or_default(:mongrel_config_dir, "#{shared_path}/config/mongrel") - fetch_or_default(:mongrel_pid_dir, "#{shared_path}/pids") - fetch_or_default(:mongrel_cluster_command, "mongrel_cluster_ctl") - fetch_or_default(:mongrel_initscript_name, "mongrel_cluster_#{application}") - utils.install_template("mongrel/mongrel_cluster.initd.centos.erb", "/etc/init.d/#{mongrel_initscript_name}") run_via "/sbin/chkconfig --level 345 #{mongrel_initscript_name} on" end lib/recipes/centos/mongrel_cluster.rb @@ -5,49 +5,23 @@ namespace :monit do desc <<-DESC Install monit. - <dl> - <dt>monit_build_options</dt> - <dd>Monit build options.</dd> - + "Source":#{link_to_source(__FILE__)} + DESC + task_arg(:monit_port, "Monit port", :default => 2812) + task_arg(:monit_password, "Monit password", :default => Proc.new{prompt.password('Monit admin password (to set): ', :verify => true)}, :default_desc => "password prompt") + task_arg(:monit_conf_dir, :default => "/etc/monit") + task_arg(:monit_pid_path, "Path to monit pid", :default => "/var/run/monit.pid") + task_arg(:monit_log_path, "Path to monit log file", :default => "/var/log/monit.log") + task_arg(:monit_build_options, <<-EOS) + Monit build options <pre> <code class="ruby"> set :monit_build_options, { :url => "http://www.tildeslash.com/monit/dist/monit-4.10.1.tar.gz" } </code> </pre> - - <dt>monit_port</dt> - <dd>Monit port</dd> - <dd class="default">Defaults to @2812@</dd> - <dd>@set :monit_port, 2812@</dd> - - <dt>monit_password</dt> - <dd>Monit password</dd> - <dd class="default">Defaults to password prompt</dd> - <dd>@set :monit_password, prompt.password('Monit admin password (to set): ')@</dd> - - <dt>monit_conf_dir</dt><dd>Directory for monitrc files.</dd> - <dd>@set :monit_conf_dir, "/etc/monit"@</dd> - - <dt>monit_pid_path</dt><dd>Path to monit pid.</dd> - @set :monit_pid_path, "/var/run/monit.pid"@</dd> - - <dt>monit_log_path</dt> - <dd>Path to monit log file.</dd> - <dd class="default">Defaults to @/var/log/monit.log@</dd> - - </dl> - "Source":#{link_to_source(__FILE__)} - DESC + EOS task :install do - # Settings - fetch_or_default(:monit_port, 2812) - fetch_or_default(:monit_password, prompt.password('Monit admin password (to set): ', :verify => true)) - fetch_or_default(:monit_conf_dir, "/etc/monit") - fetch_or_default(:monit_pid_path, "/var/run/monit.pid") - fetch_or_default(:monit_log_path, "/var/log/monit.log") - fetch(:monit_build_options) - # Install dependencies yum.install([ "flex", "byacc" ]) lib/recipes/centos/monit.rb @@ -5,19 +5,10 @@ namespace :mysql do desc <<-DESC Install mysql. - <dl> - <dt>mysql_admin_password_set</dt> - <dd>Mysql admin password (to set)</dd> - <dd class="default">Defaults to password prompt.</dd> - <pre><code class="ruby">set :mysql_admin_password_set, prompt.password('Mysql admin password (to set): ')<code></pre> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:mysql_admin_password_set, "Mysql admin password (to set)", :default => Proc.new{prompt.password('Mysql admin password (to set): ', :verify => true)}, :default_desc => "password prompt") task :install do - - # Settings - fetch_or_default(:mysql_admin_password_set, prompt.password('Mysql admin password (to set): ', :verify => true)) - # Install through package manager yum.install([ "mysql", "mysql-devel", "mysql-server" ]) lib/recipes/centos/mysql.rb @@ -5,9 +5,10 @@ namespace :nginx do desc <<-DESC Install nginx, conf, initscript, nginx user and service. - <dl> - <dt>nginx_build_options</dt> - <dd>Nginx build options. + "Source":#{link_to_source(__FILE__)} + DESC + task_arg(:nginx_build_options, <<-EOS) + Nginx build options. <pre> <code class="ruby"> set :nginx_build_options, { @@ -18,39 +19,12 @@ namespace :nginx do } </code> </pre> - </dd> - - <dt>nginx_bin_path</dt> - <dd>Nginx sbin path</dd> - <dd class="default">Defaults to /sbin/nginx</dd> - <dd>@set :nginx_bin_path, "/sbin/nginx"@</dd> - - <dt>nginx_conf_path</dt> - <dd>Path to nginx conf.</dd> - <dd class="default">Defaults to /etc/nginx/nginx.conf</dd> - <dd>@set :nginx_conf_path, "/etc/nginx/nginx.conf"@</dd> - - <dt>nginx_pid_path</dt> - <dd>Path to nginx pid file</dd> - <dd class="default">Defaults to /var/run/nginx.pid</dd> - <dd>@set :nginx_pid_path, "/var/run/nginx.pid"@</dd> - - <dt>nginx_prefix_path</dt> - <dd>Nginx install prefix</dd> - <dd class="default">Defaults to /var/nginx_</dd> - <dd>@set :nginx_prefix_path, "/var/nginx"@</dd> - </dl> - "Source":#{link_to_source(__FILE__)} - DESC - task :install do - - # Settings - fetch(:nginx_build_options) - fetch_or_default(:nginx_bin_path, "/sbin/nginx") - fetch_or_default(:nginx_conf_path, "/etc/nginx/nginx.conf") - fetch_or_default(:nginx_pid_path, "/var/run/nginx.pid") - fetch_or_default(:nginx_prefix_path, "/var/nginx") - + EOS + task_arg(:nginx_bin_path, "Nginx sbin path", :default => "/sbin/nginx") + task_arg(:nginx_conf_path, "Path to nginx conf", :default => "/etc/nginx/nginx.conf") + task_arg(:nginx_pid_path, "Path to nginx pid file", :default => "/var/run/nginx.pid") + task_arg(:nginx_prefix_path, "Nginx install prefix", :default => "/var/nginx") + task :install do # Install dependencies yum.install([ "pcre-devel", "openssl", "openssl-devel" ]) @@ -71,11 +45,10 @@ namespace :nginx do end desc "Install nginx initscript" + task_arg(:nginx_bin_path, "Nginx sbin path", :default => "/sbin/nginx") + task_arg(:nginx_conf_path, "Path to nginx conf", :default => "/etc/nginx/nginx.conf") + task_arg(:nginx_pid_path, "Path to nginx pid file", :default => "/var/run/nginx.pid") task :initscript do - fetch_or_default(:nginx_bin_path, "/sbin/nginx") - fetch_or_default(:nginx_conf_path, "/etc/nginx/nginx.conf") - fetch_or_default(:nginx_pid_path, "/var/run/nginx.pid") - utils.install_template("nginx/nginx.initd.centos.erb", "/etc/init.d/nginx") run_via "/sbin/chkconfig --level 345 nginx on" end @@ -84,8 +57,7 @@ namespace :nginx do desc "Restart nginx (service)" task :restart do sudo "/sbin/service nginx restart" - end - + end end lib/recipes/centos/nginx.rb @@ -5,14 +5,10 @@ namespace :ruby do desc <<-DESC Install ruby and rubygems. - <dl> - <dt>ruby_build_options</dt> - <dd>Ruby build options.</dd> - - <dt>rubygems_build_options<dt> - <dd>Rubygems build options.</dd> - </dl> - + "Source":#{link_to_source(__FILE__)} + DESC + task_arg(:ruby_build_options, <<-EOS) + Rubygems build options. <pre> <code class="ruby"> set :ruby_build_options, { @@ -23,14 +19,9 @@ namespace :ruby do } </code> </pre> - "Source":#{link_to_source(__FILE__)} - DESC + EOS + task_arg(:rubygems_build_options, "Rubygems build options") task :install do - - # Settings - fetch(:ruby_build_options) - fetch(:rubygems_build_options) - # Install dependencies yum.install([ "zlib", "zlib-devel", "readline-devel" ]) lib/recipes/centos/ruby.rb @@ -5,10 +5,9 @@ namespace :sphinx do desc <<-DESC Install sphinx.\n - <dl> - <dt>sphinx_build_options</dt> - <dd>Sphinx build options.</dd> - <dd> + DESC + task_arg(:sphinx_build_options, <<-EOS) + Sphinx build options. <pre> <code class="ruby"> set :sphinx_build_options, { @@ -18,19 +17,9 @@ namespace :sphinx do } </code> </pre> - </dd> - - <dt>sphinx_prefix</dt> - <dd>Sphinx install prefix</dd> - <dd class="default">Defaults to @/usr/local/sphinx@</dd> - </dl> - DESC + EOS + task_arg(:sphinx_prefix, "Sphinx install prefix", :default => "/usr/local/sphinx") task :install do - - # Settings - fetch(:sphinx_build_options) - fetch_or_default(:sphinx_prefix, "/usr/local/sphinx") - # Install dependencies yum.install([ "gcc-c++" ]) @@ -41,37 +30,25 @@ namespace :sphinx do desc <<-DESC Setup sphinx for application. - <dl> - <dt>sphinx_prefix</dt><dd>Sphinx install prefix</dd><dd class="default">Defaults to @/usr/local/sphinx@</dd> - <dt>sphinx_pid_path</dt><dd>Directory to sphinx pid</dd><dd class="default">Defaults to @\#{shared_path}/pids/searchd.pid@</dd> - <dt>sphinx_conf_path</dt><dd>Path to sphinx.conf</dd><dd class="default">Defaults to @\#{shared_path}/config/sphinx.conf@</dd> - <dt>sphinx_index_path</dt><dd>Path to sphinx indexes</dd><dd class="default">Defaults to @\#{shared_path}/var/index@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:sphinx_prefix, "Sphinx install prefix", :default => "/usr/local/sphinx") + task_arg(:sphinx_pid_path, "Directory to sphinx pid", :default => Proc.new{"#{shared_path}/pids/searchd.pid"}, :default_desc => "\#{shared_path}/pids/searchd.pid") + task_arg(:sphinx_conf_path, "Path to sphinx.conf", :default => Proc.new{"#{shared_path}/config/sphinx.conf"}, :default_desc => "\#{shared_path}/config/sphinx.conf") + task_arg(:sphinx_index_root, "Path to sphinx indexes", :default => Proc.new{"#{shared_path}/var/index"}, :default_desc => "\#{shared_path}/var/index") task :setup do - - # Settings - fetch_or_default(:sphinx_prefix, "/usr/local/sphinx") - fetch_or_default(:sphinx_pid_path, "#{shared_path}/pids/searchd.pid") - fetch_or_default(:sphinx_conf_path, "#{shared_path}/config/sphinx.conf") - fetch_or_default(:sphinx_index_root, "#{shared_path}/var/index") - initscript - # Create app indexes dir run "mkdir -p #{shared_path}/var/index" end desc "Setup sphinx initscript" + task_arg(:sphinx_prefix, "Sphinx install prefix", :default => "/usr/local/sphinx") + task_arg(:sphinx_pid_path, "Directory to sphinx pid", :default => Proc.new{"#{shared_path}/pids/searchd.pid"}, :default_desc => "\#{shared_path}/pids/searchd.pid") + task_arg(:sphinx_conf_path, "Path to sphinx.conf", :default => Proc.new{"#{shared_path}/config/sphinx.conf"}, :default_desc => "\#{shared_path}/config/sphinx.conf") + task_arg(:sphinx_index_root, "Path to sphinx indexes", :default => Proc.new{"#{shared_path}/var/index"}, :default_desc => "\#{shared_path}/var/index") task :initscript do - - fetch_or_default(:sphinx_prefix, "/usr/local/sphinx") - fetch_or_default(:sphinx_pid_path, "#{shared_path}/pids/searchd.pid") - fetch_or_default(:sphinx_conf_path, "#{shared_path}/config/sphinx.conf") - fetch_or_default(:sphinx_index_root, "#{shared_path}/var/index") - utils.install_template("sphinx/sphinx_app.initd.centos.erb", "/etc/init.d/sphinx_#{application}") run_via "/sbin/chkconfig --level 345 sphinx_#{application} on" lib/recipes/centos/sphinx.rb @@ -5,24 +5,12 @@ namespace :docs do This recipe generated this documentation. - <dl> - <dt>docs_recipes_dir</dd> - <dd>Destination directory</dd> - <dd class="default">Defaults to @docs/recipes@</dd> - <dd>@set :docs_recipes_dir, "docs/recipes"@</dd> - - <dt>docs_recipes_clear</dt> - <dd>Whether to clear destination before generating.</dd> - <dd>@set :docs_recipes_clear, true@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:docs_recipes_dir, "Destination directory", :default => "docs/recipes") + task_arg(:docs_recipes_clear, "Whether to clear destination before generating.", :default => true) task :recipes do - # Settings - fetch_or_default(:docs_recipes_dir, "docs/recipes") - fetch_or_default(:docs_recipes_clear, true) - # Build task tree top_node = capitate.task_tree lib/recipes/docs.rb @@ -3,23 +3,22 @@ namespace :logrotated do desc <<-DESC Create logrotated conf. You probably use this in other recipes and not standalone. - - <dl> - <dt>logrotate_name</dt> - <dd>Name of file in /etc/logrotate.d/</dd> - - <dt>logrotate_log_path<dt> - <dd>Path to log file. Can include wildcards, like /var/log/foo_*.log.</dd> - - <dt>logrotate_options</dt> - <dd>:rotate (Number of times to rotate before discarding)</dd> - <dd>:size (Rotate when file hits this size)</dd> - <dd>:daily, :weekly, :monthly (How often to perform rotate)</dd> - <dd>:missingok</dd> - <dd>:compress</dd> - <dd>:delaycompress</dd> - <dd>:notifempty</dd> - <dd>:copytruncate</dd> + + "Source":#{link_to_source(__FILE__)} + DESC + task_arg(:logrotate_name, "Name of file in /etc/logrotate.d/") + task_arg(:logrotate_log_path, "Path to log file. Can include wildcards, like /var/log/foo_*.log.") + task_arg(:logrotate_options, <<-EOS) + Log rotate options + + * :rotate (Number of times to rotate before discarding) + * :size (Rotate when file hits this size) + * :daily, :weekly, :monthly (How often to perform rotate) + * :missingok + * :compress + * :delaycompress + * :notifempty + * :copytruncate See man page for all the options. @@ -29,14 +28,9 @@ namespace :logrotated do :daily, :missingok, :compress, :delaycompress, :notifempty, :copytruncate ] </code> </pre> - "Source":#{link_to_source(__FILE__)} - DESC + EOS task :install_conf do - fetch(:logrotate_name) - fetch(:logrotate_log_path) - fetch(:logrotate_options) - text = [] logrotate_options.each do |option| if option.is_a?(Hash) @@ -56,26 +50,12 @@ namespace :logrotated do desc <<-DESC Force rotate files. - <dl> - <dt>logrotate_prefix</dt> - <dd>Path to logrotate</dd> - <dd>Defaults to none</dd> - - <dt>logrotate_conf_path</dt> - <dd>Path to logrotate conf</dd> - <dd>Defaults to @"/etc/logrotate.conf"@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:logrotate_bin_path, "Logrotate bin path", :default => "logrotate", :example => "/usr/local/bin/logrotate") + task_arg(:logrotate_conf_path, "Path to logrotate conf", :default => "/etc/logrotate.conf") task :force do - - fetch_or_default(:logrotate_prefix, "") - fetch_or_default(:logrotate_conf_path, "/etc/logrotate.conf") - - command = "logrotate" - command = "#{logrotate_prefix}/logrotate" unless logrotate_prefix.blank? - - run_via "#{command} -f #{logrotate_conf_path}" + run_via "#{logrotate_bin_path} -f #{logrotate_conf_path}" end end \ No newline at end of file lib/recipes/logrotated.rb @@ -3,49 +3,18 @@ namespace :memcached do desc <<-DESC Create memcached yaml in shared path. - <dl> - <dt>memcached_namespace</dt> - - <dt>memcached_ttl</dt> - <dd class="default">Defaults to @3600@</dd> - - <dt>memcached_readonly</dt> - <dd class="default">Defaults to @false@</dd> - - <dt>memcached_urlencode</dt> - <dd class="default">Defaults to @false@</dd> - - <dt>memcached_c_threshold</dt> - <dd class="default">Defaults to @10000@</dd> - - <dt>memcached_compression</dt> - <dd class="default">Defaults to @true@</dd> - - <dt>memcached_debug</dt> - <dd class="default">Defaults to @false@</dd> - - <dt>memcached_servers</dt> - <dd class="default">Defaults to @[ "localhost:11211" ]@</dd> - - <dt>memcached_yml_template</dt> - <dd class="default">Defaults to @"memcached/memcached.yml.erb"@</dd> - </dl> - "Source":#{link_to_source(__FILE__)} DESC - task :setup do - - # Settings - fetch(:memcached_namespace) - fetch_or_default(:memcached_ttl, 3600) - fetch_or_default(:memcached_readonly, false) - fetch_or_default(:memcached_urlencode, false) - fetch_or_default(:memcached_c_threshold, 10000) - fetch_or_default(:memcached_compression, true) - fetch_or_default(:memcached_debug, false) - fetch_or_default(:memcached_servers, [ "localhost:11211" ]) - fetch_or_default(:memcached_yml_template, "memcached/memcached.yml.erb") - + task_arg(:memcached_namespace, "Namespace") + task_arg(:memcached_ttl, "TTL in seconds", :default => 3600) + task_arg(:memcached_readonly, "Read only enabled", :default => false) + task_arg(:memcached_urlencode, "URL encode enabled", :default => false) + task_arg(:memcached_c_threshold, "C Threshold", :default => 10000) + task_arg(:memcached_compression, "Compression enabed", :default => true) + task_arg(:memcached_debug, "Debug enabled", :default => false) + task_arg(:memcached_servers, "List of servers", :default => ["localhost:11211"], :default_desc => "[\"localhost:11211\"]") + task_arg(:memcached_yml_template, "Memcached yml template", :default => "memcached/memcached.yml.erb") + task :setup do put(memcached_yml_template, "#{shared_path}/config/memcached.yml") end lib/recipes/memcached.rb @@ -15,11 +15,10 @@ namespace :merb do set :migrate_env, "" set :migrate_target, :latest DESC + task_arg(:rake, "Path to rake", :default => "rake") + task_arg(:merb_env, "Merb environment", :default => "") + task_arg(:migrate_target, "Migration target", :default => :latest) task :migrate, :roles => :db, :only => { :primary => true } do - rake = fetch(:rake, "rake") - merb_env = fetch(:merb_env, "production") - migrate_env = fetch(:migrate_env, "") - migrate_target = fetch(:migrate_target, :latest) current_directory = case migrate_target.to_sym when :current then current_path lib/recipes/merb.rb @@ -5,49 +5,30 @@ namespace :monit do HUP's the process from the pid file, if it exists. - <dl> - <dt>monit_pid_path</dt> - <dd>Path to monit pid file</dd> - <dd class="default">Defaults to @/var/run/monit.pid@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:monit_pid_path, "Path to monit pid file", :default => "/var/run/monit.pid") task :restart do - fetch_or_default(:monit_pid_path, "/var/run/monit.pid") - - run_via %{sh -c "[ ! -e '#{monit_pid_path}' ] || kill -HUP `cat #{monit_pid_path}`"} - + run_via %{sh -c "[ ! -e '#{monit_pid_path}' ] || kill -HUP `cat #{monit_pid_path}`"} end desc <<-DESC Unmonitor all. - <dl> - <dt>monit_bin_path</dt> - <dd>Path to monit bin.</dd> - <dd>Defaults to @monit@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:monit_bin_path, "Path to monit bin.", :default => "monit") task :unmonitor_all do - fetch_or_default(:monit_bin_path, "monit") - run_via "#{monit_bin_path} unmonitor all" end desc <<-DESC Monitor all. - <dl> - <dt>monit_bin_path</dt> - <dd>Path to monit bin.</dd> - <dd>Defaults to @monit@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:monit_bin_path, "Path to monit bin.", :default => "monit") task :monitor_all do - fetch_or_default(:monit_bin_path, "monit") - run_via "#{monit_bin_path} monitor all" end lib/recipes/monit.rb @@ -8,17 +8,13 @@ namespace :merb do "Source":#{link_to_source(__FILE__)} DESC + task_arg(:merb_nodes, "Number of nodes in merb cluster") + task_arg(:merb_port, "Starting port") + task_arg(:monit_conf_dir, "Monit config directory", :default => "/etc/monit") + task_arg(:merb_pid_dir, "Merb pid directory", :default => Proc.new {"#{shared_path}/pids"}, :default_desc => "\#{shared_path}/pids") + task_arg(:merb_monitrc_template, "Merb monitrc template", :default => "merb/merb.monitrc.erb") task :setup do - # Settings - fetch(:merb_nodes) - fetch(:merb_port) - fetch_or_default(:merb_application, "merb_#{application}") - fetch_or_default(:merb_initscript_name, "merb_#{application}") - fetch_or_default(:monit_conf_dir, "/etc/monit") - - fetch_or_default(:merb_pid_dir, "#{shared_path}/pids") - processes = [] ports = (0...merb_nodes).collect { |i| merb_port + i } ports.each do |port| @@ -32,9 +28,8 @@ namespace :merb do end set :processes, processes - - put template.load("merb/merb.monitrc.erb"), "/tmp/#{merb_application}.monitrc" - sudo "install -o root /tmp/#{merb_application}.monitrc #{monit_conf_dir}/#{merb_application}.monitrc" + + utils.install_template(merb_monitrc_template, "#{monit_conf_dir}/#{merb_application}.monitrc") end desc "Restart merb (for application)" lib/recipes/monit/merb.rb @@ -5,28 +5,12 @@ namespace :mysql do desc <<-DESC Install mysql monit hooks. - <dl> - <dt>mysql_pid_path</dt> - <dd>Path to mysql pid file</dd> - - <dt>db_port</dt> - <dd>Mysql port</dd> - <dd class="default">Defaults to @3306@</dd> - - <dt>monit_conf_dir</dt> - <dd>Monitrd directory.</dd> - <dd class="default">Defaults to @"/etc/monit"@</dd> - </dl> - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:mysql_pid_path, "Path to mysql pid file", :default => "/var/run/mysqld/mysqld.pid") + task_arg(:mysql_port, "Mysql port", :default => 3306) + task_arg(:monit_conf_dir, "Monitrd directory", :default => "/etc/monit") task :install do - - # Settings - fetch_or_default(:mysql_pid_path, "/var/run/mysqld/mysqld.pid") - fetch_or_default(:mysql_port, 3306) - fetch_or_default(:monit_conf_dir, "/etc/monit") - put template.load("mysql/mysql.monitrc.erb", binding), "/tmp/mysql.monitrc" run_via "install -o root /tmp/mysql.monitrc #{monit_conf_dir}/mysql.monitrc" end lib/recipes/monit/mysql.rb @@ -5,25 +5,11 @@ namespace :nginx do desc <<-DESC Install nginx monit hooks. - <dl> - <dt>nginx_pid_path</dt> - <dd>Path to nginx pid file</dd> - <dd>Defaults to /var/run/nginx.pid</dd> - <dd>@set :nginx_pid_path, "/var/run/nginx.pid"@</dd> - - <dt>monit_conf_dir</dt> - <dd>Destination for monitrc.</dd> - <dd>Defaults to "/etc/monit"</dd> - <dd>@set :monit_conf_dir, "/etc/monit"@</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:nginx_pid_path, "Path to nginx pid file", :default => "/var/run/nginx.pid") + task_arg(:monit_conf_dir, "Destination for monitrc", :default => "/etc/monit") task :install do - - # Settings - fetch_or_default(:nginx_pid_path, "/var/run/nginx.pid") - fetch_or_default(:monit_conf_dir, "/etc/monit") - put template.load("nginx/nginx.monitrc.erb", binding), "/tmp/nginx.monitrc" run_via "install -o root /tmp/nginx.monitrc #{monit_conf_dir}/nginx.monitrc" end lib/recipes/monit/nginx.rb @@ -4,17 +4,12 @@ namespace :sphinx do desc <<-DESC Create monit configuration for sphinx.\n - *monit_conf_dir*: Destination for monitrc. _Defaults to "/etc/monit"_\n - *sphinx_pid_path*: Location for sphinx pid. _Defaults to "[shared_path]/pids/searchd.pid"_\n - + "Source":#{link_to_source(__FILE__)} DESC + task_arg(:monit_conf_dir, :default => "/etc/monit") + task_arg(:sphinx_pid_path, :default => Proc.new{"#{shared_path}/pids/searchd.pid"}, :default_desc => "\#{shared_path}/pids/searchd.pid") task :setup do - - # Settings - fetch_or_default(:monit_conf_dir, "/etc/monit") - fetch_or_default(:sphinx_pid_path, "#{shared_path}/pids/searchd.pid") - put template.load("sphinx/sphinx.monitrc.erb"), "/tmp/sphinx_#{application}.monitrc" sudo "install -o root /tmp/sphinx_#{application}.monitrc #{monit_conf_dir}/sphinx_#{application}.monitrc" end lib/recipes/monit/sphinx.rb @@ -4,45 +4,19 @@ namespace :mysql do desc <<-DESC Create database, database user, and set grant permissions. - <dl> - <dt>db_name</dt> - <dd>Database name (application).</dd> - - <dt>db_user</dt> - <dd>Database user (application).</dd> - - <dt>db_pass</dt> - <dd>Database password (application).</dd> - - <dt>mysql_grant_locations</dt> - <dd>Grant locations. </dd> - <dd>Defaults to @[ "localhost" ]@</dd> - - <dt>mysql_grant_priv_type</dt> - <dd>Grant privilege types.</dd> - <dd>Defaults to @ALL@</dd> - - <dt>mysql_admin_user</dt> - <dd>Mysql admin user.</dd> - <dd>Defaults to password prompt.</dd> - - <dt>mysql_admin_password</dt> - <dd>Mysql admin password.</dd> - <dd>Defaults to password prompt.</dd> - </dl> "Source":#{link_to_source(__FILE__)} DESC - task :setup do - - # Settings - fetch(:db_name) - fetch(:db_user) - fetch(:db_pass) - fetch_or_default(:mysql_admin_user, "root") - fetch_or_default(:mysql_admin_password, prompt.password('Mysql admin password: ')) - fetch_or_default(:mysql_grant_priv_type, "ALL") - fetch_or_default(:mysql_grant_locations, [ "localhost" ]) + task_arg(:db_name, "Database name (application)") + task_arg(:db_user, "Database user (application)") + task_arg(:db_pass, "Database password (application)") + task_arg(:mysql_admin_user, "Mysql admin user", :default => "root") + task_arg(:mysql_admin_password, "Mysql admin password", + :default => Proc.new { prompt.password('Mysql admin password: ') }, + :example => "prompt.password('Mysql admin password: ')") + task_arg(:mysql_grant_priv_type, "Grant privilege types", :default => "ALL") + task_arg(:mysql_grant_locations, "Grant locations", :default => ["localhost"]) + task :setup do sql = template.load("mysql/install_db.sql.erb") logger.trace "Running sql:\n#{sql}\n" @@ -55,26 +29,12 @@ namespace :mysql do desc <<-DESC Create my.cnf based on template. - <dl> - <dt>my_cnf_template</dt> - <dd>Path to my.cnf template</dd> - - <dt>db_socket</dt> - <dd>Path to mysql .sock</dd> - <dd class="default">Defaults to @"/var/lib/mysql/mysql.sock"@</dd> - - <dt>db_port</dt> - <dd>Mysql port</dd> - <dd class="default">Defaults to @3306@</dd> - </dl> - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:my_cnf_template, "Path to my.cnf template", :default => "mysql/my.cnf.innodb_1024.erb") + task_arg(:db_socket, "Path to mysql .sock", :default => "/var/lib/mysql/mysql.sock") + task_arg(:db_port, "Mysql port", :default => 3306) task :install_my_cnf do - fetch_or_default(:my_cnf_template, "mysql/my.cnf.innodb_1024.erb") - fetch_or_default(:db_socket, "/var/lib/mysql/mysql.sock") - fetch_or_default(:db_port, 3306) - utils.install_template(my_cnf_template, "/etc/my.cnf") end lib/recipes/mysql.rb @@ -6,80 +6,24 @@ namespace :nginx do desc <<-DESC Generate the nginx vhost include. - <dl> - <dt>nginx_upstream_name</dt> - <dd>Application name (for upstream definition).</dd> - <dd class="default">Defaults to @:application@</dd> - - <dt>nginx_upstream_size</dt> - <dd>Number of nodes for upstream.</dd> - <dd>@set :nginx_upstream_size, 3@</dd> - - <dt>nginx_upstream_port</dt> - <dd>Starting port for upstream. If there are 3 nodes with port 9000, then instances will be at 9000, 9001, and 9002</dd> - <dd>@set :nginx_upstream_port, 9000@</dd> - - <dt>domain_name</dt>: Domain name for nginx virtual host, (without www prefix).</dd> - <dd>@set :domain_name, "foo.com"@</dd> - </dl> - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:nginx_upstream_name, "Application name (for upstream definition)", + :default => Proc.new { fetch(:application) }, + :default_desc => "fetch(:application)") + + task_arg(:nginx_upstream_size, "Number of nodes for upstream") + task_arg(:nginx_upstream_port, "Starting port for upstream. If there are 3 nodes with port 9000, then instances will be at 9000, 9001, and 9002") + task_arg(:domain_name, "Domain name") + task_arg(:nginx_vhost_template, "Path to nginx vhost template", :default => "nginx/nginx_vhost_generic.conf.erb") task :setup do - # Settings - fetch_or_default(:nginx_upstream_name, fetch(:application)) - fetch(:nginx_upstream_size) - fetch(:nginx_upstream_port) - set :nginx_upstream_ports, (0...nginx_upstream_size.to_i).collect { |i| nginx_upstream_port.to_i + i } set :public_path, current_path + "/public" - utils.install_template("nginx/nginx_vhost_generic.conf.erb", "/etc/nginx/vhosts/#{nginx_upstream_name}.conf") + utils.install_template(:nginx_vhost_template, "/etc/nginx/vhosts/#{nginx_upstream_name}.conf") end end - namespace :mongrel do - desc <<-DESC - Generate the nginx vhost include (for a mongrel setup). - - *THIS IS DEPRECATED*: Use @nginx:host:setup@ - - <dl> - <dt>mongrel_application</dt> - <dd>Mongrel application.</dd> - <dd class="default">Defaults to @:application@</dd> - - <dt>mongrel_size</dt> - <dd>Number of mongrels.</dd> - <dd>@set :mongrel_size, 3@</dd> - - <dt>*mongrel_port</dt> - <dd>Starting port for mongrels. If there are 3 mongrels with port 9000, then instances will be at 9000, 9001, and 9002</dd> - <dd>@set :mongrel_port, 9000@</dd> - - <dt>domain_name</dt>: Domain name for nginx virtual host, (without www prefix).</dd> - <dd>@set :domain_name, "foo.com"@</dd> - </dl> - "Source":#{link_to_source(__FILE__)} - DESC - task :setup do - - # Settings - fetch(:mongrel_size) - fetch(:mongrel_port) - fetch(:domain_name) - fetch_or_default(:mongrel_application, fetch(:application)) - - set :ports, (0...mongrel_size).collect { |i| mongrel_port + i } - set :public_path, current_path + "/public" - - run "mkdir -p #{shared_path}/config" - put template.load("nginx/nginx_vhost.conf.erb"), "/tmp/nginx_#{mongrel_application}.conf" - - sudo "install -o root /tmp/nginx_#{mongrel_application}.conf /etc/nginx/vhosts/#{mongrel_application}.conf" - end - end - end \ No newline at end of file lib/recipes/nginx.rb @@ -1,64 +1,6 @@ # Rails recipes namespace :rails do - desc <<-DESC - Create database yaml in shared path. Note: If both @:db_host@ and @:db_socket@ are used, @db_socket@ wins. - - *DEPRECATED*: Use @active_record:setup@ - - <dl> - <dt>db_name</dt> - <dd>Database name.</dd> - <dd>@set :db_name, "app_db_name"@</dd> - - <dt>db_user</dt> - <dd>Database user.</dd> - <dd>@set :db_user, "app_db_user"@</dd> - - <dt>db_pass</dt> - <dd>Database password.</dd> - <dd>@set :db_pass, "the_password"@</dd> - - <dt>db_host</dt> - <dd>Database host (can be nil, if you are using socket).</dd> - <dd class="default">Defaults to @nil@</dd> - - <dt>db_socket</dt> - <dd>Database socket (can be nil, if you are using host).</dd> - <dd class="default">Defaults to @nil@</dd> - <dd>@set :db_socket, "/var/lib/mysql/mysql.sock"@</dd> - - <dt>database_yml_template</dt> - <dd>Path to database yml erb template. - <dd class="default">Defaults to @rails/database.yml.erb@ (in this GEM)</dd> - </dl> - - "Source":#{link_to_source(__FILE__)} - DESC - task :setup, :roles => :app do - - # Settings - fetch(:db_name) - fetch(:db_user) - fetch(:db_pass) - fetch_or_default(:db_host, nil) - fetch_or_default(:db_socket, nil) - fetch_or_default(:database_yml_template, "rails/database.yml.erb") - - unless db_host.blank? - set :db_connect_type, "host" - set :db_connect, db_host - end - - unless db_socket.blank? - set :db_connect_type, "socket" - set :db_connect, db_socket - end - - run "mkdir -p #{shared_path}/config" - put template.load(database_yml_template), "#{shared_path}/config/database.yml" - end - desc "Make symlink for database yaml" task :update_code do run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml" lib/recipes/rails.rb @@ -2,45 +2,26 @@ namespace :sphinx do desc <<-DESC - Update sphinx for application. + Update sphinx conf for application. - <dl> - <dt>sphinx_conf_template</dt><dd>Path to sphinx.conf.erb.</dd><dd>_Defaults to "config/templates/sphinx.conf.erb"_</dd> - <dt>sphinx_conf_path</dt><dd>Path to sphinx.conf.</dd><dd>_Defaults to "[shared_path]/config/sphinx.conf"_</dd> - <dt>sphinx_port</dt><dd>Sphinx port.</dd><dd>_Defaults to 3312_</dd> - <dt>sphinx_conf_root</dt><dd>Directory for sphinx configuration, like stopwords.txt.</dd><dd>_Defaults to [current_path]/config_</dd> - <dt>sphinx_index_root</dt><dd>Directory for sphinx indexes.</dd><dd>_Defaults to "[shared_path]/var/index"_</dd> - <dt>sphinx_log_root</dt><dd>Directory for sphinx logs.</dd><dd>_Defaults to "[shared_path]/log"_</dd> - <dt>sphinx_pid_root</dt><dd>Directory for sphinx pids.</dd><dd>_Defaults to "[shared_path]/pids"_</dd> - - <dt>sphinx_db_user</dt><dd>Sphinx DB user.</dd><dd>_Defaults to db_user_</dd> - <dt>sphinx_db_pass</dt><dd>Sphinx DB password.</dd><dd>_Defaults to db_pass_</dd> - <dt>sphinx_db_name</dt><dd>Sphinx DB name.</dd><dd>_Defaults to db_name_</dd> - <dt>sphinx_db_port</dt><dd>Sphinx DB port.</dd><dd>_Defaults to db_port_</dd> - - <dt>sphinx_db_host</dt><dd>Sphinx DB host.</dd><dd>_Defaults to db_host_</dd> - <dt>sphinx_conf_host</dt><dd>Sphinx DB host to listen on.</dd><dd>_Defaults to 127.0.0.1_</dd> - - </dl> "Source":#{link_to_source(__FILE__)} DESC + task_arg(:sphinx_conf_template, "Path to sphinx.conf.erb template", :default => "config/templates/sphinx.conf.erb") + task_arg(:sphinx_port, "Sphinx port", :default => 3312) + task_arg(:sphinx_conf_path, "Path to sphinx.conf", :default => Proc.new {"#{shared_path}/config/sphinx.conf"}, :default_desc => "\#{shared_path}/config/sphinx.conf") + task_arg(:sphinx_conf_root, "Directory for sphinx configuration, like stopwords.txt", :default => Proc.new {"#{current_path}/config"}, :default_desc => "\#{current_path}/config") + task_arg(:sphinx_index_root, "Directory for sphinx indexes", :default => Proc.new {"#{shared_path}/var/index"}, :default_desc => "\#{shared_path}/var/index") + task_arg(:sphinx_log_root, "Directory for sphinx logs", :default => Proc.new {"#{shared_path}/log"}, :default_desc => "\#{shared_path}/log") + task_arg(:sphinx_pid_path, "Directory for sphinx pids", :default => Proc.new {"#{shared_path}/pids/searchd.pid"}, :default_desc => "\#{shared_path}/pids/searchd.pid") + + task_arg(:sphinx_db_user, "Sphinx DB user", :set => :db_user) + task_arg(:sphinx_db_pass, "Sphinx DB password", :set => :db_pass) + task_arg(:sphinx_db_name, "Sphinx DB name", :set => :db_name) + task_arg(:sphinx_db_port, "Sphinx DB port", :set => :db_port) + task_arg(:sphinx_db_host, "Sphinx DB host", :set => :db_host) + + task_arg(:sphinx_conf_host, "Sphinx DB host to listen on", :default => "127.0.0.1") task :update_conf do - - fetch_or_default(:sphinx_conf_template, "config/templates/sphinx.conf.erb") - fetch_or_default(:sphinx_port, 3312) - fetch_or_default(:sphinx_conf_path, "#{shared_path}/config/sphinx.conf") - fetch_or_default(:sphinx_conf_root, "#{current_path}/config") - fetch_or_default(:sphinx_index_root, "#{shared_path}/var/index") - fetch_or_default(:sphinx_log_root, "#{shared_path}/log") - fetch_or_default(:sphinx_pid_path, "#{shared_path}/pids/searchd.pid") - - fetch_or_set(:sphinx_db_user, :db_user) - fetch_or_set(:sphinx_db_pass, :db_pass) - fetch_or_set(:sphinx_db_name, :db_name) - fetch_or_set(:sphinx_db_port, :db_port) - fetch_or_set(:sphinx_db_host, :db_host) - fetch_or_default(:sphinx_conf_host, "127.0.0.1") - put(template.load(sphinx_conf_template), sphinx_conf_path) end @@ -52,17 +33,12 @@ namespace :sphinx do desc <<-DESC Rotate sphinx index for application. - *sphinx_prefix*<dd>Location to sphinx install. _Defaults to nil_\n - *sphinx_conf*<dd>Location to sphinx conf. _Defaults to "[shared_path]/config/sphinx.conf"_\n - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:sphinx_prefix, :default => nil) + task_arg(:sphinx_conf, :default => Proc.new{"#{shared_path}/config/sphinx.conf"}, :default_desc => "\#{shared_path}/config/sphinx.conf") task :rotate_all do - fetch_or_default(:sphinx_prefix, nil) - fetch_or_default(:sphinx_conf, "#{shared_path}/config/sphinx.conf") - indexer_path = sphinx_prefix ? "#{sphinx_prefix}/bin/indexer" : "indexer" - run "#{indexer_path} --config #{sphinx_conf} --rotate --all" end @@ -74,12 +50,10 @@ namespace :sphinx do "Source":#{link_to_source(__FILE__)} DESC + task_arg(:sphinx_prefix, :default => nil) + task_arg(:sphinx_conf, :default => Proc.new{"#{shared_path}/config/sphinx.conf"}, :default_desc => "\#{shared_path}/config/sphinx.conf") task :index_all do - fetch_or_default(:sphinx_prefix, nil) - fetch_or_default(:sphinx_conf, "#{shared_path}/config/sphinx.conf") - indexer_path = sphinx_prefix ? "#{sphinx_prefix}/bin/indexer" : "indexer" - run "#{indexer_path} --config #{sphinx_conf} --all" end lib/recipes/sphinx.rb @@ -3,15 +3,11 @@ namespace :sshd do desc <<-DESC Create public and private keys for ssh. - *ssh_keygen_type*: SSH keygen type. _Defaults to rsa_\n - *ssh_keygen_bits*: SSH keygen bits. _Defaults to 2048_\n - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:ssh_keygen_type, "SSH keygen type", :default => "rsa") + task_arg(:ssh_keygen_bits, "SSH keygen bits", :default => 2048) task :keygen do - # Settings - fetch_or_default(:ssh_keygen_type, "rsa") - fetch_or_default(:ssh_keygen_bits, 2048) run "ssh-keygen -t #{ssh_keygen_type} -b #{ssh_keygen_bits}" do |channel, stream, data| logger.trace data @@ -33,19 +29,14 @@ namespace :sshd do end desc <<-DESC - Add to authorized keys. Uses <tt>.ssh/authorized_keys</tt>. - - *ssh_public_key*: The public key from ssh:keygen. + Add to authorized keys. Uses @.ssh/authorized_keys@. "Source":#{link_to_source(__FILE__)} DESC + task_arg(:ssh_public_key, "The public key from sshd:keygen") + task_arg(:ssh_dir, "SSH home directory", :default => "~/.ssh") + task_arg(:authorized_keys_path, "Path to authorized keys", :default => "~/.ssh/authorized_keys") task :authorize_key do - - fetch(:ssh_public_key) - - ssh_dir = "~/.ssh" - authorized_keys_path = "#{ssh_dir}/authorized_keys" - run_all <<-CMDS if [ ! -d #{ssh_dir} ]; then mkdir #{ssh_dir} ; chmod 700 #{ssh_dir} ; fi if [ ! -f #{authorized_keys_path} ]; then touch #{authorized_keys_path} ; chmod 600 #{authorized_keys_path} ; fi lib/recipes/sshd.rb @@ -3,17 +3,12 @@ namespace :syslogd do desc <<-DESC Add entry to syslog for application. - *syslog_program_name*: syslog program name. What you used for <tt>SyslogLogger.new("program_name_here")</tt>\n - *syslog_log_path*: Path to log.\n - *syslog_conf_path*: Path to syslog conf. _Defaults to <tt>/etc/syslog.conf</tt>_\n - "Source":#{link_to_source(__FILE__)} DESC + task_arg(:syslog_program_name, "Syslog program name. What you used for @SyslogLogger.new(\"program_name_here\")@") + task_arg(:syslog_log_path, "Path to log") + task_arg(:syslog_conf_path, :default => "/etc/syslog.conf") task :setup_conf do - - fetch(:syslog_program_name) - fetch(:syslog_log_path) - fetch_or_default(:syslog_conf_path, "/etc/syslog.conf") utils.append_to(syslog_conf_path, <<-DATA, "^!#{syslog_program_name}") @@ -23,39 +18,4 @@ namespace :syslogd do DATA end - desc <<-DESC - Add entry to newsyslog for application. See newsyslog man page for details. - - Adds entry like: - - <pre> - /var/log/my_app.log 640 7 * @T00 Z - </pre> - - *syslog_log_path*: Path to log. _Defaults to <tt>/var/log/[syslog_program_name].log</tt>_\n - *newsyslog_conf_path*: Path to newsyslog conf.\n - *newsyslog_mode*: File mode (to create log with). _Defaults to _\n - *newsyslog_count*: Number of files to keep. _Defaults to 7_\n - *newsyslog_size*: Max size. _Defaults to *_\n - *newsyslog_when*: When to rotate. _Defaults to @T00_\n - *newsyslog_zb*: Whether to gzip or tarball. _Defaults to Z_\n - - "Source":#{link_to_source(__FILE__)} - DESC - task :setup_newsyslog_conf do - - fetch(:syslog_log_path) - fetch_or_default(:newsyslog_conf_path, "/etc/newsyslog.conf") - - fetch_or_default(:newsyslog_mode, "640") - fetch_or_default(:newsyslog_count, "7") - fetch_or_default(:newsyslog_size, "*") - fetch_or_default(:newsyslog_when, "@T00") - fetch_or_default(:newsyslog_zb, "Z") - - entry = "#{syslog_log_path} \t#{newsyslog_mode} \t#{newsyslog_count} \t#{newsyslog_size} \t#{newsyslog_when} \t#{newsyslog_zb}" - - utils.append_to(newsyslog_conf_path, entry, "^#{syslog_log_path}") - end - end \ No newline at end of file lib/recipes/syslogd.rb @@ -110,7 +110,7 @@ td { } .recipes pre { - margin: 0 30px; + margin: 0 30px 10px 30px; } .recipes h3 { @@ -119,6 +119,17 @@ td { background-color: #E6E2AF; } +.recipes h4 { + margin: 0; + background-color: #E6E2AF; +} + +.recipe dl +{ + padding: 0; + margin: 0; +} + .recipe { margin: 0 0 40px 0; padding: 8px; website/stylesheets/screen.css 7c923f5564b3fba846af45e2a60baa135fbd436c Gabe gabrielh@gmail.com http://github.com/gabriel/capitate/commit/8e757e16e30f67e2cde4d2140c8d6335266b37df 8e757e16e30f67e2cde4d2140c8d6335266b37df 2008-05-14T13:01:13-07:00 2008-05-14T13:01:13-07:00 task arguments dsl patch 23381f9e61646447bd5cd6a8fad61b1810bea52c Gabe gabrielh@gmail.com