doc for shell spout & bolt and bumped version

This commit is contained in:
Colin Surprenant 2012-07-12 17:04:48 -04:00
parent bbbc8c3982
commit 6844d8283e
3 changed files with 28 additions and 4 deletions

View File

@ -56,4 +56,9 @@
# 0.6.2, 07-10-2012
- issue #39, spout on_receive block will not be evaluated if :emit => false
- issue #40, bolt fail method missing
- integration tests support
- integration tests support
# 0.6.3, tbd
- issue #28, allow specification of output_fields in topology DSL
- issue #41, add support for ShellBolt and ShellSpout
- support constructor parameters for Java spout/bolt in topology DSL

View File

@ -1,4 +1,4 @@
# RedStorm v0.6.2 - JRuby on Storm
# RedStorm v0.6.3 - JRuby on Storm
[![build status](https://secure.travis-ci.org/colinsurprenant/redstorm.png)](http://travis-ci.org/colinsurprenant/redstorm)
@ -58,7 +58,7 @@ $ redstorm local|cluster [--1.8|--1.9] ...
``` ruby
source :rubygems
gem "redstorm", "~> 0.6.2"
gem "redstorm", "~> 0.6.3"
```
## Usage overview
@ -255,6 +255,25 @@ The [Storm wiki](https://github.com/nathanmarz/storm/wiki) has instructions on [
[Ruby DSL Documentation](https://github.com/colinsurprenant/redstorm/wiki/Ruby-DSL-Documentation)
## Multilang ShellSpout & ShellBolt support
Please refer to [Using non JVM languages with Storm](https://github.com/nathanmarz/storm/wiki/Using-non-JVM-languages-with-Storm) for the complete information on Multilang & shelling in Storm.
In RedStorm *ShellSpout* and *ShellBolt* are supported using the following construct in the topology definition:
``` ruby
bolt JRubyShellBolt, ["python", "splitsentence.py"] do
output_fields "word"
source SimpleSpout, :shuffle
end
```
- `JRubyShellBolt` must be used for a *ShellBolt* and the array argument `["python", "splitsentence.py"]` are the arguments to the class constructor and are the *commands* to the *ShellBolt*.
- The directory containing the topology class **must** contain a `resources/` directory with all the shell files.
See the [shell topology example](https://github.com/colinsurprenant/redstorm/tree/master/examples/shell)
## RedStorm Development
It is possible to fork the RedStorm project and run local and remote/cluster topologies directly from the project sources without installing the gem. This is a useful setup when contributing to the project.

View File

@ -1,3 +1,3 @@
module RedStorm
VERSION = '0.6.2'
VERSION = '0.6.3.b1'
end