hadoop/hadoop-yarn-project/hadoop-yarn
Daniel Templeton f7177d91d6 YARN-6309. Fair scheduler docs should have the queue and queuePlacementPolicy
elements listed in bold so that they're easier to see
(Contributed by Esmaeil Mirzaee via Daniel Templeton)

(cherry picked from commit 948afe2c92977d6924a62c1a5a1ffca315cd3e68)
2017-03-20 14:32:01 -07:00
..
bin Revert "HADOOP-12366. expose calculated paths (aw)" 2016-03-09 09:59:19 -08:00
conf
dev-support YARN-5864. Capacity Scheduler - Queue Priorities. (wangda) 2017-01-24 14:44:42 -08:00
hadoop-yarn-api YARN-6228: EntityGroupFSTimelineStore should allow configurable cache 2017-02-24 11:00:16 -08:00
hadoop-yarn-applications YARN-5257. Fix unreleased resources and null dereferences (yufeigu via rkanter) 2016-12-27 14:14:41 -08:00
hadoop-yarn-client YARN-6313. YARN logs cli should provide logs for a completed container even when application is still running. Contributed by Xuan Gong. 2017-03-14 12:58:41 -07:00
hadoop-yarn-common YARN-6294. ATS client should better handle Socket closed case. Contributed by Li Lu. 2017-03-15 11:49:51 -07:00
hadoop-yarn-registry YARN-6332. Make RegistrySecurity use short user names for ZK ACLs. Contributed by Billie Rinaldi 2017-03-16 13:00:44 +08:00
hadoop-yarn-server YARN-6353. Clean up OrderingPolicy javadoc (Daniel Templeton via Varun Saxena) 2017-03-20 23:51:15 +05:30
hadoop-yarn-site YARN-6309. Fair scheduler docs should have the queue and queuePlacementPolicy 2017-03-20 14:32:01 -07:00
README
pom.xml HADOOP-13544. JDiff reports unncessarily show unannotated APIs and cause confusion while our javadocs only show annotated and public APIs. (vinodkv via wangda) 2016-09-27 11:27:25 -07:00

README

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

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

Setup
-----
Install protobuf 2.5.0 (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)


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