README.md in elasticity-1.4.1 vs README.md in elasticity-1.5
- old
+ new
@@ -1,13 +1,9 @@
Elasticity provides programmatic access to Amazon's Elastic Map Reduce service. The aim is to conveniently wrap the API operations in a manner that makes working with EMR job flows from Ruby more productive and more enjoyable, without having to understand the nuts and bolts of the EMR REST API. At the very least, using Elasticity allows you to easily experiment with the EMR API :)
-**CREDITS**: AWS signing was used from [RightScale's](http://www.rightscale.com/) amazing [right_aws gem](https://github.com/rightscale/right_aws) which works extraordinarily well! If you need access to any AWS service (EC2, S3, etc.), have a look. Used camelize from ActiveSupport as well, thank you \Rails :)
+[](http://travis-ci.org/rslifka/elasticity)
-**CONTRIBUTIONS**:
-
-+ [Wouter Broekhof](https://github.com/wouter/) - HTTPS and AWS region support, additional params to describe_jobflows.
-
# Installation and Usage
<pre>
gem install elasticity
</pre>
@@ -97,11 +93,11 @@
## Custom Jar
Custom jar jobs are also available. To kick off a custom job, specify the path to the jar and any arguments you'd like passed to the jar.
<pre>
- custom_jar = Elasticity::PigJob.new(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_KEY"])
+ custom_jar = Elasticity::CustomJarJob.new(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_KEY"])
custom_jar.log_uri = "s3n://slif-test/output/logs"
custom_jar.action_on_failure = "TERMINATE_JOB_FLOW"
jobflow_id = custom_jar.run('s3n://elasticmapreduce/samples/cloudburst/cloudburst.jar', [
"s3n://elasticmapreduce/samples/cloudburst/input/s_suis.br",
"s3n://elasticmapreduce/samples/cloudburst/input/100k.br",
@@ -109,10 +105,16 @@
])
> "j-1IU6NM8OUPS9I"
</pre>
+Custom jar jobs support arbitrary entry points. Specify the class on which to call main() either via the JAR manifest or as the first argument to the job:
+
+<pre>
+ Elasticity::CustomJarJob.new(key, secret).run(s3_jar_path, ['MyCustomClass', 'arg1', 'arg2'])
+</pre>
+
# Amazon API Reference
Elasticity wraps all of the EMR API calls. Please see the Amazon guide for details on these operations because the default values aren't obvious (e.g. the meaning of <code>DescribeJobFlows</code> without parameters).
You may opt for "direct" access to the API where you specify the params and Elasticity takes care of the signing for you, responding with the XML from Amazon. Direct access is described below the API catalog.
@@ -341,10 +343,23 @@
result_xml[0..78]
> <DescribeJobFlowsResponse xmlns="http://elasticmapreduce.amazonaws.com/doc/2009...
</pre>
+# Something Borrowed...
+
+AWS signing was used from [RightScale's](http://www.rightscale.com/) amazing [right_aws gem](https://github.com/rightscale/right_aws) which works extraordinarily well! If you need access to any AWS service (EC2, S3, etc.), have a look.
+
+Used camelize from ActiveSupport as well, thank you \Rails :)
+
+# Thanks!
+
+Thanks to the following people who have contributed patches or helpful suggestions:
+
++ [Aram Price](https://github.com/aramprice/)
++ [Wouter Broekhof](https://github.com/wouter/)
+
# License
<pre>
Copyright 2011-2012 Robert Slifka
@@ -360,9 +375,11 @@
See the License for the specific language governing permissions and
limitations under the License.
</pre>
### Development Notes for Slif
+
+[Versioning Guide](http://docs.rubygems.org/read/chapter/7#page27), c/o [@brokenladder](https://twitter.com/#!/brokenladder)
<pre>
rake build # Build lorem-0.0.2.gem into the pkg directory
rake install # Build and install lorem-0.0.2.gem into system gems
rake release # Create tag v0.0.2 and build