kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jkr...@apache.org
Subject svn commit: r1498605 - in /kafka/site: 08/quickstart.html 08/tools.html committers.html contact.html design.html downloads.html faq.html includes/header.html introduction.html styles.css uses.html
Date Mon, 01 Jul 2013 17:44:54 GMT
Author: jkreps
Date: Mon Jul  1 17:44:53 2013
New Revision: 1498605

URL: http://svn.apache.org/r1498605
Log:
Add the use-case document and fix misc. problems. 

Added:
    kafka/site/uses.html
Removed:
    kafka/site/faq.html
Modified:
    kafka/site/08/quickstart.html
    kafka/site/08/tools.html
    kafka/site/committers.html
    kafka/site/contact.html
    kafka/site/design.html
    kafka/site/downloads.html
    kafka/site/includes/header.html
    kafka/site/introduction.html
    kafka/site/styles.css

Modified: kafka/site/08/quickstart.html
URL: http://svn.apache.org/viewvc/kafka/site/08/quickstart.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/08/quickstart.html (original)
+++ kafka/site/08/quickstart.html Mon Jul  1 17:44:53 2013
@@ -1,6 +1,6 @@
 <!--#include virtual="../includes/header.html" -->
 
-<h2>Quick Start</h3>
+<h1>Quick Start</h1>
 	
 <h3> Step 1: Download the code </h3>
 
@@ -44,20 +44,18 @@ Let's create a topic named "test" with a
 
 We can now see that topic if we run the list topic command:
 <pre>
-&gt; <b>bin/kafka-create-topic.sh --zookeeper localhost:2181 --replica 1 --partition
1 --topic test</b>
+&gt; <b>bin/kafka-list-topic.sh --zookeeper localhost:2181</b>
 </pre>
-You can configure your brokers to auto-create topics when a non-existent topic is published
to as well.
+Alternatively, you can also configure your brokers to auto-create topics when a non-existent
topic is published to.
 
 <h3>Step 4: Send some messages</h3>
 
-Kafka comes with a command line client that will take input from a file or standard in and
send it out as messages to the Kafka cluster. By default each line will be sent as a separate
message. The topic <i>test</i> is created automatically when messages are sent
to it. Omitting logging you should see something like this:
+Kafka comes with a command line client that will take input from a file or standard in and
send it out as messages to the Kafka cluster. By default each line will be sent as a separate
message.
+<p>
+Run the producer and then type a few messages to send to the server.
 
 <pre>
 &gt; <b>bin/kafka-console-producer.sh --broker-list localhost:9092 --topic test</b>

-</pre>
-Now you can type some messages to send them to the broker:
-<pre>
-&gt; <b>bin/kafka-console-producer.sh --broker-list localhost:9092 --topic test</b>

 This is a message
 This is another message
 </pre>

Modified: kafka/site/08/tools.html
URL: http://svn.apache.org/viewvc/kafka/site/08/tools.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/08/tools.html (original)
+++ kafka/site/08/tools.html Mon Jul  1 17:44:53 2013
@@ -1,13 +1,13 @@
 <!--#include virtual="../includes/header.html" -->
-<h3>Mirroring data between clusters</h3>
+<h2>Mirroring data between clusters</h2>
 We have a tool that runs a continuous copy between two clusters. The clusters are completely
independent and the topology need not match (you can have a different number of brokers and
a different number of partitions). Offsets and partitioning are currently not preserved by
this tool as it is meant for geographical replication rather than backup.
 
 Documentation <a href="https://cwiki.apache.org/confluence/display/KAFKA/Kafka+mirroring+%28MirrorMaker%29">here</a>.
 
-<h3> Administrative tools</h3>
+<h2> Administrative tools</h2>
 A set of tools for managing an 0.8 cluster is described in <a href="https://cwiki.apache.org/confluence/display/KAFKA/Replication+tools">here</a>.
 
-<h3>Migrating data from a 0.7 cluster to a 0.8 cluster</h3>
+<h2>Migrating data from a 0.7 cluster to a 0.8 cluster</h2>
 Since 0.8 is not backward compatible with 0.7.x, we provide a tool for migrating data in
an 0.7 cluster to an 0.8 cluster. Details of the tool can be found <a href="https://cwiki.apache.org/confluence/display/KAFKA/Migrating+from+0.7+to+0.8">here</a>.
 
 <!--#include virtual="../includes/footer.html" -->

Modified: kafka/site/committers.html
URL: http://svn.apache.org/viewvc/kafka/site/committers.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/committers.html (original)
+++ kafka/site/committers.html Mon Jul  1 17:44:53 2013
@@ -1,6 +1,6 @@
 <!--#include virtual="includes/header.html" -->
 
-<h2>The Committers</h3>
+<h1>The Committers</h1>
 
 <table>
   <tr>

Modified: kafka/site/contact.html
URL: http://svn.apache.org/viewvc/kafka/site/contact.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/contact.html (original)
+++ kafka/site/contact.html Mon Jul  1 17:44:53 2013
@@ -1,6 +1,6 @@
 <!--#include virtual="includes/header.html" -->
 
-<h2>Mailing Lists</h3>
+<h2>Mailing Lists</h2>
 	
 <p>
 We have a few mailing lists hosted by Apache:

Modified: kafka/site/design.html
URL: http://svn.apache.org/viewvc/kafka/site/design.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/design.html (original)
+++ kafka/site/design.html Mon Jul  1 17:44:53 2013
@@ -1,6 +1,6 @@
 <!--#include virtual="includes/header.html" -->
 
