diff --git hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm index 386be09..4c433b8 100644 --- hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm +++ hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm @@ -24,29 +24,36 @@ Yarn Commands * Overview - Yarn commands are invoked by the bin/yarn script. Running the yarn script without any arguments prints the description for all commands. + 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. + 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. | +| --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}}. | +| 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} +* 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. + Runs a jar file. Users can bundle their Yarn code in a jar file and execute + it using this command. ------- Usage: yarn jar [mainClass] args... @@ -63,11 +70,22 @@ Usage: yarn [--config confdir] COMMAND *---------------+--------------+ || COMMAND_OPTIONS || Description | *---------------+--------------+ -| -status ApplicationId | Specify an application id | +| -list | Lists applications from the RM. Supports optional use of -appTypes +| | to filter applications based on application type, and -appStates to +| | filter applications based on application state. *---------------+--------------+ -| -list | Lists all the Applications from RM | +| -appStates States | Works with -list to filter applications based on input +| | comma-separated list of application states. The valid +| | application state can be one of the following: \ +| | ALL, NEW, NEW_SAVING, SUBMITTED, ACCEPTED, RUNNING, +| | FINISHED, FAILED, KILLED *---------------+--------------+ -| -kill ApplicationId | Specify an application id | +| -appTypes Types | Works with -list to filter applications based on input +| | comma-separated list of application types. +*---------------+--------------+ +| -status ApplicationId | Prints the status of the application. +*---------------+--------------+ +| -kill ApplicationId | Kills the application. *---------------+--------------+ ** node @@ -81,9 +99,15 @@ Usage: yarn [--config confdir] COMMAND *---------------+--------------+ || COMMAND_OPTIONS || Description | *---------------+--------------+ -| -status NodeId | Specify a node id | +| -list | Lists all running nodes. Supports optional use of -states to filter +| | nodes based on node state, and -all to list all nodes. +*---------------+--------------+ +| -states States | Works with -list to filter nodes based on input +| | comma-separated list of node states. *---------------+--------------+ -| -list | Lists all the Nodes | +| -all | Works with -list to list all nodes. +*---------------+--------------+ +| -status NodeId | Prints the status report of the node. *---------------+--------------+ ** logs @@ -91,19 +115,22 @@ Usage: yarn [--config confdir] COMMAND Dump the container logs ------- - Usage: yarn logs + Usage: yarn logs -applicationId ------- *---------------+--------------+ || COMMAND_OPTIONS || Description | *---------------+--------------+ -| -applicationId ApplicationId | Specify an application id | +| -applicationId \ | Specifies ApplicationId. *---------------+--------------+ -| -appOwner AppOwner | Specify an application owner | +| -appOwner AppOwner | AppOwner (assumed to be current user if not +| | specified) *---------------+--------------+ -| -containerId ContainerId | Specify a container id | +| -containerId ContainerId | ContainerId (must be specified if node address is +| | specified) *---------------+--------------+ -| -nodeAddress NodeAddress | Specify a node address | +| -nodeAddress NodeAddress | NodeAddress in the format nodename:port (must be +| | specified if container id is specified) *---------------+--------------+ ** classpath @@ -123,7 +150,7 @@ Usage: yarn [--config confdir] COMMAND ------- -* {Administration Commands} +* Administration Commands Commands useful for administrators of a Hadoop cluster. @@ -158,25 +185,55 @@ Usage: yarn [--config confdir] COMMAND ------- Usage: yarn rmadmin [-refreshQueues] [-refreshNodes] [-refreshUserToGroupsMapping] [-refreshSuperUserGroupsConfiguration] [-refreshAdminAcls] - [-refreshServiceAcl] [-help [cmd]] + [-refreshServiceAcl] [-getGroups [username]] [-help [cmd]] + [-transitionToActive ] + [-transitionToStandby ] + [-failover [--forcefence] [--forceactive] ] + [-getServiceState ] + [-checkHealth ] ------- *---------------+--------------+ || COMMAND_OPTIONS || Description | *---------------+--------------+ -| -refreshQueues | Reload the queues' acls, states and scheduler specific properties. ResourceManager will reload the mapred-queues configuration file. | +| -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. *---------------+--------------+ -| -refreshNodes | Refresh the hosts information at the ResourceManager. | +| -refreshSuperUserGroupsConfiguration | Refresh superuser proxy groups +| | mappings. *---------------+--------------+ -| -refreshUserToGroupsMappings| Refresh user-to-groups mappings. | +| -refreshAdminAcls | Refresh acls for administration of ResourceManager. *---------------+--------------+ -| -refreshSuperUserGroupsConfiguration| Refresh superuser proxy groups mappings. | +| -refreshServiceAcl | Reload the service-level authorization policy file +| | ResoureceManager will reload the authorization policy +| | file. *---------------+--------------+ -| -refreshAdminAcls | Refresh acls for administration of ResourceManager | +| -getGroups [username] | Get groups the specified user belongs to. *---------------+--------------+ -| -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. *---------------+--------------+ -| -help [cmd] | Displays help for the given command or all commands if none is specified. | +| -transitionToActive \ | Transitions the service into Active +| | state. +*---------------+--------------+ +| -transitionToStandby \ | Transitions the service into Standby +| | state. +*---------------+--------------+ +| -failover [--forcefence] [--forceactive] \ \ | +| | Failover from the first service to the second. Unconditionally fence +| | services if the --forcefence option is used. Try to failover to the target +| | service even if it is not ready if the --forceactive option is used. +*---------------+--------------+ +| -getServiceState \ | Returns the state of the service. +*---------------+--------------+ +| -checkHealth \ | Requests that the service perform a health +| | check. The RMAdmin tool will exit with a +| | non-zero exit code if the check fails. *---------------+--------------+ ** daemonlog @@ -191,9 +248,15 @@ Usage: yarn [--config confdir] COMMAND *---------------+--------------+ || COMMAND_OPTIONS || Description | *---------------+--------------+ -| -getlevel | Prints the log level of the daemon running at . This command internally connects to http:///logLevel?log= | +| -getlevel \ \ | Prints the log level of the daemon running +| | at \. This command internally +| | connects to +| | http://\/logLevel?log=\ *---------------+--------------+ -| -setlevel | Sets the log level of the daemon running at . This command internally connects to http:///logLevel?log= | +| -setlevel \ \ \ | Sets the log level of the +| | daemon running at +| | \. This command +| | internally connects to +| | http://\/logLevel?log=\ *---------------+--------------+ -