blob: 34e292edc131e078fba09539dcc7c04300fc9da9 [file] [log] [blame]
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Spark Overview - Spark 0.7.2 Documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="css/bootstrap.min.css">
<style>
body {
padding-top: 60px;
padding-bottom: 40px;
}
</style>
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="css/bootstrap-responsive.min.css">
<link rel="stylesheet" href="css/main.css">
<script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script>
<link rel="stylesheet" href="css/pygments-default.css">
<!-- Google analytics script -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-32518208-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an outdated browser. <a href="http://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p>
<![endif]-->
<!-- This code is taken from http://twitter.github.com/bootstrap/examples/hero.html -->
<div class="navbar navbar-fixed-top" id="topbar">
<div class="navbar-inner">
<div class="container">
<div class="brand"><a href="index.html">
<img src="img/spark-logo-77x50px-hd.png" /></a><span class="version">0.7.2</span>
</div>
<ul class="nav">
<!--TODO(andyk): Add class="active" attribute to li some how.-->
<li><a href="index.html">Overview</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guides<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="quick-start.html">Quick Start</a></li>
<li><a href="scala-programming-guide.html">Scala</a></li>
<li><a href="java-programming-guide.html">Java</a></li>
<li><a href="python-programming-guide.html">Python</a></li>
<li><a href="streaming-programming-guide.html">Spark Streaming</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="api/core/index.html">Spark Java/Scala (Scaladoc)</a></li>
<li><a href="api/pyspark/index.html">Spark Python (Epydoc)</a></li>
<li><a href="api/streaming/index.html">Spark Streaming Java/Scala (Scaladoc) </a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="ec2-scripts.html">Amazon EC2</a></li>
<li><a href="spark-standalone.html">Standalone Mode</a></li>
<li><a href="running-on-mesos.html">Mesos</a></li>
<li><a href="running-on-yarn.html">YARN</a></li>
</ul>
</li>
<li class="dropdown">
<a href="api.html" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="building-with-maven.html">Building Spark with Maven</a></li>
<li><a href="configuration.html">Configuration</a></li>
<li><a href="tuning.html">Tuning Guide</a></li>
<li><a href="bagel-programming-guide.html">Bagel (Pregel on Spark)</a></li>
<li><a href="contributing-to-spark.html">Contributing to Spark</a></li>
</ul>
</li>
</ul>
<!--<p class="navbar-text pull-right"><span class="version-text">v0.7.2</span></p>-->
</div>
</div>
</div>
<div class="container" id="content">
<h1 class="title">Spark Overview</h1>
<p>Spark is a MapReduce-like cluster computing framework designed for low-latency iterative jobs and interactive use from an interpreter.
It provides clean, language-integrated APIs in <a href="scala-programming-guide.html">Scala</a>, <a href="java-programming-guide.html">Java</a>, and <a href="python-programming-guide.html">Python</a>, with a rich array of parallel operators.
Spark can run on the Apache Mesos cluster manager, Hadoop YARN, Amazon EC2, or without an independent resource manager (&ldquo;standalone mode&rdquo;).</p>
<h1 id="downloading">Downloading</h1>
<p>Get Spark by visiting the <a href="http://spark-project.org/downloads.html">downloads page</a> of the Spark website. This documentation is for Spark version 0.7.2.</p>
<h1 id="building">Building</h1>
<p>Spark requires <a href="http://www.scala-lang.org/">Scala 2.9.3</a>. You will need to have Scala&rsquo;s <code>bin</code> directory in your <code>PATH</code>,
or you will need to set the <code>SCALA_HOME</code> environment variable to point
to where you&rsquo;ve installed Scala. Scala must also be accessible through one
of these methods on slave nodes on your cluster.</p>
<p>Spark uses <a href="http://www.scala-sbt.org">Simple Build Tool</a>, which is bundled with it. To compile the code, go into the top-level Spark directory and run</p>
<pre><code>sbt/sbt package
</code></pre>
<p>Spark also supports building using Maven. If you would like to build using Maven, see the <a href="building-with-maven.html">instructions for building Spark with Maven</a>.</p>
<h1 id="testing-the-build">Testing the Build</h1>
<p>Spark comes with a number of sample programs in the <code>examples</code> directory.
To run one of the samples, use <code>./run &lt;class&gt; &lt;params&gt;</code> in the top-level Spark directory
(the <code>run</code> script sets up the appropriate paths and launches that program).
For example, <code>./run spark.examples.SparkPi</code> will run a sample program that estimates Pi. Each of the
examples prints usage help if no params are given.</p>
<p>Note that all of the sample programs take a <code>&lt;master&gt;</code> parameter specifying the cluster URL
to connect to. This can be a <a href="scala-programming-guide.html#master-urls">URL for a distributed cluster</a>,
or <code>local</code> to run locally with one thread, or <code>local[N]</code> to run locally with N threads. You should start by using
<code>local</code> for testing.</p>
<p>Finally, Spark can be used interactively from a modified version of the Scala interpreter that you can start through
<code>./spark-shell</code>. This is a great way to learn Spark.</p>
<h1 id="a-note-about-hadoop-versions">A Note About Hadoop Versions</h1>
<p>Spark uses the Hadoop core library to talk to HDFS and other Hadoop-supported
storage systems. Because the HDFS protocol has changed in different versions of
Hadoop, you must build Spark against the same version that your cluster runs.
You can change the version by setting the <code>HADOOP_VERSION</code> variable at the top
of <code>project/SparkBuild.scala</code>, then rebuilding Spark (<code>sbt/sbt clean compile</code>).</p>
<h1 id="where-to-go-from-here">Where to Go from Here</h1>
<p><strong>Programming guides:</strong></p>
<ul>
<li><a href="quick-start.html">Quick Start</a>: a quick introduction to the Spark API; start here!</li>
<li><a href="scala-programming-guide.html">Spark Programming Guide</a>: an overview of Spark concepts, and details on the Scala API</li>
<li><a href="java-programming-guide.html">Java Programming Guide</a>: using Spark from Java</li>
<li><a href="python-programming-guide.html">Python Programming Guide</a>: using Spark from Python</li>
<li><a href="streaming-programming-guide.html">Spark Streaming Guide</a>: using the alpha release of Spark Streaming</li>
</ul>
<p><strong>API Docs:</strong></p>
<ul>
<li><a href="api/core/index.html">Spark Java/Scala (Scaladoc)</a></li>
<li><a href="api/pyspark/index.html">Spark Python (Epydoc)</a></li>
<li><a href="api/streaming/index.html">Spark Streaming Java/Scala (Scaladoc)</a></li>
</ul>
<p><strong>Deployment guides:</strong></p>
<ul>
<li><a href="ec2-scripts.html">Running Spark on Amazon EC2</a>: scripts that let you launch a cluster on EC2 in about 5 minutes</li>
<li><a href="spark-standalone.html">Standalone Deploy Mode</a>: launch a standalone cluster quickly without a third-party cluster manager</li>
<li><a href="running-on-mesos.html">Running Spark on Mesos</a>: deploy a private cluster using
<a href="http://incubator.apache.org/mesos">Apache Mesos</a></li>
<li><a href="running-on-yarn.html">Running Spark on YARN</a>: deploy Spark on top of Hadoop NextGen (YARN)</li>
</ul>
<p><strong>Other documents:</strong></p>
<ul>
<li><a href="building-with-maven.html">Building Spark With Maven</a>: Build Spark using the Maven build tool</li>
<li><a href="configuration.html">Configuration</a>: customize Spark via its configuration system</li>
<li><a href="tuning.html">Tuning Guide</a>: best practices to optimize performance and memory use</li>
<li><a href="bagel-programming-guide.html">Bagel</a>: an implementation of Google&rsquo;s Pregel on Spark</li>
<li><a href="contributing-to-spark.html">Contributing to Spark</a></li>
</ul>
<p><strong>External resources:</strong></p>
<ul>
<li><a href="http://www.spark-project.org">Spark Homepage</a></li>
<li><a href="http://groups.google.com/group/spark-users">Mailing List</a>: ask questions about Spark here</li>
<li><a href="http://ampcamp.berkeley.edu/">AMP Camp</a>: a two-day training camp at UC Berkeley that featured talks and exercises
about Spark, Shark, Mesos, and more. <a href="http://ampcamp.berkeley.edu/agenda-2012">Videos</a>,
<a href="http://ampcamp.berkeley.edu/agenda-2012">slides</a> and <a href="http://ampcamp.berkeley.edu/exercises-2012">exercises</a> are
available online for free.</li>
<li><a href="http://spark-project.org/examples.html">Code Examples</a>: more are also available in the <a href="https://github.com/mesos/spark/tree/master/examples/src/main/scala/spark/examples">examples subfolder</a> of Spark</li>
<li><a href="http://www.cs.berkeley.edu/~matei/papers/2012/nsdi_spark.pdf">Paper Describing Spark</a></li>
<li><a href="http://www.eecs.berkeley.edu/Pubs/TechRpts/2012/EECS-2012-259.pdf">Paper Describing Spark Streaming</a></li>
</ul>
<h1 id="community">Community</h1>
<p>To get help using Spark or keep up with Spark development, sign up for the <a href="http://groups.google.com/group/spark-users">spark-users mailing list</a>.</p>
<p>If you&rsquo;re in the San Francisco Bay Area, there&rsquo;s a regular <a href="http://www.meetup.com/spark-users/">Spark meetup</a> every few weeks. Come by to meet the developers and other users.</p>
<p>Finally, if you&rsquo;d like to contribute code to Spark, read <a href="contributing-to-spark.html">how to contribute</a>.</p>
<!-- Main hero unit for a primary marketing message or call to action -->
<!--<div class="hero-unit">
<h1>Hello, world!</h1>
<p>This is a template for a simple marketing or informational website. It includes a large callout called the hero unit and three supporting pieces of content. Use it as a starting point to create something more unique.</p>
<p><a class="btn btn-primary btn-large">Learn more &raquo;</a></p>
</div>-->
<!-- Example row of columns -->
<!--<div class="row">
<div class="span4">
<h2>Heading</h2>
<p>Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. </p>
<p><a class="btn" href="#">View details &raquo;</a></p>
</div>
<div class="span4">
<h2>Heading</h2>
<p>Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. </p>
<p><a class="btn" href="#">View details &raquo;</a></p>
</div>
<div class="span4">
<h2>Heading</h2>
<p>Donec sed odio dui. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Vestibulum id ligula porta felis euismod semper. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</p>
<p><a class="btn" href="#">View details &raquo;</a></p>
</div>
</div>
<hr>-->
<!--<footer>
<p></p>
</footer>-->
</div> <!-- /container -->
<script src="js/vendor/jquery-1.8.0.min.js"></script>
<script src="js/vendor/bootstrap.min.js"></script>
<script src="js/main.js"></script>
<!-- A script to fix internal hash links because we have an overlapping top bar.
Based on https://github.com/twitter/bootstrap/issues/193#issuecomment-2281510 -->
<script>
$(function() {
function maybeScrollToHash() {
if (window.location.hash && $(window.location.hash).length) {
var newTop = $(window.location.hash).offset().top - $('#topbar').height() - 5;
$(window).scrollTop(newTop);
}
}
$(window).bind('hashchange', function() {
maybeScrollToHash();
});
// Scroll now too in case we had opened the page on a hash, but wait 1 ms because some browsers
// will try to do *their* initial scroll after running the onReady handler.
setTimeout(function() { maybeScrollToHash(); }, 1)
})
</script>
</body>
</html>