You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/10/17 12:02:03 UTC
[pulsar-site] branch main updated: Docs sync done from apache/pulsar(#0c7a0d1)
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 3b511a90033 Docs sync done from apache/pulsar(#0c7a0d1)
3b511a90033 is described below
commit 3b511a90033c0866cf1a641ddc4341f3538b1a9d
Author: Pulsar Site Updater <de...@pulsar.apache.org>
AuthorDate: Mon Oct 17 12:01:59 2022 +0000
Docs sync done from apache/pulsar(#0c7a0d1)
---
.../website-next/docs/reference-cli-bookkeeper.md | 106 ++
.../website-next/docs/reference-cli-broker-tool.md | 36 +
.../docs/reference-cli-pulsar-daemon.md | 48 +
.../docs/reference-cli-pulsar-shell.md | 155 +++
site2/website-next/docs/reference-cli-tools.md | 1069 +-------------------
site2/website-next/docs/reference-pulsar-admin.md | 13 +
6 files changed, 370 insertions(+), 1057 deletions(-)
diff --git a/site2/website-next/docs/reference-cli-bookkeeper.md b/site2/website-next/docs/reference-cli-bookkeeper.md
new file mode 100644
index 00000000000..2f6cf6ac7e8
--- /dev/null
+++ b/site2/website-next/docs/reference-cli-bookkeeper.md
@@ -0,0 +1,106 @@
+---
+id: reference-cli-bookkeeper
+title: Pulsar CLI tools - bookkeeper
+sidebar_label: "cli-bookkeeper"
+---
+
+## `bookkeeper`
+A tool for managing BookKeeper.
+
+Usage
+
+```bash
+bookkeeper command
+```
+
+Environment variables
+
+The table below lists the environment variables that you can use to configure the bookkeeper tool.
+
+|Variable|Description|Default|
+|---|---|---|
+|BOOKIE_LOG_CONF|Log4j configuration file|conf/log4j2.yaml|
+|BOOKIE_CONF|BookKeeper configuration file|conf/bk_server.conf|
+|BOOKIE_EXTRA_OPTS|Extra options to be passed to the JVM||
+|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath||
+|ENTRY_FORMATTER_CLASS|The Java class used to format entries||
+|BOOKIE_PID_DIR|Folder where the BookKeeper server PID file should be stored||
+|BOOKIE_STOP_TIMEOUT|Wait time before forcefully killing the Bookie server instance if attempts to stop it are not successful||
+|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
+
+
+### `autorecovery`
+Runs an auto-recovery service
+
+Usage
+
+```bash
+bookkeeper autorecovery options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-c`, `--conf`|Configuration for the auto-recovery||
+
+
+### `bookie`
+Starts up a BookKeeper server (aka bookie)
+
+Usage
+
+```bash
+bookkeeper bookie options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-c`, `--conf`|Configuration for the auto-recovery||
+|-readOnly|Force start a read-only bookie server|false|
+|-withAutoRecovery|Start auto-recovery service bookie server|false|
+
+
+### `localbookie`
+Runs a test ensemble of N bookies locally
+
+Usage
+
+```bash
+bookkeeper localbookie N
+```
+
+### `upgrade`
+Upgrade the bookie’s filesystem
+
+Usage
+
+```bash
+bookkeeper upgrade options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-c`, `--conf`|Configuration for the auto-recovery||
+|`-u`, `--upgrade`|Upgrade the bookie’s directories||
+
+
+### `shell`
+Run shell for admin commands. To see a full listing of those commands, run bookkeeper shell without an argument.
+
+Usage
+
+```bash
+bookkeeper shell
+```
+
+Example
+
+```bash
+bookkeeper shell bookiesanity
+```
+
diff --git a/site2/website-next/docs/reference-cli-broker-tool.md b/site2/website-next/docs/reference-cli-broker-tool.md
new file mode 100644
index 00000000000..56e2de9f5a2
--- /dev/null
+++ b/site2/website-next/docs/reference-cli-broker-tool.md
@@ -0,0 +1,36 @@
+---
+id: reference-cli-broker-tool
+title: Pulsar CLI tools - broker-tool
+sidebar_label: "cli-broker-tool"
+---
+
+## `broker-tool`
+
+The `broker- tool` is used for operations on a specific broker.
+
+Usage
+
+```bash
+broker-tool command
+```
+
+Example
+
+Two ways to get more information about a command as below:
+
+```bash
+broker-tool help command
+broker-tool command --help
+```
+
+### `load-report`
+
+Collect the load report of a specific broker.
+The command is run on a broker, and used for troubleshooting why broker can’t collect right load report.
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-i`, `--interval`| Interval to collect load report, in milliseconds ||
+|`-h`, `--help`| Display help information ||
diff --git a/site2/website-next/docs/reference-cli-pulsar-daemon.md b/site2/website-next/docs/reference-cli-pulsar-daemon.md
new file mode 100644
index 00000000000..b210f1793da
--- /dev/null
+++ b/site2/website-next/docs/reference-cli-pulsar-daemon.md
@@ -0,0 +1,48 @@
+---
+id: reference-cli-pulsar-daemon
+title: Pulsar CLI tools - pulsar-daemon
+sidebar_label: "cli-pulsar-daemon"
+---
+
+## `pulsar-daemon`
+
+A wrapper around the pulsar tool that’s used to start and stop processes, such as ZooKeeper, bookies, and Pulsar brokers, in the background using nohup.
+
+pulsar-daemon has a similar interface to the pulsar command but adds start and stop commands for various services. For a listing of those services, run pulsar-daemon to see the help output or see the documentation for the pulsar command.
+
+Usage
+
+```bash
+pulsar-daemon command
+```
+
+### `start`
+Start a service in the background using nohup.
+
+Usage
+
+```bash
+pulsar-daemon start service
+```
+
+### `stop`
+Stop a service that’s already been started using start.
+
+Usage
+
+```bash
+pulsar-daemon stop service options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|-force|Stop the service forcefully if not stopped by normal shutdown.|false|
+
+### `restart`
+Restart a service that has already been started.
+
+```bash
+pulsar-daemon restart service
+```
\ No newline at end of file
diff --git a/site2/website-next/docs/reference-cli-pulsar-shell.md b/site2/website-next/docs/reference-cli-pulsar-shell.md
new file mode 100644
index 00000000000..fc22af59034
--- /dev/null
+++ b/site2/website-next/docs/reference-cli-pulsar-shell.md
@@ -0,0 +1,155 @@
+---
+id: reference-cli-pulsar-shell
+title: Pulsar CLI tools - pulsar-shell
+sidebar_label: "cli-pulsar-shell"
+---
+
+## `pulsar-shell`
+
+[Pulsar shell](administration-pulsar-shell.md) tool.
+
+### Interactive mode
+
+Usage
+
+```bash
+pulsar-shell
+```
+
+Options
+
+| Flag | Description | Default |
+|--------------------|---------------------------------------------------------------------------|------------------|
+| `-c`, `--config` | Client configuration file. It is used as a `default` config. | conf/client.conf |
+| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception. | false |
+| `-h`, `--help` | Show this help. | |
+
+
+### Non interactive mode
+
+Usage
+
+```bash
+pulsar-shell -f [FILE]
+pulsar-shell -e [COMMAND]
+echo "[COMMAND]" | pulsar-shell -
+```
+
+Options
+
+| Flag | Description | Default |
+|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------|
+| `-c`, `--config` | Client configuration file. It is used as a `default` config. | conf/client.conf |
+| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception. | false |
+| `-np`, `--no-progress` | Display raw output of the commands without the fancy progress visualization. | false |
+| `-f`, `--filename` | Input filename with a list of commands to be executed. Each command must be separated by a newline. | |
+| `-e`, `--execute-command` | Execute this command and exit. | |
+| `-` | Read commands from the standard input. | |
+| `-h`, `--help` | Show this help. | |
+
+
+Commands
+* `admin` - See [Admin API](admin-api-overview.md)
+* `client` - See [pulsar-client](#pulsar-client)
+* `config`
+
+
+### `config`
+
+Manage shell configurations.
+
+#### `use`
+
+Use a specific configuration for next commands.
+
+```bash
+default(localhost)> config use mycluster
+```
+
+#### `create`
+
+Create a new configuration.
+
+```bash
+default(localhost)> config create --file ./conf/client.conf mycluster
+```
+
+Options
+
+| Flag | Description | Default |
+|----------|--------------------------|-----------------|
+| `--file` | File path of the config. | |
+| `--url` | URL of the config. | |
+| `--value` | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. | |
+
+#### `update`
+
+Update an existing configuration.
+
+```bash
+default(localhost)> config update --file ./conf/client.conf mycluster
+```
+
+Options
+
+| Flag | Description | Default |
+|----------|--------------------------|-----------------|
+| `--file` | File path of the config. | |
+| `--url` | URL of the config. | |
+| `--value` | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. | |
+
+#### `set-property`
+
+Set a value for a specified configuration property.
+
+```bash
+default(localhost)> config set-property -p webServiceUrl -v http://<cluster-hostname> mycluster
+```
+
+Options
+
+| Flag | Description | Default |
+|--------------------|-----------------------------|-----------------|
+| `-p`, `--property` | Property name to update. | |
+| `-v`, `--value` | New value for the property. | |
+
+
+#### `get-property`
+
+Get the value for a specified configuration property.
+
+```bash
+default(localhost)> config get-property -p webServiceUrl mycluster
+```
+
+Options
+
+| Flag | Description | Default |
+|--------------------|-----------------------------|-----------------|
+| `-p`, `--property` | Property name to update. | |
+
+
+#### `view`
+
+View details of a config.
+
+```bash
+default(localhost)> config view mycluster
+```
+
+#### `delete`
+
+Delete a config. You can't delete a config if it's currently used.
+
+```bash
+default(localhost)> config delete mycluster
+```
+
+
+#### `list`
+
+List all the configuration names.
+
+```bash
+default(localhost)> config list
+```
\ No newline at end of file
diff --git a/site2/website-next/docs/reference-cli-tools.md b/site2/website-next/docs/reference-cli-tools.md
index 8d172c8a3b4..cde841484a4 100644
--- a/site2/website-next/docs/reference-cli-tools.md
+++ b/site2/website-next/docs/reference-cli-tools.md
@@ -6,1066 +6,21 @@ sidebar_label: "Pulsar CLI tools"
Pulsar offers several command-line tools that you can use for managing Pulsar installations, performance testing, using command-line producers and consumers, and more.
-All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](getting-started-standalone.md). The following tools are currently documented:
+* [`pulsar-admin`](https://pulsar.apache.org/reference/#/latest/pulsar-admin/)
+* [`pulsar`](https://pulsar.apache.org/reference/#/latest/pulsar/)
+* [`pulsar-client`](https://pulsar.apache.org/reference/#/latest/pulsar-client/)
+* [`pulsar-perf`](https://pulsar.apache.org/reference/#/latest/pulsar-perf/)
+* [`pulsar-daemon`](reference-cli-pulsar-daemon.md)
+* [`pulsar-shell`](reference-cli-pulsar-shell.md)
+* [`bookkeeper`](reference-cli-bookkeeper.md)
+* [`broker-tool`](reference-cli-broker-tool.md)
-* [`pulsar`](#pulsar)
-* [`pulsar-client`](#pulsar-client)
-* [`pulsar-daemon`](#pulsar-daemon)
-* [`pulsar-perf`](#pulsar-perf)
-* [`bookkeeper`](#bookkeeper)
-* [`broker-tool`](#broker-tool)
-* [`pulsar-shell`](#pulsar-shell)
+All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](getting-started-standalone.md).
-:::tip
+You can get help for any CLI tool, command, or subcommand using the `--help` flag, or `-h` for short. Here's an example:
- - This page only shows **some frequently used commands**. For the latest information about `pulsar`, `pulsar-client`, and `pulsar-perf`, including commands, flags, descriptions, and more information, see [Pulsar tools](/tools/).
-
- - You can get help for any CLI tool, command, or subcommand using the `--help` flag, or `-h` for short. Here's an example:
-
-:::
-
-> ```shell
-> bin/pulsar broker --help
-> ```
-
-
-## `pulsar`
-
-The pulsar tool is used to start Pulsar components, such as bookies and ZooKeeper, in the foreground.
-
-These processes can also be started in the background, using nohup, using the pulsar-daemon tool, which has the same command interface as pulsar.
-
-Usage:
-
-```bash
-pulsar command
-```
-
-Commands:
-* `bookie`
-* `broker`
-* `compact-topic`
-* `configuration-store`
-* `initialize-cluster-metadata`
-* `proxy`
-* `standalone`
-* `websocket`
-* `zookeeper`
-* `zookeeper-shell`
-* `autorecovery`
-
-Example:
-
-```bash
-PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker
+```shell
+bin/pulsar broker --help
```
-Environment variables
-
-The table below lists the environment variables that you can use to configure the `pulsar` tool.
-
-|Variable|Description|Default|
-|---|---|---|
-|`PULSAR_LOG_CONF`|Log4j configuration file|`conf/log4j2.yaml`|
-|`PULSAR_BROKER_CONF`|Configuration file for broker|`conf/broker.conf`|
-|`PULSAR_BOOKKEEPER_CONF`|description: Configuration file for bookie|`conf/bookkeeper.conf`|
-|`PULSAR_ZK_CONF`|Configuration file for zookeeper|`conf/zookeeper.conf`|
-|`PULSAR_CONFIGURATION_STORE_CONF`|Configuration file for the configuration store|`conf/global_zookeeper.conf`|
-|`PULSAR_WEBSOCKET_CONF`|Configuration file for websocket proxy|`conf/websocket.conf`|
-|`PULSAR_STANDALONE_CONF`|Configuration file for standalone|`conf/standalone.conf`|
-|`PULSAR_EXTRA_OPTS`|Extra options to be passed to the jvm||
-|`PULSAR_EXTRA_CLASSPATH`|Extra paths for Pulsar's classpath||
-|`PULSAR_PID_DIR`|Folder where the pulsar server PID file should be stored||
-|`PULSAR_STOP_TIMEOUT`|Wait time before forcefully killing the Bookie server instance if attempts to stop it are not successful||
-|`PULSAR_GC_LOG`|Gc options to be passed to the jvm||
-
-
-### `bookie`
-
-Starts up a bookie server
-
-Usage:
-
-```bash
-pulsar bookie options
-```
-
-Options
-
-|Option|Description|Default|
-|---|---|---|
-|`-readOnly`|Force start a read-only bookie server|false|
-|`-withAutoRecovery`|Start auto-recover service bookie server|false|
-
-
-Example
-
-```bash
-PULSAR_BOOKKEEPER_CONF=/path/to/bookkeeper.conf pulsar bookie \
--readOnly \
--withAutoRecovery
-```
-
-### `broker`
-
-Starts up a Pulsar broker
-
-Usage
-
-```bash
-pulsar broker options
-```
-
-Options
-
-|Option|Description|Default|
-|---|---|---|
-|`-bc` , `--bookie-conf`|Configuration file for BookKeeper||
-|`-rb` , `--run-bookie`|Run a BookKeeper bookie on the same host as the Pulsar broker|false|
-|`-ra` , `--run-bookie-autorecovery`|Run a BookKeeper autorecovery daemon on the same host as the Pulsar broker|false|
-
-Example
-
-```bash
-PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker
-```
-
-### `compact-topic`
-
-Run compaction against a Pulsar topic (in a new process)
-
-Usage
-
-```bash
-pulsar compact-topic options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-t` , `--topic`|The Pulsar topic that you would like to compact||
-
-Example
-
-```bash
-pulsar compact-topic --topic topic-to-compact
-```
-
-### `configuration-store`
-
-Starts up the Pulsar configuration store
-
-Usage
-
-```bash
-pulsar configuration-store
-```
-
-Example
-
-```bash
-PULSAR_CONFIGURATION_STORE_CONF=/path/to/configuration_store.conf pulsar configuration-store
-```
-
-### `initialize-cluster-metadata`
-
-One-time cluster metadata initialization
-
-Usage
-
-```bash
-pulsar initialize-cluster-metadata options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-ub` , `--broker-service-url`|The broker service URL for the new cluster||
-|`-tb` , `--broker-service-url-tls`|The broker service URL for the new cluster with TLS encryption||
-|`-c` , `--cluster`|Cluster name||
-|`-cms` , `--configuration-metadata-store`|The configuration metadata store quorum connection string||
-|`--existing-bk-metadata-service-uri`|The metadata service URI of the existing BookKeeper cluster that you want to use||
-|`-h` , `--help`|Help message|false|
-|`--initial-num-stream-storage-containers`|The number of storage containers of BookKeeper stream storage|16|
-|`--initial-num-transaction-coordinators`|The number of transaction coordinators assigned in a cluster|16|
-|`-uw` , `--web-service-url`|The web service URL for the new cluster||
-|`-tw` , `--web-service-url-tls`|The web service URL for the new cluster with TLS encryption||
-|`-md` , `--metadata-store`|The metadata store service url||
-|`--zookeeper-session-timeout-ms`|The local ZooKeeper session timeout. The time unit is in millisecond(ms)|30000|
-
-
-### `proxy`
-
-Manages the Pulsar proxy
-
-Usage
-
-```bash
-pulsar proxy options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-cms`, `--configuration-metadata-store`|Configuration metadata store connection string||
-|`-md` , `--metadata-store`|Metadata Store service url||
-
-Example
-
-```bash
-PULSAR_PROXY_CONF=/path/to/proxy.conf pulsar proxy \
---metadata-store zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 \
---configuration-metadata-store zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181
-```
-
-### `standalone`
-
-Run a broker service with local bookies and local ZooKeeper
-
-Usage
-
-```bash
-pulsar standalone options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-a` , `--advertised-address`|The standalone broker advertised address||
-|`--bookkeeper-dir`|Local bookies’ base data directory|data/standalone/bookkeeper|
-|`--bookkeeper-port`|Local bookies’ base port|3181|
-|`--no-broker`|Only start ZooKeeper and BookKeeper services, not the broker|false|
-|`--num-bookies`|The number of local bookies|1|
-|`--only-broker`|Only start the Pulsar broker service (not ZooKeeper or BookKeeper)||
-|`--wipe-data`|Clean up previous ZooKeeper/BookKeeper data||
-|`--zookeeper-dir`|Local ZooKeeper’s data directory|data/standalone/zookeeper|
-|`--zookeeper-port` |Local ZooKeeper’s port|2181|
-
-Example
-
-```bash
-PULSAR_STANDALONE_CONF=/path/to/standalone.conf pulsar standalone
-```
-
-### `websocket`
-
-Usage
-
-```bash
-pulsar websocket
-```
-
-Example
-
-```bash
-PULSAR_WEBSOCKET_CONF=/path/to/websocket.conf pulsar websocket
-```
-
-### `zookeeper`
-
-Starts up a ZooKeeper cluster
-
-Usage
-
-```bash
-pulsar zookeeper
-```
-
-Example
-
-```bash
-PULSAR_ZK_CONF=/path/to/zookeeper.conf pulsar zookeeper
-```
-
-### `zookeeper-shell`
-
-Connects to a running ZooKeeper cluster using the ZooKeeper shell
-
-Usage
-
-```bash
-pulsar zookeeper-shell options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration file for ZooKeeper||
-|`-server`|Configuration zk address, eg: `127.0.0.1:2181`||
-
-### `autorecovery`
-
-Runs an auto-recovery service.
-
-Usage
-
-```bash
-pulsar autorecovery options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the autorecovery|N/A|
-
-
-## `pulsar-client`
-
-The pulsar-client tool
-
-Usage
-
-```bash
-pulsar-client command
-```
-
-Commands
-* `produce`
-* `consume`
-
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{\"key1\":\"val1\",\"key2\":\"val2\"}"|{"saslJaasClientSectionName":"PulsarClient", "serverType":"broker"}|
-|`--auth-plugin`|Authentication plugin class name|org.apache.pulsar.client.impl.auth.AuthenticationSasl|
-|`--listener-name`|Listener name for the broker||
-|`--proxy-protocol`|Proxy protocol to select type of routing at proxy||
-|`--proxy-url`|Proxy-server URL to which to connect||
-|`--url`|Broker URL to which to connect|pulsar://localhost:6650/ <br /> ws://localhost:8080 |
-| `-v`, `--version` | Get the version of the Pulsar client
-|`-h`, `--help`|Show this help
-
-
-### `produce`
-Send a message or messages to a specific broker and topic
-
-Usage
-
-```bash
-pulsar-client produce topic options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-f`, `--files`|Comma-separated file paths to send; either -m or -f must be specified|[]|
-|`-m`, `--messages`|Comma-separated string of messages to send; either -m or -f must be specified|[]|
-|`-n`, `--num-produce`|The number of times to send the message(s); the count of messages/files * num-produce should be below 1000|1|
-|`-r`, `--rate`|Rate (in messages per second) at which to produce; a value 0 means to produce messages as fast as possible|0.0|
-|`-db`, `--disable-batching`|Disable batch sending of messages|false|
-|`-c`, `--chunking`|Split the message and publish in chunks if the message size is larger than the allowed max size|false|
-|`-s`, `--separator`|Character to split messages string with.|","|
-|`-k`, `--key`|Message key to add|key=value string, like k1=v1,k2=v2.|
-|`-p`, `--properties`|Properties to add. If you want to add multiple properties, use the comma as the separator, e.g. `k1=v1,k2=v2`.| |
-|`-ekn`, `--encryption-key-name`|The public key name to encrypt payload.| |
-|`-ekv`, `--encryption-key-value`|The URI of public key to encrypt payload. For example, `file:///path/to/public.key` or `data:application/x-pem-file;base64,*****`.| |
-
-
-### `consume`
-Consume messages from a specific broker and topic
-
-Usage
-
-```bash
-pulsar-client consume topic options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`--hex`|Display binary messages in hexadecimal format.|false|
-|`-n`, `--num-messages`|Number of messages to consume, 0 means to consume forever.|1|
-|`-r`, `--rate`|Rate (in messages per second) at which to consume; a value 0 means to consume messages as fast as possible|0.0|
-|`--regex`|Indicate the topic name is a regex pattern|false|
-|`-s`, `--subscription-name`|Subscription name||
-|`-t`, `--subscription-type`|The type of the subscription. Possible values: Exclusive, Shared, Failover, Key_Shared.|Exclusive|
-|`-p`, `--subscription-position`|The position of the subscription. Possible values: Latest, Earliest.|Latest|
-|`-m`, `--subscription-mode`|Subscription mode. Possible values: Durable, NonDurable.|Durable|
-|`-q`, `--queue-size`|The size of consumer's receiver queue.|0|
-|`-mc`, `--max_chunked_msg`|Max pending chunk messages.|0|
-|`-ac`, `--auto_ack_chunk_q_full`|Auto ack for the oldest message in consumer's receiver queue if the queue full.|false|
-|`--hide-content`|Do not print the message to the console.|false|
-|`-st`, `--schema-type`|Set the schema type. Use `auto_consume` to dump AVRO and other structured data types. Possible values: bytes, auto_consume.|bytes|
-|`-ekv`, `--encryption-key-value`|The URI of public key to encrypt payload. For example, `file:///path/to/public.key` or `data:application/x-pem-file;base64,*****`.| |
-|`-pm`, `--pool-messages`|Use the pooled message.|true|
-
-## `pulsar-daemon`
-A wrapper around the pulsar tool that’s used to start and stop processes, such as ZooKeeper, bookies, and Pulsar brokers, in the background using nohup.
-
-pulsar-daemon has a similar interface to the pulsar command but adds start and stop commands for various services. For a listing of those services, run pulsar-daemon to see the help output or see the documentation for the pulsar command.
-
-Usage
-
-```bash
-pulsar-daemon command
-```
-
-Commands
-* `start`
-* `stop`
-* `restart`
-
-
-### `start`
-Start a service in the background using nohup.
-
-Usage
-
-```bash
-pulsar-daemon start service
-```
-
-### `stop`
-Stop a service that’s already been started using start.
-
-Usage
-
-```bash
-pulsar-daemon stop service options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|-force|Stop the service forcefully if not stopped by normal shutdown.|false|
-
-### `restart`
-Restart a service that has already been started.
-
-```bash
-pulsar-daemon restart service
-```
-
-## `pulsar-perf`
-A tool for performance testing a Pulsar broker.
-
-Usage
-
-```bash
-pulsar-perf command
-```
-
-Commands
-* `consume`
-* `produce`
-* `read`
-* `websocket-producer`
-* `managed-ledger`
-* `monitor-brokers`
-* `simulation-client`
-* `simulation-controller`
-* `transaction`
-* `help`
-
-Environment variables
-
-The table below lists the environment variables that you can use to configure the pulsar-perf tool.
-
-|Variable|Description|Default|
-|---|---|---|
-|`PULSAR_LOG_CONF`|Log4j configuration file|conf/log4j2.yaml|
-|`PULSAR_CLIENT_CONF`|Configuration file for the client|conf/client.conf|
-|`PULSAR_EXTRA_OPTS`|Extra options to be passed to the JVM||
-|`PULSAR_EXTRA_CLASSPATH`|Extra paths for Pulsar's classpath||
-|`PULSAR_GC_LOG`|Gc options to be passed to the jvm||
-
-Commands `consume`, `produce`, `read` and `transaction` share the following client options:
-
-|Flag|Description|Default|
-|---|---|---|
-|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class. For example, `key1:val1,key2:val2` or `{"key1":"val1","key2":"val2"}`.||
-|`--auth-plugin`|Authentication plugin class name||
-|`-bw`, `--busy-wait`|Enable or disable Busy-Wait on the Pulsar client|false|
-|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
-|`-cf`, `--conf-file`|Configuration file||
-|`-i`, `--stats-interval-seconds`|Statistics interval seconds. If 0, statistics will be disabled|0|
-|`-ioThreads`, `--num-io-threads`|Set the number of threads to be used for handling connections to brokers|1|
-|`--listener-name`|Listener name for the broker||
-|`-lt`, `--num-listener-threads`|Set the number of threads to be used for message listeners|1|
-|`--tls-allow-insecure`|Allow insecure TLS connection||
-|`--tls-enable-hostname-verification`|Enable TLS hostname verification||
-|`--trust-cert-file`|Path for the trusted TLS certificate file||
-|`-u`, `--service-url`|Pulsar service URL||
-
-
-### `consume`
-Run a consumer
-
-Usage
-
-```
-pulsar-perf consume options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-ac`, `--auto_ack_chunk_q_full`|Auto ack for the oldest message in consumer's receiver queue if the queue full|false|
-|`--acks-delay-millis`|Acknowledgments grouping delay in millis|100|
-|`--batch-index-ack`|Enable or disable the batch index acknowledgment|false|
-|`-v`, `--encryption-key-value-file`|The file which contains the private key to decrypt payload||
-|`-m`, `--num-messages`|Number of messages to consume in total. If the value is equal to or smaller than 0, it keeps consuming messages.|0|
-|`-e`, `--expire_time_incomplete_chunked_messages`|The expiration time for incomplete chunk messages (in milliseconds)|0|
-|`-mc`, `--max_chunked_msg`|Max pending chunk messages|0|
-|`-n`, `--num-consumers`|Number of consumers (per topic)|1|
-|`-ns`, `--num-subscriptions`|Number of subscriptions (per topic)|1|
-|`-t`, `--num-topics`|The number of topics|1|
-|`-pm`, `--pool-messages`|Use the pooled message|true|
-|`-r`, `--rate`|Simulate a slow message consumer (rate in msg/s)|0|
-|`-q`, `--receiver-queue-size`|Size of the receiver queue|1000|
-|`-p`, `--receiver-queue-size-across-partitions`|Max total size of the receiver queue across partitions|50000|
-|`--replicated`|Whether the subscription status should be replicated|false|
-|`-s`, `--subscriber-name`|Subscriber name prefix||
-|`-ss`, `--subscriptions`|A list of subscriptions to consume on (e.g. sub1,sub2)|sub|
-|`-st`, `--subscription-type`|Subscriber type. Possible values are Exclusive, Shared, Failover, Key_Shared.|Exclusive|
-|`-sp`, `--subscription-position`|Subscriber position. Possible values are Latest, Earliest.|Latest|
-|`-time`, `--test-duration`|Test duration (in seconds). If this value is less than or equal to 0, it keeps consuming messages.|0|
-
-
-Below are **transaction** related options.
-
-If you want `--txn-timeout`, `--numMessage-perTransaction`, `-nmt`, `-ntxn`, or `-abort` take effect, set `--txn-enable` to true.
-
-|Flag|Description|Default|
-|---|---|---|
-`-tto`, `--txn-timeout`|Set the time of transaction timeout (in second). |10
-`-nmt`, `--numMessage-perTransaction`|The number of messages acknowledged by a transaction. |50
-`-txn`, `--txn-enable`|Enable or disable a transaction.|false
-`-ntxn`|The number of opened transactions. 0 means the number of transactions is unlimited. |0
-`-abort`|Abort a transaction. |true
-
-### `produce`
-Run a producer
-
-Usage
-
-```bash
-pulsar-perf produce options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-am`, `--access-mode`|Producer access mode. Valid values are `Shared`, `Exclusive` and `WaitForExclusive`|Shared|
-|`-au`, `--admin-url`|Pulsar admin URL||
-|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
-|`-bb`, `--batch-max-bytes`|Maximum number of bytes per batch|4194304|
-|`-bm`, `--batch-max-messages`|Maximum number of messages per batch|1000|
-|`-ch`, `--chunking`|Split the message and publish in chunks if the message size is larger than allowed max size|false|
-|`-d`, `--delay`|Mark messages with a given delay in seconds|0s|
-|`-z`, `--compression`|Compress messages’ payload. Possible values are NONE, LZ4, ZLIB, ZSTD or SNAPPY.||
-|`-k`, `--encryption-key-name`|The public key name to encrypt payload||
-|`-v`, `--encryption-key-value-file`|The file which contains the public key to encrypt payload||
-|`-ef`, `--exit-on-failure`|Exit from the process on publish failure|false|
-|`-fc`, `--format-class`|Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter|
-|`-fp`, `--format-payload`|Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false|
-|`-h`, `--help`|Help message|false|
-|`-o`, `--max-outstanding`|Max number of outstanding messages|1000|
-|`-p`, `--max-outstanding-across-partitions`|Max number of outstanding messages across partitions|50000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If this value is less than or equal to 0, it keeps publishing messages.|0|
-|`-mk`, `--message-key-generation-mode`|The generation mode of message key. Valid options are `autoIncrement`, `random`||
-|`-n`, `--num-producers`|The number of producers (per topic)|1|
-|`-threads`, `--num-test-threads`|Number of test threads|1|
-|`-t`, `--num-topic`|The number of topics|1|
-|`-np`, `--partitions`|Create partitioned topics with the given number of partitions. Setting this value to 0 means not trying to create a topic||
-|`-f`, `--payload-file`|Use payload from an UTF-8 encoded text file and a payload will be randomly selected when publishing messages||
-|`-e`, `--payload-delimiter`|The delimiter used to split lines when using payload from a file|\n|
-|`-pn`, `--producer-name`|Producer Name||
-|`-r`, `--rate`|Publish rate msg/s across topics|100|
-|`--send-timeout`|Set the sendTimeout|0|
-|`--separator`|Separator between the topic and topic number|-|
-|`-s`, `--size`|Message size (in bytes)|1024|
-|`-time`, `--test-duration`|Test duration (in seconds). If this value is less than or equal to 0, it keeps publishing messages.|0|
-|`--warmup-time`|Warm-up time in seconds|1|
-
-Below are **transaction** related options.
-
-If you want `--txn-timeout`, `--numMessage-perTransaction`, or `-abort` take effect, set `--txn-enable` to true.
-
-|Flag|Description|Default|
-|---|---|---|
-`-tto`, `--txn-timeout`|Set the time of transaction timeout (in second). |5
-`-nmt`, `--numMessage-perTransaction`|The number of messages acknowledged by a transaction. |50
-`-txn`, `--txn-enable`|Enable or disable a transaction.|true
-`-abort`|Abort a transaction. |true
-
-### `read`
-Run a topic reader
-
-Usage
-
-```bash
-pulsar-perf read options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-h`, `--help`|Help message|false|
-|`-n`, `--num-messages`|Number of messages to consume in total. If the value is equal to or smaller than 0, it keeps consuming messages.|0|
-|`-t`, `--num-topics`|The number of topics|1|
-|`-r`, `--rate`|Simulate a slow message reader (rate in msg/s)|0|
-|`-q`, `--receiver-queue-size`|Size of the receiver queue|1000|
-|`-m`, `--start-message-id`|Start message id. This can be either 'earliest', 'latest' or a specific message id by using 'lid:eid'|earliest|
-|`-time`, `--test-duration`|Test duration (in seconds). If this value is less than or equal to 0, it keeps consuming messages.|0|
-|`--use-tls`|Use TLS encryption on the connection|false|
-
-### `websocket-producer`
-Run a websocket producer
-
-Usage
-
-```bash
-pulsar-perf websocket-producer options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class. For example, `key1:val1,key2:val2` or `{"key1":"val1","key2":"val2"}`.||
-|`--auth-plugin`|Authentication plugin class name||
-|`-cf`, `--conf-file`|Configuration file||
-|`-h`, `--help`|Help message|false|
-|`-m`, `--num-messages`|Number of messages to publish in total. If this value is less than or equal to 0, it keeps publishing messages.|0|
-|`-t`, `--num-topic`|The number of topics|1|
-|`-f`, `--payload-file`|Use payload from a file instead of empty buffer||
-|`-e`, `--payload-delimiter`|The delimiter used to split lines when using payload from a file|\n|
-|`-fp`, `--format-payload`|Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false|
-|`-fc`, `--format-class`|Custom formatter class name|`org.apache.pulsar.testclient.DefaultMessageFormatter`|
-|`-u`, `--proxy-url`|Pulsar Proxy URL, e.g., "ws://localhost:8080/"||
-|`-r`, `--rate`|Publish rate msg/s across topics|100|
-|`-s`, `--size`|Message size in byte|1024|
-|`-time`, `--test-duration`|Test duration (in seconds). If this value is less than or equal to 0, it keeps publishing messages.|0|
-
-
-### `managed-ledger`
-Write directly on managed-ledgers
-
-Usage
-
-```bash
-pulsar-perf managed-ledger options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-a`, `--ack-quorum`|Ledger ack quorum|1|
-|`-dt`, `--digest-type`|BookKeeper digest type. Possible Values: [CRC32, MAC, CRC32C, DUMMY]|CRC32C|
-|`-e`, `--ensemble-size`|Ledger ensemble size|1|
-|`-h`, `--help`|Help message|false|
-|`-c`, `--max-connections`|Max number of TCP connections to a single bookie|1|
-|`-o`, `--max-outstanding`|Max number of outstanding requests|1000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If this value is less than or equal to 0, it keeps publishing messages.|0|
-|`-t`, `--num-topic`|Number of managed ledgers|1|
-|`-r`, `--rate`|Write rate msg/s across managed ledgers|100|
-|`-s`, `--size`|Message size in byte|1024|
-|`-time`, `--test-duration`|Test duration (in seconds). If this value is less than or equal to 0, it keeps publishing messages.|0|
-|`--threads`|Number of threads writing|1|
-|`-w`, `--write-quorum`|Ledger write quorum|1|
-|`-md`, `--metadata-store`|Metadata store service URL. For example: zk:my-zk:2181||
-
-
-### `monitor-brokers`
-Continuously receive broker data and/or load reports
-
-Usage
-
-```bash
-pulsar-perf monitor-brokers options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`--connect-string`|A connection string for one or more ZooKeeper servers||
-|`-h`, `--help`|Help message|false|
-
-
-### `simulation-client`
-Run a simulation server acting as a Pulsar client. Uses the client configuration specified in `conf/client.conf`.
-
-Usage
-
-```bash
-pulsar-perf simulation-client options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`--port`|Port to listen on for controller|0|
-|`--service-url`|Pulsar Service URL||
-|`-h`, `--help`|Help message|false|
-
-### `simulation-controller`
-Run a simulation controller to give commands to servers
-
-Usage
-
-```bash
-pulsar-perf simulation-controller options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`--client-port`|The port that the clients are listening on|0|
-|`--clients`|Comma-separated list of client hostnames||
-|`--cluster`|The cluster to test on||
-|`-h`, `--help`|Help message|false|
-
-### `transaction`
-
-Run a transaction. For more information, see [Pulsar transactions](txn-why.md).
-
-**Usage**
-
-```bash
-pulsar-perf transaction options
-```
-
-**Options**
-
-|Flag|Description|Default|
-|---|---|---|
-`-au`, `--admin-url`|Pulsar admin URL.|N/A
-`-h`, `--help`|Help messages.|N/A
-`-ns`, `--num-subscriptions`|Number of subscriptions per topic.|1
-`-threads`, `--num-test-threads`|Number of test threads. <br /><br />This thread is for a new transaction to ack messages from consumer topics, produce messages to producer topics, and commit or abort this transaction. <br /><br /> Increasing the number of threads increases the parallelism of the performance test, consequently, it increases the intensity of the stress test.|1
-`-nmc`, `--numMessage-perTransaction-consume`|Set the number of messages consumed in a transaction. <br /><br /> If transaction is disabled, it means the number of messages consumed in a task instead of in a transaction.|1
-`-nmp`, `--numMessage-perTransaction-produce`|Set the number of messages produced in a transaction. <br /><br />If transaction is disabled, it means the number of messages produced in a task instead of in a transaction.|1
-`-ntxn`, `--number-txn`|Set the number of transactions. <br /><br /> 0 means the number of transactions is unlimited. <br /><br /> If transaction is disabled, it means the number of tasks instead of transactions. |0
-`-np`, `--partitions`|Create partitioned topics with a given number of partitions. <br /><br /> 0 means not trying to create a topic.
-`-q`, `--receiver-queue-size`|Size of the receiver queue.|1000
-`-sp`, `--subscription-position`|Subscription position.|Earliest
-`-st`, `--subscription-type`|Subscription type.|Shared
-`-ss`, `--subscriptions`|A list of subscriptions to consume. <br /><br /> For example, sub1,sub2.|[sub]
-`-time`, `--test-duration`|Test duration (in second). <br /><br /> 0 means keeping publishing messages.|0
-`--topics-c`|All topics assigned to consumers.|[test-consume]
-`--topics-p`|All topics assigned to producers . |[test-produce]
-`--txn-disEnable`|Disable transaction.|true
-`-tto`, `--txn-timeout`|Set the time of transaction timeout (in second). <br /><br /> If you want `--txn-timeout` takes effect, set `--txn-enable` to true.|5
-`-abort`|Abort the transaction. <br /><br /> If you want `-abort` takes effect, set `--txn-disEnable` to false.|true
-`-txnRate`|Set the rate of opened transactions or tasks. <br /><br /> 0 means no limit.|0
-
-### `help`
-This help message
-
-Usage
-
-```bash
-pulsar-perf help
-```
-
-## `bookkeeper`
-A tool for managing BookKeeper.
-
-Usage
-
-```bash
-bookkeeper command
-```
-
-Commands
-* `autorecovery`
-* `bookie`
-* `localbookie`
-* `upgrade`
-* `shell`
-
-
-Environment variables
-
-The table below lists the environment variables that you can use to configure the bookkeeper tool.
-
-|Variable|Description|Default|
-|---|---|---|
-|BOOKIE_LOG_CONF|Log4j configuration file|conf/log4j2.yaml|
-|BOOKIE_CONF|BookKeeper configuration file|conf/bk_server.conf|
-|BOOKIE_EXTRA_OPTS|Extra options to be passed to the JVM||
-|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath||
-|ENTRY_FORMATTER_CLASS|The Java class used to format entries||
-|BOOKIE_PID_DIR|Folder where the BookKeeper server PID file should be stored||
-|BOOKIE_STOP_TIMEOUT|Wait time before forcefully killing the Bookie server instance if attempts to stop it are not successful||
-|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
-
-
-### `autorecovery`
-Runs an auto-recovery service
-
-Usage
-
-```bash
-bookkeeper autorecovery options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery||
-
-
-### `bookie`
-Starts up a BookKeeper server (aka bookie)
-
-Usage
-
-```bash
-bookkeeper bookie options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery||
-|-readOnly|Force start a read-only bookie server|false|
-|-withAutoRecovery|Start auto-recovery service bookie server|false|
-
-
-### `localbookie`
-Runs a test ensemble of N bookies locally
-
-Usage
-
-```bash
-bookkeeper localbookie N
-```
-
-### `upgrade`
-Upgrade the bookie’s filesystem
-
-Usage
-
-```bash
-bookkeeper upgrade options
-```
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery||
-|`-u`, `--upgrade`|Upgrade the bookie’s directories||
-
-
-### `shell`
-Run shell for admin commands. To see a full listing of those commands, run bookkeeper shell without an argument.
-
-Usage
-
-```bash
-bookkeeper shell
-```
-
-Example
-
-```bash
-bookkeeper shell bookiesanity
-```
-
-## `broker-tool`
-
-The `broker- tool` is used for operations on a specific broker.
-
-Usage
-
-```bash
-broker-tool command
-```
-
-Commands
-* `load-report`
-* `help`
-
-Example
-Two ways to get more information about a command as below:
-
-```bash
-broker-tool help command
-broker-tool command --help
-```
-
-### `load-report`
-
-Collect the load report of a specific broker.
-The command is run on a broker, and used for troubleshooting why broker can’t collect right load report.
-
-Options
-
-|Flag|Description|Default|
-|---|---|---|
-|`-i`, `--interval`| Interval to collect load report, in milliseconds ||
-|`-h`, `--help`| Display help information ||
-
-
-## `pulsar-shell`
-
-[Pulsar shell](administration-pulsar-shell.md) tool.
-
-### Interactive mode
-
-Usage
-
-```bash
-pulsar-shell
-```
-
-Options
-
-| Flag | Description | Default |
-|--------------------|---------------------------------------------------------------------------|------------------|
-| `-c`, `--config` | Client configuration file. It is used as a `default` config. | conf/client.conf |
-| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception. | false |
-| `-h`, `--help` | Show this help. | |
-
-
-### Non interactive mode
-
-Usage
-
-```bash
-pulsar-shell -f [FILE]
-pulsar-shell -e [COMMAND]
-echo "[COMMAND]" | pulsar-shell -
-```
-
-Options
-
-| Flag | Description | Default |
-|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------|
-| `-c`, `--config` | Client configuration file. It is used as a `default` config. | conf/client.conf |
-| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception. | false |
-| `-np`, `--no-progress` | Display raw output of the commands without the fancy progress visualization. | false |
-| `-f`, `--filename` | Input filename with a list of commands to be executed. Each command must be separated by a newline. | |
-| `-e`, `--execute-command` | Execute this command and exit. | |
-| `-` | Read commands from the standard input. | |
-| `-h`, `--help` | Show this help. | |
-
-
-Commands
-* `admin` - See [Admin API](admin-api-overview.md)
-* `client` - See [pulsar-client](#pulsar-client)
-* `config`
-
-
-### `config`
-
-Manage shell configurations.
-
-#### `use`
-
-Use a specific configuration for next commands.
-
-```bash
-default(localhost)> config use mycluster
-```
-
-#### `create`
-
-Create a new configuration.
-
-```bash
-default(localhost)> config create --file ./conf/client.conf mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|----------|--------------------------|-----------------|
-| `--file` | File path of the config. | |
-| `--url` | URL of the config. | |
-| `--value` | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. | |
-
-#### `update`
-
-Update an existing configuration.
-
-```bash
-default(localhost)> config update --file ./conf/client.conf mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|----------|--------------------------|-----------------|
-| `--file` | File path of the config. | |
-| `--url` | URL of the config. | |
-| `--value` | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. | |
-
-#### `set-property`
-
-Set a value for a specified configuration property.
-
-```bash
-default(localhost)> config set-property -p webServiceUrl -v http://<cluster-hostname> mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|--------------------|-----------------------------|-----------------|
-| `-p`, `--property` | Property name to update. | |
-| `-v`, `--value` | New value for the property. | |
-
-
-#### `get-property`
-
-Get the value for a specified configuration property.
-
-```bash
-default(localhost)> config get-property -p webServiceUrl mycluster
-```
-
-Options
-
-| Flag | Description | Default |
-|--------------------|-----------------------------|-----------------|
-| `-p`, `--property` | Property name to update. | |
-
-
-#### `view`
-
-View details of a config.
-
-```bash
-default(localhost)> config view mycluster
-```
-
-#### `delete`
-
-Delete a config. You can't delete a config if it's currently used.
-
-```bash
-default(localhost)> config delete mycluster
-```
-
-
-#### `list`
-
-List all the configuration names.
-```bash
-default(localhost)> config list
-```
\ No newline at end of file
diff --git a/site2/website-next/docs/reference-pulsar-admin.md b/site2/website-next/docs/reference-pulsar-admin.md
index a2d017a1697..cbd4005eaa3 100644
--- a/site2/website-next/docs/reference-pulsar-admin.md
+++ b/site2/website-next/docs/reference-pulsar-admin.md
@@ -2429,6 +2429,15 @@ Usage
pulsar-admin topics stats topic
```
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-etb`,`--get-earliest-time-in-backlog` | Set to `true` to get the earliest time in backlog | false |
+|`-gpb`,`--get-precise-backlog`| Set to `true` to get precise backlog | false |
+|`-sbs`,` --get-subscription-backlog-size`| Set to `true` to get backlog size for each subscription, locking required | false |
+
+
:::note
The unit of `storageSize` and `averageMsgSize` is Byte.
@@ -2466,8 +2475,11 @@ Options
|Flag|Description|Default|
|---|---|---|
+|`-gpb`,`--get-precise-backlog`| Set to `true` to get precise backlog | false |
+|`-sbs`,` --get-subscription-backlog-size`| Set to `true` to get backlog size for each subscription, locking required | false |
|`--per-partition`|Get per-partition stats|false|
+
### `partitioned-stats-internal`
Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
@@ -2725,6 +2737,7 @@ pulsar-admin topics remove-message-ttl tenant/namespace/topic
```
Options
+
|Flag|Description|Default|
|---|---|---|
|`--enable`, `-e`|Enable message deduplication on the specified topic.|false|