[YARN-1531] True up yarn command documentation

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.4.0
• Component/s: documentation
• Labels: documentaion
• Hadoop Flags: Reviewed
• Assignee: Akira Ajisaka
• Reporter: Akira Ajisaka
• Created: 24/Dec/13 09:37
• Updated: 10/Apr/14 13:11
• Resolved: 12/Feb/14 22:32

Description

There are some options which are not written to Yarn Command document.
For example, "yarn rmadmin" command options are as follows:

 Usage: yarn rmadmin
   -refreshQueues 
   -refreshNodes 
   -refreshSuperUserGroupsConfiguration 
   -refreshUserToGroupsMappings 
   -refreshAdminAcls 
   -refreshServiceAcl 
   -getGroups [username]
   -help [cmd]
   -transitionToActive <serviceId>
   -transitionToStandby <serviceId>
   -failover [--forcefence] [--forceactive] <serviceId> <serviceId>
   -getServiceState <serviceId>
   -checkHealth <serviceId>

But some of the new options such as "-getGroups", "-transitionToActive", and "-transitionToStandby" are not documented.

Issue Links

• blocks: YARN-1570 Formatting the lines within 80 chars in YarnCommands.apt.vm
• is related to: YARN-1480 RM web services getApps() accepts many more filters than ApplicationCLI "list" command