Apache Spark - A unified analytics engine for large-scale data processing
Go to file
Tathagata Das b004150adb [SPARK-4806] Streaming doc update for 1.2
Important updates to the streaming programming guide
- Make the fault-tolerance properties easier to understand, with information about write ahead logs
- Update the information about deploying the spark streaming app with information about Driver HA
- Update Receiver guide to discuss reliable vs unreliable receivers.

Author: Tathagata Das <tathagata.das1565@gmail.com>
Author: Josh Rosen <joshrosen@databricks.com>
Author: Josh Rosen <rosenville@gmail.com>

Closes #3653 from tdas/streaming-doc-update-1.2 and squashes the following commits:

f53154a [Tathagata Das] Addressed Josh's comments.
ce299e4 [Tathagata Das] Minor update.
ca19078 [Tathagata Das] Minor change
f746951 [Tathagata Das] Mentioned performance problem with WAL
7787209 [Tathagata Das] Merge branch 'streaming-doc-update-1.2' of github.com:tdas/spark into streaming-doc-update-1.2
2184729 [Tathagata Das] Updated Kafka and Flume guides with reliability information.
2f3178c [Tathagata Das] Added more information about writing reliable receivers in the custom receiver guide.
91aa5aa [Tathagata Das] Improved API Docs menu
5707581 [Tathagata Das] Added Pythn API badge
b9c8c24 [Tathagata Das] Merge pull request #26 from JoshRosen/streaming-programming-guide
b8c8382 [Josh Rosen] minor fixes
a4ef126 [Josh Rosen] Restructure parts of the fault-tolerance section to read a bit nicer when skipping over the headings
65f66cd [Josh Rosen] Fix broken link to fault-tolerance semantics section.
f015397 [Josh Rosen] Minor grammar / pluralization fixes.
3019f3a [Josh Rosen] Fix minor Markdown formatting issues
aa8bb87 [Tathagata Das] Small update.
195852c [Tathagata Das] Updated based on Josh's comments, updated receiver reliability and deploying section, and also updated configuration.
17b99fb [Tathagata Das] Merge remote-tracking branch 'apache-github/master' into streaming-doc-update-1.2
a0217c0 [Tathagata Das] Changed Deploying menu layout
67fcffc [Tathagata Das] Added cluster mode + supervise example to submitting application guide.
e45453b [Tathagata Das] Update streaming guide, added deploying section.
192c7a7 [Tathagata Das] Added more info about Python API, and rewrote the checkpointing section.
2014-12-11 06:21:23 -08:00
assembly SPARK-4338. [YARN] Ditch yarn-alpha. 2014-12-09 11:02:43 -08:00
bagel Bumping version to 1.3.0-SNAPSHOT. 2014-11-18 21:24:18 -08:00
bin [SPARK-4793] [Deploy] ensure .jar at end of line 2014-12-10 13:30:45 -08:00
conf SPARK-3663 Document SPARK_LOG_DIR and SPARK_PID_DIR 2014-11-14 13:33:35 -08:00
core [CORE]codeStyle: uniform ConcurrentHashMap define in StorageLevel.scala with other places 2014-12-10 20:44:59 -08:00
data/mllib SPARK-2363. Clean MLlib's sample data files 2014-07-13 19:27:43 -07:00
dev SPARK-4338. [YARN] Ditch yarn-alpha. 2014-12-09 11:02:43 -08:00
docker [SPARK-1342] Scala 2.10.4 2014-04-01 18:35:50 -07:00
docs [SPARK-4806] Streaming doc update for 1.2 2014-12-11 06:21:23 -08:00
ec2 [SPARK-4745] Fix get_existing_cluster() function with multiple security groups 2014-12-04 14:14:39 -08:00
examples [SPARK-4774] [SQL] Makes HiveFromSpark more portable 2014-12-08 15:44:18 -08:00
external [SPARK-3154][STREAMING] Replace ConcurrentHashMap with mutable.HashMap and remove @volatile from 'stopped' 2014-12-08 23:54:15 -08:00
extras Bumping version to 1.3.0-SNAPSHOT. 2014-11-18 21:24:18 -08:00
graphx [SPARK-4620] Add unpersist in Graph and GraphImpl 2014-12-07 19:42:02 -08:00
mllib [FIX][DOC] Fix broken links in ml-guide.md 2014-12-04 20:16:35 +08:00
network Config updates for the new shuffle transport. 2014-12-09 19:29:09 -08:00
project SPARK-4338. [YARN] Ditch yarn-alpha. 2014-12-09 11:02:43 -08:00
python [SPARK-4580] [SPARK-4610] [mllib] [docs] Documentation for tree ensembles + DecisionTree API fix 2014-12-04 09:57:50 +08:00
repl [SPARK-4472][Shell] Print "Spark context available as sc." only when SparkContext is created... 2014-11-21 00:42:43 -08:00
sbin [SPARK-874] adding a --wait flag 2014-12-09 12:16:19 -08:00
sbt [SPARK-4701] Typo in sbt/sbt 2014-12-03 12:08:00 -08:00
sql [SPARK-4791] [sql] Infer schema from case class with multiple constructors 2014-12-10 23:41:15 -08:00
streaming [SPARK-4196][SPARK-4602][Streaming] Fix serialization issue in PairDStreamFunctions.saveAsNewAPIHadoopFiles 2014-11-25 14:16:27 -08:00
tools Bumping version to 1.3.0-SNAPSHOT. 2014-11-18 21:24:18 -08:00
yarn SPARK-4338. [YARN] Ditch yarn-alpha. 2014-12-09 11:02:43 -08:00
.gitattributes [SPARK-3870] EOL character enforcement 2014-10-31 12:39:52 -07:00
.gitignore [Release] Correctly translate contributors name in release notes 2014-12-03 19:10:07 -08:00
.rat-excludes Support cross building for Scala 2.11 2014-11-11 21:36:48 -08:00
CONTRIBUTING.md [Docs] minor grammar fix 2014-09-17 12:33:09 -07:00
LICENSE SPARK-3926 [CORE] Reopened: result of JavaRDD collectAsMap() is not serializable 2014-12-08 16:13:03 -08:00
make-distribution.sh SPARK-2192 [BUILD] Examples Data Not in Binary Distribution 2014-12-01 16:31:04 +08:00
NOTICE SPARK-1827. LICENSE and NOTICE files need a refresh to contain transitive dependency info 2014-05-14 09:38:33 -07:00
pom.xml SPARK-4338. [YARN] Ditch yarn-alpha. 2014-12-09 11:02:43 -08:00
README.md SPARK-971 [DOCS] Link to Confluence wiki from project website / documentation 2014-11-09 17:40:48 -08:00
scalastyle-config.xml [Core] Upgrading ScalaStyle version to 0.5 and removing SparkSpaceAfterCommentStartChecker. 2014-10-16 02:05:44 -04:00
tox.ini [SPARK-3073] [PySpark] use external sort in sortBy() and sortByKey() 2014-08-26 16:57:40 -07:00

