hadoop/hadoop-yarn-project/hadoop-yarn
Suresh Srinivas ead0693d68 YARN-328. Merge r1433231 from trunk.
git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/branch-2@1433233 13f79535-47bb-0310-9956-ffa450edef68
2013-01-15 00:22:56 +00:00
..
bin YARN-40. Provided support for missing YARN commands Contributed by Devaraj K and Vinod Kumar Vavilapalli. 2012-10-08 22:19:43 +00:00
conf YARN-334. Maven RAT plugin is not checking all source files (tgraves) 2013-01-14 15:01:01 +00:00
dev-support YARN-184. Remove unnecessary locking in fair scheduler, and address findbugs excludes. (sandyr via tucu) 2012-11-18 05:46:29 +00:00
hadoop-yarn-api YARN-328. Merge r1433231 from trunk. 2013-01-15 00:22:56 +00:00
hadoop-yarn-applications Merge -r 1411234:1411235 from trunk to branch-2. Fixes: YARN-129. Simplify classpath construction for mini YARN tests. 2012-11-19 15:16:57 +00:00
hadoop-yarn-client YARN-334. Maven RAT plugin is not checking all source files (tgraves) 2013-01-14 15:01:01 +00:00
hadoop-yarn-common YARN-328. Merge r1433231 from trunk. 2013-01-15 00:22:56 +00:00
hadoop-yarn-server Merge -c 1433138 from trunk to branch-2 to fix YARN-330. Fix flakey test: TestNodeManagerShutdown#testKillContainersOnShutdown. Contributed by Sandy Ryza 2013-01-14 21:36:32 +00:00
hadoop-yarn-site Merge HDFS-3077 (QuorumJournalManager) backport into branch-2. 2012-12-05 19:22:17 +00:00
README Merge -c 1370666 from trunk to branch-2 to fix YARN-1. Promote YARN to be a sub-project of Apache Hadoop. 2012-08-08 05:33:56 +00:00
pom.xml YARN-334. Maven RAT plugin is not checking all source files (tgraves) 2013-01-14 15:01:01 +00:00

README

YARN (YET ANOTHER RESOURCE NEGOTIATOR or YARN Application Resource Negotiator)
------------------------------------------------------------------------------

Requirements
-------------
Java: JDK 1.6
Maven: Maven 3

Setup
-----
Install protobuf 2.4.0a or higher (Download from http://code.google.com/p/protobuf/downloads/list)
 - install the protoc executable (configure, make, make install)
 - install the maven artifact (cd java; mvn install)
Installing protoc requires gcc 4.1.x or higher.
If the make step fails with (Valid until a fix is released for protobuf 2.4.0a)
    ./google/protobuf/descriptor.h:1152: error:
    `google::protobuf::internal::Mutex*google::protobuf::DescriptorPool::mutex_'
    is private
  Replace descriptor.cc with http://protobuf.googlecode.com/svn-history/r380/trunk/src/google/protobuf/descriptor.cc


Quick Maven Tips
----------------
clean workspace: mvn clean
compile and test: mvn install
skip tests: mvn install -DskipTests
skip test execution but compile: mvn install -Dmaven.test.skip.exec=true
clean and test: mvn clean install
run selected test after compile: mvn test -Dtest=TestClassName (combined: mvn clean install -Dtest=TestClassName)
create runnable binaries after install: mvn assembly:assembly -Pnative (combined: mvn clean install assembly:assembly -Pnative)

Eclipse Projects
----------------
http://maven.apache.org/guides/mini/guide-ide-eclipse.html

1. Generate .project and .classpath files in all maven modules
mvn eclipse:eclipse
CAUTION: If the project structure has changed from your previous workspace, clean up all .project and .classpath files recursively. Then run:
mvn eclipse:eclipse

2. Import the projects in eclipse.

3. Set the environment variable M2_REPO to point to your .m2/repository location.

NetBeans Projects
-----------------

NetBeans has builtin support of maven projects. Just "Open Project..."
and everything is setup automatically. Verified with NetBeans 6.9.1.


Custom Hadoop Dependencies
--------------------------

By default Hadoop dependencies are specified in the top-level pom.xml
properties section. One can override them via -Dhadoop-common.version=...
on the command line. ~/.m2/settings.xml can also be used to specify
these properties in different profiles, which is useful for IDEs.

Modules
-------
YARN consists of multiple modules. The modules are listed below as per the directory structure:

hadoop-yarn-api - Yarn's cross platform external interface

hadoop-yarn-common - Utilities which can be used by yarn clients and server

hadoop-yarn-server - Implementation of the hadoop-yarn-api
	hadoop-yarn-server-common - APIs shared between resourcemanager and nodemanager
	hadoop-yarn-server-nodemanager (TaskTracker replacement)
	hadoop-yarn-server-resourcemanager (JobTracker replacement)

Utilities for understanding the code
------------------------------------
Almost all of the yarn components as well as the mapreduce framework use
state-machines for all the data objects. To understand those central pieces of
the code, a visual representation of the state-machines helps much. You can first
convert the state-machines into graphviz(.gv) format by
running:
   mvn compile -Pvisualize
Then you can use the dot program for generating directed graphs and convert the above
.gv files to images. The graphviz package has the needed dot program and related
utilites.For e.g., to generate png files you can run:
   dot -Tpng NodeManager.gv > NodeManager.png