Heron is designed to be fully backward compatible with existing Apache Storm projects, allowing simple Maven POM.xml changes to migrate existing Storm topologies.
Navigate to Twitter Heron Releases and download the following self extracting binary API install script for your platform.
For example, if you want to download for Mac OSX (darwin), the corresponding binaries will be
where <version> is the desired heron version.
Run the download self installing binary for heron API as follows (example for version 0.13.2). Note “--user --maven” syntax.
$ chmod +x heron-api-install-0.13.2-darwin.sh $ ./heron-api-install-0.13.2-darwin.sh --user --maven Heron API installer --------------------- # Binary package at HEAD (@) - [Commit](https://github.com/twitter/heron/commit/) Installing jars to local maven repo. Heron API is now installed! See http://heron.github.io/docs/getting-started.html to start a new project!
Heron API is now installed in local Maven .m2 repository:
~/.m2/repository/com/twitter/heron/heron-api ~/.m2/repository/com/twitter/heron/heron-storm
Copy POM.xml dependency segments below and paste into your exsiting Storm POM.xml file in Dependencies block.
<dependency>
<groupId>com.twitter.heron</groupId>
<artifactId>heron-api</artifactId>
<version>SNAPSHOT</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.twitter.heron</groupId>
<artifactId>heron-storm</artifactId>
<version>SNAPSHOT</version>
<scope>compile</scope>
</dependency>
Delete Storm dependency in POM.xml file.
<dependency>
<groupId>org.apache.storm</groupId>
<artifactId>storm-core</artifactId>
<version>storm-VERSION</version>
<scope>provided</scope>
</dependency>
Delete Clojure Plugin from POM.xml file
<plugin>
<groupId>com.theoryinpractise</groupId>
<artifactId>clojure-maven-plugin</artifactId>
<version>1.3.12</version>
<extensions>true</extensions>
<configuration>
<sourceDirectories>
<sourceDirectory>src/clj</sourceDirectory>
</sourceDirectories>
</configuration>
</plugin>
Run Maven Lifecycle commands
$ mvn clean $ mvn compile $ mvn package
Note: Storm Distribute RPC is deprecated in Heron.
Launch the compiled Maven project on local cluster using submit.
Modify your project base directory “{basedir}” and “{PATH-TO-PROJECT}.jar”, by Maven convention located in: ${basedir}/target
Modify TOPOLOGY-FILE-NAME and TOPOLOGY-CLASS-NAME to your project.
$ heron submit local ${basedir}/target/PATH-TO-PROJECT.jar TOPOLOGY-FILE-NAME TOPOLOGY-CLASS-NAME
Example submit command using example topology from Getting Started guide:
usage: heron submit local topology-file-name topology-class-name [topology-args] $ heron submit local ~/.heron/examples/heron-examples.jar com.twitter.heron.examples.ExclamationTopology ExclamationTopology
Deploying Existing topologies in clustered, scheduler-driven environments (Aurora, Mesos, Local)
Developing Topologies with the Architecture of Heron