root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity
587 Commits 84 Branches 277 Tags 600 MiB
Java 86.8%
Scala 10.9%
Python 1.9%
Shell 0.2%
Go to file
Joe Stein 15bb3961d9 KAFKA-1133 LICENSE and NOTICE files need to get into META-INF when jars are built before they're signed for publishing to maven reviewed by Joel Koshy 2013-11-24 21:35:10 -05:00
bin KAFKA-1081 Remove re-run functionality from start script and use exec to launch commands to avoid spurious .sh process. 2013-10-11 15:20:46 -07:00
config kafka-1076; system tests in 0.8 are broken due to wrong log4j config; patched by Joel Koshy; reviewed by Jay Kreps and Jun Rao 2013-10-06 09:11:07 -07:00
contrib kafka-946; Kafka Hadoop Consumer fails when verifying message checksum; patched by Sam Meder; reviewed by Jun Rao 2013-09-24 08:31:18 -07:00
core KAFKA-1086 Improve GetOffsetShell to find metadata automatically; reviwed by Jun Rao and Joel Koshy 2013-10-16 16:31:05 -07:00
examples kafka-871; Rename ZkConfig properties; patched by Swapnil Ghike; reviewed by Jun Rao 2013-04-25 18:57:31 -07:00
lib Updated SBT JAR to 0.12.1 2013-01-07 10:42:01 -07:00
perf KAFKA-1046 Added support for Scala 2.10 builds while maintaining compatibility with 2.8.x; reviewed by Neha and Jun 2013-09-09 15:21:05 -07:00
project KAFKA-1133 LICENSE and NOTICE files need to get into META-INF when jars are built before they're signed for publishing to maven reviewed by Joel Koshy 2013-11-24 21:35:10 -05:00
system_test KAFKA-1089; Fix run-class and log4j for migration tool system test; 2013-10-16 09:31:07 -07:00
.gitignore Re-applied old patch from KAFKA-139 2012-12-14 17:12:38 -07:00
.rat-excludes KAFKA-151 Standard .rat-excludes file and rat script;patched by nehanarkhede; reviewed by junrao 2011-10-14 01:30:12 +00:00
.reviewboardrc KAFKA-1053 Kafka patch review tool that integrates JIRA and reviewboard; reviewed by Joel Koshy, Swapnil Ghike and Guozhang Wang 2013-09-17 20:44:33 -07:00
LICENSE KAFKA-533 changes to NOTICE and LICENSE related to KAFKA-534 removing client libraries from repo 2012-09-27 00:25:23 +00:00
NOTICE KAFKA-533 changes to NOTICE and LICENSE related to KAFKA-534 removing client libraries from repo 2012-09-27 00:25:23 +00:00
README.md kafka-954; tidy up README file for better general availability; patched by Jun Rao; reviewed by Joe Stein and Neha Narkhede 2013-10-08 13:04:12 -07:00
kafka-patch-review.py KAFKA-1094 Configure reviewboard url in kafka-patch-review tool; reviewed by Neha Narkhede 2013-10-19 16:37:30 -07:00
sbt kafka-843; Re-add the release-zip sbt target; patched by Cosmin Lehene; reviewed by Jun Rao 2013-04-11 11:01:11 -07:00
sbt.bat provides windows batch script for starting Kafka/Zookeeper; patched by Antoine Vianey; reviewed by Jun Rao; kafka-581 2012-10-24 16:57:56 +00:00

README.md

Apache Kafka

See our web site for details on the project.

Building it

  1. ./sbt update
  2. ./sbt package
  3. ./sbt assembly-package-dependency

To build for a particular version of Scala (either 2.8.0, 2.8.2, 2.9.1, 2.9.2 or 2.10.1), change step 2 above to: 2. ./sbt "++2.8.0 package"

To build for all supported versions of Scala, change step 2 above to: 2. ./sbt +package

Running it

Follow instuctions in http://kafka.apache.org/documentation.html#quickstart

Running unit tests

./sbt test

Building a binary release zip or gzipped tar ball

./sbt release-zip ./sbt release-tar The release file can be found inside ./target/RELEASE/.

Other Build Tips

Here are some useful sbt commands, to be executed at the sbt command prompt (./sbt). Prefixing with "++ " runs the command for a specific Scala version, prefixing with "+" will perform the action for all versions of Scala, and no prefix runs the command for the default (2.8.0) version of Scala. -

tasks : Lists all the sbt commands and their descriptions clean : Deletes all generated files (the target directory). compile : Compile all the sub projects, but not create the jars test : Run all unit tests in all sub projects release-zip : Create all the jars, run unit tests and create a deployable release zip release-tar : Create all the jars, run unit tests and create a deployable release gzipped tar tall package: Creates jars for src, test, docs etc projects : List all the sub projects project sub_project_name : Switch to a particular sub-project. For example, to switch to the core kafka code, use "project core-kafka"

The following commands can be run only on a particular sub project - test-only package.test.TestName : Runs only the specified test in the current sub project run : Provides options to run any of the classes that have a main method. For example, you can switch to project java-examples, and run the examples there by executing "project java-examples" followed by "run"

For more details please see the SBT documentation

Contribution

Kafka is a new project, and we are interested in building the community; we would welcome any thoughts or patches. You can reach us on the Apache mailing lists.

To contribute follow the instructions here:

We also welcome patches for the website and documentation which can be found here: