aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--yarn/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/yarn/README.md b/yarn/README.md
new file mode 100644
index 0000000000..3639f2c364
--- /dev/null
+++ b/yarn/README.md
@@ -0,0 +1,16 @@
+# YARN DIRECTORY LAYOUT
+
+Hadoop Yarn related code are organized
+
+Hadoop Yarn related codes are organized in separate modules with layered dependency.
+
+ * common : Common codes that will be called into by other modules.
+
+ * 2.0 / 2.2 : Codes that involve specific version of Hadoop YARN API. Depends on common module.
+
+ 2.0 actually represents 0.23 and 2.0
+ 2.2 actually represents 2.2 and later, until the API is break again.
+
+ * Scheduler : Implementation of various YARN Scheduler and backend. Depends on 2.0 / 2.2 modules.
+ * Assembly : For maven build to assembly all other modules in Yarn into one single jar.
+