This is an automated email from the ASF dual-hosted git repository. mmerli pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git
The following commit(s) were added to refs/heads/master by this push: new fadb667 Update CLI documentation (WIP) (#1296) fadb667 is described below commit fadb667a3da40de3e8a4b0312fad54bc8ee9aa6d Author: Luc Perkins <lucperk...@gmail.com> AuthorDate: Mon Feb 26 20:06:04 2018 -0800 Update CLI documentation (WIP) (#1296) * add new flags on pulsar.yaml * add compact-topic command * add more commands --- site/_data/cli/pulsar-admin.yaml | 33 +++++++++++++++++++++++++++++---- site/_data/cli/pulsar.yaml | 20 +++++++++++++++++++- 2 files changed, 48 insertions(+), 5 deletions(-) diff --git a/site/_data/cli/pulsar-admin.yaml b/site/_data/cli/pulsar-admin.yaml index eb7c805..7260e5d 100644 --- a/site/_data/cli/pulsar-admin.yaml +++ b/site/_data/cli/pulsar-admin.yaml @@ -27,7 +27,8 @@ commands: description: Dump allocator stats argument: allocator-name - name: destinations - description: Dump destination stats + deprecated: true + description: Dump topic stats options: - flags: -i, --indent description: Indent JSON output @@ -44,6 +45,12 @@ commands: - flags: -i, --indent description: Indent JSON output default: 'false' + - name: topics + description: Dump topic stats + options: + - flags: -i, --indent + description: Indent JSON output + default: 'false' - name: brokers description: Operations about brokers subcommands: @@ -67,6 +74,8 @@ commands: description: Get list of updatable configuration name - name: get-all-dynamic-config description: Get all overridden dynamic-configuration values + - name: get-internal-config + description: Get internal configuration information - name: clusters description: Operations about clusters subcommands: @@ -392,6 +401,16 @@ commands: - name: non-persistent description: Operations on persistent topics subcommands: + - name: create-partitioned-topic + description: Create a partitioned topic. A partitioned non-persistent topic must be created before producers can publish to it. + argument: non-persistent://property/cluster/namespace/topic + options: + - flags: -p, --partitions + description: The number of partitions for the topic + default: 0 + - name: lookup + description: Look up a non-persistent topic on the current serving broker + argument: non-persistent://property/cluster/namespace/topic - name: stats description: Get the stats for the topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period. argument: non-persistent://property/cluster/namespace/topic @@ -401,9 +420,15 @@ commands: - name: get-partitioned-topic-metadata description: Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, this will return an empty topic with zero partitions. argument: non-persistent://property/cluster/namespace/topic - - name: unload - description: Unload a topic - argument: non-persistent://property/cluster/namespace/topic + - name: list + description: Get a list of non-persistent topics under a namespace + argument: property/cluster/namespace + - name: list-in-bundle + description: Get a list of non-persistent topics present under a namespace bundle + argument: property/cluster/namespace + options: + - flags: -b, --bundle + description: The bundle range - name: properties description: Operations about properties subcommands: diff --git a/site/_data/cli/pulsar.yaml b/site/_data/cli/pulsar.yaml index 650b18a..fee9b84 100644 --- a/site/_data/cli/pulsar.yaml +++ b/site/_data/cli/pulsar.yaml @@ -47,8 +47,24 @@ commands: pulsar broker \ --conf /path/to/broker.conf options: - - flags: -c, --conf + - flags: -c, --broker-conf description: Configuration file for the broker + - flags: -bc, --bookie-conf + description: Configuration file for BookKeeper + - flags: -rb, --run-bookie + description: Run a BookKeeper bookie on the same host as the Pulsar broker + default: 'false' + - flags: -ra, --run-bookie-autorecovery + description: Run a BookKeeper autorecovery daemon on the same host as the Pulsar broker + default: 'false' +- name: compact-topic + description: Run compaction against a Pulsar topic + example: | + pulsar compact-topic \ + --topic persistent://sample/standalone/ns1/topic-to-compact + options: + - flags: -t, --topic + description: The Pulsar topic that you would like to compact - name: discovery description: Run a discovery server example: | @@ -137,6 +153,8 @@ commands: options: - flags: -c, --conf description: Configuration file for ZooKeeper +- name: zookeeper-shell + description: Opens up a shell client to the ZooKeeper cluster used by Pulsar env_vars: - name: PULSAR_LOG_CONF description: Log4j configuration file -- To stop receiving notification emails like this one, please contact mme...@apache.org.