Compare commits
140 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e5828f8442 | ||
|
|
f121d04bf6 | ||
|
|
3dc113fcd4 | ||
|
|
22ad6c5dd8 | ||
|
|
b117ef5b08 | ||
|
|
35474ad1a5 | ||
|
|
fc5e86b269 | ||
|
|
7f8ca7da39 | ||
|
|
31239d98d0 | ||
|
|
472395edf8 | ||
|
|
6b7d5e5161 | ||
|
|
977c80ffdd | ||
|
|
2804316bbb | ||
|
|
26859c2ec2 | ||
|
|
27152b0e76 | ||
|
|
160945b499 | ||
|
|
f2be566051 | ||
|
|
a504a59f0b | ||
|
|
e6b61801b1 | ||
|
|
dc231f072b | ||
|
|
b77b23b306 | ||
|
|
185617dddc | ||
|
|
9e4cc02827 | ||
|
|
8b6e2481f4 | ||
|
|
79f376368c | ||
|
|
3576ae82af | ||
|
|
303d54155f | ||
|
|
2e36cbf045 | ||
|
|
d3059ca563 | ||
|
|
9e42dfb253 | ||
|
|
eca48170a5 | ||
|
|
86e3cd12dd | ||
|
|
efd5a786f5 | ||
|
|
7e9117812f | ||
|
|
55f405a2b4 | ||
|
|
615bb0d4ba | ||
|
|
0ae144e468 | ||
|
|
0c2b2a4ac2 | ||
|
|
e68946f186 | ||
|
|
52edb7fd28 | ||
|
|
8446528f5a | ||
|
|
d41a8726bd | ||
|
|
7bb1e58879 | ||
|
|
62b6cac741 | ||
|
|
2a7dadc2b2 | ||
|
|
9cd772ac0f | ||
|
|
2b27d0a51a | ||
|
|
99204d7c1d | ||
|
|
e9b5ed81b8 | ||
|
|
7d751470d2 | ||
|
|
68c1a01f15 | ||
|
|
08f9027cb4 | ||
|
|
4f7692bed9 | ||
|
|
dd95cea997 | ||
|
|
f3988b0c52 | ||
|
|
fbb17dd37d | ||
|
|
31a72b454b | ||
|
|
e5a8c38da6 | ||
|
|
d199ef2b4d | ||
|
|
7a1895e435 | ||
|
|
151ddb45c8 | ||
|
|
51513dcb6d | ||
|
|
0b6fdad3a2 | ||
|
|
096f532624 | ||
|
|
efeef5b4f0 | ||
|
|
0eb08dd8ae | ||
|
|
92ba6e0ba7 | ||
|
|
2b90c48eb4 | ||
|
|
dbfd8ba49a | ||
|
|
d6837177cd | ||
|
|
58b45c4933 | ||
|
|
fbdf4d7220 | ||
|
|
895672efe8 | ||
|
|
8597e0dc16 | ||
|
|
408ba06c3f | ||
|
|
a0f82840eb | ||
|
|
1317013898 | ||
|
|
6a7720872f | ||
|
|
b3a5fa9c1b | ||
|
|
41e095cf04 | ||
|
|
2c9f6c25fc | ||
|
|
ce0261c3de | ||
|
|
f138d26e7e | ||
|
|
6000e837fe | ||
|
|
02299c4c1c | ||
|
|
6dc9fe2667 | ||
|
|
a61d808487 | ||
|
|
5f98544dab | ||
|
|
99da671f5d | ||
|
|
26599f630f | ||
|
|
cfe6a49900 | ||
|
|
ddccab4c63 | ||
|
|
3151663f37 | ||
|
|
98486513b6 | ||
|
|
b969e03086 | ||
|
|
be593846e2 | ||
|
|
2458c4e75f | ||
|
|
314e2f5530 | ||
|
|
d6c5e6ddea | ||
|
|
261164e694 | ||
|
|
92e637a231 | ||
|
|
08b94716f2 | ||
|
|
44d589a28f | ||
|
|
4bf1f26032 | ||
|
|
2a2786e676 | ||
|
|
91811425aa | ||
|
|
adb40881d7 | ||
|
|
fd3dc590d9 | ||
|
|
8651bbdbee | ||
|
|
ced0d0aa9d | ||
|
|
10e572de94 | ||
|
|
426241d461 | ||
|
|
5a258b8dc3 | ||
|
|
eeeef65c88 | ||
|
|
d67a2f4e11 | ||
|
|
ce5c8b4c04 | ||
|
|
9d859dae92 | ||
|
|
04884366b3 | ||
|
|
8c78d1e1ee | ||
|
|
35a5f972fe | ||
|
|
868bc44a4e | ||
|
|
644956db29 | ||
|
|
bd07ed809d | ||
|
|
26bb8995c9 | ||
|
|
7005860c3c | ||
|
|
90356ca41d | ||
|
|
2ce3a15bb7 | ||
|
|
f960277ae8 | ||
|
|
4f5402af4a | ||
|
|
a27f964881 | ||
|
|
cf008385b4 | ||
|
|
f633a579d6 | ||
|
|
ea90bf3615 | ||
|
|
c65c71b1c0 | ||
|
|
6f10f4f014 | ||
|
|
be6d1b805c | ||
|
|
58e936a7e2 | ||
|
|
d4f29d6909 | ||
|
|
571163795f | ||
|
|
845ee9ef38 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,5 +1,8 @@
|
||||
.bundle
|
||||
coverage
|
||||
example/log/*
|
||||
man/*.html
|
||||
man/*.markdown
|
||||
pkg
|
||||
tags
|
||||
|
||||
|
||||
18
Gemfile
Normal file
18
Gemfile
Normal file
@@ -0,0 +1,18 @@
|
||||
source "http://rubygems.org"
|
||||
|
||||
group :development do
|
||||
gem 'parka'
|
||||
gem 'rake'
|
||||
gem 'ronn'
|
||||
end
|
||||
|
||||
group :test do
|
||||
gem 'fakefs', '~> 0.2.1'
|
||||
gem 'rcov', '~> 0.9.8'
|
||||
gem 'rr', '~> 1.0.2'
|
||||
gem 'rspec', '~> 2.0.0'
|
||||
end
|
||||
|
||||
gem 'json', '~> 1.5.1'
|
||||
gem 'term-ansicolor', '~> 1.0.5'
|
||||
gem 'thor', '>= 0.13.6'
|
||||
49
Gemfile.lock
Normal file
49
Gemfile.lock
Normal file
@@ -0,0 +1,49 @@
|
||||
GEM
|
||||
remote: http://rubygems.org/
|
||||
specs:
|
||||
diff-lcs (1.1.2)
|
||||
fakefs (0.2.1)
|
||||
hpricot (0.8.2)
|
||||
json (1.5.1)
|
||||
mime-types (1.16)
|
||||
mustache (0.11.2)
|
||||
parka (0.3.1)
|
||||
rest-client
|
||||
thor
|
||||
rake (0.8.7)
|
||||
rcov (0.9.8)
|
||||
rdiscount (1.6.5)
|
||||
rest-client (1.6.0)
|
||||
mime-types (>= 1.16)
|
||||
ronn (0.7.3)
|
||||
hpricot (>= 0.8.2)
|
||||
mustache (>= 0.7.0)
|
||||
rdiscount (>= 1.5.8)
|
||||
rr (1.0.2)
|
||||
rspec (2.0.1)
|
||||
rspec-core (~> 2.0.1)
|
||||
rspec-expectations (~> 2.0.1)
|
||||
rspec-mocks (~> 2.0.1)
|
||||
rspec-core (2.0.1)
|
||||
rspec-expectations (2.0.1)
|
||||
diff-lcs (>= 1.1.2)
|
||||
rspec-mocks (2.0.1)
|
||||
rspec-core (~> 2.0.1)
|
||||
rspec-expectations (~> 2.0.1)
|
||||
term-ansicolor (1.0.5)
|
||||
thor (0.14.6)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
fakefs (~> 0.2.1)
|
||||
json (~> 1.5.1)
|
||||
parka
|
||||
rake
|
||||
rcov (~> 0.9.8)
|
||||
ronn
|
||||
rr (~> 1.0.2)
|
||||
rspec (~> 2.0.0)
|
||||
term-ansicolor (~> 1.0.5)
|
||||
thor (>= 0.13.6)
|
||||
9
README.markdown
Normal file
9
README.markdown
Normal file
@@ -0,0 +1,9 @@
|
||||
# Foreman
|
||||
|
||||
## Manual
|
||||
|
||||
See the [man page](http://ddollar.github.com/foreman) for usage.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
85
README.rdoc
85
README.rdoc
@@ -1,85 +0,0 @@
|
||||
= Foreman
|
||||
|
||||
== Procfile
|
||||
|
||||
alpha ./bin/alpha
|
||||
bravo ./bin/bravo some args
|
||||
charlie ./bin/charlie -n 5
|
||||
|
||||
== Development mode
|
||||
|
||||
=== Running
|
||||
|
||||
Log files will be output to standard out, colorized to aid in visual separation.
|
||||
|
||||
$ foreman start
|
||||
[01:27:08] [alpha] started with pid 4393
|
||||
[01:27:08] [bravo] started with pid 4394
|
||||
[01:27:08] [charlie] started with pid 4395
|
||||
[01:27:08] [bravo] initializing...
|
||||
[01:27:08] [bravo] complete
|
||||
|
||||
=== Using Screen
|
||||
|
||||
Launch the processes in a screen session in indivudal windows
|
||||
|
||||
$ foreman screen
|
||||
|
||||
== Single Process Execution
|
||||
|
||||
$ foreman execute alpha
|
||||
|
||||
== Exporting to Upstart
|
||||
|
||||
=== Export to upstart scripts
|
||||
|
||||
$ foreman export sampleapp
|
||||
|
||||
$ initctl list | grep sampleapp
|
||||
sampleapp start/running
|
||||
sampleapp-alpha (1) start/running, process 4204
|
||||
sampleapp-bravo (1) start/running, process 4589
|
||||
sampleapp-charlie (1) start/running, process 4597
|
||||
|
||||
=== Change process concurrency levels
|
||||
|
||||
$ foreman scale sampleapp alpha 4
|
||||
sampleapp-alpha (2) start/running, process 4164
|
||||
sampleapp-alpha (3) start/running, process 4166
|
||||
sampleapp-alpha (4) start/running, process 4168
|
||||
|
||||
$ initctl list | grep sampleapp
|
||||
sampleapp start/running
|
||||
sampleapp-alpha (4) start/running, process 4168
|
||||
sampleapp-alpha (3) start/running, process 4166
|
||||
sampleapp-alpha (2) start/running, process 4164
|
||||
sampleapp-alpha (1) start/running, process 4204
|
||||
sampleapp-bravo (1) start/running, process 4589
|
||||
sampleapp-charlie (1) start/running, process 4597
|
||||
|
||||
$ foreman scale sampleapp alpha 1
|
||||
sampleapp-alpha stop/waiting
|
||||
sampleapp-alpha stop/waiting
|
||||
sampleapp-alpha stop/waiting
|
||||
|
||||
=== Good Upstart citizen
|
||||
|
||||
All Upstart commands work as expected
|
||||
|
||||
$ start sampleapp
|
||||
$ stop sampleapp
|
||||
$ restart sampleapp
|
||||
|
||||
=== Standardized Logging
|
||||
|
||||
/var/log/sampleapp/alpha.log
|
||||
/var/log/sampleapp/bravo.log
|
||||
/var/log/sampleapp/charlie.log
|
||||
|
||||
== License
|
||||
|
||||
MIT
|
||||
|
||||
== Copyright
|
||||
|
||||
(c) 2010 David Dollar
|
||||
59
Rakefile
59
Rakefile
@@ -1,3 +1,7 @@
|
||||
require "rubygems"
|
||||
require "bundler"
|
||||
Bundler.setup
|
||||
|
||||
require "rake"
|
||||
require "rspec"
|
||||
require "rspec/core/rake_task"
|
||||
@@ -21,53 +25,28 @@ end
|
||||
Rspec::Core::RakeTask.new("rcov:build") do |t|
|
||||
t.pattern = 'spec/**/*_spec.rb'
|
||||
t.rcov = true
|
||||
t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
|
||||
t.rcov_opts = [ "--exclude", ".bundle", "--exclude", "spec" ]
|
||||
end
|
||||
|
||||
desc 'Build the manual'
|
||||
task :man do
|
||||
require 'ronn'
|
||||
ENV['RONN_MANUAL'] = "Foreman Manual"
|
||||
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
|
||||
sh "ronn -w -s toc -r5 --markdown man/*.ronn"
|
||||
sh "git add man/*.?"
|
||||
sh "git commit -m \"updating man pages\""
|
||||
sh "git add README.markdown"
|
||||
sh "git commit -m 'update readme' || echo 'nothing to commit'"
|
||||
end
|
||||
|
||||
######################################################
|
||||
|
||||
begin
|
||||
require 'jeweler'
|
||||
Jeweler::Tasks.new do |s|
|
||||
s.name = "foreman"
|
||||
s.version = Foreman::VERSION
|
||||
|
||||
s.summary = "Process manager for applications with multiple components"
|
||||
s.description = s.summary
|
||||
s.author = "David Dollar"
|
||||
s.email = "ddollar@gmail.com"
|
||||
s.homepage = "http://github.com/ddollar/foreman"
|
||||
|
||||
s.platform = Gem::Platform::RUBY
|
||||
s.has_rdoc = false
|
||||
|
||||
s.files = %w(Rakefile README.md) + Dir["{bin,lib,spec}/**/*"]
|
||||
s.require_path = "lib"
|
||||
|
||||
# #s.bindir = "bin"
|
||||
# s.executables = Dir["bin/*"]
|
||||
s.default_executable = "foreman"
|
||||
|
||||
s.add_development_dependency 'fakefs', '~> 0.2.1'
|
||||
s.add_development_dependency 'rake', '~> 0.8.7'
|
||||
s.add_development_dependency 'rcov', '~> 0.9.8'
|
||||
s.add_development_dependency 'rr', '~> 0.10.11'
|
||||
s.add_development_dependency 'rspec', '~> 2.0.0'
|
||||
|
||||
s.add_dependency 'term-ansicolor', '~> 1.0.5'
|
||||
s.add_dependency 'thor', '~> 0.13.6'
|
||||
end
|
||||
Jeweler::GemcutterTasks.new
|
||||
rescue LoadError
|
||||
puts "Jeweler not available. Install it with: sudo gem install jeweler"
|
||||
desc "Generate the Github docs"
|
||||
task :pages => :man do
|
||||
sh %{
|
||||
cp man/foreman.1.html /tmp/foreman.1.html
|
||||
git checkout gh-pages
|
||||
rm ./index.html
|
||||
cp /tmp/foreman.1.html ./index.html
|
||||
git add -u index.html
|
||||
git commit -m "rebuilding man page"
|
||||
git push origin -f gh-pages
|
||||
git checkout master
|
||||
}
|
||||
end
|
||||
|
||||
2
data/example/Procfile
Normal file
2
data/example/Procfile
Normal file
@@ -0,0 +1,2 @@
|
||||
ticker: ./ticker $PORT
|
||||
error : ./error
|
||||
2
data/example/Procfile.without_colon
Normal file
2
data/example/Procfile.without_colon
Normal file
@@ -0,0 +1,2 @@
|
||||
ticker ./ticker $PORT
|
||||
error ./error
|
||||
4
data/example/log/neverdie.log
Normal file
4
data/example/log/neverdie.log
Normal file
@@ -0,0 +1,4 @@
|
||||
tick
|
||||
tick
|
||||
./never_die:6:in `sleep': Interrupt
|
||||
from ./never_die:6
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
while true
|
||||
puts "tick"
|
||||
puts "tick: #{ARGV.inspect}"
|
||||
sleep 1
|
||||
end
|
||||
8
data/export/upstart/master.conf.erb
Normal file
8
data/export/upstart/master.conf.erb
Normal file
@@ -0,0 +1,8 @@
|
||||
pre-start script
|
||||
|
||||
bash << "EOF"
|
||||
mkdir -p <%= log_root %>
|
||||
chown -R <%= user %> <%= log_root %>
|
||||
EOF
|
||||
|
||||
end script
|
||||
6
data/export/upstart/process.conf.erb
Normal file
6
data/export/upstart/process.conf.erb
Normal file
@@ -0,0 +1,6 @@
|
||||
start on starting <%= app %>-<%= process.name %>
|
||||
stop on stopping <%= app %>-<%= process.name %>
|
||||
respawn
|
||||
|
||||
chdir <%= engine.directory %>
|
||||
exec su - <%= user %> -c 'export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'
|
||||
2
data/export/upstart/process_master.conf.erb
Normal file
2
data/export/upstart/process_master.conf.erb
Normal file
@@ -0,0 +1,2 @@
|
||||
start on starting <%= app %>
|
||||
stop on stopping <%= app %>
|
||||
@@ -1,2 +0,0 @@
|
||||
ticker ./ticker
|
||||
error ./error
|
||||
@@ -1,13 +0,0 @@
|
||||
pre-start script
|
||||
|
||||
bash << "EOF"
|
||||
mkdir -p /var/log/<%= app %>
|
||||
|
||||
<% engine.processes.keys.sort.each do |process| %>
|
||||
<% 1.upto(concurrency[process]).each do |num| %>
|
||||
start <%=app%>-<%=process%>-<%=num%>
|
||||
<% end %>
|
||||
<% end %>
|
||||
EOF
|
||||
|
||||
end script
|
||||
@@ -1,5 +0,0 @@
|
||||
stop on stopping <%= app %>
|
||||
respawn
|
||||
|
||||
chdir <%= engine.directory %>
|
||||
exec <%= process.command %> >> /var/log/<%=app%>/<%=process.name%>-<%=num%>.log 2>&1
|
||||
107
foreman.gemspec
107
foreman.gemspec
@@ -1,88 +1,29 @@
|
||||
# Generated by jeweler
|
||||
# DO NOT EDIT THIS FILE DIRECTLY
|
||||
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
||||
# -*- encoding: utf-8 -*-
|
||||
$:.unshift File.expand_path("../lib", __FILE__)
|
||||
require "foreman/version"
|
||||
|
||||
Gem::Specification.new do |s|
|
||||
s.name = %q{foreman}
|
||||
s.version = "0.4.1"
|
||||
Gem::Specification.new do |gem|
|
||||
gem.name = "foreman"
|
||||
gem.version = Foreman::VERSION
|
||||
|
||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
||||
s.authors = ["David Dollar"]
|
||||
s.date = %q{2010-06-23}
|
||||
s.default_executable = %q{foreman}
|
||||
s.description = %q{Process manager for applications with multiple components}
|
||||
s.email = %q{ddollar@gmail.com}
|
||||
s.executables = ["foreman"]
|
||||
s.extra_rdoc_files = [
|
||||
"README.rdoc"
|
||||
]
|
||||
s.files = [
|
||||
"Rakefile",
|
||||
"bin/foreman",
|
||||
"lib/foreman.rb",
|
||||
"lib/foreman/cli.rb",
|
||||
"lib/foreman/configuration.rb",
|
||||
"lib/foreman/engine.rb",
|
||||
"lib/foreman/export.rb",
|
||||
"lib/foreman/export/base.rb",
|
||||
"lib/foreman/export/upstart.rb",
|
||||
"lib/foreman/process.rb",
|
||||
"spec/foreman/cli_spec.rb",
|
||||
"spec/foreman/configuration_spec.rb",
|
||||
"spec/foreman/engine_spec.rb",
|
||||
"spec/foreman/export/upstart_spec.rb",
|
||||
"spec/foreman/export_spec.rb",
|
||||
"spec/foreman/process_spec.rb",
|
||||
"spec/foreman_spec.rb",
|
||||
"spec/spec_helper.rb"
|
||||
]
|
||||
s.has_rdoc = false
|
||||
s.homepage = %q{http://github.com/ddollar/foreman}
|
||||
s.rdoc_options = ["--charset=UTF-8"]
|
||||
s.require_paths = ["lib"]
|
||||
s.rubygems_version = %q{1.3.7}
|
||||
s.summary = %q{Process manager for applications with multiple components}
|
||||
s.test_files = [
|
||||
"spec/foreman/cli_spec.rb",
|
||||
"spec/foreman/configuration_spec.rb",
|
||||
"spec/foreman/engine_spec.rb",
|
||||
"spec/foreman/export/upstart_spec.rb",
|
||||
"spec/foreman/export_spec.rb",
|
||||
"spec/foreman/process_spec.rb",
|
||||
"spec/foreman_spec.rb",
|
||||
"spec/spec_helper.rb"
|
||||
]
|
||||
gem.author = "David Dollar"
|
||||
gem.email = "ddollar@gmail.com"
|
||||
gem.homepage = "http://github.com/ddollar/foreman"
|
||||
gem.summary = "Process manager for applications with multiple components"
|
||||
|
||||
if s.respond_to? :specification_version then
|
||||
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
||||
s.specification_version = 3
|
||||
gem.description = gem.summary
|
||||
|
||||
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
||||
s.add_development_dependency(%q<fakefs>, ["~> 0.2.1"])
|
||||
s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
|
||||
s.add_development_dependency(%q<rcov>, ["~> 0.9.8"])
|
||||
s.add_development_dependency(%q<rr>, ["~> 0.10.11"])
|
||||
s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
|
||||
s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
|
||||
s.add_runtime_dependency(%q<thor>, ["~> 0.13.6"])
|
||||
else
|
||||
s.add_dependency(%q<fakefs>, ["~> 0.2.1"])
|
||||
s.add_dependency(%q<rake>, ["~> 0.8.7"])
|
||||
s.add_dependency(%q<rcov>, ["~> 0.9.8"])
|
||||
s.add_dependency(%q<rr>, ["~> 0.10.11"])
|
||||
s.add_dependency(%q<rspec>, ["~> 2.0.0"])
|
||||
s.add_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
|
||||
s.add_dependency(%q<thor>, ["~> 0.13.6"])
|
||||
end
|
||||
else
|
||||
s.add_dependency(%q<fakefs>, ["~> 0.2.1"])
|
||||
s.add_dependency(%q<rake>, ["~> 0.8.7"])
|
||||
s.add_dependency(%q<rcov>, ["~> 0.9.8"])
|
||||
s.add_dependency(%q<rr>, ["~> 0.10.11"])
|
||||
s.add_dependency(%q<rspec>, ["~> 2.0.0"])
|
||||
s.add_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
|
||||
s.add_dependency(%q<thor>, ["~> 0.13.6"])
|
||||
end
|
||||
gem.executables = "foreman"
|
||||
gem.files = Dir["**/*"].select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
|
||||
gem.files << "man/foreman.1"
|
||||
|
||||
gem.add_dependency 'json', '~> 1.5.1'
|
||||
gem.add_dependency 'term-ansicolor', '~> 1.0.5'
|
||||
gem.add_dependency 'thor', '>= 0.13.6'
|
||||
|
||||
gem.add_development_dependency 'rake'
|
||||
gem.add_development_dependency 'ronn'
|
||||
gem.add_development_dependency 'fakefs', '~> 0.2.1'
|
||||
gem.add_development_dependency 'rcov', '~> 0.9.8'
|
||||
gem.add_development_dependency 'rr', '~> 1.0.2'
|
||||
gem.add_development_dependency 'rspec', '~> 2.0.0'
|
||||
end
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module Foreman
|
||||
require "foreman/version"
|
||||
|
||||
VERSION = "0.4.1"
|
||||
module Foreman
|
||||
|
||||
class AppDoesNotExist < Exception; end
|
||||
|
||||
|
||||
@@ -1,55 +1,65 @@
|
||||
require "foreman"
|
||||
require "foreman/configuration"
|
||||
require "foreman/engine"
|
||||
require "foreman/export"
|
||||
require "thor"
|
||||
|
||||
class Foreman::CLI < Thor
|
||||
|
||||
class_option :procfile, :type => :string, :aliases => "-p", :desc => "Default: ./Procfile"
|
||||
class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
|
||||
|
||||
desc "start [PROCESS]", "Start the application, or a specific process"
|
||||
|
||||
method_option :screen, :type => :boolean, :aliases => "-s"
|
||||
method_option :port, :type => :numeric, :aliases => "-p"
|
||||
method_option :concurrency, :type => :string, :aliases => "-c",
|
||||
:banner => '"alpha=5,bar=3"'
|
||||
|
||||
def start(process=nil)
|
||||
check_procfile!
|
||||
|
||||
|
||||
if process
|
||||
engine.execute(process)
|
||||
elsif options[:screen]
|
||||
engine.screen
|
||||
engine.execute(process, options)
|
||||
else
|
||||
engine.start
|
||||
engine.start(options)
|
||||
end
|
||||
end
|
||||
|
||||
desc "export FORMAT LOCATION", "Export the application to another process management format"
|
||||
|
||||
method_option :app, :type => :string, :aliases => "-a"
|
||||
method_option :concurrency, :type => :string, :aliases => "-c",
|
||||
method_option :app, :type => :string, :aliases => "-a"
|
||||
method_option :log, :type => :string, :aliases => "-l"
|
||||
method_option :port, :type => :numeric, :aliases => "-p"
|
||||
method_option :user, :type => :string, :aliases => "-u"
|
||||
method_option :concurrency, :type => :string, :aliases => "-c",
|
||||
:banner => '"alpha=5,bar=3"'
|
||||
|
||||
def export(format, location=nil)
|
||||
check_procfile!
|
||||
|
||||
formatter = case format
|
||||
when "json" then Foreman::Export::JSON
|
||||
when "inittab" then Foreman::Export::Inittab
|
||||
when "upstart" then Foreman::Export::Upstart
|
||||
else error "Unknown export format: #{format}."
|
||||
end
|
||||
|
||||
formatter.new(engine).export(location,
|
||||
:name => options[:app],
|
||||
:concurrency => options[:concurrency]
|
||||
)
|
||||
formatter.new(engine).export(location, options)
|
||||
|
||||
rescue Foreman::Export::Exception => ex
|
||||
error ex.message
|
||||
end
|
||||
|
||||
desc "check", "Validate your application's Procfile"
|
||||
|
||||
def check
|
||||
processes = engine.processes_in_order.map { |p| p.first }
|
||||
error "no processes defined" unless processes.length > 0
|
||||
display "valid procfile detected (#{processes.join(', ')})"
|
||||
end
|
||||
|
||||
private ######################################################################
|
||||
|
||||
def check_procfile!
|
||||
error("Procfile does not exist.") unless File.exist?(procfile)
|
||||
error("#{procfile} does not exist.") unless File.exist?(procfile)
|
||||
end
|
||||
|
||||
def engine
|
||||
@@ -57,10 +67,12 @@ private ######################################################################
|
||||
end
|
||||
|
||||
def procfile
|
||||
options[:procfile] || "./Procfile"
|
||||
options[:procfile] || "Procfile"
|
||||
end
|
||||
|
||||
private ######################################################################
|
||||
def display(message)
|
||||
puts message
|
||||
end
|
||||
|
||||
def error(message)
|
||||
puts "ERROR: #{message}"
|
||||
@@ -71,4 +83,11 @@ private ######################################################################
|
||||
File.exist?(procfile)
|
||||
end
|
||||
|
||||
def options
|
||||
original_options = super
|
||||
return original_options unless File.exists?(".foreman")
|
||||
defaults = YAML::load_file(".foreman")
|
||||
Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
@@ -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,8 +1,10 @@
|
||||
require "foreman"
|
||||
require "foreman/process"
|
||||
require "foreman/utils"
|
||||
require "pty"
|
||||
require "tempfile"
|
||||
require "term/ansicolor"
|
||||
require "fileutils"
|
||||
|
||||
class Foreman::Engine
|
||||
|
||||
@@ -11,7 +13,7 @@ class Foreman::Engine
|
||||
|
||||
extend Term::ANSIColor
|
||||
|
||||
COLORS = [ cyan, yellow, green, magenta, on_blue ]
|
||||
COLORS = [ cyan, yellow, green, magenta, red ]
|
||||
|
||||
def initialize(procfile)
|
||||
@procfile = read_procfile(procfile)
|
||||
@@ -20,48 +22,75 @@ class Foreman::Engine
|
||||
|
||||
def processes
|
||||
@processes ||= begin
|
||||
@order = []
|
||||
procfile.split("\n").inject({}) do |hash, line|
|
||||
next if line.strip == ""
|
||||
process = Foreman::Process.new(*line.split(" ", 2))
|
||||
name, command = line.split(/ *: +/, 2)
|
||||
unless command
|
||||
warn_deprecated_procfile!
|
||||
name, command = line.split(/ +/, 2)
|
||||
end
|
||||
process = Foreman::Process.new(name, command)
|
||||
process.color = next_color
|
||||
@order << process.name
|
||||
hash.update(process.name => process)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def start
|
||||
def process_order
|
||||
processes
|
||||
@order.uniq
|
||||
end
|
||||
|
||||
def processes_in_order
|
||||
process_order.map do |name|
|
||||
[name, processes[name]]
|
||||
end
|
||||
end
|
||||
|
||||
def start(options={})
|
||||
proctitle "ruby: foreman master"
|
||||
|
||||
processes.each do |name, process|
|
||||
fork process
|
||||
processes_in_order.each do |name, process|
|
||||
fork process, options
|
||||
end
|
||||
|
||||
trap("TERM") { kill_and_exit("TERM") }
|
||||
trap("INT") { kill_and_exit("INT") }
|
||||
trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
|
||||
trap("INT") { puts "SIGINT received"; kill_all("INT") }
|
||||
|
||||
watch_for_termination
|
||||
end
|
||||
|
||||
def screen
|
||||
tempfile = Tempfile.new("foreman")
|
||||
tempfile.puts "sessionname foreman"
|
||||
processes.each do |name, process|
|
||||
tempfile.puts "screen -t #{name} #{process.command}"
|
||||
end
|
||||
tempfile.close
|
||||
def execute(name, options={})
|
||||
fork processes[name], options
|
||||
|
||||
system "screen -c #{tempfile.path}"
|
||||
trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
|
||||
trap("INT") { puts "SIGINT received"; kill_all("INT") }
|
||||
|
||||
tempfile.delete
|
||||
watch_for_termination
|
||||
end
|
||||
|
||||
def execute(name)
|
||||
run(processes[name], false)
|
||||
def port_for(process, num, base_port=nil)
|
||||
base_port ||= 5000
|
||||
offset = processes_in_order.map { |p| p.first }.index(process.name) * 100
|
||||
base_port.to_i + offset + num - 1
|
||||
end
|
||||
|
||||
private ######################################################################
|
||||
|
||||
def fork(process)
|
||||
def fork(process, options={})
|
||||
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
|
||||
|
||||
1.upto(concurrency[process.name]) do |num|
|
||||
fork_individual(process, num, port_for(process, num, options[:port]))
|
||||
end
|
||||
end
|
||||
|
||||
def fork_individual(process, num, port)
|
||||
ENV["PORT"] = port.to_s
|
||||
ENV["PS"] = "#{process.name}.#{num}"
|
||||
|
||||
pid = Process.fork do
|
||||
run(process)
|
||||
end
|
||||
@@ -70,32 +99,33 @@ private ######################################################################
|
||||
running_processes[pid] = process
|
||||
end
|
||||
|
||||
def run(process, log_to_file=true)
|
||||
def run(process)
|
||||
proctitle "ruby: foreman #{process.name}"
|
||||
|
||||
Dir.chdir directory do
|
||||
FileUtils.mkdir_p "log"
|
||||
command = process.command
|
||||
begin
|
||||
Dir.chdir directory do
|
||||
command = process.command
|
||||
|
||||
begin
|
||||
PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
|
||||
until stdin.eof?
|
||||
info stdin.gets, process
|
||||
end
|
||||
end
|
||||
rescue PTY::ChildExited, Interrupt
|
||||
end
|
||||
rescue PTY::ChildExited, Interrupt
|
||||
begin
|
||||
info "process exiting", process
|
||||
rescue Interrupt
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def kill_and_exit(signal="TERM")
|
||||
def kill_all(signal="TERM")
|
||||
info "terminating"
|
||||
running_processes.each do |pid, process|
|
||||
info "killing #{process.name} in pid #{pid}"
|
||||
Process.kill(signal, pid)
|
||||
end
|
||||
exit 0
|
||||
end
|
||||
|
||||
def info(message, process=nil)
|
||||
@@ -115,8 +145,8 @@ private ######################################################################
|
||||
end
|
||||
|
||||
def pad_process_name(process)
|
||||
name = process ? process.name : "system"
|
||||
name.ljust(longest_process_name)
|
||||
name = process ? "#{ENV["PS"]}" : "system"
|
||||
name.ljust(longest_process_name + 3) # add 3 for process number padding
|
||||
end
|
||||
|
||||
def print_info
|
||||
@@ -138,7 +168,8 @@ private ######################################################################
|
||||
pid, status = Process.wait2
|
||||
process = running_processes.delete(pid)
|
||||
info "process terminated", process
|
||||
kill_and_exit
|
||||
kill_all
|
||||
Process.waitall
|
||||
end
|
||||
|
||||
def running_processes
|
||||
@@ -151,4 +182,12 @@ private ######################################################################
|
||||
@current_color >= COLORS.length ? "" : COLORS[@current_color]
|
||||
end
|
||||
|
||||
def warn_deprecated_procfile!
|
||||
return if @already_warned_deprecated
|
||||
@already_warned_deprecated = true
|
||||
puts "!!! This format of Procfile is deprecated, and will not work starting in v0.12"
|
||||
puts "!!! Use a colon to separate the process name from the command"
|
||||
puts "!!! e.g. web: thin start"
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
@@ -4,4 +4,6 @@ module Foreman::Export
|
||||
class Exception < ::Exception; end
|
||||
end
|
||||
|
||||
require "foreman/export/json"
|
||||
require "foreman/export/inittab"
|
||||
require "foreman/export/upstart"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
require "foreman/configuration"
|
||||
require "foreman/export"
|
||||
require "foreman/utils"
|
||||
|
||||
class Foreman::Export::Base
|
||||
|
||||
@@ -24,17 +24,7 @@ private ######################################################################
|
||||
end
|
||||
|
||||
def export_template(name)
|
||||
File.read(File.expand_path("../../../../export/#{name}", __FILE__))
|
||||
end
|
||||
|
||||
def parse_concurrency(concurrency)
|
||||
@concurrency ||= begin
|
||||
pairs = concurrency.to_s.gsub(/\s/, "").split(",")
|
||||
pairs.inject(Hash.new(1)) do |hash, pair|
|
||||
process, amount = pair.split("=")
|
||||
hash.update(process => amount.to_i)
|
||||
end
|
||||
end
|
||||
File.read(File.expand_path("../../../../data/export/#{name}", __FILE__))
|
||||
end
|
||||
|
||||
def write_file(filename, contents)
|
||||
|
||||
38
lib/foreman/export/inittab.rb
Normal file
38
lib/foreman/export/inittab.rb
Normal file
@@ -0,0 +1,38 @@
|
||||
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/#{app}"
|
||||
|
||||
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
|
||||
|
||||
inittab = []
|
||||
inittab << "# ----- foreman #{app} processes -----"
|
||||
|
||||
engine.processes.values.inject(1) do |index, process|
|
||||
1.upto(concurrency[process.name]) do |num|
|
||||
id = app.slice(0, 2).upcase + sprintf("%02d", index)
|
||||
port = engine.port_for(process, num, options[:port])
|
||||
inittab << "#{id}:4:respawn:/bin/su - #{user} -c 'PORT=#{port} #{process.command} >> #{log_root}/#{process.name}-#{num}.log 2>&1'"
|
||||
index += 1
|
||||
end
|
||||
index
|
||||
end
|
||||
|
||||
inittab << "# ----- end foreman #{app} processes -----"
|
||||
|
||||
inittab = inittab.join("\n") + "\n"
|
||||
|
||||
if fname
|
||||
FileUtils.mkdir_p(log_root) rescue error "could not create #{log_root}"
|
||||
FileUtils.chown(user, nil, log_root) rescue error "could not chown #{log_root} to #{user}"
|
||||
write_file(fname, inittab)
|
||||
else
|
||||
puts inittab
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
13
lib/foreman/export/json.rb
Normal file
13
lib/foreman/export/json.rb
Normal file
@@ -0,0 +1,13 @@
|
||||
require "foreman/export/base"
|
||||
require "json"
|
||||
|
||||
class Foreman::Export::JSON < Foreman::Export::Base
|
||||
|
||||
def export(fname=nil, options={})
|
||||
processes = engine.processes.values.inject({}) do |hash, process|
|
||||
hash.update(process.name => { "command" => process.command })
|
||||
end
|
||||
puts processes.to_json
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,5 +1,4 @@
|
||||
require "erb"
|
||||
require "foreman/configuration"
|
||||
require "foreman/export/base"
|
||||
|
||||
class Foreman::Export::Upstart < Foreman::Export::Base
|
||||
@@ -10,40 +9,33 @@ class Foreman::Export::Upstart < Foreman::Export::Base
|
||||
FileUtils.mkdir_p location
|
||||
|
||||
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|
|
||||
say "cleaning up: #{file}"
|
||||
FileUtils.rm(file)
|
||||
end
|
||||
|
||||
concurrency = parse_concurrency(options[:concurrency])
|
||||
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
|
||||
|
||||
master_template = export_template("upstart/master.conf.erb")
|
||||
master_config = ERB.new(master_template).result(binding)
|
||||
write_file "#{location}/#{app}.conf", master_config
|
||||
|
||||
process_template = export_template("upstart/process.conf.erb")
|
||||
|
||||
|
||||
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|
|
||||
port = engine.port_for(process, num, options[:port])
|
||||
process_config = ERB.new(process_template).result(binding)
|
||||
write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
|
||||
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
|
||||
|
||||
15
lib/foreman/utils.rb
Normal file
15
lib/foreman/utils.rb
Normal file
@@ -0,0 +1,15 @@
|
||||
require "foreman"
|
||||
|
||||
class Foreman::Utils
|
||||
|
||||
def self.parse_concurrency(concurrency)
|
||||
@concurrency ||= begin
|
||||
pairs = concurrency.to_s.gsub(/\s/, "").split(",")
|
||||
pairs.inject(Hash.new(1)) do |hash, pair|
|
||||
process, amount = pair.split("=")
|
||||
hash.update(process => amount.to_i)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
5
lib/foreman/version.rb
Normal file
5
lib/foreman/version.rb
Normal file
@@ -0,0 +1,5 @@
|
||||
module Foreman
|
||||
|
||||
VERSION = "0.12.0"
|
||||
|
||||
end
|
||||
131
man/foreman.1
131
man/foreman.1
@@ -1,16 +1,16 @@
|
||||
.\" generated with Ronn/v0.7.0
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.0
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "FOREMAN" "1" "June 2010" "Foreman 0.4.1" "Foreman Manual"
|
||||
.TH "FOREMAN" "1" "March 2011" "Foreman 0.12.0.pre1" "Foreman Manual"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBforeman\fR \- manage Procfile\-based applications
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBforeman\fR start [process]
|
||||
\fBforeman start [process]\fR
|
||||
.
|
||||
.br
|
||||
\fBforeman\fR export \fIformat\fR [location]
|
||||
\fBforeman export <format> [location]\fR
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
\fBForeman\fR is a manager for Procfile\-based applications\. Its aim is to abstract away the details of the Procfile format, and allow you to either run your application directly or export it to some other process management format\.
|
||||
@@ -28,8 +28,12 @@ If a parameter is passed, foreman will run one instance of the specified applica
|
||||
The following options control how the application is run:
|
||||
.
|
||||
.TP
|
||||
\fB\-s\fR, \fB\-\-screen\fR
|
||||
Run the application as a series of screen windows rather than interleaved in stdout\.
|
||||
\fB\-c\fR, \fB\-\-concurrency\fR
|
||||
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
|
||||
.
|
||||
.TP
|
||||
\fB\-p\fR, \fB\-\-port\fR
|
||||
Specify which port to use as the base for this application\. Should be a multiple of 1000\.
|
||||
.
|
||||
.SH "EXPORTING"
|
||||
\fBforeman export\fR is used to export your application to another process management format\.
|
||||
@@ -46,13 +50,120 @@ Use this name rather than the application\'s root directory name as the name of
|
||||
.
|
||||
.TP
|
||||
\fB\-c\fR, \fB\-\-concurrency\fR
|
||||
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR\.
|
||||
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
|
||||
.
|
||||
.TP
|
||||
\fB\-l\fR, \fB\-\-log\fR
|
||||
Specify the directory to place process logs in\.
|
||||
.
|
||||
.TP
|
||||
\fB\-p\fR, \fB\-\-port\fR
|
||||
Specify which port to use as the base for this application\. Should be a multiple of 1000\.
|
||||
.
|
||||
.TP
|
||||
\fB\-u\fR, \fB\-\-user\fR
|
||||
Specify the user the application should be run as\. Defaults to the app name
|
||||
.
|
||||
.SH "OPTIONS"
|
||||
These options control all modes of foreman\'s operation\.
|
||||
.
|
||||
.TP
|
||||
\fB\-f\fR, \fB\-\-procfile\fR
|
||||
Specify an alternate location for the application\'s Procfile\. This file\'s containing directory will be assumed to be the root directory of the application\.
|
||||
.
|
||||
.SH "EXPORT FORMATS"
|
||||
foreman currently supports the following output formats:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB\-p\fR, \fB\-\-procfile\fR Specify an alternate location for the application\'s Procfile\. This file\'s containing directory will be assumed to be the root directory of the application\.
|
||||
json
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
inittab
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
upstart
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "JSON EXPORT"
|
||||
Will export your processes as JSON:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
{ "web": { "command": "bundle exec thin start" } }
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "INITTAB EXPORT"
|
||||
Will export a chunk of inittab\-compatible configuration:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
# \-\-\-\-\- foreman example processes \-\-\-\-\-
|
||||
EX01:4:respawn:/bin/su \- example \-c \'PORT=5000 bundle exec thin start >> /var/log/web\-1\.log 2>&1\'
|
||||
EX02:4:respawn:/bin/su \- example \-c \'PORT=5100 bundle exec rake jobs:work >> /var/log/job\-1\.log 2>&1\'
|
||||
# \-\-\-\-\- end foreman example processes \-\-\-\-\-
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "UPSTART EXPORT"
|
||||
Will create a series of upstart scripts in the location you specify\. Scripts will be structured to make the following commands valid:
|
||||
.
|
||||
.P
|
||||
\fBstart appname\fR
|
||||
.
|
||||
.P
|
||||
\fBstop appname\-processname\fR
|
||||
.
|
||||
.P
|
||||
\fBrestart appname\-processname\-3\fR
|
||||
.
|
||||
.SH "PROCFILE"
|
||||
A Procfile should contain both a name for the process and the command used to run it\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
web: bundle exec thin start
|
||||
job: bundle exec rake jobs:work
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
You can validate your Procfile format using the \fBcheck\fR command
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ foreman check
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "DEFAULT OPTIONS"
|
||||
If a \fB\.foreman\fR file exists in the current directory, default options will be read from it\. This file should be in YAML format with the long option name as keys\. Example:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
concurrency: alpha=0
|
||||
port: 15000
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
@@ -89,7 +200,7 @@ Run one process type from the application defined in a specific Procfile:
|
||||
.
|
||||
.nf
|
||||
|
||||
$ foreman start alpha \-p ~/app/Procfile
|
||||
$ foreman start alpha \-p ~/myapp/Procfile
|
||||
.
|
||||
.fi
|
||||
.
|
||||
|
||||
@@ -3,8 +3,8 @@ foreman(1) -- manage Procfile-based applications
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
`foreman` start [process]<br>
|
||||
`foreman` export <format> [location]
|
||||
`foreman start [process]`<br>
|
||||
`foreman export <format> [location]`
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
@@ -15,7 +15,7 @@ format.
|
||||
|
||||
## 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
|
||||
type of process defined in your Procfile.
|
||||
@@ -25,9 +25,13 @@ application type.
|
||||
|
||||
The following options control how the application is run:
|
||||
|
||||
* `-s`, `--screen`:
|
||||
Run the application as a series of screen windows rather than interleaved
|
||||
in stdout.
|
||||
* `-c`, `--concurrency`:
|
||||
Specify the number of each process type to run. The value passed in
|
||||
should be in the format `process=num,process=num`
|
||||
|
||||
* `-p`, `--port`:
|
||||
Specify which port to use as the base for this application. Should be
|
||||
a multiple of 1000.
|
||||
|
||||
## EXPORTING
|
||||
|
||||
@@ -42,20 +46,88 @@ The following options control how the application is run:
|
||||
* `-a`, `--app`:
|
||||
Use this name rather than the application's root directory name as the
|
||||
name of the application when exporting.
|
||||
|
||||
|
||||
* `-c`, `--concurrency`:
|
||||
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`
|
||||
|
||||
* `-l`, `--log`:
|
||||
Specify the directory to place process logs in.
|
||||
|
||||
* `-p`, `--port`:
|
||||
Specify which port to use as the base for this application. Should be
|
||||
a multiple of 1000.
|
||||
|
||||
* `-u`, `--user`:
|
||||
Specify the user the application should be run as. Defaults to the
|
||||
app name
|
||||
|
||||
## OPTIONS
|
||||
|
||||
These options control all modes of foreman's operation.
|
||||
|
||||
* `-p`, `--procfile`
|
||||
* `-f`, `--procfile`:
|
||||
Specify an alternate location for the application's Procfile. This file's
|
||||
containing directory will be assumed to be the root directory of the
|
||||
application.
|
||||
|
||||
## EXPORT FORMATS
|
||||
|
||||
foreman currently supports the following output formats:
|
||||
|
||||
* json
|
||||
|
||||
* inittab
|
||||
|
||||
* upstart
|
||||
|
||||
## JSON EXPORT
|
||||
|
||||
Will export your processes as JSON:
|
||||
|
||||
{ "web": { "command": "bundle exec thin start" } }
|
||||
|
||||
## INITTAB EXPORT
|
||||
|
||||
Will export a chunk of inittab-compatible configuration:
|
||||
|
||||
# ----- foreman example processes -----
|
||||
EX01:4:respawn:/bin/su - example -c 'PORT=5000 bundle exec thin start >> /var/log/web-1.log 2>&1'
|
||||
EX02:4:respawn:/bin/su - example -c 'PORT=5100 bundle exec rake jobs:work >> /var/log/job-1.log 2>&1'
|
||||
# ----- end foreman example processes -----
|
||||
|
||||
## UPSTART EXPORT
|
||||
|
||||
Will create a series of upstart scripts in the location you specify. Scripts
|
||||
will be structured to make the following commands valid:
|
||||
|
||||
`start appname`
|
||||
|
||||
`stop appname-processname`
|
||||
|
||||
`restart appname-processname-3`
|
||||
|
||||
## 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
|
||||
|
||||
You can validate your Procfile format using the `check` command
|
||||
|
||||
$ foreman check
|
||||
|
||||
## DEFAULT OPTIONS
|
||||
|
||||
If a `.foreman` file exists in the current directory, default options will
|
||||
be read from it. This file should be in YAML format with the long option
|
||||
name as keys. Example:
|
||||
|
||||
concurrency: alpha=0
|
||||
port: 15000
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
Start one instance of each process type, interleave the output on stdout:
|
||||
@@ -65,10 +137,10 @@ Start one instance of each process type, interleave the output on stdout:
|
||||
Export the application in upstart format:
|
||||
|
||||
$ foreman export upstart /etc/init
|
||||
|
||||
|
||||
Run one process type from the application defined in a specific Procfile:
|
||||
|
||||
$ foreman start alpha -p ~/app/Procfile
|
||||
$ foreman start alpha -p ~/myapp/Procfile
|
||||
|
||||
## COPYRIGHT
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ describe "Foreman::CLI" do
|
||||
|
||||
it "runs successfully" do
|
||||
dont_allow(subject).error
|
||||
mock.instance_of(Foreman::Engine).start
|
||||
mock.instance_of(Foreman::Engine).start({})
|
||||
subject.start
|
||||
end
|
||||
end
|
||||
@@ -51,14 +51,34 @@ describe "Foreman::CLI" do
|
||||
|
||||
it "runs successfully" do
|
||||
dont_allow(subject).error
|
||||
mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {
|
||||
:concurrency => nil,
|
||||
:name => nil
|
||||
})
|
||||
mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {})
|
||||
subject.export("upstart", "/tmp/foo")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "check" do
|
||||
describe "with a valid Procfile" do
|
||||
before { write_procfile }
|
||||
|
||||
it "displays the jobs" do
|
||||
mock(subject).display("valid procfile detected (alpha, bravo)")
|
||||
subject.check
|
||||
end
|
||||
end
|
||||
|
||||
describe "with a blank Procfile" do
|
||||
before do
|
||||
FileUtils.touch("Procfile")
|
||||
end
|
||||
|
||||
it "displays an error" do
|
||||
mock_error(subject, "no processes defined") do
|
||||
subject.check
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
@@ -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
|
||||
@@ -10,30 +10,54 @@ describe "Foreman::Engine" do
|
||||
lambda { subject }.should raise_error
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
describe "with a Procfile" do
|
||||
before { write_procfile }
|
||||
|
||||
it "reads the processes" do
|
||||
write_procfile
|
||||
subject.processes["alpha"].command.should == "./alpha"
|
||||
subject.processes["bravo"].command.should == "./bravo"
|
||||
end
|
||||
end
|
||||
|
||||
describe "with a deprecated Procfile" do
|
||||
before do
|
||||
File.open("Procfile", "w") do |file|
|
||||
file.puts "name command"
|
||||
end
|
||||
end
|
||||
|
||||
it "should print a deprecation warning" do
|
||||
mock(subject).warn_deprecated_procfile!
|
||||
subject.processes.length.should == 1
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
describe "start" do
|
||||
it "forks the processes" do
|
||||
write_procfile
|
||||
mock(subject).fork(subject.processes["alpha"])
|
||||
mock(subject).fork(subject.processes["bravo"])
|
||||
mock(subject).fork(subject.processes["alpha"], {})
|
||||
mock(subject).fork(subject.processes["bravo"], {})
|
||||
mock(subject).watch_for_termination
|
||||
subject.start
|
||||
end
|
||||
|
||||
it "handles concurrency" do
|
||||
write_procfile
|
||||
mock(subject).fork_individual(subject.processes["alpha"], 1, 5000)
|
||||
mock(subject).fork_individual(subject.processes["alpha"], 2, 5001)
|
||||
mock(subject).fork_individual(subject.processes["bravo"], 1, 5100)
|
||||
mock(subject).watch_for_termination
|
||||
subject.start(:concurrency => "alpha=2")
|
||||
end
|
||||
end
|
||||
|
||||
describe "execute" do
|
||||
it "runs the processes" do
|
||||
write_procfile
|
||||
mock(subject).run(subject.processes["alpha"], false)
|
||||
mock(subject).fork(subject.processes["alpha"], {})
|
||||
mock(subject).watch_for_termination
|
||||
subject.execute("alpha")
|
||||
end
|
||||
end
|
||||
|
||||
@@ -26,8 +26,8 @@ end
|
||||
|
||||
def write_procfile(procfile="Procfile")
|
||||
File.open(procfile, "w") do |file|
|
||||
file.puts "alpha ./alpha"
|
||||
file.puts "bravo ./bravo"
|
||||
file.puts "alpha: ./alpha"
|
||||
file.puts "bravo: ./bravo"
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
Reference in New Issue
Block a user