Compare commits

...
30 Commits
Author SHA1 Message Date
David Dollar be593846e2 Regenerated gemspec for version 0.4.7 2010-06-29 17:08:49 -04:00
David Dollar 2458c4e75f 0.4.7 2010-06-29 17:08:46 -04:00
David Dollar 314e2f5530 fix -l, dont append app name 2010-06-29 17:08:30 -04:00
David Dollar d6c5e6ddea Regenerated gemspec for version 0.4.6 2010-06-29 16:49:17 -04:00
David Dollar 261164e694 update readme 2010-06-29 16:49:17 -04:00
David Dollar 92e637a231 0.4.6 2010-06-29 16:49:14 -04:00
David Dollar 08b94716f2 support -l to export for specifying log root 2010-06-29 16:49:02 -04:00
David Dollar 44d589a28f Regenerated gemspec for version 0.4.5 2010-06-29 16:01:19 -04:00
David Dollar 4bf1f26032 update readme 2010-06-29 16:01:18 -04:00
David Dollar 2a2786e676 0.4.5 2010-06-29 16:01:16 -04:00
David Dollar 91811425aa update gemspec 2010-06-29 16:00:21 -04:00
Adam WigginsandDavid Dollar adb40881d7 inittab export 2010-06-30 03:59:51 +08:00
David Dollar fd3dc590d9 fix spawn command for launching as a user 2010-06-28 23:27:05 -04:00
David Dollar 8651bbdbee make sure to chown the log dir to the app's user 2010-06-28 23:26:55 -04:00
David Dollar ced0d0aa9d fix gemspec 2010-06-28 23:09:23 -04:00
David Dollar 10e572de94 restructure init files, add optional --user flag for export 2010-06-28 22:52:44 -04:00
David Dollar 426241d461 remove unneeded code 2010-06-24 16:51:51 -04:00
David Dollar 5a258b8dc3 Regenerated gemspec for version 0.4.4 2010-06-23 19:13:54 -04:00
David Dollar eeeef65c88 0.4.4. 2010-06-23 19:13:50 -04:00
David Dollar d67a2f4e11 include export dir with gem 2010-06-23 19:13:40 -04:00
David Dollar ce5c8b4c04 update readme 2010-06-23 19:11:52 -04:00
David Dollar 9d859dae92 remove potentially confusing period 2010-06-23 19:11:47 -04:00
David Dollar 04884366b3 describe procfile 2010-06-23 19:10:05 -04:00
David Dollar 8c78d1e1ee update readme 2010-06-23 19:09:14 -04:00
David Dollar 35a5f972fe more docs tweaks 2010-06-23 19:05:00 -04:00
David Dollar 868bc44a4e update readme 2010-06-23 19:04:58 -04:00
David Dollar 644956db29 update readme 2010-06-23 19:04:25 -04:00
David Dollar bd07ed809d more docs tweaks 2010-06-23 19:04:22 -04:00
David Dollar 26bb8995c9 update readme 2010-06-23 19:03:40 -04:00
David Dollar 7005860c3c more docs tweaks 2010-06-23 19:03:33 -04:00
15 changed files with 98 additions and 147 deletions
+20 -4
View File
@@ -15,7 +15,7 @@ format.
## RUNNING ## RUNNING
`foreman start` is used to run your application directly from the command line. `foreman start` is used to run your application directly from the command line.
If no additional parameters are passed, foreman will run one instance of each If no additional parameters are passed, foreman will run one instance of each
type of process defined in your Procfile. type of process defined in your Procfile.
@@ -42,10 +42,17 @@ The following options control how the application is run:
* `-a`, `--app`: * `-a`, `--app`:
Use this name rather than the application's root directory name as the Use this name rather than the application's root directory name as the
name of the application when exporting. name of the application when exporting.
* `-l`, `--log`:
Specify the directory to place process logs in.
* `-c`, `--concurrency`: * `-c`, `--concurrency`:
Specify the number of each process type to run. The value passed in Specify the number of each process type to run. The value passed in
should be in the format `process=num,process=num`. should be in the format `process=num,process=num`
* `-u`, `--user`:
Specify the user the application should be run as. Defaults to the
app name
## OPTIONS ## OPTIONS
@@ -56,6 +63,14 @@ These options control all modes of foreman's operation.
containing directory will be assumed to be the root directory of the containing directory will be assumed to be the root directory of the
application. application.
## PROCFILE
A Procfile should contain both a name for the process and the command used
to run it.
web bundle exec thin start
job bundle exec rake jobs:work
## EXAMPLES ## EXAMPLES
Start one instance of each process type, interleave the output on stdout: Start one instance of each process type, interleave the output on stdout:
@@ -65,7 +80,7 @@ Start one instance of each process type, interleave the output on stdout:
Export the application in upstart format: Export the application in upstart format:
$ foreman export upstart /etc/init $ foreman export upstart /etc/init
Run one process type from the application defined in a specific Procfile: Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/app/Procfile $ foreman start alpha -p ~/app/Procfile
@@ -80,6 +95,7 @@ Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
[RUNNING]: #RUNNING "RUNNING" [RUNNING]: #RUNNING "RUNNING"
[EXPORTING]: #EXPORTING "EXPORTING" [EXPORTING]: #EXPORTING "EXPORTING"
[OPTIONS]: #OPTIONS "OPTIONS" [OPTIONS]: #OPTIONS "OPTIONS"
[PROCFILE]: #PROCFILE "PROCFILE"
[EXAMPLES]: #EXAMPLES "EXAMPLES" [EXAMPLES]: #EXAMPLES "EXAMPLES"
[COPYRIGHT]: #COPYRIGHT "COPYRIGHT" [COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
+1 -1
View File
@@ -64,7 +64,7 @@ begin
s.platform = Gem::Platform::RUBY s.platform = Gem::Platform::RUBY
s.has_rdoc = false s.has_rdoc = false
s.files = %w(Rakefile README.md) + Dir["{bin,lib,spec}/**/*"] s.files = %w(Rakefile README.md) + Dir["{bin,export,lib,spec}/**/*"]
s.require_path = "lib" s.require_path = "lib"
# #s.bindir = "bin" # #s.bindir = "bin"
+2 -7
View File
@@ -1,13 +1,8 @@
pre-start script pre-start script
bash << "EOF" bash << "EOF"
mkdir -p /var/log/<%= app %> mkdir -p <%= log_root %>
chown -R <%= user %> <%= log_root %>
<% engine.processes.keys.sort.each do |process| %>
<% 1.upto(concurrency[process]).each do |num| %>
start <%=app%>-<%=process%>-<%=num%>
<% end %>
<% end %>
EOF EOF
end script end script
+3 -2
View File
@@ -1,5 +1,6 @@
stop on stopping <%= app %> start on starting <%= app %>-<%= process.name %>
stop on stopping <%= app %>-<%= process.name %>
respawn respawn
chdir <%= engine.directory %> chdir <%= engine.directory %>
exec <%= process.command %> >> /var/log/<%=app%>/<%=process.name%>-<%=num%>.log 2>&1 exec su <%= user %> -c "<%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1"
+2
View File
@@ -0,0 +1,2 @@
start on starting <%= app %>
stop on stopping <%= app %>
+6 -5
View File
@@ -5,11 +5,11 @@
Gem::Specification.new do |s| Gem::Specification.new do |s|
s.name = %q{foreman} s.name = %q{foreman}
s.version = "0.4.3" s.version = "0.4.7"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["David Dollar"] s.authors = ["David Dollar"]
s.date = %q{2010-06-23} s.date = %q{2010-06-29}
s.default_executable = %q{foreman} s.default_executable = %q{foreman}
s.description = %q{Process manager for applications with multiple components} s.description = %q{Process manager for applications with multiple components}
s.email = %q{ddollar@gmail.com} s.email = %q{ddollar@gmail.com}
@@ -20,16 +20,18 @@ Gem::Specification.new do |s|
s.files = [ s.files = [
"Rakefile", "Rakefile",
"bin/foreman", "bin/foreman",
"export/upstart/master.conf.erb",
"export/upstart/process.conf.erb",
"export/upstart/process_master.conf.erb",
"lib/foreman.rb", "lib/foreman.rb",
"lib/foreman/cli.rb", "lib/foreman/cli.rb",
"lib/foreman/configuration.rb",
"lib/foreman/engine.rb", "lib/foreman/engine.rb",
"lib/foreman/export.rb", "lib/foreman/export.rb",
"lib/foreman/export/base.rb", "lib/foreman/export/base.rb",
"lib/foreman/export/inittab.rb",
"lib/foreman/export/upstart.rb", "lib/foreman/export/upstart.rb",
"lib/foreman/process.rb", "lib/foreman/process.rb",
"spec/foreman/cli_spec.rb", "spec/foreman/cli_spec.rb",
"spec/foreman/configuration_spec.rb",
"spec/foreman/engine_spec.rb", "spec/foreman/engine_spec.rb",
"spec/foreman/export/upstart_spec.rb", "spec/foreman/export/upstart_spec.rb",
"spec/foreman/export_spec.rb", "spec/foreman/export_spec.rb",
@@ -45,7 +47,6 @@ Gem::Specification.new do |s|
s.summary = %q{Process manager for applications with multiple components} s.summary = %q{Process manager for applications with multiple components}
s.test_files = [ s.test_files = [
"spec/foreman/cli_spec.rb", "spec/foreman/cli_spec.rb",
"spec/foreman/configuration_spec.rb",
"spec/foreman/engine_spec.rb", "spec/foreman/engine_spec.rb",
"spec/foreman/export/upstart_spec.rb", "spec/foreman/export/upstart_spec.rb",
"spec/foreman/export_spec.rb", "spec/foreman/export_spec.rb",
+1 -1
View File
@@ -1,6 +1,6 @@
module Foreman module Foreman
VERSION = "0.4.3" VERSION = "0.4.7"
class AppDoesNotExist < Exception; end class AppDoesNotExist < Exception; end
+5 -2
View File
@@ -1,5 +1,4 @@
require "foreman" require "foreman"
require "foreman/configuration"
require "foreman/engine" require "foreman/engine"
require "foreman/export" require "foreman/export"
require "thor" require "thor"
@@ -27,19 +26,23 @@ class Foreman::CLI < Thor
desc "export FORMAT LOCATION", "Export the application to another process management format" desc "export FORMAT LOCATION", "Export the application to another process management format"
method_option :app, :type => :string, :aliases => "-a" method_option :app, :type => :string, :aliases => "-a"
method_option :log, :type => :string, :aliases => "-l"
method_option :user, :type => :string, :aliases => "-u"
method_option :concurrency, :type => :string, :aliases => "-c", method_option :concurrency, :type => :string, :aliases => "-c",
:banner => '"alpha=5,bar=3"' :banner => '"alpha=5,bar=3"'
def export(format, location=nil) def export(format, location=nil)
check_procfile! check_procfile!
formatter = case format formatter = case format
when "upstart" then Foreman::Export::Upstart when "upstart" then Foreman::Export::Upstart
when "inittab" then Foreman::Export::Inittab
else error "Unknown export format: #{format}." else error "Unknown export format: #{format}."
end end
formatter.new(engine).export(location, formatter.new(engine).export(location,
:name => options[:app], :name => options[:app],
:user => options[:user],
:log => options[:log],
:concurrency => options[:concurrency] :concurrency => options[:concurrency]
) )
rescue Foreman::Export::Exception => ex rescue Foreman::Export::Exception => ex
-55
View File
@@ -1,55 +0,0 @@
require "foreman"
class Foreman::Configuration
attr_reader :app
attr_reader :processes
def initialize(app)
@app = app
@processes = {}
read_initial_config
end
def scale(process, amount)
old_amount = processes[process].to_i
processes[process] = amount.to_i
amount = amount.to_i
if (old_amount < amount)
((old_amount + 1) .. amount).each { |num| system "start #{app}-#{process} NUM=#{num}" }
elsif (amount < old_amount)
((amount + 1) .. old_amount).each { |num| system "stop #{app}-#{process} NUM=#{num}" }
end
write
end
def write
write_file "/etc/foreman/#{app}.conf", <<-UPSTART_CONFIG
#{app}_processes="#{processes.keys.sort.join(' ')}"
#{processes.keys.sort.map { |k| "#{app}_#{k}=\"#{processes[k]}\"" }.join("\n")}
UPSTART_CONFIG
end
private ######################################################################
def read_initial_config
config = File.read("/etc/foreman/#{app}.conf").split("\n").inject({}) do |accum, line|
key, value = line.match(/^(.+?)\s*=\s*"(.+?)"\s*$/).captures
#accum.update(parts(1) => parts(2))
accum.update(key => value)
end
config["#{app}_processes"].split(" ").each do |process|
processes[process] = config["#{app}_#{process}"].to_i
end
rescue Errno::ENOENT
end
def write_file(filename, contents)
File.open(filename, "w") do |file|
file.puts contents
end
end
end
+1
View File
@@ -5,3 +5,4 @@ module Foreman::Export
end end
require "foreman/export/upstart" require "foreman/export/upstart"
require "foreman/export/inittab"
-1
View File
@@ -1,4 +1,3 @@
require "foreman/configuration"
require "foreman/export" require "foreman/export"
class Foreman::Export::Base class Foreman::Export::Base
+31
View File
@@ -0,0 +1,31 @@
require "foreman/export/base"
class Foreman::Export::Inittab < Foreman::Export::Base
def export(fname=nil, options={})
app = options[:app] || File.basename(engine.directory)
user = options[:user] || app
log_root = options[:log] || "/var/log"
concurrency = parse_concurrency(options[:concurrency])
inittab = []
inittab << "# ----- foreman #{app} processes -----"
engine.processes.values.each_with_index do |process, num|
id = app.slice(0, 2).upcase + sprintf("%02d", num+1)
inittab << "#{id}:4:respawn:/bin/su - #{user} -c '#{process.command} >> #{log_root}/#{process.name}-#{num+1}.log 2>&1'"
end
inittab << "# ----- end foreman #{app} processes -----"
inittab = inittab.join("\n") + "\n"
if fname
FileUtils.mkdir_p(log_root)
FileUtils.chown(user, nil, log_root)
write_file(fname, inittab)
else
puts inittab
end
end
end
+7 -16
View File
@@ -1,5 +1,4 @@
require "erb" require "erb"
require "foreman/configuration"
require "foreman/export/base" require "foreman/export/base"
class Foreman::Export::Upstart < Foreman::Export::Base class Foreman::Export::Upstart < Foreman::Export::Base
@@ -10,6 +9,8 @@ class Foreman::Export::Upstart < Foreman::Export::Base
FileUtils.mkdir_p location FileUtils.mkdir_p location
app = options[:app] || File.basename(engine.directory) app = options[:app] || File.basename(engine.directory)
user = options[:user] || app
log_root = options[:log] || "/var/log/#{app}"
Dir["#{location}/#{app}*.conf"].each do |file| Dir["#{location}/#{app}*.conf"].each do |file|
say "cleaning up: #{file}" say "cleaning up: #{file}"
@@ -23,27 +24,17 @@ class Foreman::Export::Upstart < Foreman::Export::Base
write_file "#{location}/#{app}.conf", master_config write_file "#{location}/#{app}.conf", master_config
process_template = export_template("upstart/process.conf.erb") process_template = export_template("upstart/process.conf.erb")
engine.processes.values.each do |process| engine.processes.values.each do |process|
process_master_template = export_template("upstart/process_master.conf.erb")
process_master_config = ERB.new(process_master_template).result(binding)
write_file "#{location}/#{app}-#{process.name}.conf", process_master_config
1.upto(concurrency[process.name]) do |num| 1.upto(concurrency[process.name]) do |num|
process_config = ERB.new(process_template).result(binding) process_config = ERB.new(process_template).result(binding)
write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
end end
end end
return
write_file "#{location}/#{app}.conf", <<-UPSTART_MASTER
UPSTART_MASTER
engine.processes.each do |process|
write_file process_conf, <<-UPSTART_CHILD
UPSTART_CHILD
end
engine.processes.each do |name, process|
config.processes[name] ||= 1
end
config.write
end end
end end
+19 -4
View File
@@ -15,7 +15,7 @@ format.
## RUNNING ## RUNNING
`foreman start` is used to run your application directly from the command line. `foreman start` is used to run your application directly from the command line.
If no additional parameters are passed, foreman will run one instance of each If no additional parameters are passed, foreman will run one instance of each
type of process defined in your Procfile. type of process defined in your Procfile.
@@ -42,10 +42,17 @@ The following options control how the application is run:
* `-a`, `--app`: * `-a`, `--app`:
Use this name rather than the application's root directory name as the Use this name rather than the application's root directory name as the
name of the application when exporting. name of the application when exporting.
* `-l`, `--log`:
Specify the directory to place process logs in.
* `-c`, `--concurrency`: * `-c`, `--concurrency`:
Specify the number of each process type to run. The value passed in Specify the number of each process type to run. The value passed in
should be in the format `process=num,process=num`. should be in the format `process=num,process=num`
* `-u`, `--user`:
Specify the user the application should be run as. Defaults to the
app name
## OPTIONS ## OPTIONS
@@ -56,6 +63,14 @@ These options control all modes of foreman's operation.
containing directory will be assumed to be the root directory of the containing directory will be assumed to be the root directory of the
application. application.
## PROCFILE
A Procfile should contain both a name for the process and the command used
to run it.
web bundle exec thin start
job bundle exec rake jobs:work
## EXAMPLES ## EXAMPLES
Start one instance of each process type, interleave the output on stdout: Start one instance of each process type, interleave the output on stdout:
@@ -65,7 +80,7 @@ Start one instance of each process type, interleave the output on stdout:
Export the application in upstart format: Export the application in upstart format:
$ foreman export upstart /etc/init $ foreman export upstart /etc/init
Run one process type from the application defined in a specific Procfile: Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/app/Procfile $ foreman start alpha -p ~/app/Procfile
-49
View File
@@ -1,49 +0,0 @@
require "spec_helper"
require "foreman/configuration"
describe "Foreman::Configuration" do
subject { Foreman::Configuration.new("testapp") }
describe "initialize" do
describe "without an existing config" do
it "has no processes" do
subject.processes.length.should == 0
end
end
describe "with an existing config" do
it "has processes" do
write_foreman_config("testapp")
subject.processes["alpha"].should == 1
subject.processes["bravo"].should == 2
end
end
end
describe "scale" do
before(:each) { write_foreman_config("testapp") }
it "can scale up" do
mock(subject).system("start testapp-alpha NUM=2")
mock(subject).system("start testapp-alpha NUM=3")
subject.scale("alpha", 3)
end
it "can scale down" do
mock(subject).system("stop testapp-bravo NUM=2")
subject.scale("bravo", 1)
end
end
describe "wite" do
it "can write a configuration file" do
subject.scale("charlie", 3)
subject.scale("delta", 4)
File.read("/etc/foreman/testapp.conf").should == <<-FOREMAN_CONFIG
testapp_processes="charlie delta"
testapp_charlie="3"
testapp_delta="4"
FOREMAN_CONFIG
end
end
end