Compare commits

...

10 Commits

Author SHA1 Message Date
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
12 changed files with 218 additions and 50 deletions

1
.gitignore vendored
View File

@@ -1,7 +1,6 @@
.bundle
coverage
example/log/*
man/*.?
man/*.html
man/*.markdown
pkg

17
Gemfile
View File

@@ -1,18 +1,3 @@
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'
gemspec

View File

@@ -1,19 +1,27 @@
PATH
remote: .
specs:
foreman (0.13.1)
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)
json (1.5.1)
mime-types (1.16)
mustache (0.11.2)
parka (0.3.1)
parka (0.6.2)
crack
rest-client
thor
rake (0.8.7)
rcov (0.9.8)
rdiscount (1.6.5)
rest-client (1.6.0)
rest-client (1.6.1)
mime-types (>= 1.16)
ronn (0.7.3)
hpricot (>= 0.8.2)
@@ -38,12 +46,10 @@ PLATFORMS
DEPENDENCIES
fakefs (~> 0.2.1)
json (~> 1.5.1)
foreman!
parka
rake
rcov (~> 0.9.8)
ronn
rr (~> 1.0.2)
rspec (~> 2.0.0)
term-ansicolor (~> 1.0.5)
thor (>= 0.13.6)

View File

@@ -33,19 +33,23 @@ task :man do
ENV['RONN_MANUAL'] = "Foreman Manual"
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
sh "ronn -w -s toc -r5 --markdown man/*.ronn"
end
desc "Commit the manual to git"
task "man:commit" => :man do
sh "git add README.markdown"
sh "git commit -m 'update readme' || echo 'nothing to commit'"
end
desc "Generate the Github docs"
task :pages => :man do
task :pages => "man:commit" 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 commit -m "saving man page to github docs"
git push origin -f gh-pages
git checkout master
}

View File

@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
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 'parka'
gem.add_development_dependency 'rake'
gem.add_development_dependency 'ronn'
gem.add_development_dependency 'fakefs', '~> 0.2.1'

View File

@@ -1,3 +1,5 @@
require "foreman/version"
module Foreman
class AppDoesNotExist < Exception; end

View File

@@ -2,6 +2,7 @@ require "foreman"
require "foreman/engine"
require "foreman/export"
require "thor"
require "yaml"
class Foreman::CLI < Thor
@@ -36,7 +37,6 @@ class Foreman::CLI < Thor
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}."

View File

@@ -4,6 +4,5 @@ module Foreman::Export
class Exception < ::Exception; end
end
require "foreman/export/json"
require "foreman/export/inittab"
require "foreman/export/upstart"

View File

@@ -1,13 +0,0 @@
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

View File

@@ -1,5 +1,5 @@
module Foreman
VERSION = "0.12.0.pre1"
VERSION = "0.13.1"
end

194
man/foreman.1 Normal file
View File

@@ -0,0 +1,194 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOREMAN" "1" "May 2011" "Foreman 0.13.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\-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

View File

@@ -75,18 +75,10 @@ These options control all modes of foreman's operation.
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: