Removed sbt folder and changed docs accordingly
This commit is contained in:
Prashant Sharma
parent
8821c3a526
commit
6be4c11194
30
README.md
30
README.md
|
|
@ -13,9 +13,9 @@ This README file only contains basic setup instructions.
|
|||
## Building
|
||||
|
||||
Spark requires Scala 2.10. The project is built using Simple Build Tool (SBT),
|
||||
which is packaged with it. To build Spark and its example programs, run:
|
||||
which can be obtained from [here](http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html). To build Spark and its example programs, run:
|
||||
|
||||
sbt/sbt assembly
|
||||
sbt assembly
|
||||
|
||||
Once you've built Spark, the easiest way to start using it is the shell:
|
||||
|
||||
|
|
@ -36,6 +36,22 @@ All of the Spark samples take a `<master>` parameter that is the cluster URL
|
|||
to connect to. This can be a mesos:// or spark:// URL, or "local" to run
|
||||
locally with one thread, or "local[N]" to run locally with N threads.
|
||||
|
||||
## Running tests
|
||||
|
||||
### With sbt. (you need sbt installed)
|
||||
Once you have built spark with `sbt assembly` mentioned in [Building](#Building) section. Test suits can be run as follows on *nix based systems using sbt.
|
||||
|
||||
`SPARK_HOME=$(pwd) SPARK_TESTING=1 sbt test`
|
||||
|
||||
TODO: figure out instructions for windows.
|
||||
|
||||
### With maven.
|
||||
|
||||
1. Build assembly by
|
||||
`mvn package -DskipTests`
|
||||
|
||||
2. Run tests
|
||||
`mvn test`
|
||||
|
||||
## A Note About Hadoop Versions
|
||||
|
||||
|
|
@ -49,22 +65,22 @@ For Apache Hadoop versions 1.x, Cloudera CDH MRv1, and other Hadoop
|
|||
versions without YARN, use:
|
||||
|
||||
# Apache Hadoop 1.2.1
|
||||
$ SPARK_HADOOP_VERSION=1.2.1 sbt/sbt assembly
|
||||
$ SPARK_HADOOP_VERSION=1.2.1 sbt assembly
|
||||
|
||||
# Cloudera CDH 4.2.0 with MapReduce v1
|
||||
$ SPARK_HADOOP_VERSION=2.0.0-mr1-cdh4.2.0 sbt/sbt assembly
|
||||
$ SPARK_HADOOP_VERSION=2.0.0-mr1-cdh4.2.0 sbt assembly
|
||||
|
||||
For Apache Hadoop 2.2.X, 2.1.X, 2.0.X, 0.23.x, Cloudera CDH MRv2, and other Hadoop versions
|
||||
with YARN, also set `SPARK_YARN=true`:
|
||||
|
||||
# Apache Hadoop 2.0.5-alpha
|
||||
$ SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true sbt/sbt assembly
|
||||
$ SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true sbt assembly
|
||||
|
||||
# Cloudera CDH 4.2.0 with MapReduce v2
|
||||
$ SPARK_HADOOP_VERSION=2.0.0-cdh4.2.0 SPARK_YARN=true sbt/sbt assembly
|
||||
$ SPARK_HADOOP_VERSION=2.0.0-cdh4.2.0 SPARK_YARN=true sbt assembly
|
||||
|
||||
# Apache Hadoop 2.2.X and newer
|
||||
$ SPARK_HADOOP_VERSION=2.2.0 SPARK_YARN=true sbt/sbt assembly
|
||||
$ SPARK_HADOOP_VERSION=2.2.0 SPARK_YARN=true sbt assembly
|
||||
|
||||
When developing a Spark application, specify the Hadoop version by adding the
|
||||
"hadoop-client" artifact to your project's dependencies. For example, if you're
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ To mark a block of code in your markdown to be syntax highlighted by jekyll duri
|
|||
|
||||
## API Docs (Scaladoc and Epydoc)
|
||||
|
||||
You can build just the Spark scaladoc by running `sbt/sbt doc` from the SPARK_PROJECT_ROOT directory.
|
||||
You can build just the Spark scaladoc by running `sbt doc` from the SPARK_PROJECT_ROOT directory.
|
||||
|
||||
Similarly, you can build just the PySpark epydoc by running `epydoc --config epydoc.conf` from the SPARK_PROJECT_ROOT/pyspark directory.
|
||||
|
||||
When you run `jekyll` in the docs directory, it will also copy over the scaladoc for the various Spark subprojects into the docs directory (and then also into the _site directory). We use a jekyll plugin to run `sbt/sbt doc` before building the site so if you haven't run it (recently) it may take some time as it generates all of the scaladoc. The jekyll plugin also generates the PySpark docs using [epydoc](http://epydoc.sourceforge.net/).
|
||||
When you run `jekyll` in the docs directory, it will also copy over the scaladoc for the various Spark subprojects into the docs directory (and then also into the _site directory). We use a jekyll plugin to run `sbt doc` before building the site so if you haven't run it (recently) it may take some time as it generates all of the scaladoc. The jekyll plugin also generates the PySpark docs using [epydoc](http://epydoc.sourceforge.net/).
|
||||
|
||||
NOTE: To skip the step of building and copying over the Scala and Python API docs, run `SKIP_API=1 jekyll`.
|
||||
|
|
|
|||
|
|
@ -26,8 +26,8 @@ if not (ENV['SKIP_API'] == '1' or ENV['SKIP_SCALADOC'] == '1')
|
|||
curr_dir = pwd
|
||||
cd("..")
|
||||
|
||||
puts "Running sbt/sbt doc from " + pwd + "; this may take a few minutes..."
|
||||
puts `sbt/sbt doc`
|
||||
puts "Running sbt doc from " + pwd + "; this may take a few minutes..."
|
||||
puts `sbt doc`
|
||||
|
||||
puts "Moving back into docs dir."
|
||||
cd("docs")
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ layout: global
|
|||
title: Spark API documentation (Scaladoc)
|
||||
---
|
||||
|
||||
Here you can find links to the Scaladoc generated for the Spark sbt subprojects. If the following links don't work, try running `sbt/sbt doc` from the Spark project home directory.
|
||||
Here you can find links to the Scaladoc generated for the Spark sbt subprojects. If the following links don't work, try running `sbt doc` from the Spark project home directory.
|
||||
|
||||
- [Spark](api/core/index.html)
|
||||
- [Spark Examples](api/examples/index.html)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ with these distributions:
|
|||
When compiling Spark, you'll need to
|
||||
[set the SPARK_HADOOP_VERSION flag](index.html#a-note-about-hadoop-versions):
|
||||
|
||||
SPARK_HADOOP_VERSION=1.0.4 sbt/sbt assembly
|
||||
SPARK_HADOOP_VERSION=1.0.4 sbt assembly
|
||||
|
||||
The table below lists the corresponding `SPARK_HADOOP_VERSION` code for each CDH/HDP release. Note that
|
||||
some Hadoop releases are binary compatible across client versions. This means the pre-built Spark
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Spark runs on both Windows and UNIX-like systems (e.g. Linux, Mac OS). All you n
|
|||
|
||||
Spark uses [Simple Build Tool](http://www.scala-sbt.org), which is bundled with it. To compile the code, go into the top-level Spark directory and run
|
||||
|
||||
sbt/sbt assembly
|
||||
sbt assembly
|
||||
|
||||
For its Scala API, Spark {{site.SPARK_VERSION}} depends on Scala {{site.SCALA_VERSION}}. If you write applications in Scala, you will need to use this same version of Scala in your own program -- newer major versions may not work. You can get the right version of Scala from [scala-lang.org](http://www.scala-lang.org/download/).
|
||||
|
||||
|
|
@ -56,12 +56,12 @@ Hadoop, you must build Spark against the same version that your cluster uses.
|
|||
By default, Spark links to Hadoop 1.0.4. You can change this by setting the
|
||||
`SPARK_HADOOP_VERSION` variable when compiling:
|
||||
|
||||
SPARK_HADOOP_VERSION=2.2.0 sbt/sbt assembly
|
||||
SPARK_HADOOP_VERSION=2.2.0 sbt assembly
|
||||
|
||||
In addition, if you wish to run Spark on [YARN](running-on-yarn.html), set
|
||||
`SPARK_YARN` to `true`:
|
||||
|
||||
SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true sbt/sbt assembly
|
||||
SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true sbt assembly
|
||||
|
||||
Note that on Windows, you need to set the environment variables on separate lines, e.g., `set SPARK_HADOOP_VERSION=1.2.1`.
|
||||
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ The script automatically adds the `pyspark` package to the `PYTHONPATH`.
|
|||
The `pyspark` script launches a Python interpreter that is configured to run PySpark applications. To use `pyspark` interactively, first build Spark, then launch it directly from the command line without any options:
|
||||
|
||||
{% highlight bash %}
|
||||
$ sbt/sbt assembly
|
||||
$ sbt assembly
|
||||
$ ./pyspark
|
||||
{% endhighlight %}
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ See the [programming guide](scala-programming-guide.html) for a more complete re
|
|||
To follow along with this guide, you only need to have successfully built Spark on one machine. Simply go into your Spark directory and run:
|
||||
|
||||
{% highlight bash %}
|
||||
$ sbt/sbt assembly
|
||||
$ sbt assembly
|
||||
{% endhighlight %}
|
||||
|
||||
# Interactive Analysis with the Spark Shell
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ was added to Spark in version 0.6.0, and improved in 0.7.0 and 0.8.0.
|
|||
We need a consolidated Spark JAR (which bundles all the required dependencies) to run Spark jobs on a YARN cluster.
|
||||
This can be built by setting the Hadoop version and `SPARK_YARN` environment variable, as follows:
|
||||
|
||||
SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true ./sbt/sbt assembly
|
||||
SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true ./sbt assembly
|
||||
|
||||
The assembled JAR will be something like this:
|
||||
`./assembly/target/scala-{{site.SCALA_VERSION}}/spark-assembly_{{site.SPARK_VERSION}}-hadoop2.0.5.jar`.
|
||||
|
|
@ -25,7 +25,7 @@ The build process now also supports new YARN versions (2.2.x). See below.
|
|||
- The assembled jar can be installed into HDFS or used locally.
|
||||
- Your application code must be packaged into a separate JAR file.
|
||||
|
||||
If you want to test out the YARN deployment mode, you can use the current Spark examples. A `spark-examples_{{site.SCALA_VERSION}}-{{site.SPARK_VERSION}}` file can be generated by running `sbt/sbt assembly`. NOTE: since the documentation you're reading is for Spark version {{site.SPARK_VERSION}}, we are assuming here that you have downloaded Spark {{site.SPARK_VERSION}} or checked it out of source control. If you are using a different version of Spark, the version numbers in the jar generated by the sbt package command will obviously be different.
|
||||
If you want to test out the YARN deployment mode, you can use the current Spark examples. A `spark-examples_{{site.SCALA_VERSION}}-{{site.SPARK_VERSION}}` file can be generated by running `sbt assembly`. NOTE: since the documentation you're reading is for Spark version {{site.SPARK_VERSION}}, we are assuming here that you have downloaded Spark {{site.SPARK_VERSION}} or checked it out of source control. If you are using a different version of Spark, the version numbers in the jar generated by the sbt package command will obviously be different.
|
||||
|
||||
# Configuration
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ The command to launch the YARN Client is as follows:
|
|||
For example:
|
||||
|
||||
# Build the Spark assembly JAR and the Spark examples JAR
|
||||
$ SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true ./sbt/sbt assembly
|
||||
$ SPARK_HADOOP_VERSION=2.0.5-alpha SPARK_YARN=true ./sbt assembly
|
||||
|
||||
# Configure logging
|
||||
$ cp conf/log4j.properties.template conf/log4j.properties
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ In addition, if you wish to access an HDFS cluster, you need to add a dependency
|
|||
artifactId = hadoop-client
|
||||
version = <your-hdfs-version>
|
||||
|
||||
For other build systems, you can run `sbt/sbt assembly` to pack Spark and its dependencies into one JAR (`assembly/target/scala-{{site.SCALA_VERSION}}/spark-assembly-{{site.SPARK_VERSION}}-hadoop*.jar`), then add this to your CLASSPATH. Set the HDFS version as described [here](index.html#a-note-about-hadoop-versions).
|
||||
For other build systems, you can run `sbt assembly` to pack Spark and its dependencies into one JAR (`assembly/target/scala-{{site.SCALA_VERSION}}/spark-assembly-{{site.SPARK_VERSION}}-hadoop*.jar`), then add this to your CLASSPATH. Set the HDFS version as described [here](index.html#a-note-about-hadoop-versions).
|
||||
|
||||
Finally, you need to import some Spark classes and implicit conversions into your program. Add the following lines:
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,13 @@ DISTDIR="$FWDIR/dist"
|
|||
|
||||
# Get version from SBT
|
||||
export TERM=dumb # Prevents color codes in SBT output
|
||||
VERSION=$($FWDIR/sbt/sbt "show version" | tail -1 | cut -f 2 | sed 's/^\([a-zA-Z0-9.-]*\).*/\1/')
|
||||
|
||||
if ! test `which sbt` ;then
|
||||
echo -e "You need sbt installed and available on path, please follow the instructions here: http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html"
|
||||
exit -1;
|
||||
fi
|
||||
|
||||
VERSION=$(sbt "show version" | tail -1 | cut -f 2 | sed 's/^\([a-zA-Z0-9.-]*\).*/\1/')
|
||||
|
||||
# Initialize defaults
|
||||
SPARK_HADOOP_VERSION=1.0.4
|
||||
|
|
@ -83,7 +89,9 @@ fi
|
|||
# Build fat JAR
|
||||
export SPARK_HADOOP_VERSION
|
||||
export SPARK_YARN
|
||||
"$FWDIR/sbt/sbt" "assembly/assembly"
|
||||
cd $FWDIR
|
||||
|
||||
"sbt" "assembly/assembly"
|
||||
|
||||
# Make directories
|
||||
rm -rf "$DISTDIR"
|
||||
|
|
|
|||
2
pyspark
2
pyspark
|
|
@ -31,7 +31,7 @@ if [ ! -f "$FWDIR/RELEASE" ]; then
|
|||
ls "$FWDIR"/assembly/target/scala-$SCALA_VERSION/spark-assembly*hadoop*.jar >& /dev/null
|
||||
if [[ $? != 0 ]]; then
|
||||
echo "Failed to find Spark assembly in $FWDIR/assembly/target" >&2
|
||||
echo "You need to build Spark with sbt/sbt assembly before running this program" >&2
|
||||
echo "You need to build Spark with sbt assembly before running this program" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ if [ -e "$EXAMPLES_DIR"/target/spark-examples*[0-9Tg].jar ]; then
|
|||
fi
|
||||
if [[ -z $SPARK_EXAMPLES_JAR ]]; then
|
||||
echo "Failed to find Spark examples assembly in $FWDIR/examples/target" >&2
|
||||
echo "You need to build Spark with sbt/sbt assembly before running this program" >&2
|
||||
echo "You need to build Spark with sbt assembly before running this program" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
|
|
|||
43
sbt/sbt
43
sbt/sbt
|
|
@ -1,43 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
#
|
||||
# Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
# contributor license agreements. See the NOTICE file distributed with
|
||||
# this work for additional information regarding copyright ownership.
|
||||
# The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
# (the "License"); you may not use this file except in compliance with
|
||||
# the License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
cygwin=false
|
||||
case "`uname`" in
|
||||
CYGWIN*) cygwin=true;;
|
||||
esac
|
||||
|
||||
EXTRA_ARGS="-Xmx1200m -XX:MaxPermSize=350m -XX:ReservedCodeCacheSize=256m"
|
||||
if [ "$MESOS_HOME" != "" ]; then
|
||||
EXTRA_ARGS="$EXTRA_ARGS -Djava.library.path=$MESOS_HOME/lib/java"
|
||||
fi
|
||||
|
||||
export SPARK_HOME=$(cd "$(dirname $0)/.." 2>&1 >/dev/null ; pwd)
|
||||
export SPARK_TESTING=1 # To put test classes on classpath
|
||||
|
||||
SBT_JAR="$SPARK_HOME"/sbt/sbt-launch-*.jar
|
||||
if $cygwin; then
|
||||
SBT_JAR=`cygpath -w $SBT_JAR`
|
||||
export SPARK_HOME=`cygpath -w $SPARK_HOME`
|
||||
EXTRA_ARGS="$EXTRA_ARGS -Djline.terminal=jline.UnixTerminal -Dsbt.cygwin=true"
|
||||
stty -icanon min 1 -echo > /dev/null 2>&1
|
||||
java $EXTRA_ARGS $SBT_OPTS -jar $SBT_JAR "$@"
|
||||
stty icanon echo > /dev/null 2>&1
|
||||
else
|
||||
java $EXTRA_ARGS $SBT_OPTS -jar $SBT_JAR "$@"
|
||||
fi
|
||||
Binary file not shown.
25
sbt/sbt.cmd
25
sbt/sbt.cmd
|
|
@ -1,25 +0,0 @@
|
|||
@echo off
|
||||
|
||||
rem
|
||||
rem Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
rem contributor license agreements. See the NOTICE file distributed with
|
||||
rem this work for additional information regarding copyright ownership.
|
||||
rem The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
rem (the "License"); you may not use this file except in compliance with
|
||||
rem the License. You may obtain a copy of the License at
|
||||
rem
|
||||
rem http://www.apache.org/licenses/LICENSE-2.0
|
||||
rem
|
||||
rem Unless required by applicable law or agreed to in writing, software
|
||||
rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||
rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
rem See the License for the specific language governing permissions and
|
||||
rem limitations under the License.
|
||||
rem
|
||||
|
||||
set EXTRA_ARGS=
|
||||
if not "%MESOS_HOME%x"=="x" set EXTRA_ARGS=-Djava.library.path=%MESOS_HOME%\lib\java
|
||||
|
||||
set SPARK_HOME=%~dp0..
|
||||
|
||||
java -Xmx1200M -XX:MaxPermSize=200m -XX:ReservedCodeCacheSize=256m %EXTRA_ARGS% -jar %SPARK_HOME%\sbt\sbt-launch-0.11.3-2.jar "%*"
|
||||
|
|
@ -104,7 +104,7 @@ if [ ! -f "$FWDIR/RELEASE" ]; then
|
|||
jars_list=$(ls "$FWDIR"/assembly/target/scala-$SCALA_VERSION/ | grep "spark-assembly.*hadoop.*.jar")
|
||||
if [ "$num_jars" -eq "0" ]; then
|
||||
echo "Failed to find Spark assembly in $FWDIR/assembly/target/scala-$SCALA_VERSION/" >&2
|
||||
echo "You need to build Spark with 'sbt/sbt assembly' before running this program." >&2
|
||||
echo "You need to build Spark with 'sbt assembly' before running this program." >&2
|
||||
exit 1
|
||||
fi
|
||||
if [ "$num_jars" -gt "1" ]; then
|
||||
|
|
|
|||
Loading…
Reference in a new issue