You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@slider.apache.org by "Gour Saha (JIRA)" <ji...@apache.org> on 2014/09/26 04:07:34 UTC

[jira] [Created] (SLIDER-458) Slider CLI help is very verbose

Gour Saha created SLIDER-458:
--------------------------------

             Summary: Slider CLI help is very verbose
                 Key: SLIDER-458
                 URL: https://issues.apache.org/jira/browse/SLIDER-458
             Project: Slider
          Issue Type: Bug
            Reporter: Gour Saha


The Slider CLI help is very verbose. In fact just typing {{./slider}} does not print the usage. A user has to literally type {{./slider help}}

The default output of both hdfs and yarn CLIs are very slick and the help can be drilled down progressively to different levels.

Here is what Slider CLI outputs today (in comparison to yarn CLI) -

{noformat}
[yarn@c6410 bin]$ ./slider help
slider_home = "/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT"
slider_jvm_opts = "-Djava.net.preferIPv4Stack=true -Djava.awt.headless=true -Xmx256m -Djava.confdir=/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT/conf"
classpath = "/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT/lib/*:/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT/conf::"

command is java -Djava.net.preferIPv4Stack=true -Djava.awt.headless=true -Xmx256m -Djava.confdir=/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT/conf --classpath "/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT/lib/*:/vagrant/slider_home/slider-0.51.0-incubating-SNAPSHOT/conf::" org.apache.slider.Slider help


