[GEARPUMP-238] Correct release naming and packaging

Author: Kam Kasravi <kamkasravi@yahoo.com>

Closes #111 from kkasravi/GEARPUMP-238.
2 files changed
tree: 0cb5b831bcc77eb578359e95e8f735147a0051d1
  1. bin/
  2. conf/
  3. core/
  4. dev-tools/
  5. docs/
  6. examples/
  7. experiments/
  8. external/
  9. gearpump-hadoop/
  10. integrationtest/
  11. licenses/
  12. notes/
  13. project/
  14. services/
  15. shaded/
  16. streaming/
  17. unmanagedlibs/
  18. yarnconf/
  19. .coveragerc
  20. .gitignore
  21. .rat-excludes
  22. .sbtopts
  23. .travis.yml
  24. CHANGELOG.md
  25. codecov.yml
  28. jvm.sbt
  29. KEYS
  31. LICENSE.bin
  32. NOTICE
  33. pubring.asc
  34. README.md
  35. ReleaseProcess.md
  36. scalastyle-config.xml
  37. secring.asc.enc
  38. version.sbt

Apache Gearpump (incubating) GitHub release GitHub license Build Status codecov.io


Gearpump is a lightweight real-time big data streaming engine. It is inspired by recent advances in the Akka framework and a desire to improve on existing streaming frameworks.

The name Gearpump is a reference to the engineering term “gear pump”, which is a super simple pump that consists of only two gears, but is very powerful at streaming water.

We model streaming within the Akka actor hierarchy.

Per initial benchmarks we are able to process near 18 million messages/second (100 bytes per message) with a 8ms latency on a 4-node cluster.

For steps to reproduce the performance test, please check Performance benchmark.

Useful Resources

How to Build

1). Clone the Gearpump repository

  git clone https://github.com/apache/incubator-gearpump.git
  cd gearpump

2). Build package

  ## Please use scala 2.11 or 2.10
  ## The target package path: output/target/gearpump-${version}.zip
  sbt clean +assembly +packArchiveZip

After the build, there will be a package file gearpump-${version}.zip generated under output/target/ folder.

To build scala document, use

   ## Will generate the scala doc under target/scala_2.xx/unidoc/
   sbt unidoc

NOTE: The build requires network connection. If you are behind an enterprise proxy, make sure you have set the proxy in your env before running the build commands. For windows:

set HTTP_PROXY=http://host:port
set HTTPS_PROXY= http://host:port

For Linux:

export HTTP_PROXY=http://host:port
export HTTPS_PROXY= http://host:port

How to run Gearpump integration test

Gearpump has an integration test system which is based on Docker. Please check the instructions.

How to do style check before submitting a pull request?

Before submitting a PR, you should always run style check first:

  ## Run style check for compile, test, and integration test.
  sbt scalastyle test:scalastyle it:scalastyle

How to generate the license report to generate a list of all dependencies

  sbt dumpLicenseReport

How to generate dependencies by declared license

  sbt dependencyLicenseInfo

Contributors (time order)



Gearpump itself is licensed under the Apache License (2.0). For library it used, please see LICENSE.


The netty transport code work is based on Apache Storm. Thanks Apache Storm contributors.

The cgroup code work is based on JStorm. Thanks JStorm contributors.

Thanks to Jetbrains for providing a IntelliJ IDEA Free Open Source License.