YARN-1520. update capacity scheduler docs to include necessary parameters (Chen He via jeagles)

git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/branch-2@1577779 13f79535-47bb-0310-9956-ffa450edef68

hadoop-yarn-project/CHANGES.txt

@@ -23,6 +23,9 @@ Release 2.5.0 - UNRELEASED
     YARN-1833. TestRMAdminService Fails in trunk and branch-2 (Mit Desais via
     jeagles)
 
+    YARN-1520. update capacity scheduler docs to include necessary parameters
+    (Chen He via jeagles)
+
   OPTIMIZATIONS
 
   BUG FIXES 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/CapacityScheduler.apt.vm

@@ -297,18 +297,48 @@ Hadoop MapReduce Next Generation - Capacity Scheduler
     <Note:> An <ACL> is of the form <user1>, <user2><space><group1>, <group2>.
     The special value of <<*>> implies <anyone>. The special value of <space>
     implies <no one>. The default is <<*>> for the root queue if not specified.
-     
-    * Reviewing the configuration of the CapacityScheduler
+
+  * Other Properties
+
+    * Resource Calculator
+
+
+*--------------------------------------+--------------------------------------+
+|| Property                            || Description                         |
+*--------------------------------------+--------------------------------------+
+| <<<yarn.scheduler.capacity.resource-calculator>>> | |
+| | The ResourceCalculator implementation to be used to compare Resources in the |
+| | scheduler. The default i.e. org.apache.hadoop.yarn.util.resource.DefaultResourseCalculator |
+| | only uses Memory while DominantResourceCalculator uses Dominant-resource |
+| | to compare multi-dimensional resources such as Memory, CPU etc. A Java |
+| | ResourceCalculator class name is expected. |
+*--------------------------------------+--------------------------------------+
+
+
+    * Data Locality
+
+*--------------------------------------+--------------------------------------+
+|| Property                            || Description                         |
+*--------------------------------------+--------------------------------------+
+| <<<yarn.scheduler.capacity.node-locality-delay>>> | |
+| | Number of missed scheduling opportunities after which the CapacityScheduler |
+| | attempts to schedule rack-local containers. Typically, this should be set to |
+| | number of nodes in the cluster. By default is setting approximately number |
+| | of nodes in one rack which is 40. Positive integer value is expected.|
+*--------------------------------------+--------------------------------------+
+
+
+  * Reviewing the configuration of the CapacityScheduler
 
       Once the installation and configuration is completed, you can review it 
       after starting the YARN cluster from the web-ui.
 
-      * Start the YARN cluster in the normal manner.
+    * Start the YARN cluster in the normal manner.
 
-      * Open the <<<ResourceManager>>> web UI.
+    * Open the <<<ResourceManager>>> web UI.
 
-      * The </scheduler> web-page should show the resource usages of individual 
-        queues.
+    * The </scheduler> web-page should show the resource usages of individual 
+      queues.
       
       []