BIGTOP-1086. fix miscellaneous failures in package tests
[bigtop.git] / bigtop-tests / test-artifacts / spark / src / main / resources / README.md
1 # Spark
2
3 Lightning-Fast Cluster Computing - <http://spark.incubator.apache.org/>
4
5
6 ## Online Documentation
7
8 You can find the latest Spark documentation, including a programming
9 guide, on the project webpage at <http://spark.incubator.apache.org/documentation.html>.
10 This README file only contains basic setup instructions.
11
12
13 ## Building
14
15 Spark requires Scala 2.9.2 (Scala 2.10 is not yet supported). The project is
16 built using Simple Build Tool (SBT), which is packaged with it. To build
17 Spark and its example programs, run:
18
19     sbt/sbt package
20
21 Spark also supports building using Maven. If you would like to build using Maven,
22 see the [instructions for building Spark with Maven](http://spark.incubator.apache.org/docs/latest/building-with-maven.html)
23 in the spark documentation..
24
25 To run Spark, you will need to have Scala's bin directory in your `PATH`, or
26 you will need to set the `SCALA_HOME` environment variable to point to where
27 you've installed Scala. Scala must be accessible through one of these
28 methods on your cluster's worker nodes as well as its master.
29
30 To run one of the examples, use `./run <class> <params>`. For example:
31
32     ./run spark.examples.SparkLR local[2]
33
34 will run the Logistic Regression example locally on 2 CPUs.
35
36 Each of the example programs prints usage help if no params are given.
37
38 All of the Spark samples take a `<host>` parameter that is the cluster URL
39 to connect to. This can be a mesos:// or spark:// URL, or "local" to run
40 locally with one thread, or "local[N]" to run locally with N threads.
41
42
43 ## A Note About Hadoop Versions
44
45 Spark uses the Hadoop core library to talk to HDFS and other Hadoop-supported
46 storage systems. Because the HDFS API has changed in different versions of
47 Hadoop, you must build Spark against the same version that your cluster runs.
48 You can change the version by setting the `HADOOP_VERSION` variable at the top
49 of `project/SparkBuild.scala`, then rebuilding Spark.
50
51
52 ## Configuration
53
54 Please refer to the "Configuration" guide in the online documentation for a
55 full overview on how to configure Spark. At the minimum, you will need to
56 create a `conf/spark-env.sh` script (copy `conf/spark-env.sh.template`) and
57 set the following two variables:
58
59 - `SCALA_HOME`: Location where Scala is installed.
60
61 - `MESOS_NATIVE_LIBRARY`: Your Mesos library (only needed if you want to run
62   on Mesos). For example, this might be `/usr/local/lib/libmesos.so` on Linux.
63
64
65 ## Contributing to Spark
66
67 Contributions via GitHub pull requests are gladly accepted from their original
68 author. Along with any pull requests, please state that the contribution is
69 your original work and that you license the work to the project under the
70 project's open source license. Whether or not you state this explicitly, by
71 submitting any copyrighted material via pull request, email, or other means
72 you agree to license the material under the project's open source license and
73 warrant that you have the legal authority to do so.