Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 | ||
|
|
d5d774c9c2 | ||
|
|
b77952ff7f | ||
|
|
3495fa2fea | ||
|
|
4741dceeb0 | ||
|
|
dc1cb08d27 | ||
|
|
b51e8046ce | ||
|
|
922eb7438e | ||
|
|
6811a8d96a |
@@ -1,3 +1,6 @@
|
|||||||
coverage
|
coverage
|
||||||
example/log/*
|
example/log/*
|
||||||
|
man/*.?
|
||||||
|
man/*.html
|
||||||
|
man/*.markdown
|
||||||
pkg
|
pkg
|
||||||
|
|||||||
+103
@@ -0,0 +1,103 @@
|
|||||||
|
foreman(1) -- manage Procfile-based applications
|
||||||
|
================================================
|
||||||
|
|
||||||
|
## SYNOPSIS
|
||||||
|
|
||||||
|
`foreman start [process]`<br>
|
||||||
|
`foreman export <var>format</var> [location]`
|
||||||
|
|
||||||
|
## DESCRIPTION
|
||||||
|
|
||||||
|
**Foreman** 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.
|
||||||
|
|
||||||
|
## RUNNING
|
||||||
|
|
||||||
|
`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.
|
||||||
|
|
||||||
|
If a parameter is passed, foreman will run one instance of the specified
|
||||||
|
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.
|
||||||
|
|
||||||
|
## EXPORTING
|
||||||
|
|
||||||
|
`foreman export` is used to export your application to another process
|
||||||
|
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.
|
||||||
|
|
||||||
|
* `-l`, `--log`:
|
||||||
|
Specify the directory to place process logs in.
|
||||||
|
|
||||||
|
* `-c`, `--concurrency`:
|
||||||
|
Specify the number of each process type to run. The value passed in
|
||||||
|
should be in the format `process=num,process=num`
|
||||||
|
|
||||||
|
* `-u`, `--user`:
|
||||||
|
Specify the user the application should be run as. Defaults to the
|
||||||
|
app name
|
||||||
|
|
||||||
|
## OPTIONS
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## PROCFILE
|
||||||
|
|
||||||
|
A Procfile should contain both a name for the process and the command used
|
||||||
|
to run it.
|
||||||
|
|
||||||
|
web bundle exec thin start
|
||||||
|
job bundle exec rake jobs:work
|
||||||
|
|
||||||
|
## EXAMPLES
|
||||||
|
|
||||||
|
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"
|
||||||
|
[PROCFILE]: #PROCFILE "PROCFILE"
|
||||||
|
[EXAMPLES]: #EXAMPLES "EXAMPLES"
|
||||||
|
[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
|
||||||
|
|
||||||
|
|
||||||
|
[foreman(1)]: foreman.1.html
|
||||||
-85
@@ -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
|
|
||||||
@@ -6,6 +6,7 @@ $:.unshift File.expand_path("../lib", __FILE__)
|
|||||||
require "foreman"
|
require "foreman"
|
||||||
|
|
||||||
task :default => :spec
|
task :default => :spec
|
||||||
|
task :release => :man
|
||||||
|
|
||||||
desc "Run all specs"
|
desc "Run all specs"
|
||||||
Rspec::Core::RakeTask.new(:spec) do |t|
|
Rspec::Core::RakeTask.new(:spec) do |t|
|
||||||
@@ -23,6 +24,29 @@ Rspec::Core::RakeTask.new("rcov:build") do |t|
|
|||||||
t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
|
t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc 'Build the manual'
|
||||||
|
task :man do
|
||||||
|
ENV['RONN_MANUAL'] = "Foreman Manual"
|
||||||
|
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
|
||||||
|
sh "ronn -w -s toc -r5 --markdown man/*.ronn"
|
||||||
|
sh "cp man/foreman.1.markdown README.markdown"
|
||||||
|
sh "git add README.markdown"
|
||||||
|
sh "git commit -m 'update readme' || echo 'nothing to commit'"
|
||||||
|
end
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
######################################################
|
######################################################
|
||||||
|
|
||||||
begin
|
begin
|
||||||
@@ -40,7 +64,7 @@ begin
|
|||||||
s.platform = Gem::Platform::RUBY
|
s.platform = Gem::Platform::RUBY
|
||||||
s.has_rdoc = false
|
s.has_rdoc = false
|
||||||
|
|
||||||
s.files = %w(Rakefile README.md) + Dir["{bin,lib,spec}/**/*"]
|
s.files = %w(Rakefile README.md) + Dir["{bin,export,lib,spec}/**/*"]
|
||||||
s.require_path = "lib"
|
s.require_path = "lib"
|
||||||
|
|
||||||
# #s.bindir = "bin"
|
# #s.bindir = "bin"
|
||||||
|
|||||||
@@ -0,0 +1,8 @@
|
|||||||
|
pre-start script
|
||||||
|
|
||||||
|
bash << "EOF"
|
||||||
|
mkdir -p <%= log_root %>
|
||||||
|
chown -R <%= user %> <%= log_root %>
|
||||||
|
EOF
|
||||||
|
|
||||||
|
end script
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
start on starting <%= app %>-<%= process.name %>
|
||||||
|
stop on stopping <%= app %>-<%= process.name %>
|
||||||
|
respawn
|
||||||
|
|
||||||
|
chdir <%= engine.directory %>
|
||||||
|
exec su <%= user %> -c "<%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1"
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
start on starting <%= app %>
|
||||||
|
stop on stopping <%= app %>
|
||||||
+8
-6
@@ -5,30 +5,33 @@
|
|||||||
|
|
||||||
Gem::Specification.new do |s|
|
Gem::Specification.new do |s|
|
||||||
s.name = %q{foreman}
|
s.name = %q{foreman}
|
||||||
s.version = "0.3.2"
|
s.version = "0.4.7"
|
||||||
|
|
||||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
||||||
s.authors = ["David Dollar"]
|
s.authors = ["David Dollar"]
|
||||||
s.date = %q{2010-06-22}
|
s.date = %q{2010-06-29}
|
||||||
s.default_executable = %q{foreman}
|
s.default_executable = %q{foreman}
|
||||||
s.description = %q{Process manager for applications with multiple components}
|
s.description = %q{Process manager for applications with multiple components}
|
||||||
s.email = %q{ddollar@gmail.com}
|
s.email = %q{ddollar@gmail.com}
|
||||||
s.executables = ["foreman"]
|
s.executables = ["foreman"]
|
||||||
s.extra_rdoc_files = [
|
s.extra_rdoc_files = [
|
||||||
"README.rdoc"
|
"README.markdown"
|
||||||
]
|
]
|
||||||
s.files = [
|
s.files = [
|
||||||
"Rakefile",
|
"Rakefile",
|
||||||
"bin/foreman",
|
"bin/foreman",
|
||||||
|
"export/upstart/master.conf.erb",
|
||||||
|
"export/upstart/process.conf.erb",
|
||||||
|
"export/upstart/process_master.conf.erb",
|
||||||
"lib/foreman.rb",
|
"lib/foreman.rb",
|
||||||
"lib/foreman/cli.rb",
|
"lib/foreman/cli.rb",
|
||||||
"lib/foreman/configuration.rb",
|
|
||||||
"lib/foreman/engine.rb",
|
"lib/foreman/engine.rb",
|
||||||
"lib/foreman/export.rb",
|
"lib/foreman/export.rb",
|
||||||
|
"lib/foreman/export/base.rb",
|
||||||
|
"lib/foreman/export/inittab.rb",
|
||||||
"lib/foreman/export/upstart.rb",
|
"lib/foreman/export/upstart.rb",
|
||||||
"lib/foreman/process.rb",
|
"lib/foreman/process.rb",
|
||||||
"spec/foreman/cli_spec.rb",
|
"spec/foreman/cli_spec.rb",
|
||||||
"spec/foreman/configuration_spec.rb",
|
|
||||||
"spec/foreman/engine_spec.rb",
|
"spec/foreman/engine_spec.rb",
|
||||||
"spec/foreman/export/upstart_spec.rb",
|
"spec/foreman/export/upstart_spec.rb",
|
||||||
"spec/foreman/export_spec.rb",
|
"spec/foreman/export_spec.rb",
|
||||||
@@ -44,7 +47,6 @@ Gem::Specification.new do |s|
|
|||||||
s.summary = %q{Process manager for applications with multiple components}
|
s.summary = %q{Process manager for applications with multiple components}
|
||||||
s.test_files = [
|
s.test_files = [
|
||||||
"spec/foreman/cli_spec.rb",
|
"spec/foreman/cli_spec.rb",
|
||||||
"spec/foreman/configuration_spec.rb",
|
|
||||||
"spec/foreman/engine_spec.rb",
|
"spec/foreman/engine_spec.rb",
|
||||||
"spec/foreman/export/upstart_spec.rb",
|
"spec/foreman/export/upstart_spec.rb",
|
||||||
"spec/foreman/export_spec.rb",
|
"spec/foreman/export_spec.rb",
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
module Foreman
|
module Foreman
|
||||||
|
|
||||||
VERSION = "0.3.2"
|
VERSION = "0.4.7"
|
||||||
|
|
||||||
class AppDoesNotExist < Exception; end
|
class AppDoesNotExist < Exception; end
|
||||||
|
|
||||||
|
|||||||
+43
-28
@@ -1,51 +1,66 @@
|
|||||||
require "foreman"
|
require "foreman"
|
||||||
require "foreman/configuration"
|
|
||||||
require "foreman/engine"
|
require "foreman/engine"
|
||||||
require "foreman/export"
|
require "foreman/export"
|
||||||
require "thor"
|
require "thor"
|
||||||
|
|
||||||
class Foreman::CLI < Thor
|
class Foreman::CLI < Thor
|
||||||
|
|
||||||
desc "start [PROCFILE]", "Run the app described in PROCFILE"
|
class_option :procfile, :type => :string, :aliases => "-p", :desc => "Default: ./Procfile"
|
||||||
|
|
||||||
def start(procfile="Procfile")
|
desc "start [PROCESS]", "Start the application, or a specific process"
|
||||||
error "#{procfile} does not exist." unless procfile_exists?(procfile)
|
|
||||||
Foreman::Engine.new(procfile).start
|
method_option :screen, :type => :boolean, :aliases => "-s"
|
||||||
|
|
||||||
|
def start(process=nil)
|
||||||
|
check_procfile!
|
||||||
|
|
||||||
|
if process
|
||||||
|
engine.execute(process)
|
||||||
|
elsif options[:screen]
|
||||||
|
engine.screen
|
||||||
|
else
|
||||||
|
engine.start
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "execute PROCESS [PROCFILE]", "Run an instance of the specified process from PROCFILE"
|
desc "export FORMAT LOCATION", "Export the application to another process management format"
|
||||||
|
|
||||||
def execute(process, procfile="Procfile")
|
method_option :app, :type => :string, :aliases => "-a"
|
||||||
error "#{procfile} does not exist." unless procfile_exists?(procfile)
|
method_option :log, :type => :string, :aliases => "-l"
|
||||||
Foreman::Engine.new(procfile).execute(process)
|
method_option :user, :type => :string, :aliases => "-u"
|
||||||
end
|
method_option :concurrency, :type => :string, :aliases => "-c",
|
||||||
|
:banner => '"alpha=5,bar=3"'
|
||||||
desc "screen [PROCFILE]", "Run the app described in PROCFILE as screen windows"
|
def export(format, location=nil)
|
||||||
|
check_procfile!
|
||||||
def screen(procfile="Procfile")
|
|
||||||
error "#{procfile} does not exist." unless procfile_exists?(procfile)
|
|
||||||
Foreman::Engine.new(procfile).screen
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "export APP [PROCFILE] [FORMAT]", "Export the app described in PROCFILE as APP to another FORMAT"
|
|
||||||
|
|
||||||
def export(app, procfile="Procfile", format="upstart")
|
|
||||||
error "#{procfile} does not exist." unless procfile_exists?(procfile)
|
|
||||||
|
|
||||||
formatter = case format
|
formatter = case format
|
||||||
when "upstart" then Foreman::Export::Upstart
|
when "upstart" then Foreman::Export::Upstart
|
||||||
|
when "inittab" then Foreman::Export::Inittab
|
||||||
else error "Unknown export format: #{format}."
|
else error "Unknown export format: #{format}."
|
||||||
end
|
end
|
||||||
|
|
||||||
formatter.new(Foreman::Engine.new(procfile)).export(app)
|
formatter.new(engine).export(location,
|
||||||
|
:name => options[:app],
|
||||||
|
:user => options[:user],
|
||||||
|
:log => options[:log],
|
||||||
|
:concurrency => options[:concurrency]
|
||||||
|
)
|
||||||
|
rescue Foreman::Export::Exception => ex
|
||||||
|
error ex.message
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "scale APP PROCESS AMOUNT", "Change the concurrency of a given process type"
|
private ######################################################################
|
||||||
|
|
||||||
def scale(app, process, amount)
|
def check_procfile!
|
||||||
config = Foreman::Configuration.new(app)
|
error("Procfile does not exist.") unless File.exist?(procfile)
|
||||||
error "No such process: #{process}." unless config.processes[process]
|
end
|
||||||
config.scale(process, amount)
|
|
||||||
|
def engine
|
||||||
|
@engine ||= Foreman::Engine.new(procfile)
|
||||||
|
end
|
||||||
|
|
||||||
|
def procfile
|
||||||
|
options[:procfile] || "./Procfile"
|
||||||
end
|
end
|
||||||
|
|
||||||
private ######################################################################
|
private ######################################################################
|
||||||
|
|||||||
@@ -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
|
|
||||||
@@ -83,8 +83,8 @@ private ######################################################################
|
|||||||
info stdin.gets, process
|
info stdin.gets, process
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
rescue PTY::ChildExited
|
rescue PTY::ChildExited, Interrupt
|
||||||
# exited
|
info "process exiting", process
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
require "foreman"
|
require "foreman"
|
||||||
|
|
||||||
module Foreman::Export
|
module Foreman::Export
|
||||||
|
class Exception < ::Exception; end
|
||||||
end
|
end
|
||||||
|
|
||||||
require "foreman/export/upstart"
|
require "foreman/export/upstart"
|
||||||
|
require "foreman/export/inittab"
|
||||||
|
|||||||
@@ -0,0 +1,47 @@
|
|||||||
|
require "foreman/export"
|
||||||
|
|
||||||
|
class Foreman::Export::Base
|
||||||
|
|
||||||
|
attr_reader :engine
|
||||||
|
|
||||||
|
def initialize(engine)
|
||||||
|
@engine = engine
|
||||||
|
end
|
||||||
|
|
||||||
|
def export
|
||||||
|
raise "export method must be overridden"
|
||||||
|
end
|
||||||
|
|
||||||
|
private ######################################################################
|
||||||
|
|
||||||
|
def error(message)
|
||||||
|
raise Foreman::Export::Exception.new(message)
|
||||||
|
end
|
||||||
|
|
||||||
|
def say(message)
|
||||||
|
puts "[foreman export] %s" % message
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
def write_file(filename, contents)
|
||||||
|
say "writing: #{filename}"
|
||||||
|
|
||||||
|
File.open(filename, "w") do |file|
|
||||||
|
file.puts contents
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
require "foreman/export/base"
|
||||||
|
|
||||||
|
class Foreman::Export::Inittab < Foreman::Export::Base
|
||||||
|
|
||||||
|
def export(fname=nil, options={})
|
||||||
|
app = options[:app] || File.basename(engine.directory)
|
||||||
|
user = options[:user] || app
|
||||||
|
log_root = options[:log] || "/var/log"
|
||||||
|
|
||||||
|
concurrency = parse_concurrency(options[:concurrency])
|
||||||
|
|
||||||
|
inittab = []
|
||||||
|
inittab << "# ----- foreman #{app} processes -----"
|
||||||
|
engine.processes.values.each_with_index do |process, num|
|
||||||
|
id = app.slice(0, 2).upcase + sprintf("%02d", num+1)
|
||||||
|
inittab << "#{id}:4:respawn:/bin/su - #{user} -c '#{process.command} >> #{log_root}/#{process.name}-#{num+1}.log 2>&1'"
|
||||||
|
end
|
||||||
|
inittab << "# ----- end foreman #{app} processes -----"
|
||||||
|
|
||||||
|
inittab = inittab.join("\n") + "\n"
|
||||||
|
|
||||||
|
if fname
|
||||||
|
FileUtils.mkdir_p(log_root)
|
||||||
|
FileUtils.chown(user, nil, log_root)
|
||||||
|
write_file(fname, inittab)
|
||||||
|
else
|
||||||
|
puts inittab
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -1,65 +1,39 @@
|
|||||||
require "foreman/configuration"
|
require "erb"
|
||||||
require "foreman/export"
|
require "foreman/export/base"
|
||||||
|
|
||||||
class Foreman::Export::Upstart
|
class Foreman::Export::Upstart < Foreman::Export::Base
|
||||||
|
|
||||||
attr_reader :engine
|
def export(location, options={})
|
||||||
|
error("Must specify a location") unless location
|
||||||
|
|
||||||
def initialize(engine)
|
FileUtils.mkdir_p location
|
||||||
@engine = engine
|
|
||||||
end
|
|
||||||
|
|
||||||
def export(app)
|
app = options[:app] || File.basename(engine.directory)
|
||||||
FileUtils.mkdir_p "/etc/foreman"
|
user = options[:user] || app
|
||||||
FileUtils.mkdir_p "/etc/init"
|
log_root = options[:log] || "/var/log/#{app}"
|
||||||
|
|
||||||
config = Foreman::Configuration.new(app)
|
Dir["#{location}/#{app}*.conf"].each do |file|
|
||||||
|
say "cleaning up: #{file}"
|
||||||
|
FileUtils.rm(file)
|
||||||
|
end
|
||||||
|
|
||||||
write_file "/etc/init/#{app}.conf", <<-UPSTART_MASTER
|
concurrency = parse_concurrency(options[:concurrency])
|
||||||
pre-start script
|
|
||||||
|
|
||||||
bash << "EOF"
|
master_template = export_template("upstart/master.conf.erb")
|
||||||
mkdir -p /var/log/#{app}
|
master_config = ERB.new(master_template).result(binding)
|
||||||
|
write_file "#{location}/#{app}.conf", master_config
|
||||||
|
|
||||||
if [ -f /etc/foreman/#{app}.conf ]; then
|
process_template = export_template("upstart/process.conf.erb")
|
||||||
source /etc/foreman/#{app}.conf
|
|
||||||
fi
|
|
||||||
|
|
||||||
for process in $( echo "$#{app}_processes" ); do
|
|
||||||
process_count_config="#{app}_$process"
|
|
||||||
process_count=${!process_count_config}
|
|
||||||
|
|
||||||
for ((i=1; i<=${process_count:=1}; i+=1)); do
|
|
||||||
start #{app}-$process NUM=$i
|
|
||||||
done
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
end script
|
|
||||||
UPSTART_MASTER
|
|
||||||
|
|
||||||
engine.processes.values.each do |process|
|
engine.processes.values.each do |process|
|
||||||
write_file "/etc/init/#{app}-#{process.name}.conf", <<-UPSTART_CHILD
|
process_master_template = export_template("upstart/process_master.conf.erb")
|
||||||
instance $NUM
|
process_master_config = ERB.new(process_master_template).result(binding)
|
||||||
stop on stopping #{app}
|
write_file "#{location}/#{app}-#{process.name}.conf", process_master_config
|
||||||
respawn
|
|
||||||
|
|
||||||
chdir #{engine.directory}
|
1.upto(concurrency[process.name]) do |num|
|
||||||
exec #{process.command} >>/var/log/#{app}/#{process.name}.log 2>&1
|
process_config = ERB.new(process_template).result(binding)
|
||||||
UPSTART_CHILD
|
write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
|
||||||
end
|
end
|
||||||
|
|
||||||
engine.processes.each do |name, process|
|
|
||||||
config.processes[name] ||= 1
|
|
||||||
end
|
|
||||||
config.write
|
|
||||||
end
|
|
||||||
|
|
||||||
private ######################################################################
|
|
||||||
|
|
||||||
def write_file(filename, contents)
|
|
||||||
File.open(filename, "w") do |file|
|
|
||||||
file.puts contents
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,90 @@
|
|||||||
|
foreman(1) -- manage Procfile-based applications
|
||||||
|
================================================
|
||||||
|
|
||||||
|
## SYNOPSIS
|
||||||
|
|
||||||
|
`foreman start [process]`<br>
|
||||||
|
`foreman export <format> [location]`
|
||||||
|
|
||||||
|
## DESCRIPTION
|
||||||
|
|
||||||
|
**Foreman** 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.
|
||||||
|
|
||||||
|
## RUNNING
|
||||||
|
|
||||||
|
`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.
|
||||||
|
|
||||||
|
If a parameter is passed, foreman will run one instance of the specified
|
||||||
|
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.
|
||||||
|
|
||||||
|
## EXPORTING
|
||||||
|
|
||||||
|
`foreman export` is used to export your application to another process
|
||||||
|
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.
|
||||||
|
|
||||||
|
* `-l`, `--log`:
|
||||||
|
Specify the directory to place process logs in.
|
||||||
|
|
||||||
|
* `-c`, `--concurrency`:
|
||||||
|
Specify the number of each process type to run. The value passed in
|
||||||
|
should be in the format `process=num,process=num`
|
||||||
|
|
||||||
|
* `-u`, `--user`:
|
||||||
|
Specify the user the application should be run as. Defaults to the
|
||||||
|
app name
|
||||||
|
|
||||||
|
## OPTIONS
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## PROCFILE
|
||||||
|
|
||||||
|
A Procfile should contain both a name for the process and the command used
|
||||||
|
to run it.
|
||||||
|
|
||||||
|
web bundle exec thin start
|
||||||
|
job bundle exec rake jobs:work
|
||||||
|
|
||||||
|
## EXAMPLES
|
||||||
|
|
||||||
|
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>
|
||||||
@@ -25,27 +25,6 @@ describe "Foreman::CLI" do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "execute" do
|
|
||||||
describe "with a non-existent Procfile" do
|
|
||||||
it "prints an error" do
|
|
||||||
mock_error(subject, "Procfile does not exist.") do
|
|
||||||
dont_allow.instance_of(Foreman::Engine).start
|
|
||||||
subject.execute("alpha")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "with a Procfile" do
|
|
||||||
before(:each) { write_procfile }
|
|
||||||
|
|
||||||
it "runs successfully" do
|
|
||||||
dont_allow(subject).error
|
|
||||||
mock.instance_of(Foreman::Engine).execute("alpha")
|
|
||||||
subject.execute("alpha")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "export" do
|
describe "export" do
|
||||||
describe "with a non-existent Procfile" do
|
describe "with a non-existent Procfile" do
|
||||||
it "prints an error" do
|
it "prints an error" do
|
||||||
@@ -62,7 +41,7 @@ describe "Foreman::CLI" do
|
|||||||
describe "with an invalid formatter" do
|
describe "with an invalid formatter" do
|
||||||
it "prints an error" do
|
it "prints an error" do
|
||||||
mock_error(subject, "Unknown export format: invalidformatter.") do
|
mock_error(subject, "Unknown export format: invalidformatter.") do
|
||||||
subject.export("testapp", "Procfile", "invalidformatter")
|
subject.export("invalidformatter")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -72,33 +51,11 @@ describe "Foreman::CLI" do
|
|||||||
|
|
||||||
it "runs successfully" do
|
it "runs successfully" do
|
||||||
dont_allow(subject).error
|
dont_allow(subject).error
|
||||||
subject.export("testapp")
|
mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {
|
||||||
end
|
:concurrency => nil,
|
||||||
end
|
:name => nil
|
||||||
end
|
})
|
||||||
end
|
subject.export("upstart", "/tmp/foo")
|
||||||
|
|
||||||
describe "scale" do
|
|
||||||
describe "without an existing configuration" do
|
|
||||||
it "displays an error" do
|
|
||||||
mock_error(subject, "No such process: alpha.") do
|
|
||||||
subject.scale("testapp", "alpha", "2")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "with an existing configuration" do
|
|
||||||
before(:each) { write_foreman_config("testapp") }
|
|
||||||
|
|
||||||
it "scales a process that exists" do
|
|
||||||
mock.instance_of(Foreman::Configuration).scale("alpha", "2")
|
|
||||||
subject.scale("testapp", "alpha", "2")
|
|
||||||
end
|
|
||||||
|
|
||||||
it "errors if a process that does not exist is specified" do
|
|
||||||
mock_error(subject, "No such process: invalidprocess.") do
|
|
||||||
dont_allow.instance_of(Foreman::Configuration).scale
|
|
||||||
subject.scale("testapp", "invalidprocess", "2")
|
|
||||||
end
|
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
|
|
||||||
Reference in New Issue
Block a user