You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by zh...@apache.org on 2015/01/12 19:19:07 UTC
[25/34] hadoop git commit: YARN-3002. YARN documentation needs
updating post-shell rewrite (aw)
YARN-3002. YARN documentation needs updating post-shell rewrite (aw)
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/ee3b5c65
Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/ee3b5c65
Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/ee3b5c65
Branch: refs/heads/HDFS-EC
Commit: ee3b5c658bcf75cc822fd805edb61aab1eedb9d0
Parents: 8f2e17e
Author: Allen Wittenauer <aw...@apache.org>
Authored: Fri Jan 9 15:01:29 2015 -0800
Committer: Zhe Zhang <zh...@apache.org>
Committed: Mon Jan 12 10:18:02 2015 -0800
----------------------------------------------------------------------
hadoop-yarn-project/CHANGES.txt | 2 +
.../src/site/apt/TimelineServer.apt.vm | 2 +-
.../src/site/apt/YarnCommands.apt.vm | 272 ++++++++++++-------
3 files changed, 179 insertions(+), 97 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hadoop/blob/ee3b5c65/hadoop-yarn-project/CHANGES.txt
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/CHANGES.txt b/hadoop-yarn-project/CHANGES.txt
index 514c282..bcd3c5b 100644
--- a/hadoop-yarn-project/CHANGES.txt
+++ b/hadoop-yarn-project/CHANGES.txt
@@ -32,6 +32,8 @@ Trunk - Unreleased
YARN-2525. yarn logs command gives error on trunk (Akira AJISAKA via aw)
+ YARN-3002. YARN documentation needs updating post-shell rewrite (aw)
+
Release 2.7.0 - UNRELEASED
INCOMPATIBLE CHANGES
http://git-wip-us.apache.org/repos/asf/hadoop/blob/ee3b5c65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/TimelineServer.apt.vm
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/TimelineServer.apt.vm b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/TimelineServer.apt.vm
index 6c8203c..7bb504e 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/TimelineServer.apt.vm
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/TimelineServer.apt.vm
@@ -215,7 +215,7 @@ YARN Timeline Server
Or users can start the Timeline server / history service as a daemon:
+---+
- $ yarn-daemon.sh start timelineserver
+ $ yarn --daemon start timelineserver
+---+
* Accessing generic-data via command-line
http://git-wip-us.apache.org/repos/asf/hadoop/blob/ee3b5c65/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm
index cf41271..2de901b 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/apt/YarnCommands.apt.vm
@@ -11,70 +11,49 @@
~~ limitations under the License. See accompanying LICENSE file.
---
- Yarn Commands
+ YARN Commands
---
---
${maven.build.timestamp}
-Yarn Commands
+YARN Commands
%{toc|section=1|fromDepth=0}
* Overview
- Yarn commands are invoked by the bin/yarn script. Running the yarn script
+ 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] [--loglevel loglevel] COMMAND
-------
+ Usage: <<<yarn [SHELL_OPTIONS] COMMAND [GENERIC_OPTIONS] [COMMAND_OPTIONS]>>>
- Yarn has an option parsing framework that employs parsing generic options as
+ 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.
-*---------------+--------------+
-| --loglevel loglevel | Overwrites the log level. Valid log levels are FATAL,
-| | ERROR, WARN, INFO, DEBUG, and TRACE. Default is INFO.
-*---------------+--------------+
+*-------------------------+-------------+
+| SHELL_OPTIONS | The common set of shell options. These are documented on the {{{../../hadoop-project-dist/hadoop-common/CommandsManual.html#Shell Options}Commands Manual}} page.
+*-------------------------+----+
+| GENERIC_OPTIONS | The common set of options supported by multiple commands. See the Hadoop {{{../../hadoop-project-dist/hadoop-common/CommandsManual.html#Generic Options}Commands Manual}} for more information.
+*------------------+---------------+
| 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
+** <<<application>>>
- 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...
--------
-
-** application
-
- Prints application(s) report/kill application
-
--------
- Usage: yarn application <options>
--------
+ Usage: <<<yarn application [options] >>>
*---------------+--------------+
|| COMMAND_OPTIONS || Description |
*---------------+--------------+
-| -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.
-*---------------+--------------+
| -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: \
@@ -84,40 +63,66 @@ Usage: yarn [--config confdir] [--loglevel loglevel] COMMAND
| -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.
+| -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.
*---------------+--------------+
| -kill ApplicationId | Kills the application.
*---------------+--------------+
+| -status ApplicationId | Prints the status of the application.
+*---------------+--------------+
-** node
+ Prints application(s) report/kill application
- Prints node report(s)
+** <<<applicationattempt>>>
--------
- Usage: yarn node <options>
--------
+ Usage: <<<yarn applicationattempt [options] >>>
*---------------+--------------+
|| COMMAND_OPTIONS || Description |
*---------------+--------------+
-| -list | Lists all running nodes. Supports optional use of -states to filter
-| | nodes based on node state, and -all to list all nodes.
+| -help | Help
*---------------+--------------+
-| -states States | Works with -list to filter nodes based on input
-| | comma-separated list of node states.
+| -list ApplicationId | Lists applications attempts from the RM
*---------------+--------------+
-| -all | Works with -list to list all nodes.
+| -status Application Attempt Id | Prints the status of the application attempt.
*---------------+--------------+
-| -status NodeId | Prints the status report of the node.
+
+ prints applicationattempt(s) report
+
+** <<<classpath>>>
+
+ Usage: <<<yarn classpath>>>
+
+ Prints the class path needed to get the Hadoop jar and the required libraries
+
+
+** <<<container>>>
+
+ Usage: <<<yarn container [options] >>>
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description |
+*---------------+--------------+
+| -help | Help
+*---------------+--------------+
+| -list ApplicationId | Lists containers for the application attempt.
+*---------------+--------------+
+| -status ContainerId | Prints the status of the container.
*---------------+--------------+
-** logs
+ prints container(s) report
- Dump the container logs
+** <<<jar>>>
+
+ Usage: <<<yarn jar <jar> [mainClass] args... >>>
+
+ Runs a jar file. Users can bundle their YARN code in a jar file and execute
+ it using this command.
+
+** <<<logs>>>
--------
- Usage: yarn logs -applicationId <application ID> <options>
--------
+ Usage: <<<yarn logs -applicationId <application ID> [options] >>>
*---------------+--------------+
|| COMMAND_OPTIONS || Description |
@@ -130,77 +135,125 @@ Usage: yarn [--config confdir] [--loglevel loglevel] COMMAND
| -containerId ContainerId | ContainerId (must be specified if node address is
| | specified)
*---------------+--------------+
+| -help | Help
+*---------------+--------------+
| -nodeAddress NodeAddress | NodeAddress in the format nodename:port (must be
| | specified if container id is specified)
*---------------+--------------+
-** classpath
+ Dump the container logs
+
- Prints the class path needed to get the Hadoop jar and the required libraries
+** <<<node>>>
+
+ Usage: <<<yarn node [options] >>>
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description |
+*---------------+--------------+
+| -all | Works with -list to list all nodes.
+*---------------+--------------+
+| -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.
+*---------------+--------------+
+| -status NodeId | Prints the status report of the node.
+*---------------+--------------+
+
+ Prints node report(s)
--------
- Usage: yarn classpath
--------
+** <<<queue>>>
-** version
+ Usage: <<<yarn queue [options] >>>
+
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description |
+*---------------+--------------+
+| -help | Help
+*---------------+--------------+
+| -status QueueName | Prints the status of the queue.
+*---------------+--------------+
- Prints the version.
+ Prints queue information
--------
- Usage: yarn version
--------
+** <<<version>>>
+
+ Usage: <<<yarn version>>>
+
+ Prints the Hadoop version.
* {Administration Commands}
Commands useful for administrators of a Hadoop cluster.
-** resourcemanager
+** <<<daemonlog>>>
- Start the ResourceManager
+ Usage:
--------
- Usage: yarn resourcemanager [-format-state-store]
--------
+---------------------------------
+ yarn daemonlog -getlevel <host:port> <name>
+ yarn daemonlog -setlevel <host:port> <name> <level>
+---------------------------------
*---------------+--------------+
|| COMMAND_OPTIONS || Description |
*---------------+--------------+
-| -format-state-store | Formats the RMStateStore. This will clear the
-| | RMStateStore and is useful if past applications are no
-| | longer needed. This should be run only when the
-| | ResourceManager is not running.
+| -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\>
*---------------+--------------+
-** nodemanager
+ Get/Set the log level for each daemon.
+
+
+** <<<nodemanager>>>
+
+ Usage: <<<yarn nodemanager>>>
Start the NodeManager
--------
- Usage: yarn nodemanager
--------
+** <<<proxyserver>>>
-** proxyserver
+ Usage: <<<yarn proxyserver>>>
Start the web proxy server
--------
- Usage: yarn proxyserver
--------
+** <<<resourcemanager>>>
-** rmadmin
+ Usage: <<<yarn resourcemanager [-format-state-store]>>>
- Runs ResourceManager admin client
+*---------------+--------------+
+|| COMMAND_OPTIONS || Description |
+*---------------+--------------+
+| -format-state-store | Formats the RMStateStore. This will clear the
+| | RMStateStore and is useful if past applications are no
+| | longer needed. This should be run only when the
+| | ResourceManager is not running.
+*---------------+--------------+
+
+ Start the ResourceManager
+
+
+** <<<rmadmin>>>
+
+ Usage:
--------
- Usage: yarn rmadmin [-refreshQueues] [-refreshNodes] [-refreshUserToGroupsMapping]
- [-refreshSuperUserGroupsConfiguration] [-refreshAdminAcls]
+----
+ yarn rmadmin [-refreshQueues] [-refreshNodes] [-refreshUserToGroupsMapping]
+ [-refreshSuperUserGroupsConfiguration] [-refreshAdminAcls]
[-refreshServiceAcl] [-getGroups [username]] [-help [cmd]]
[-transitionToActive <serviceId>]
[-transitionToStandby <serviceId>]
[-getServiceState <serviceId>]
[-checkHealth <serviceId>]
--------
+----
*---------------+--------------+
|| COMMAND_OPTIONS || Description |
@@ -240,25 +293,52 @@ Usage: yarn [--config confdir] [--loglevel loglevel] COMMAND
| | non-zero exit code if the check fails.
*---------------+--------------+
-** daemonlog
+ Runs ResourceManager admin client
- Get/Set the log level for each daemon.
+** scmadmin
--------
- Usage: yarn daemonlog -getlevel <host:port> <name>
- Usage: yarn daemonlog -setlevel <host:port> <name> <level>
--------
+ Usage: <<<yarn scmadmin [options] >>>
*---------------+--------------+
|| 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\>
+| -help | Help
*---------------+--------------+
-| -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\>
+| -runCleanerTask | Runs the cleaner task
*---------------+--------------+
+ Runs Shared Cache Manager admin client
+
+
+** sharedcachemanager
+
+ Usage: <<<yarn sharedcachemanager>>>
+
+ Start the Shared Cache Manager
+
+** timelineserver
+
+ Usage: <<<yarn timelineserver>>>
+
+ Start the TimeLineServer
+
+
+* Files
+
+** <<etc/hadoop/hadoop-env.sh>>
+
+ This file stores the global settings used by all Hadoop shell commands.
+
+** <<etc/hadoop/yarn-env.sh>>
+
+ This file stores overrides used by all YARN shell commands.
+
+** <<etc/hadoop/hadoop-user-functions.sh>>
+
+ This file allows for advanced users to override some shell functionality.
+
+** <<~/.hadooprc>>
+ This stores the personal environment for an individual user. It is
+ processed after the <<<hadoop-env.sh>>>, <<<hadoop-user-functions.sh>>>, and <<<yarn-env.sh>>> files
+ and can contain the same settings.