2014-09-26 01:46:49,169 [main] INFO  client.SliderClient -
  Usage: <main class> [options]   [command] [command options]
    Options:
          --help

         Default: false
  Commands:
      am-suicide      Tell the Slider Application Master to simulate a process failure by terminating itself
      Usage: am-suicide [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
              --exitcode
             exit code
             Default: 1
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
              --message
             reason for the action
              --wait
             time for AM to wait before exiting
             Default: 1000
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      build      Build a Slider cluster specification -but do not start it
      Usage: build [options]
        Options:
              --appconf
             Path to cluster configuration directory in HDFS
              --apphome
             Home directory of a pre-installed application
              --basepath
             Slider base path on the filesystem
          --component, --comp, --role
             --component <name> <count>
             Default: []
          --compopt, --co, --roleopt
             Component option --compopt <component> <name> <option>
             Default: []
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --image
             The full path to a .tar or .tar.gz path containing the application
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          --option, -O
             --option<name> <value>
             Default: []
              --package
             URI to a slider package
              --provider
             Provider of the specific cluster application
             Default: agent
              --queue
             Queue to submit the application
          --rescompopt, --rco
             Component resource option --rescompopt <component> <name> <option>
             Default: []
          --resopt, -ro
             Resource option --resopt<name> <value>
             Default: []
              --resources
             File defining the resources of this instance
              --template
             Template application configuration
              --zkhosts
             comma separated list of the Zookeeper hosts
              --zkpath
             Zookeeper path for the application
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      create      Create a live Slider application
      Usage: create [options]
        Options:
              --appconf
             Path to cluster configuration directory in HDFS
              --apphome
             Home directory of a pre-installed application
              --basepath
             Slider base path on the filesystem
          --component, --comp, --role
             --component <name> <count>
             Default: []
          --compopt, --co, --roleopt
             Component option --compopt <component> <name> <option>
             Default: []
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --image
             The full path to a .tar or .tar.gz path containing the application
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          --option, -O
             --option<name> <value>
             Default: []
              --package
             URI to a slider package
              --provider
             Provider of the specific cluster application
             Default: agent
              --queue
             Queue to submit the application
          --rescompopt, --rco
             Component resource option --rescompopt <component> <name> <option>
             Default: []
          --resopt, -ro
             Resource option --resopt<name> <value>
             Default: []
              --resources
             File defining the resources of this instance
              --rm
             Resource manager hostname:port
              --template
             Template application configuration
              --wait
             time to wait for an action to complete
             Default: 0
              --zkhosts
             comma separated list of the Zookeeper hosts
              --zkpath
             Zookeeper path for the application
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      update      Update template for a Slider application
      Usage: update [options]
        Options:
              --appconf
             Path to cluster configuration directory in HDFS
              --apphome
             Home directory of a pre-installed application
              --basepath
             Slider base path on the filesystem
          --component, --comp, --role
             --component <name> <count>
             Default: []
          --compopt, --co, --roleopt
             Component option --compopt <component> <name> <option>
             Default: []
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --image
             The full path to a .tar or .tar.gz path containing the application
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          --option, -O
             --option<name> <value>
             Default: []
              --package
             URI to a slider package
              --provider
             Provider of the specific cluster application
             Default: agent
              --queue
             Queue to submit the application
          --rescompopt, --rco
             Component resource option --rescompopt <component> <name> <option>
             Default: []
          --resopt, -ro
             Resource option --resopt<name> <value>
             Default: []
              --resources
             File defining the resources of this instance
              --template
             Template application configuration
              --zkhosts
             comma separated list of the Zookeeper hosts
              --zkpath
             Zookeeper path for the application
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      destroy      Destroy a frozen Slider application)
      Usage: destroy [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      exists      Probe for an application running
      Usage: exists [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --live
             verify that the cluster is running
             Default: false
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      flex      Flex a Slider application
      Usage: flex [options]
        Options:
              --basepath
             Slider base path on the filesystem
          --component, --comp, --role
             --component <name> <count>
             Default: []
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      stop      Stop a running application
      Usage: stop [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --force
             force the operation
             Default: false
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
              --message
             reason for the operation
             Default: stop command issued
              --wait
             time to wait for an action to complete
             Default: 0
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      getconf      Get the configuration of an application
      Usage: getconf [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --format
             Format for a response: [text|xml|json|properties]
             Default: xml
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          --out, -o
             Output file for the configuration data
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      kill-container      Kill a container in the application
      Usage: kill-container [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
              --id
             ID of the container
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      list      List running Slider applications
      Usage: list [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      registry      Query the registry of a YARN application
      Usage: registry [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
              --dest
             Output destination
          --fs, --filesystem
             Filesystem Binding
              --format
             Format for a response: <xml|json|properties>
             Default: xml
              --getconf
             get configuration
              --getfiles
             get files
              --internal
             fetch internal registry entries
             Default: false
              --list
             list services
             Default: false
              --listconf
             list configurations
             Default: false
              --listfiles
             list files
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
              --name
             name of an instance
              --servicetype
             optional service type
             Default: org-apache-slider
              --verbose
             verbose output
             Default: false
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      status      Get the status of an application
      Usage: status [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          --out, -o
             Output file for the configuration data
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      start      Start a stopped application
      Usage: start [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
              --rm
             Resource manager hostname:port
              --wait
             time to wait for an action to complete
             Default: 0
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      help      Print help information
      Usage: help [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      usage      Print help information
      Usage: usage [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      version      Print the Slider version information
      Usage: version [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []

      install-package      Install the application package in the home directory under sub-folder packages
      Usage: install-package [options]
        Options:
              --basepath
             Slider base path on the filesystem
              --debug
             Debug mode
             Default: false
          --fs, --filesystem
             Filesystem Binding
          --m, --manager
             Binding (usually hostname:port) of the YARN resource manager
              --name
             The type of the package
              --package
             Path to app package on local disk
              --replacepkg
             Overwrite existing package
             Default: false
          -D
             Definitions
             Default: []
          -S
             system properties in the form name value These are set after the
             JVM is started.
             Default: []


actions:
2014-09-26 01:46:49,183 [main] INFO  util.ExitUtil - Exiting with status 0
{noformat}

This is what yarn CLI outputs today -

{noformat}
[yarn@c6410 bin]$ yarn
Usage: yarn [--config confdir] COMMAND
where COMMAND is one of:
  resourcemanager -format-state-store   deletes the RMStateStore
  resourcemanager                       run the ResourceManager
  nodemanager                           run a nodemanager on each slave
  timelineserver                        run the timeline server
  rmadmin                               admin tools
  version                               print the version
  jar <jar>                             run a jar file
  application                           prints application(s)
                                        report/kill application
  applicationattempt                    prints applicationattempt(s)
                                        report
  container                             prints container(s) report
  node                                  prints node report(s)
  logs                                  dump container logs
  classpath                             prints the class path needed to
                                        get the Hadoop jar and the
                                        required libraries
  daemonlog                             get/set the log level for each
                                        daemon
 or
  CLASSNAME                             run the class named CLASSNAME
Most commands print help when invoked w/o parameters.
{noformat}





--
This message was sent by Atlassian JIRA
(v6.3.4#6332)