MAPREDUCE-3497. Added docs for YARN CLI. Contributed by Thomas Graves.

git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1296902 13f79535-47bb-0310-9956-ffa450edef68

hadoop-mapreduce-project/CHANGES.txt

@@ -153,6 +153,8 @@ Release 0.23.2 - UNRELEASED
     MAPREDUCE-3614. Fixed MR AM to close history file quickly and send a correct
     final state to the RM when it is killed. (Ravi Prakash via vinodkv)
 
+    MAPREDUCE-3497. Added docs for YARN CLI. (tgraves via acmurthy) 
+
   OPTIMIZATIONS
 
     MAPREDUCE-3901. Modified JobHistory records in YARN to lazily load job and

hadoop-mapreduce-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm

@@ -0,0 +1,165 @@
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~   http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License. See accompanying LICENSE file.
+
+  ---
+  Yarn Commands
+  ---
+  ---
+  ${maven.build.timestamp}
+
+Yarn Commands
+
+  \[ {{{./index.html}Go Back}} \]
+
+%{toc|section=1|fromDepth=0}
+
+* Overview
+
+  Yarn commands are invoked by the bin/yarn script. Running the yarn script without any arguments prints the description for all commands.
+
+------
+Usage: yarn [--config confdir] COMMAND
+------
+
+  Yarn has an option parsing framework that employs parsing generic options as well as running classes.
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description                   |
+*---------------+--------------+
+| --config confdir | Overwrites the default Configuration directory. Default is ${HADOOP_PREFIX}/conf. | 
+*---------------+--------------+
+| COMMAND COMMAND_OPTIONS | Various commands with their options are described in the following sections. The commands have been grouped into {{User Commands}} and {{Administration Commands}}. |
+*---------------+--------------+
+
+* {User Commands}
+
+  Commands useful for users of a Hadoop cluster.
+
+** jar
+
+  Runs a jar file. Users can bundle their Yarn code in a jar file and execute it using this command.
+
+-------
+  Usage: yarn jar <jar> [mainClass] args...
+-------
+
+** logs
+
+  Dump the container logs
+
+-------
+  Usage: yarn logs <options>
+-------
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description                   |
+*---------------+--------------+
+| -applicationId ApplicationId | Specify an application id |
+*---------------+--------------+
+| -appOwner AppOwner | Specify an application owner |
+*---------------+--------------+
+| -containerId ContainerId | Specify a container id |
+*---------------+--------------+
+| -nodeAddress NodeAddress | Specify a node address |
+*---------------+--------------+
+
+** classpath
+
+  Prints the class path needed to get the Hadoop jar and the required libraries
+
+-------
+  Usage: yarn classpath
+-------
+
+** version
+
+  Prints the version.
+
+-------
+  Usage: yarn version
+-------
+
+
+* {Administration Commands}
+
+  Commands useful for administrators of a Hadoop cluster.
+
+** resourcemanager
+
+  Start the ResourceManager
+
+-------
+  Usage: yarn resourcemanager
+-------
+
+** nodemanager
+
+  Start the NodeManager
+
+-------
+  Usage: yarn nodemanager
+-------
+
+** proxyserver
+
+  Start the web proxy server
+
+-------
+  Usage: yarn proxyserver
+-------
+
+** rmadmin
+
+  Runs ResourceManager admin client
+
+-------
+  Usage: yarn rmadmin [-refreshQueues] [-refreshNodes] [-refreshUserToGroupsMapping] 
+                      [-refreshSuperUserGroupsConfiguration] [-refreshAdminAcls] 
+                      [-refreshServiceAcl] [-help [cmd]]
+-------
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description                   |
+*---------------+--------------+
+| -refreshQueues | Reload the queues' acls, states and scheduler specific properties. ResourceManager will reload the mapred-queues configuration file. |
+*---------------+--------------+
+| -refreshNodes | Refresh the hosts information at the ResourceManager. |
+*---------------+--------------+
+| -refreshUserToGroupsMappings| Refresh user-to-groups mappings. |
+*---------------+--------------+
+| -refreshSuperUserGroupsConfiguration| Refresh superuser proxy groups mappings. |
+*---------------+--------------+
+| -refreshAdminAcls | Refresh acls for administration of ResourceManager |
+*---------------+--------------+
+| -refreshServiceAcl | Reload the service-level authorization policy file ResoureceManager will reload the authorization policy file. |
+*---------------+--------------+
+| -help [cmd] | Displays help for the given command or all commands if none is specified. |
+*---------------+--------------+
+
+** daemonlog
+
+  Get/Set the log level for each daemon.
+
+-------
+  Usage: yarn daemonlog -getlevel <host:port> <name> 
+  Usage: yarn daemonlog -setlevel <host:port> <name> <level>
+-------
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description                   |
+*---------------+--------------+
+| -getlevel <host:port> <name> | Prints the log level of the daemon running at <host:port>. This command internally connects to http://<host:port>/logLevel?log=<name> |
+*---------------+--------------+
+| -setlevel <host:port> <name> <level>  | Sets the log level of the daemon running at <host:port>. This command internally connects to http://<host:port>/logLevel?log=<name> |
+*---------------+--------------+
+
+