hadoop/hadoop-yarn-project/hadoop-yarn
Wangda Tan 26e87be3f2 YARN-7056. [Partial backport] Document Resource Profiles feature. (Sunil G via wangda)
Change-Id: I5f5d52cdf7aba4ac09684aab573e6916dbad183e
(cherry picked from commit 6b88cd1901)
2019-08-29 17:02:47 -07:00
..
bin YARN-7190 Ensure only NM classpath in 2.x gets TSv2 related hbase jars, not the user classpath (Contributed by Varun Saxena via Vrushali C) 2017-10-17 23:36:41 +05:30
conf YARN-6623. Add support to turn off launching privileged containers in the container-executor. (Varun Vasudev via wangda) 2017-10-20 11:22:28 -07:00
dev-support YARN-6788. [YARN-3926] Improve performance of resource profile branch 2019-08-29 17:02:46 -07:00
hadoop-yarn-api YARN-6933. [YARN-3926] ResourceUtils.DISALLOWED_NAMES check is duplicated. Contributed by Manikandan R. 2019-08-29 17:02:47 -07:00
hadoop-yarn-applications YARN-7039. Fix javac and javadoc errors in YARN-3926 branch. (Sunil G via wangda) 2019-08-29 17:02:46 -07:00
hadoop-yarn-client YARN-7043. [Partial backport] Cleanup ResourceProfileManager. (wangda) 2019-08-29 17:02:46 -07:00
hadoop-yarn-common YARN-6933. [YARN-3926] ResourceUtils.DISALLOWED_NAMES check is duplicated. Contributed by Manikandan R. 2019-08-29 17:02:47 -07:00
hadoop-yarn-registry HADOOP-16331. Fix ASF License check in pom.xml. Contributed by Akira Ajisaka. 2019-05-29 17:41:21 +09:00
hadoop-yarn-server YARN-7039. Fix javac and javadoc errors in YARN-3926 branch. (Sunil G via wangda) 2019-08-29 17:02:46 -07:00
hadoop-yarn-site YARN-7056. [Partial backport] Document Resource Profiles feature. (Sunil G via wangda) 2019-08-29 17:02:47 -07:00
hadoop-yarn-ui HADOOP-16331. Fix ASF License check in pom.xml. Contributed by Akira Ajisaka. 2019-05-29 17:41:21 +09:00
README HADOOP-9872. Improve protoc version handling and detection. (tucu) 2013-08-14 22:29:46 +00:00
pom.xml HADOOP-16331. Fix ASF License check in pom.xml. Contributed by Akira Ajisaka. 2019-05-29 17:41:21 +09: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