merlimat closed pull request #1296: Update CLI documentation (WIP)
URL: https://github.com/apache/incubator-pulsar/pull/1296
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/site/_data/cli/pulsar-admin.yaml b/site/_data/cli/pulsar-admin.yaml
index eb7c8059b..7260e5d02 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 650b18a7e..fee9b84dc 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
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
