document how to build from source
Project: http://git-wip-us.apache.org/repos/asf/storm/repo Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/601cee72 Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/601cee72 Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/601cee72 Branch: refs/heads/master Commit: 601cee72aba6d9130bd02a08617f973e14c61eea Parents: f432abf Author: P. Taylor Goetz <ptgo...@gmail.com> Authored: Tue May 5 15:39:25 2015 -0400 Committer: P. Taylor Goetz <ptgo...@gmail.com> Committed: Tue May 5 15:39:25 2015 -0400 ---------------------------------------------------------------------- README.md | 33 ++++++++++++++++++++ .../apache/storm/flux/model/TopologyDef.java | 1 - 2 files changed, 33 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/storm/blob/601cee72/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 92fec10..6683848 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,39 @@ the layout and configuration of your topologies. To use Flux, add it as a dependency and package all your Storm components in a fat jar, then create a YAML document to define your topology (see below for YAML configuration options). +### Building from Source +The easiest way to use Flux, is to add it as a Maven dependency in you project as described below. + +If you would like to build Flux from source and run the unit/integration tests, you will need the following installed +on your system: + +* Python 2.6.x or later +* Node.js 0.10.x or later + +#### Building with unit tests enabled: + +``` +mvn clean install +``` + +#### Building with unit tests disabled: +If you would like to build Flux without installing Python or Node.js you can simply skip the unit tests: + +``` +mvn clean install -DskipTests=true +``` + +Note that if you plan on using Flux to deploy topologies to a remote cluster, you will still need to have Python +installed since it is required by Apache Storm. + + +#### Building with integration tests enabled: + +``` +mvn clean install -DskipIntegration=false +``` + + ### Packaging with Maven To enable Flux for your Storm components, you need to add it as a dependency such that it's included in the Storm topology jar. This can be accomplished with the Maven shade plugin (preferred) or the Maven assembly plugin (not http://git-wip-us.apache.org/repos/asf/storm/blob/601cee72/flux-core/src/main/java/org/apache/storm/flux/model/TopologyDef.java ---------------------------------------------------------------------- diff --git a/flux-core/src/main/java/org/apache/storm/flux/model/TopologyDef.java b/flux-core/src/main/java/org/apache/storm/flux/model/TopologyDef.java index 6c34018..a6ae450 100644 --- a/flux-core/src/main/java/org/apache/storm/flux/model/TopologyDef.java +++ b/flux-core/src/main/java/org/apache/storm/flux/model/TopologyDef.java @@ -45,7 +45,6 @@ public class TopologyDef { private TopologySourceDef topologySource; // the following are required if we're defining a core storm topology DAG in YAML, etc. - //TODO if any of these are specified and `topologySource != null` it should be considered an error. private Map<String, BoltDef> boltMap = new LinkedHashMap<String, BoltDef>(); private Map<String, SpoutDef> spoutMap = new LinkedHashMap<String, SpoutDef>(); private List<StreamDef> streams = new ArrayList<StreamDef>();
