more storm subcommands; add a README.md
This commit is contained in:
halfelf
parent
b4e903eb4f
commit
5f6c5b1268
96
plugins/storm/README.md
Normal file
96
plugins/storm/README.md
Normal file
@ -0,0 +1,96 @@
|
||||
# storm - Apache Storm command line client
|
||||
|
||||
Storm command line autocompletion plugin.
|
||||
|
||||
For more information, see [storm documentations](http://storm.incubator.apache.org/documentation/Command-line-client.html), or `storm help`.
|
||||
|
||||
## INSTALLATION
|
||||
|
||||
Just add the plugin to your `.zshrc`:
|
||||
|
||||
```bash
|
||||
plugins=(foo bar storm)
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
`storm`, then press tab
|
||||
|
||||
## OPTIONS
|
||||
|
||||
`storm activate topology-name`
|
||||
|
||||
Activates the specified topology's spouts.
|
||||
|
||||
`storm classpath`
|
||||
|
||||
Prints the classpath used by the storm client when running commands.
|
||||
|
||||
`storm deactivate topology-name`
|
||||
|
||||
Deactivates the specified topology's spouts.
|
||||
|
||||
`storm dev-zookeeper`
|
||||
|
||||
Launches a fresh Zookeeper server using "dev.zookeeper.path" as its local dir and "storm.zookeeper.port" as its port. This is only intended for development/testing, the Zookeeper instance launched is not configured to be used in production.
|
||||
|
||||
`storm drpc`
|
||||
|
||||
Launches a DRPC daemon. This command should be run under supervision with a tool like daemontools or monit. See [Distributed RPC](http://storm.incubator.apache.org/documentation/Distributed-RPC) for more information.
|
||||
|
||||
`storm help`
|
||||
|
||||
Print one help message or list of available commands.
|
||||
|
||||
|
||||
`storm jar topology-jar-path class ...`
|
||||
|
||||
Runs the main method of class with the specified arguments. The storm jars and configs in ~/.storm are put on the classpath. The process is configured so that [StormSubmitter](http://storm.incubator.apache.org/apidocs/backtype/storm/StormSubmitter.html) will upload the jar at topology-jar-path when the topology is submitted.
|
||||
|
||||
`storm kill topology-name [-w wait-time-secs]`
|
||||
|
||||
Kills the topology with the name topology-name. Storm will first deactivate the topology's spouts for the duration of the topology's message timeout to allow all messages currently being processed to finish processing. Storm will then shutdown the workers and clean up their state. You can override the length of time Storm waits between deactivation and shutdown with the -w flag.
|
||||
|
||||
`storm list`
|
||||
|
||||
List the running topologies and their statuses.
|
||||
|
||||
`storm localconfvalue conf-name`
|
||||
|
||||
Prints out the value for conf-name in the local Storm configs. The local Storm configs are the ones in ~/.storm/storm.yaml merged in with the configs in defaults.yaml.
|
||||
|
||||
`storm logviewer`
|
||||
|
||||
Launches the log viewer daemon. It provides a web interface for viewing storm log files. This command should be run under supervision with a tool like daemontools or monit. See [Setting up a Storm cluster](http://storm.incubator.apache.org/documentation/Setting-up-a-Storm-cluster) for more information.
|
||||
|
||||
`storm nimbus`
|
||||
|
||||
Launches the nimbus daemon. This command should be run under supervision with a tool like daemontools or monit. See [Setting up a Storm cluster](http://storm.incubator.apache.org/documentation/Setting-up-a-Storm-cluster) for more information.
|
||||
|
||||
`storm rebalance topology-name [-w wait-time-secs] [-n new-num-workers] [-e component=parallelism]*`
|
||||
|
||||
Sometimes you may wish to spread out where the workers for a topology are running. For example, let's say you have a 10 node cluster running 4 workers per node, and then let's say you add another 10 nodes to the cluster. You may wish to have Storm spread out the workers for the running topology so that each node runs 2 workers. One way to do this is to kill the topology and resubmit it, but Storm provides a "rebalance" command that provides an easier way to do this.
|
||||
|
||||
Rebalance will first deactivate the topology for the duration of the message timeout (overridable with the -w flag) and then redistribute the workers evenly around the cluster. The topology will then return to its previous state of activation (so a deactivated topology will still be deactivated and an activated topology will go back to being activated).
|
||||
|
||||
The rebalance command can also be used to change the parallelism of a running topology. Use the -n and -e switches to change the number of workers or number of executors of a component respectively.
|
||||
|
||||
`storm remoteconfvalue conf-name`
|
||||
|
||||
Prints out the value for conf-name in the cluster's Storm configs. The cluster's Storm configs are the ones in `$STORM-PATH/conf/storm.yaml` merged in with the configs in `defaults.yaml`. This command must be run on a cluster machine.
|
||||
|
||||
`storm repl`
|
||||
|
||||
Opens up a Clojure REPL with the storm jars and configuration on the classpath. Useful for debugging.
|
||||
|
||||
`storm supervisor`
|
||||
|
||||
Launches the supervisor daemon. This command should be run under supervision with a tool like daemontools or monit. See [Setting up a Storm cluster](http://storm.incubator.apache.org/documentation/Setting-up-a-Storm-cluster) for more information.
|
||||
|
||||
`storm ui`
|
||||
|
||||
Launches the UI daemon. The UI provides a web interface for a Storm cluster and shows detailed stats about running topologies. This command should be run under supervision with a tool like daemontools or monit. See [Setting up a Storm cluster](http://storm.incubator.apache.org/documentation/Setting-up-a-Storm-cluster) for more information.
|
||||
|
||||
`storm version`
|
||||
|
||||
Prints the version number of this Storm release.
|
||||
@ -5,19 +5,22 @@ function _storm_commands() {
|
||||
case $state in
|
||||
subcommand)
|
||||
subcommands=(
|
||||
"activate:Activates the specified topology’s spouts."
|
||||
"classpath:Prints the classpath used by the storm client when running commands."
|
||||
"deactivate:Deactivates the specified topology’s spouts."
|
||||
"dev-zookeeper:Launches a fresh Zookeeper server for development/testing."
|
||||
"drpc:Launches a DRPC daemon."
|
||||
"help:Print usage."
|
||||
"jar:Runs the main method of class with the specified arguments."
|
||||
"kill:Kills the topology with the name topology-name."
|
||||
"activate:Activates the specified topology’s spouts."
|
||||
"deactivate:Deactivates the specified topology’s spouts."
|
||||
"localconfvalue:Prints out the value for conf-name in the local Storm configs."
|
||||
"logviewer:Launches the log viewer daemon."
|
||||
"rebalance:Spread out where the workers for a topology are running."
|
||||
"repl:Opens up a Clojure REPL with the storm jars and configuration on the classpath."
|
||||
"classpath:Prints the classpath used by the storm client when running commands."
|
||||
"localconfvalue:Prints out the value for conf-name in the local Storm configs."
|
||||
"remoteconfvalue:Prints out the value for conf-name in the cluster’s Storm configs."
|
||||
"nimbus:Launches the nimbus daemon."
|
||||
"supervisor:Launches the supervisor daemon."
|
||||
"ui:Launches the UI daemon."
|
||||
"drpc:Launches a DRPC daemon. "
|
||||
"version:Print version."
|
||||
)
|
||||
_describe -t subcommands 'storm subcommands' subcommands && ret=0
|
||||
esac
|
||||
|
||||
Loading…
Reference in New Issue
Block a user