Compare commits

...
153 Commits
Author SHA1 Message Date
David Dollar c419f8213b 0.17.0 2011-06-02 12:10:30 -04:00
David Dollar 7f61fb61ea credits 2011-06-02 12:10:21 -04:00
David Dollar 577a5c7c5c make sure tests run on machines other than mine 2011-06-02 12:09:30 -04:00
David Dollar 56940c56d9 Merge pull request #31 from jayzes/master
Loading the shell environment in the exported upstart configuration
2011-06-02 08:51:45 -07:00
Jay Zeschin f308ad886d Change directories when using su - -c to execute a command since you lose the current working directory 2011-06-01 10:38:07 -06:00
Jay Zeschin 55375b9bde Edited data/export/upstart/process.conf.erb via GitHub 2011-05-31 16:30:45 -07:00
David Dollar 85fcccffa8 more readme touchup 2011-05-13 12:10:38 -04:00
David Dollar 58fc18d015 fix up readme 2011-05-13 12:08:41 -04:00
David Dollar f7c9802ef7 0.16.0 2011-05-13 12:05:58 -04:00
David Dollar 1c00d65f29 env is only available in foreground mode for now 2011-05-13 12:05:47 -04:00
David Dollar 9193a675a3 add support for process environments 2011-05-13 12:02:13 -04:00
David Dollar 8f0b14810c Merge pull request #20 from dpiddy/master
Change requires so export/upstart_spec can run on its own
2011-05-13 09:02:01 -07:00
Dan Peterson 124e27ed22 Change requires so export/upstart_spec can be run on its own. 2011-05-13 11:44:53 -03:00
David Dollar f34f161899 0.15.0 2011-05-12 13:05:43 -04:00
David Dollar 191581fe85 kill with TERM, even when INT is received by foreman 2011-05-12 13:05:25 -04:00
David Dollar b98d558bed add blog post to readme 2011-05-12 11:29:56 -04:00
David Dollar 180f63624e 0.14.0 2011-05-11 21:42:12 -04:00
David Dollar 13fd1188ad add export specs 2011-05-11 21:41:56 -04:00
David Dollar 92c2b15785 Merge pull request #18 from clifff/master
Upstart process su'ing into wrong dir
2011-05-11 18:04:18 -07:00
clifff 4a2d7565b7 Cleaner version of ensuring upstart process su goes to the correct dir 2011-05-11 18:51:31 -04:00
clifff 49720e0458 Moved upstart process 'chdir' into after su into user, since that will change dir to user home 2011-05-11 18:23:38 -04:00
David Dollar c4de19f4da 0.13.1 2011-05-10 11:02:16 -04:00
David Dollar 490c8b73bf make sure to require yaml 2011-05-10 11:02:02 -04:00
David Dollar f622f43cf4 update manual 2011-05-07 17:49:53 -04:00
David Dollar 9ab701f5b9 0.13.0 2011-05-07 14:52:58 -04:00
David Dollar 1a5d2428b9 tweak doc build tasks 2011-05-07 14:52:32 -04:00
David Dollar 564aa740e1 remove json export 2011-05-07 14:52:25 -04:00
David Dollar 95115f4e78 switch to "gemspec" stanza for Gemfile 2011-05-07 14:51:56 -04:00
David Dollar e5828f8442 0.12.0 2011-04-01 15:23:31 -04:00
David Dollar f121d04bf6 autorequire foreman/version 2011-03-25 19:30:47 -04:00
David Dollar 3dc113fcd4 add man page to repository 2011-03-25 19:30:04 -04:00
David Dollar 22ad6c5dd8 0.12.0.pre1 2011-03-25 19:29:11 -04:00
David Dollar b117ef5b08 remove parka, relax thor version 2011-03-25 19:25:27 -04:00
David Dollar 35474ad1a5 0.11.1 2011-03-08 12:17:44 -05:00
David Dollar fc5e86b269 describe .foreman in man page 2011-03-08 12:17:03 -05:00
David Dollar 7f8ca7da39 support .foreman file for default options 2011-03-08 12:14:48 -05:00
David Dollar 31239d98d0 ignore ctags file 2011-01-30 16:18:12 -08:00
David Dollar 472395edf8 0.11.0 2011-01-27 16:15:26 -08:00
David Dollar 6b7d5e5161 deprecate colon-less syntax, add check command 2011-01-27 16:14:43 -08:00
David Dollar 977c80ffdd add json export 2011-01-27 16:13:44 -08:00
David Dollar 2804316bbb 0.10.1 2010-12-22 13:56:13 -05:00
David Dollar 26859c2ec2 dont need a log dir 2010-12-22 13:55:51 -05:00
David Dollar 27152b0e76 docs pedantry 2010-12-13 18:13:11 -05:00
David Dollar 160945b499 doc the rake task so it shows in -T 2010-12-13 18:12:28 -05:00
David Dollar f2be566051 update man page 2010-12-13 18:11:36 -05:00
David Dollar a504a59f0b add a colon to the mock Procfile 2010-12-13 18:08:40 -05:00
David Dollar e6b61801b1 0.10.0 2010-12-13 18:05:41 -05:00
David Dollar dc231f072b allow optional colon after process name 2010-12-13 18:05:06 -05:00
David Dollar b77b23b306 declare license 2010-11-16 17:47:53 -05:00
David Dollar 185617dddc 0.9.2 2010-11-09 13:42:18 -05:00
David Dollar 9e4cc02827 upgrade dependencies 2010-11-09 13:41:18 -05:00
David Dollar 8b6e2481f4 ruby 1.8.6 compatibility 2010-11-09 13:41:08 -05:00
David Dollar 79f376368c 0.9.1 2010-11-03 15:00:59 -07:00
David Dollar 3576ae82af use process order to determine port assignments 2010-11-03 15:00:35 -07:00
David Dollar 303d54155f uniq the order for safety 2010-11-03 14:13:06 -07:00
David Dollar 2e36cbf045 0.9.0 2010-11-03 14:11:37 -07:00
David Dollar d3059ca563 always run processes in order they are defined in the procfile 2010-11-03 14:11:30 -07:00
David Dollar 9e42dfb253 change back to Procfile 2010-11-03 14:05:06 -07:00
David Dollar eca48170a5 fixing specs 2010-10-15 17:26:18 -07:00
David Dollar 86e3cd12dd using Psfile 2010-10-15 17:25:12 -07:00
David Dollar efd5a786f5 showing PORT here can be confusing 2010-10-15 16:29:40 -07:00
David Dollar 7e9117812f 0.9.0.beta.1 2010-10-15 16:18:54 -07:00
David Dollar 55f405a2b4 catch some common error cases 2010-10-15 16:17:55 -07:00
David Dollar 615bb0d4ba pass ENV["PS"] through to child processes (worker.1) and use it for display output 2010-10-15 16:08:33 -07:00
David Dollar 0ae144e468 better handling of Interrupt rescues 2010-10-15 16:06:06 -07:00
David Dollar 0c2b2a4ac2 prevent double interrupt 2010-10-15 15:55:53 -07:00
David Dollar e68946f186 change to Pstypes 2010-10-15 15:53:43 -07:00
David Dollar 52edb7fd28 move data under data 2010-10-15 15:53:27 -07:00
David Dollar 8446528f5a change to Pstypes 2010-10-15 15:50:40 -07:00
David Dollar d41a8726bd update dependencies 2010-10-15 15:50:19 -07:00
David Dollar 7bb1e58879 0.8.0 2010-09-20 16:22:31 -04:00
David Dollar 62b6cac741 print message when signal received 2010-09-20 16:22:13 -04:00
Keith Rarick 2a7dadc2b2 Wait cleanly for child processes to exit.
Signed-off-by: David Dollar <ddollar@gmail.com>
2010-09-20 16:21:41 -04:00
David Dollar 9cd772ac0f 0.7.5 2010-09-17 09:31:24 -04:00
David Dollar 2b27d0a51a include files from export in the gem 2010-09-17 09:31:08 -04:00
Keith Rarick 99204d7c1d Wait for descendant processes to exit. 2010-09-17 21:28:01 +08:00
Ricardo Chimal, Jr e9b5ed81b8 bugfix upstart export erb templates 2010-09-17 21:27:29 +08:00
David Dollar 7d751470d2 0.7.3 2010-08-24 17:41:36 -04:00
David Dollar 68c1a01f15 add executable and man page to gem release 2010-08-24 17:41:22 -04:00
David Dollar 08f9027cb4 0.7.2 2010-08-24 17:24:43 -04:00
David Dollar 4f7692bed9 switch to parka for gem management 2010-08-24 17:23:03 -04:00
David Dollar dd95cea997 update docs 2010-07-21 07:23:32 -07:00
David Dollar f3988b0c52 Regenerated gemspec for version 0.7.1 2010-07-20 16:20:20 -07:00
David Dollar fbb17dd37d 0.7.1 2010-07-20 16:20:16 -07:00
David Dollar 31a72b454b clean up development concurrency, make sure ports exist in dev mode 2010-07-20 16:20:03 -07:00
David Dollar e5a8c38da6 clean up exports 2010-07-20 16:19:40 -07:00
David Dollar d199ef2b4d Regenerated gemspec for version 0.7.0 2010-07-19 17:14:04 -07:00
David Dollar 7a1895e435 0.7.0 2010-07-19 17:13:54 -07:00
David Dollar 151ddb45c8 remove screen option, seems too hokey 2010-07-19 17:11:42 -07:00
David Dollar 51513dcb6d pedantry 2010-07-19 17:08:48 -07:00
David Dollar 0b6fdad3a2 allow concurrency to be used in development mode 2010-07-19 17:08:42 -07:00
David Dollar 096f532624 fix failing spec 2010-07-19 15:50:19 -07:00
David Dollar efeef5b4f0 Regenerated gemspec for version 0.6.0 2010-07-06 16:43:00 -04:00
David Dollar 0eb08dd8ae 0.6.0 2010-07-06 16:42:50 -04:00
Adam Wiggins 92ba6e0ba7 use app name in log root for inittab export 2010-07-07 04:42:08 +08:00
David Dollar 2b90c48eb4 point to the better-formatted man page for help 2010-07-04 14:39:27 -04:00
David Dollar dbfd8ba49a Regenerated gemspec for version 0.5.1 2010-06-30 23:11:30 -04:00
David Dollar d6837177cd 0.5.1 2010-06-30 23:11:26 -04:00
Adam Wiggins 58b45c4933 require fileutils for ruby 1.8.6 compat 2010-07-01 11:10:44 +08:00
David Dollar fbdf4d7220 add a bit more example to the docs 2010-06-30 21:48:11 -04:00
David Dollar 895672efe8 update readme 2010-06-30 21:47:17 -04:00
David Dollar 8597e0dc16 update readme 2010-06-30 21:46:46 -04:00
David Dollar 408ba06c3f update readme 2010-06-30 21:45:57 -04:00
David Dollar a0f82840eb update readme 2010-06-30 21:45:50 -04:00
David Dollar 1317013898 update readme 2010-06-30 21:44:34 -04:00
David Dollar 6a7720872f update readme 2010-06-30 21:44:18 -04:00
David Dollar b3a5fa9c1b update readme 2010-06-30 21:44:13 -04:00
David Dollar 41e095cf04 update readme 2010-06-30 21:42:48 -04:00
David Dollar 2c9f6c25fc update readme 2010-06-30 21:42:40 -04:00
David Dollar ce0261c3de update readme 2010-06-30 21:42:23 -04:00
David Dollar f138d26e7e update readme 2010-06-30 21:42:10 -04:00
David Dollar 6000e837fe update readme 2010-06-30 21:42:02 -04:00
David Dollar 02299c4c1c update readme 2010-06-30 21:41:54 -04:00
David Dollar 6dc9fe2667 update readme 2010-06-30 21:41:29 -04:00
David Dollar a61d808487 update readme 2010-06-30 21:41:13 -04:00
David Dollar 5f98544dab update readme 2010-06-30 21:40:56 -04:00
David Dollar 99da671f5d update readme 2010-06-30 21:40:25 -04:00
David Dollar 26599f630f Regenerated gemspec for version 0.5.0 2010-06-30 21:32:44 -04:00
David Dollar cfe6a49900 update readme 2010-06-30 21:32:44 -04:00
David Dollar ddccab4c63 0.5.0 2010-06-30 21:32:38 -04:00
David Dollar 3151663f37 add -p flag to specify the base port for apps 2010-06-30 21:32:26 -04:00
David Dollar 98486513b6 switch procfile option to -f 2010-06-30 21:18:30 -04:00
David Dollar b969e03086 pedantry 2010-06-29 20:42:06 -04:00
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 Wiggins 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
42 changed files with 781 additions and 433 deletions
+1
View File
@@ -0,0 +1 @@
FOO=bar
+3 -1
View File
@@ -1,6 +1,8 @@
.bundle
coverage coverage
example/log/* example/log/*
man/*.?
man/*.html man/*.html
man/*.markdown man/*.markdown
pkg pkg
tags
+3
View File
@@ -0,0 +1,3 @@
source "http://rubygems.org"
gemspec
+55
View File
@@ -0,0 +1,55 @@
PATH
remote: .
specs:
foreman (0.17.0)
term-ansicolor (~> 1.0.5)
thor (>= 0.13.6)
GEM
remote: http://rubygems.org/
specs:
crack (0.1.8)
diff-lcs (1.1.2)
fakefs (0.2.1)
hpricot (0.8.2)
mime-types (1.16)
mustache (0.11.2)
parka (0.6.2)
crack
rest-client
thor
rake (0.8.7)
rcov (0.9.8)
rdiscount (1.6.5)
rest-client (1.6.1)
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)
foreman!
parka
rake
rcov (~> 0.9.8)
ronn
rr (~> 1.0.2)
rspec (~> 2.0.0)
+18 -75
View File
@@ -1,87 +1,30 @@
foreman(1) -- manage Procfile-based applications # Foreman
================================================
## SYNOPSIS ## Installation
`foreman start [process]`<br> gem install foreman
`foreman export <var>format</var> [location]`
## DESCRIPTION ## Description
**Foreman** is a manager for Procfile-based applications. Its aim is to http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
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.
## RUNNING ## Manual
`foreman start` is used to run your application directly from the command line. See the [man page](http://ddollar.github.com/foreman) for usage.
If no additional parameters are passed, foreman will run one instance of each ## Authorship
type of process defined in your Procfile.
If a parameter is passed, foreman will run one instance of the specified Created by David Dollar
application type.
The following options control how the application is run: Patches contributed by:
* `-s`, `--screen`: * Adam Wiggins
Run the application as a series of screen windows rather than interleaved * clifff
in stdout. * Dan Peterson
* Jay Zeschin
* Keith Rarick
* Ricardo Chimal, Jr
## EXPORTING ## License
`foreman export` is used to export your application to another process MIT
management format.
An location to export can be passed as an argument. This argument may be
either required or optional depending on the export format.
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`.
## OPTIONS
These options control all modes of foreman's operation.
* `-p`, `--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.
## EXAMPLES
Start one instance of each process type, interleave the output on stdout:
$ foreman start
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
## COPYRIGHT
Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
[RUNNING]: #RUNNING "RUNNING"
[EXPORTING]: #EXPORTING "EXPORTING"
[OPTIONS]: #OPTIONS "OPTIONS"
[EXAMPLES]: #EXAMPLES "EXAMPLES"
[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
[foreman(1)]: foreman.1.html
+12 -42
View File
@@ -1,3 +1,7 @@
require "rubygems"
require "bundler"
Bundler.setup
require "rake" require "rake"
require "rspec" require "rspec"
require "rspec/core/rake_task" require "rspec/core/rake_task"
@@ -21,7 +25,7 @@ end
Rspec::Core::RakeTask.new("rcov:build") do |t| Rspec::Core::RakeTask.new("rcov:build") do |t|
t.pattern = 'spec/**/*_spec.rb' t.pattern = 'spec/**/*_spec.rb'
t.rcov = true t.rcov = true
t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ] t.rcov_opts = [ "--exclude", ".bundle", "--exclude", "spec" ]
end end
desc 'Build the manual' desc 'Build the manual'
@@ -29,58 +33,24 @@ task :man do
ENV['RONN_MANUAL'] = "Foreman Manual" ENV['RONN_MANUAL'] = "Foreman Manual"
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}" ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
sh "ronn -w -s toc -r5 --markdown man/*.ronn" sh "ronn -w -s toc -r5 --markdown man/*.ronn"
sh "cp man/foreman.1.markdown README.markdown" end
desc "Commit the manual to git"
task "man:commit" => :man do
sh "git add README.markdown" sh "git add README.markdown"
sh "git commit -m 'update readme' || echo 'nothing to commit'" sh "git commit -m 'update readme' || echo 'nothing to commit'"
end end
task :pages => :man do desc "Generate the Github docs"
task :pages => "man:commit" do
sh %{ sh %{
cp man/foreman.1.html /tmp/foreman.1.html cp man/foreman.1.html /tmp/foreman.1.html
git checkout gh-pages git checkout gh-pages
rm ./index.html rm ./index.html
cp /tmp/foreman.1.html ./index.html cp /tmp/foreman.1.html ./index.html
git add -u index.html git add -u index.html
git commit -m "rebuilding man page" git commit -m "saving man page to github docs"
git push origin -f gh-pages git push origin -f gh-pages
git checkout master git checkout master
} }
end 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"
end
+2
View File
@@ -0,0 +1,2 @@
ticker: ./ticker $PORT
error : ./error
+2
View File
@@ -0,0 +1,2 @@
ticker ./ticker $PORT
error ./error
+4
View File
@@ -0,0 +1,4 @@
tick
tick
./never_die:6:in `sleep': Interrupt
from ./never_die:6
+6
View File
@@ -0,0 +1,6 @@
#!/usr/bin/env ruby
while true
puts "tick: #{ARGV.inspect} -- FOO:#{ENV["FOO"]}"
sleep 1
end
+8
View File
@@ -0,0 +1,8 @@
pre-start script
bash << "EOF"
mkdir -p <%= log_root %>
chown -R <%= user %> <%= log_root %>
EOF
end script
+5
View File
@@ -0,0 +1,5 @@
start on starting <%= app %>-<%= process.name %>
stop on stopping <%= app %>-<%= process.name %>
respawn
exec su - <%= user %> -c 'cd <%= engine.directory %>; export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'
@@ -0,0 +1,2 @@
start on starting <%= app %>
stop on stopping <%= app %>
-2
View File
@@ -1,2 +0,0 @@
ticker ./ticker
error ./error
-6
View File
@@ -1,6 +0,0 @@
#!/usr/bin/env ruby
while true
puts "tick"
sleep 1
end
-13
View File
@@ -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
-5
View File
@@ -1,5 +0,0 @@
stop on stopping <%= app %>
respawn
chdir <%= engine.directory %>
exec <%= process.command %> >> /var/log/<%=app%>/<%=process.name%>-<%=num%>.log 2>&1
+24 -83
View File
@@ -1,88 +1,29 @@
# Generated by jeweler $:.unshift File.expand_path("../lib", __FILE__)
# DO NOT EDIT THIS FILE DIRECTLY require "foreman/version"
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
# -*- encoding: utf-8 -*-
Gem::Specification.new do |s| Gem::Specification.new do |gem|
s.name = %q{foreman} gem.name = "foreman"
s.version = "0.4.3" gem.version = Foreman::VERSION
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= gem.author = "David Dollar"
s.authors = ["David Dollar"] gem.email = "ddollar@gmail.com"
s.date = %q{2010-06-23} gem.homepage = "http://github.com/ddollar/foreman"
s.default_executable = %q{foreman} gem.summary = "Process manager for applications with multiple components"
s.description = %q{Process manager for applications with multiple components}
s.email = %q{ddollar@gmail.com}
s.executables = ["foreman"]
s.extra_rdoc_files = [
"README.markdown"
]
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"
]
if s.respond_to? :specification_version then gem.description = gem.summary
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
s.specification_version = 3
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then gem.executables = "foreman"
s.add_development_dependency(%q<fakefs>, ["~> 0.2.1"]) gem.files = Dir["**/*"].select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
s.add_development_dependency(%q<rake>, ["~> 0.8.7"]) gem.files << "man/foreman.1"
s.add_development_dependency(%q<rcov>, ["~> 0.9.8"])
s.add_development_dependency(%q<rr>, ["~> 0.10.11"]) gem.add_dependency 'term-ansicolor', '~> 1.0.5'
s.add_development_dependency(%q<rspec>, ["~> 2.0.0"]) gem.add_dependency 'thor', '>= 0.13.6'
s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
s.add_runtime_dependency(%q<thor>, ["~> 0.13.6"]) gem.add_development_dependency 'parka'
else gem.add_development_dependency 'rake'
s.add_dependency(%q<fakefs>, ["~> 0.2.1"]) gem.add_development_dependency 'ronn'
s.add_dependency(%q<rake>, ["~> 0.8.7"]) gem.add_development_dependency 'fakefs', '~> 0.2.1'
s.add_dependency(%q<rcov>, ["~> 0.9.8"]) gem.add_development_dependency 'rcov', '~> 0.9.8'
s.add_dependency(%q<rr>, ["~> 0.10.11"]) gem.add_development_dependency 'rr', '~> 1.0.2'
s.add_dependency(%q<rspec>, ["~> 2.0.0"]) gem.add_development_dependency '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
end end
+2 -2
View File
@@ -1,6 +1,6 @@
module Foreman require "foreman/version"
VERSION = "0.4.3" module Foreman
class AppDoesNotExist < Exception; end class AppDoesNotExist < Exception; end
+36 -17
View File
@@ -1,55 +1,65 @@
require "foreman" require "foreman"
require "foreman/configuration"
require "foreman/engine" require "foreman/engine"
require "foreman/export" require "foreman/export"
require "thor" require "thor"
require "yaml"
class Foreman::CLI < 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" desc "start [PROCESS]", "Start the application, or a specific process"
method_option :screen, :type => :boolean, :aliases => "-s" method_option :env, :type => :string, :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
method_option :port, :type => :numeric, :aliases => "-p"
method_option :concurrency, :type => :string, :aliases => "-c", :banner => '"alpha=5,bar=3"'
def start(process=nil) def start(process=nil)
check_procfile! check_procfile!
if process if process
engine.execute(process) engine.execute(process, options)
elsif options[:screen]
engine.screen
else else
engine.start engine.start(options)
end end
end end
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 :concurrency, :type => :string, :aliases => "-c", 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"' :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 "inittab" then Foreman::Export::Inittab
when "upstart" then Foreman::Export::Upstart when "upstart" then Foreman::Export::Upstart
else error "Unknown export format: #{format}." else error "Unknown export format: #{format}."
end end
formatter.new(engine).export(location, formatter.new(engine).export(location, options)
:name => options[:app],
:concurrency => options[:concurrency]
)
rescue Foreman::Export::Exception => ex rescue Foreman::Export::Exception => ex
error ex.message error ex.message
end 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 ###################################################################### private ######################################################################
def check_procfile! def check_procfile!
error("Procfile does not exist.") unless File.exist?(procfile) error("#{procfile} does not exist.") unless File.exist?(procfile)
end end
def engine def engine
@@ -57,10 +67,12 @@ private ######################################################################
end end
def procfile def procfile
options[:procfile] || "./Procfile" options[:procfile] || "Procfile"
end end
private ###################################################################### def display(message)
puts message
end
def error(message) def error(message)
puts "ERROR: #{message}" puts "ERROR: #{message}"
@@ -71,4 +83,11 @@ private ######################################################################
File.exist?(procfile) File.exist?(procfile)
end 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 end
-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
+96 -30
View File
@@ -1,8 +1,10 @@
require "foreman" require "foreman"
require "foreman/process" require "foreman/process"
require "foreman/utils"
require "pty" require "pty"
require "tempfile" require "tempfile"
require "term/ansicolor" require "term/ansicolor"
require "fileutils"
class Foreman::Engine class Foreman::Engine
@@ -11,7 +13,7 @@ class Foreman::Engine
extend Term::ANSIColor extend Term::ANSIColor
COLORS = [ cyan, yellow, green, magenta, on_blue ] COLORS = [ cyan, yellow, green, magenta, red ]
def initialize(procfile) def initialize(procfile)
@procfile = read_procfile(procfile) @procfile = read_procfile(procfile)
@@ -20,48 +22,81 @@ class Foreman::Engine
def processes def processes
@processes ||= begin @processes ||= begin
@order = []
procfile.split("\n").inject({}) do |hash, line| procfile.split("\n").inject({}) do |hash, line|
next if line.strip == "" 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 process.color = next_color
@order << process.name
hash.update(process.name => process) hash.update(process.name => process)
end end
end 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={})
environment = read_environment(options[:env])
proctitle "ruby: foreman master" proctitle "ruby: foreman master"
processes.each do |name, process| processes_in_order.each do |name, process|
fork process fork process, options, environment
end end
trap("TERM") { kill_and_exit("TERM") } trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
trap("INT") { kill_and_exit("INT") } trap("INT") { puts "SIGINT received"; kill_all("TERM") }
watch_for_termination watch_for_termination
end end
def screen def execute(name, options={})
tempfile = Tempfile.new("foreman") environment = read_environment(options[:env])
tempfile.puts "sessionname foreman"
processes.each do |name, process|
tempfile.puts "screen -t #{name} #{process.command}"
end
tempfile.close
system "screen -c #{tempfile.path}" fork processes[name], options, environment
tempfile.delete trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
trap("INT") { puts "SIGINT received"; kill_all("TERM") }
watch_for_termination
end end
def execute(name) def port_for(process, num, base_port=nil)
run(processes[name], false) base_port ||= 5000
offset = processes_in_order.map { |p| p.first }.index(process.name) * 100
base_port.to_i + offset + num - 1
end end
private ###################################################################### private ######################################################################
def fork(process) def fork(process, options={}, environment={})
concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
1.upto(concurrency[process.name]) do |num|
fork_individual(process, num, port_for(process, num, options[:port]), environment)
end
end
def fork_individual(process, num, port, environment)
environment.each { |k,v| ENV[k] = v }
ENV["PORT"] = port.to_s
ENV["PS"] = "#{process.name}.#{num}"
pid = Process.fork do pid = Process.fork do
run(process) run(process)
end end
@@ -70,32 +105,33 @@ private ######################################################################
running_processes[pid] = process running_processes[pid] = process
end end
def run(process, log_to_file=true) def run(process)
proctitle "ruby: foreman #{process.name}" proctitle "ruby: foreman #{process.name}"
Dir.chdir directory do begin
FileUtils.mkdir_p "log" Dir.chdir directory do
command = process.command command = process.command
begin
PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid| PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
until stdin.eof? until stdin.eof?
info stdin.gets, process info stdin.gets, process
end end
end end
rescue PTY::ChildExited, Interrupt end
rescue PTY::ChildExited, Interrupt
begin
info "process exiting", process info "process exiting", process
rescue Interrupt
end end
end end
end end
def kill_and_exit(signal="TERM") def kill_all(signal="TERM")
info "terminating" info "terminating"
running_processes.each do |pid, process| running_processes.each do |pid, process|
info "killing #{process.name} in pid #{pid}" info "killing #{process.name} in pid #{pid}"
Process.kill(signal, pid) Process.kill(signal, pid)
end end
exit 0
end end
def info(message, process=nil) def info(message, process=nil)
@@ -106,6 +142,11 @@ private ######################################################################
puts puts
end end
def error(message)
puts "ERROR: #{message}"
exit 1
end
def longest_process_name def longest_process_name
@longest_process_name ||= begin @longest_process_name ||= begin
longest = processes.keys.map { |name| name.length }.sort.last longest = processes.keys.map { |name| name.length }.sort.last
@@ -115,8 +156,8 @@ private ######################################################################
end end
def pad_process_name(process) def pad_process_name(process)
name = process ? process.name : "system" name = process ? "#{ENV["PS"]}" : "system"
name.ljust(longest_process_name) name.ljust(longest_process_name + 3) # add 3 for process number padding
end end
def print_info def print_info
@@ -138,7 +179,8 @@ private ######################################################################
pid, status = Process.wait2 pid, status = Process.wait2
process = running_processes.delete(pid) process = running_processes.delete(pid)
info "process terminated", process info "process terminated", process
kill_and_exit kill_all
Process.waitall
end end
def running_processes def running_processes
@@ -151,4 +193,28 @@ private ######################################################################
@current_color >= COLORS.length ? "" : COLORS[@current_color] @current_color >= COLORS.length ? "" : COLORS[@current_color]
end 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
def read_environment(filename)
error "No such file: #{filename}" if filename && !File.exists?(filename)
filename ||= ".env"
environment = {}
if File.exists?(filename)
File.read(filename).split("\n").each do |line|
if line =~ /\A([A-Za-z_]+)=(.*)\z/
environment[$1] = $2
end
end
end
environment
end
end end
+2
View File
@@ -4,4 +4,6 @@ module Foreman::Export
class Exception < ::Exception; end class Exception < ::Exception; end
end end
require "foreman/export/base"
require "foreman/export/inittab"
require "foreman/export/upstart" require "foreman/export/upstart"
+2 -12
View File
@@ -1,5 +1,5 @@
require "foreman/configuration"
require "foreman/export" require "foreman/export"
require "foreman/utils"
class Foreman::Export::Base class Foreman::Export::Base
@@ -24,17 +24,7 @@ private ######################################################################
end end
def export_template(name) def export_template(name)
File.read(File.expand_path("../../../../export/#{name}", __FILE__)) File.read(File.expand_path("../../../../data/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
end end
def write_file(filename, contents) def write_file(filename, contents)
+38
View File
@@ -0,0 +1,38 @@
require "foreman/export"
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
+10 -18
View File
@@ -1,6 +1,5 @@
require "erb" require "erb"
require "foreman/configuration" require "foreman/export"
require "foreman/export/base"
class Foreman::Export::Upstart < 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 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}"
FileUtils.rm(file) FileUtils.rm(file)
end end
concurrency = parse_concurrency(options[:concurrency]) concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
master_template = export_template("upstart/master.conf.erb") master_template = export_template("upstart/master.conf.erb")
master_config = ERB.new(master_template).result(binding) master_config = ERB.new(master_template).result(binding)
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|
port = engine.port_for(process, num, options[:port])
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
+15
View 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
View File
@@ -0,0 +1,5 @@
module Foreman
VERSION = "0.17.0"
end
+198
View File
@@ -0,0 +1,198 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOREMAN" "1" "May 2011" "Foreman 0.15.0" "Foreman Manual"
.
.SH "NAME"
\fBforeman\fR \- manage Procfile\-based applications
.
.SH "SYNOPSIS"
\fBforeman start [process]\fR
.
.br
\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\.
.
.SH "RUNNING"
\fBforeman start\fR is used to run your application directly from the command line\.
.
.P
If no additional parameters are passed, foreman will run one instance of each type of process defined in your Procfile\.
.
.P
If a parameter is passed, foreman will run one instance of the specified application type\.
.
.P
The following options control how the application is run:
.
.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
.
.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\.
.
.P
An location to export can be passed as an argument\. This argument may be either required or optional depending on the export format\.
.
.P
The following options control how the application is run:
.
.TP
\fB\-a\fR, \fB\-\-app\fR
Use this name rather than the application\'s root directory name as the name of the application when exporting\.
.
.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
.
.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\-e\fR, \fB\-\-env\fR
Specify a file containing the environment that should be set up for each child process\. The file should be key/value pairs separated by \fB=\fR, with one key/value pair per line\.
.
.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
inittab
.
.IP "\(bu" 4
upstart
.
.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
.
.SH "EXAMPLES"
Start one instance of each process type, interleave the output on stdout:
.
.IP "" 4
.
.nf
$ foreman start
.
.fi
.
.IP "" 0
.
.P
Export the application in upstart format:
.
.IP "" 4
.
.nf
$ foreman export upstart /etc/init
.
.fi
.
.IP "" 0
.
.P
Run one process type from the application defined in a specific Procfile:
.
.IP "" 4
.
.nf
$ foreman start alpha \-p ~/myapp/Procfile
.
.fi
.
.IP "" 0
.
.SH "COPYRIGHT"
Foreman is Copyright (C) 2010 David Dollar \fIhttp://daviddollar\.org\fR
+78 -9
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.
@@ -25,9 +25,13 @@ application type.
The following options control how the application is run: The following options control how the application is run:
* `-s`, `--screen`: * `-c`, `--concurrency`:
Run the application as a series of screen windows rather than interleaved Specify the number of each process type to run. The value passed in
in stdout. 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 ## EXPORTING
@@ -42,20 +46,85 @@ 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.
* `-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`
* `-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 ## OPTIONS
These options control all modes of foreman's operation. These options control all modes of foreman's operation.
* `-p`, `--procfile` * `-e`, `--env`:
Specify a file containing the environment that should be set up for each
child process. The file should be key/value pairs separated by `=`, with
one key/value pair per line.
* `-f`, `--procfile`:
Specify an alternate location for the application's Procfile. This file's Specify an alternate location for the application's Procfile. This file's
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.
## EXPORT FORMATS
foreman currently supports the following output formats:
* inittab
* upstart
## 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 ## 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,10 +134,10 @@ 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 ~/myapp/Procfile
## COPYRIGHT ## COPYRIGHT
+25 -5
View File
@@ -19,7 +19,7 @@ describe "Foreman::CLI" do
it "runs successfully" do it "runs successfully" do
dont_allow(subject).error dont_allow(subject).error
mock.instance_of(Foreman::Engine).start mock.instance_of(Foreman::Engine).start({})
subject.start subject.start
end end
end end
@@ -51,14 +51,34 @@ describe "Foreman::CLI" do
it "runs successfully" do it "runs successfully" do
dont_allow(subject).error dont_allow(subject).error
mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", { mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {})
:concurrency => nil,
:name => nil
})
subject.export("upstart", "/tmp/foo") subject.export("upstart", "/tmp/foo")
end end
end end
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 end
-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
+55 -6
View File
@@ -10,31 +10,80 @@ describe "Foreman::Engine" do
lambda { subject }.should raise_error lambda { subject }.should raise_error
end end
end end
describe "with a Procfile" do describe "with a Procfile" do
before { write_procfile }
it "reads the processes" do it "reads the processes" do
write_procfile
subject.processes["alpha"].command.should == "./alpha" subject.processes["alpha"].command.should == "./alpha"
subject.processes["bravo"].command.should == "./bravo" subject.processes["bravo"].command.should == "./bravo"
end end
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 end
describe "start" do describe "start" do
it "forks the processes" do it "forks the processes" do
write_procfile write_procfile
mock(subject).fork(subject.processes["alpha"]) mock(subject).fork(subject.processes["alpha"], {}, {})
mock(subject).fork(subject.processes["bravo"]) mock(subject).fork(subject.processes["bravo"], {}, {})
mock(subject).watch_for_termination mock(subject).watch_for_termination
subject.start subject.start
end 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 end
describe "execute" do describe "execute" do
it "runs the processes" do it "runs the processes" do
write_procfile write_procfile
mock(subject).run(subject.processes["alpha"], false) mock(subject).fork(subject.processes["alpha"], {}, {})
mock(subject).watch_for_termination
subject.execute("alpha") subject.execute("alpha")
end end
end end
describe "environment" do
before(:each) do
write_procfile
stub(Process).fork
stub(subject).info
mock(subject).watch_for_termination
end
it "should read if specified" do
File.open("/tmp/env", "w") { |f| f.puts("FOO=baz") }
subject.execute("alpha", :env => "/tmp/env")
end
it "should fail if specified and doesnt exist" do
mock(subject).error("No such file: /tmp/env")
subject.execute("alpha", :env => "/tmp/env")
end
it "should read .env if none specified" do
File.open(".env", "w") { |f| f.puts("FOO=qoo") }
mock(subject).fork_individual(anything, anything, anything, { "FOO" => "qoo" })
subject.execute("bravo")
end
end
end end
+23
View File
@@ -1,2 +1,25 @@
require "spec_helper" require "spec_helper"
require "foreman/engine"
require "foreman/export/upstart" require "foreman/export/upstart"
require "tmpdir"
describe Foreman::Export::Upstart do
let(:procfile) { FileUtils.mkdir_p("/tmp/app"); write_procfile("/tmp/app/Procfile") }
let(:engine) { Foreman::Engine.new(procfile) }
let(:upstart) { Foreman::Export::Upstart.new(engine) }
before(:each) { load_export_templates_into_fakefs("upstart") }
before(:each) { stub(upstart).say }
it "exports to the filesystem" do
upstart.export("/tmp/init")
p [:d, Dir["/tmp/init/**"]]
File.read("/tmp/init/app.conf").should == example_export_file("upstart/app.conf")
File.read("/tmp/init/app-alpha.conf").should == example_export_file("upstart/app-alpha.conf")
File.read("/tmp/init/app-alpha-1.conf").should == example_export_file("upstart/app-alpha-1.conf")
File.read("/tmp/init/app-alpha-2.conf").should == example_export_file("upstart/app-alpha-2.conf")
File.read("/tmp/init/app-bravo.conf").should == example_export_file("upstart/app-bravo.conf")
File.read("/tmp/init/app-bravo-1.conf").should == example_export_file("upstart/app-bravo-1.conf")
end
end
@@ -0,0 +1,5 @@
start on starting app-alpha
stop on stopping app-alpha
respawn
exec su - app -c 'cd /tmp/app; export PORT=5000; ./alpha >> /var/log/app/alpha-1.log 2>&1'
@@ -0,0 +1,5 @@
start on starting app-alpha
stop on stopping app-alpha
respawn
exec su - app -c 'cd /tmp/app; export PORT=5001; ./alpha >> /var/log/app/alpha-2.log 2>&1'
@@ -0,0 +1,2 @@
start on starting app
stop on stopping app
@@ -0,0 +1,5 @@
start on starting app-bravo
stop on stopping app-bravo
respawn
exec su - app -c 'cd /tmp/app; export PORT=5100; ./bravo >> /var/log/app/bravo-1.log 2>&1'
@@ -0,0 +1,2 @@
start on starting app
stop on stopping app
+8
View File
@@ -0,0 +1,8 @@
pre-start script
bash << "EOF"
mkdir -p /var/log/app
chown -R app /var/log/app
EOF
end script
+24 -3
View File
@@ -3,7 +3,7 @@ require "rspec"
require "fakefs/safe" require "fakefs/safe"
require "fakefs/spec_helpers" require "fakefs/spec_helpers"
$:.unshift "lib" $:.unshift File.expand_path("../../lib", __FILE__)
def mock_error(subject, message) def mock_error(subject, message)
mock_exit do mock_exit do
@@ -26,9 +26,30 @@ end
def write_procfile(procfile="Procfile") def write_procfile(procfile="Procfile")
File.open(procfile, "w") do |file| File.open(procfile, "w") do |file|
file.puts "alpha ./alpha" file.puts "alpha: ./alpha"
file.puts "bravo ./bravo" file.puts "bravo: ./bravo"
end end
File.expand_path(procfile)
end
def load_export_templates_into_fakefs(type)
FakeFS.deactivate!
files = Dir[File.expand_path("../../data/export/#{type}/**", __FILE__)].inject({}) do |hash, file|
hash.update(file => File.read(file))
end
FakeFS.activate!
files.each do |filename, contents|
File.open(filename, "w") do |f|
f.puts contents
end
end
end
def example_export_file(filename)
FakeFS.deactivate!
data = File.read(File.expand_path("../resources/export/#{filename}", __FILE__))
FakeFS.activate!
data
end end
Rspec.configure do |config| Rspec.configure do |config|