Repository: incubator-samza Updated Branches: refs/heads/0.7.0 5e34ec9bf -> 1a6992d32
SAMZA-303. Edit README to bring it up-to-date. Project: http://git-wip-us.apache.org/repos/asf/incubator-samza/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-samza/commit/1a6992d3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-samza/tree/1a6992d3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-samza/diff/1a6992d3 Branch: refs/heads/0.7.0 Commit: 1a6992d32faad1fca2fc50bc809c1169311608fc Parents: 5e34ec9 Author: Martin Kleppmann <[email protected]> Authored: Wed Jun 25 17:35:56 2014 +0100 Committer: Martin Kleppmann <[email protected]> Committed: Wed Jun 25 17:58:13 2014 +0100 ---------------------------------------------------------------------- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1a6992d3/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 552a91a..48a7479 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ ## What is Samza? -Apache Incubator Samza is a distributed stream processing framework. It uses <a target="_blank" href="http://kafka.apache.org";>Apache Kafka</a> for messaging, and <a target="_blank" href="http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-site/YARN.html";>Apache Hadoop YARN</a> to provide fault tolerance, processor isolation, security, and resource management. +[Apache Incubator Samza](http://samza.incubator.apache.org/) is a distributed stream processing framework. It uses [Apache Kafka](http://kafka.apache.org) for messaging, and [Apache Hadoop YARN](http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-site/YARN.html) to provide fault tolerance, processor isolation, security, and resource management. -* **Simpe API:** Unlike most low-level messaging system APIs, Samza provides a very simple call-back based "process message" API that should be familiar to anyone that's used Map/Reduce. -* **Managed state:** Samza manages snapshotting and restoration of a stream processor's state. Samza will restore a stream processor's state to a snapshot consistent with the processor's last read messages when the processor is restarted. -* **Fault tolerance:** Samza will work with YARN to restart your stream processor if there is a machine or processor failure. -* **Durability:** Samza uses Kafka to guarantee that messages will be processed in the order they were written to a partition, and that no messages will ever be lost. -* **Scalability:** Samza is partitioned and distributed at every level. Kafka provides ordered, partitioned, re-playable, fault-tolerant streams. YARN provides a distributed environment for Samza containers to run in. +Samza's key features include: + +* **Simple API:** Unlike most low-level messaging system APIs, Samza provides a very simple callback-based "process message" API comparable to MapReduce. +* **Managed state:** Samza manages snapshotting and restoration of a stream processor's state. When the processor is restarted, Samza restores its state to a consistent snapshot. Samza is built to handle large amounts of state (many gigabytes per partition). +* **Fault tolerance:** Whenever a machine in the cluster fails, Samza works with YARN to transparently migrate your tasks to another machine. +* **Durability:** Samza uses Kafka to guarantee that messages are processed in the order they were written to a partition, and that no messages are ever lost. +* **Scalability:** Samza is partitioned and distributed at every level. Kafka provides ordered, partitioned, replayable, fault-tolerant streams. YARN provides a distributed environment for Samza containers to run in. * **Pluggable:** Though Samza works out of the box with Kafka and YARN, Samza provides a pluggable API that lets you run Samza with other messaging systems and execution environments. -* **Processor isolation:** Samza works with Apache YARN, which supports processor security through Hadoop's security model, and resource isolation through Linux CGroups. +* **Processor isolation:** Samza works with Apache YARN, which supports Hadoop's security model, and resource isolation through Linux CGroups. -Check out [Hello Samza](/startup/hello-samza/0.7.0) to try Samza. Read the [Background](/learn/documentation/0.7.0/introduction/background.html) page to learn more about Samza. +Check out [Hello Samza](https://samza.incubator.apache.org/startup/hello-samza/0.7.0/) to try Samza. Read the [Background](https://samza.incubator.apache.org/learn/documentation/0.7.0/introduction/background.html) page to learn more about Samza. ### Building Samza -To build Samza from a git checkout or binary release, run: +To build Samza from a git checkout, run: ./gradlew clean build @@ -59,13 +61,9 @@ To modify a job's checkpoint (assumes that the job is not currently running), gi ./gradlew samza-shell:checkpointTool -PconfigPath=file:///path/to/job/config.properties \ -PnewOffsets=file:///path/to/new/offsets.properties -#### Maven - -Samza uses Kafka, which is not managed by Maven. To use Kafka as though it were a Maven artifact, Samza installs Kafka into a local repository using the `mvn install` command. You must have Maven installed to build Samza. - ### Developers -To get eclipse projects, run: +To get Eclipse projects, run: ./gradlew eclipse