-<h2>Why we built this</h2>
+<h1>Why we built this</h1>
 <p>
 Kafka is a distributed, partitioned, replicated, multi-subscriber commit log.
 <p>

Modified: kafka/site/downloads.html
URL: http://svn.apache.org/viewvc/kafka/site/downloads.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/downloads.html (original)
+++ kafka/site/downloads.html Mon Jul  1 17:44:53 2013
@@ -1,6 +1,6 @@
 <!--#include virtual="includes/header.html" -->
 
-<h2>Releases</h2>
+<h1>Releases</h1>
 
 The current stable version is 0.7.2. However we have released a beta version of 0.8 which
is being actively used at large-scale, and though it still has some rough edges, we feel it
is production-ready and is a better starting point for new users.
 <p>

Modified: kafka/site/includes/header.html
URL: http://svn.apache.org/viewvc/kafka/site/includes/header.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/includes/header.html (original)
+++ kafka/site/includes/header.html Mon Jul  1 17:44:53 2013
@@ -38,6 +38,7 @@
 				<ul>
 					<li><a href="/downloads.html">download</a></li>
 					<li><a href="/introduction.html">introduction</a></li>
+					<li><a href="/uses.html">uses</a></li>
 					<li><a href="/design.html">design</a></li>
 					<li><a href="/implementation.html">implementation</a></li>
 					<li><a href="https://cwiki.apache.org/confluence/display/KAFKA/Clients">clients</a></li>

Modified: kafka/site/introduction.html
URL: http://svn.apache.org/viewvc/kafka/site/introduction.html?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/introduction.html (original)
+++ kafka/site/introduction.html Mon Jul  1 17:44:53 2013
@@ -1,6 +1,6 @@
 <!--#include virtual="includes/header.html" -->
 
-<h2>Introduction to Kafka</h2>
+<h1>Introduction to Kafka</h1>
 
 Kafka is a distributed, partitioned, replicated commit log as a service. It provides the
functionality of a messaging system, but with a unique design.
 <p>

Modified: kafka/site/styles.css
URL: http://svn.apache.org/viewvc/kafka/site/styles.css?rev=1498605&r1=1498604&r2=1498605&view=diff
==============================================================================
--- kafka/site/styles.css (original)
+++ kafka/site/styles.css Mon Jul  1 17:44:53 2013
@@ -13,6 +13,18 @@ code, pre {
 h1, h2, h3, h4 {
   color: #2e4a8e;
 }
+h1 {
+	font-size: 20pt;
+}
+h2 {
+	font-size: 18pt;
+}
+h3 {
+	font-size: 16pt;
+}
+h4 {
+	font-size: 14pt;
+}
 a {
 	color: #2e4a8e;
 	text-decoration: none;
@@ -90,7 +102,7 @@ a {
   padding: 15px;
 }
 .buzzword {
-	font-style: italic;
 	font-size: 18pt;
 	line-height: 200%;
-}
\ No newline at end of file
+	color: #2e4a8e;
+}

Added: kafka/site/uses.html
URL: http://svn.apache.org/viewvc/kafka/site/uses.html?rev=1498605&view=auto
==============================================================================
--- kafka/site/uses.html (added)
+++ kafka/site/uses.html Mon Jul  1 17:44:53 2013
@@ -0,0 +1,31 @@
+<!--#include virtual="includes/header.html" -->
+
+<h1>Use Cases</h1>
+
+Here is a description of a few of the popular use cases for Apache Kafka.
+
+<h2>Messaging</h2>
+
+Kafka works well as a replacement for a more traditional message broker. Message brokers
are used for a variety of reasons (to decouple processing from data producers, to buffer unprocessed
messages, etc). In comparison to most messaging systems Kafka has better throughput, built-in
partitioning, replication, and fault-tolerance which makes it a good solution for large scale
message processing applications.
+<p>
+Messaging uses are often comparatively low-throughput but may require low end-to-end latency
and often depend on the strong durability guarantees Kafka provides.
+
+<h2>Website Activity Tracking</h2>
+
+The original use case for Kafka was to be able to rebuild a user activity tracking pipeline
as a set of real-time publish-subscribe feeds. This means site activity (page views, searches,
or other actions users may take) is published to central feeds where it is available for real-time
processing, real-time monitoring, or loading into Hadoop or offline data warehousing systems
for offline processing and reporting.
+<p>
+Activity tracking is often very high volume as many activity messages are generated for each
user page view.
+
+<h2>Metrics</h2>
+
+Kafka is often used for operation monitoring data pipelines. This involves aggregating statistics
from distributed applications to produce centralized feeds of operational data.
+
+<h2>Log Aggregation</h2>
+
+Many people use Kafka as a replacement for a log aggregation solution. Log aggregation typically
collects physical log files off servers and puts them in a central place (a file server or
HDFS perhaps) for processing. Kafka abstracts away the details of files and gives a cleaner
abstraction of log or event data as a stream of messages. This allows for lower-latency processing
and easier support for multiple data sources and distributed data consumption.
+
+<h2>Stream Processing</h2>
+
+Many users end up doing stage-wise processing of data where data is consumed from topics
of raw data and then aggregated, enriched, or otherwise transformed into new Kafka topics
for further consumption. For example a processing flow for article recommendation might crawl
article content from RSS feeds and publish it to an "articles" topic; further processing might
help normalize or deduplicate this content to a topic of cleaned article content; a final
stage might attempt to match this content to users. This creates a graph of real-time data
flow out of the individual topics. The <a href="https://github.com/nathanmarz/storm">Storm</a>
framework is one popular way for implementing some of these transformations.
+
+<!--#include virtual="includes/footer.html" -->
\ No newline at end of file



Mime
View raw message