Compare commits

..

28 Commits

Author SHA1 Message Date
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
David Dollar
90356ca41d Regenerated gemspec for version 0.4.3 2010-06-23 19:01:56 -04:00
David Dollar
2ce3a15bb7 dont die if there are no docs to commit 2010-06-23 19:01:54 -04:00
David Dollar
f960277ae8 0.4.3 2010-06-23 19:01:07 -04:00
David Dollar
4f5402af4a update readme 2010-06-23 19:00:57 -04:00
David Dollar
a27f964881 tweak docs 2010-06-23 19:00:55 -04:00
David Dollar
cf008385b4 update readme on man build 2010-06-23 18:59:56 -04:00
David Dollar
f633a579d6 update readme 2010-06-23 18:59:41 -04:00
David Dollar
ea90bf3615 update docs 2010-06-23 18:58:37 -04:00
David Dollar
c65c71b1c0 update docs 2010-06-23 18:58:17 -04:00
David Dollar
6f10f4f014 fix up readme 2010-06-23 18:57:13 -04:00
David Dollar
be6d1b805c Regenerated gemspec for version 0.4.2 2010-06-23 18:54:31 -04:00
David Dollar
58e936a7e2 0.4.2 2010-06-23 18:54:29 -04:00
David Dollar
d4f29d6909 back to master after done 2010-06-23 18:54:17 -04:00
David Dollar
571163795f task to build pages 2010-06-23 18:53:20 -04:00
David Dollar
845ee9ef38 dont store man in repo 2010-06-23 18:50:36 -04:00
8 changed files with 133 additions and 197 deletions

1
.gitignore vendored
View File

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

96
README.markdown Normal file
View File

@@ -0,0 +1,96 @@
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.
* `-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.
## 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

View File

@@ -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

View File

@@ -26,12 +26,25 @@ end
desc 'Build the manual'
task :man do
require 'ronn'
ENV['RONN_MANUAL'] = "Foreman Manual"
ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
sh "ronn -w -s toc -r5 --markdown man/*.ronn"
sh "git add man/*.?"
sh "git commit -m \"updating man pages\""
sh "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
######################################################
@@ -51,7 +64,7 @@ begin
s.platform = Gem::Platform::RUBY
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.bindir = "bin"

View File

@@ -5,7 +5,7 @@
Gem::Specification.new do |s|
s.name = %q{foreman}
s.version = "0.4.1"
s.version = "0.4.4"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["David Dollar"]
@@ -15,11 +15,13 @@ Gem::Specification.new do |s|
s.email = %q{ddollar@gmail.com}
s.executables = ["foreman"]
s.extra_rdoc_files = [
"README.rdoc"
"README.markdown"
]
s.files = [
"Rakefile",
"bin/foreman",
"export/upstart/master.conf.erb",
"export/upstart/process.conf.erb",
"lib/foreman.rb",
"lib/foreman/cli.rb",
"lib/foreman/configuration.rb",

View File

@@ -1,6 +1,6 @@
module Foreman
VERSION = "0.4.1"
VERSION = "0.4.4"
class AppDoesNotExist < Exception; end

View File

@@ -1,99 +0,0 @@
.\" generated with Ronn/v0.7.0
.\" http://github.com/rtomayko/ronn/tree/0.7.0
.
.TH "FOREMAN" "1" "June 2010" "Foreman 0.4.1" "Foreman Manual"
.
.SH "NAME"
\fBforeman\fR \- manage Procfile\-based applications
.
.SH "SYNOPSIS"
\fBforeman\fR start [process]
.
.br
\fBforeman\fR export \fIformat\fR [location]
.
.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\-s\fR, \fB\-\-screen\fR
Run the application as a series of screen windows rather than interleaved in stdout\.
.
.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\.
.
.SH "OPTIONS"
These options control all modes of foreman\'s operation\.
.
.IP "\(bu" 4
\fB\-p\fR, \fB\-\-procfile\fR Specify an alternate location for the application\'s Procfile\. This file\'s containing directory will be assumed to be the root directory of the application\.
.
.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 ~/app/Procfile
.
.fi
.
.IP "" 0
.
.SH "COPYRIGHT"
Foreman is Copyright (C) 2010 David Dollar \fIhttp://daviddollar\.org\fR

View File

@@ -3,8 +3,8 @@ foreman(1) -- manage Procfile-based applications
## SYNOPSIS
`foreman` start [process]<br>
`foreman` export <format> [location]
`foreman start [process]`<br>
`foreman export <format> [location]`
## DESCRIPTION
@@ -15,7 +15,7 @@ format.
## RUNNING
`foreman start` is used to run your application directly from the command line.
`foreman start` is used to run your application directly from the command line.
If no additional parameters are passed, foreman will run one instance of each
type of process defined in your Procfile.
@@ -42,10 +42,10 @@ The following options control how the application is run:
* `-a`, `--app`:
Use this name rather than the application's root directory name as the
name of the application when exporting.
* `-c`, `--concurrency`:
Specify the number of each process type to run. The value passed in
should be in the format `process=num,process=num`.
should be in the format `process=num,process=num`
## OPTIONS
@@ -56,6 +56,14 @@ These options control all modes of foreman's operation.
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:
@@ -65,7 +73,7 @@ Start one instance of each process type, interleave the output on stdout:
Export the application in upstart format:
$ foreman export upstart /etc/init
Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/app/Procfile