Apache Spark

Spark is a fast and general cluster computing system for Big Data. It provides high-level APIs in Scala, Java, and Python, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and structured data processing, MLlib for machine learning, GraphX for graph processing, and Spark Streaming for stream processing.

http://spark.apache.org/

Online Documentation

You can find the latest Spark documentation, including a programming guide, on the project web page and project wiki. This README file only contains basic setup instructions.

Building Spark

Spark is built using Apache Maven. To build Spark and its example programs, run:

mvn -DskipTests clean package

(You do not need to do this if you downloaded a pre-built package.) More detailed documentation is available from the project site, at "Building Spark with Maven".

Interactive Scala Shell

The easiest way to start using Spark is through the Scala shell:

./bin/spark-shell

Try the following command, which should return 1000:

scala> sc.parallelize(1 to 1000).count()

Interactive Python Shell

Alternatively, if you prefer Python, you can use the Python shell:

./bin/pyspark

And run the following command, which should also return 1000:

>>> sc.parallelize(range(1000)).count()

Example Programs

Spark also comes with several sample programs in the examples directory. To run one of them, use ./bin/run-example <class> [params]. For example:

./bin/run-example SparkPi

will run the Pi example locally.

You can set the MASTER environment variable when running examples to submit examples to a cluster. This can be a mesos:// or spark:// URL, "yarn-cluster" or "yarn-client" to run on YARN, and "local" to run locally with one thread, or "local[N]" to run locally with N threads. You can also use an abbreviated class name if the class is in the examples package. For instance:

MASTER=spark://host:7077 ./bin/run-example SparkPi

Many of the example programs print usage help if no params are given.

Running Tests

Testing first requires building Spark. Once Spark is built, tests can be run using:

./dev/run-tests

Please see the guidance on how to run all automated tests.

A Note About Hadoop Versions

Spark uses the Hadoop core library to talk to HDFS and other Hadoop-supported storage systems. Because the protocols have changed in different versions of Hadoop, you must build Spark against the same version that your cluster runs.

Please refer to the build documentation at "Specifying the Hadoop Version" for detailed guidance on building for a particular distribution of Hadoop, including building for particular Hive and Hive Thriftserver distributions. See also "Third Party Hadoop Distributions" for guidance on building a Spark application that works with a particular distribution.

Configuration

Please refer to the Configuration guide in the online documentation for an overview on how to configure Spark.