Docs sync done from apache/pulsar (#0219921)
diff --git a/static/reference/next/pulsar-perf/pulsar-perf.md b/static/reference/next/pulsar-perf/pulsar-perf.md
index dd67609..d33a8a4 100644
--- a/static/reference/next/pulsar-perf/pulsar-perf.md
+++ b/static/reference/next/pulsar-perf/pulsar-perf.md
@@ -9,14 +9,12 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Print help message|false|
-| `-cf, --conf-file` | Pulsar configuration file|null|
-| `-u, --service-url` | Pulsar Service URL|null|
-| `--auth-plugin` | Authentication plugin class name|null|
-| `--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"}".|null|
+| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/|
+| `--auth-plugin` | Authentication plugin class name||
+| `--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"}".||
| `--trust-cert-file` | Path for the trusted TLS certificate file||
-| `--tls-allow-insecure` | Allow insecure TLS connection|null|
-| `--tls-enable-hostname-verification` | Enable TLS hostname verification|null|
+| `--tls-allow-insecure` | Allow insecure TLS connection|false|
+| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false|
| `-c, --max-connections` | Max number of TCP connections to a single broker|1|
| `-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. The default value is 1.|1|
@@ -24,8 +22,8 @@
| `--listener-name` | Listener name for the broker.|null|
| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1|
| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000|
-| `--proxy-url` | Proxy-server URL to which to connect.|null|
-| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|null|
+| `--proxy-url` | Proxy-server URL to which to connect.||
+| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.||
| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0|
| `-t, --num-topics, --num-topic` | Number of topics. Must matchthe given number of topic arguments.|1|
| `-threads, --num-test-threads` | Number of test threads|1|
@@ -35,7 +33,7 @@
| `--separator` | Separator between the topic and topic number|-|
| `--send-timeout` | Set the sendTimeout value default 0 to keep compatibility with previous version of pulsar-perf|0|
| `-pn, --producer-name` | Producer Name|null|
-| `-au, --admin-url` | Pulsar Admin URL|null|
+| `-au, --admin-url` | Pulsar Admin URL|http://localhost:8080/|
| `-ch, --chunking` | Should split the message and publish in chunks if message size is larger than allowed max size|false|
| `-o, --max-outstanding` | Max number of outstanding messages|0|
| `-p, --max-outstanding-across-partitions` | Max number of outstanding messages across partitions|0|
@@ -65,6 +63,8 @@
| `-txn, --txn-enable` | Enable or disable the transaction|false|
| `-abort` | Abort the transaction. (After --txn-enable setting to true, -abort takes effect)|false|
| `--histogram-file` | HdrHistogram output file|null|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## consume
@@ -77,14 +77,12 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Print help message|false|
-| `-cf, --conf-file` | Pulsar configuration file|null|
-| `-u, --service-url` | Pulsar Service URL|null|
-| `--auth-plugin` | Authentication plugin class name|null|
-| `--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"}".|null|
+| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/|
+| `--auth-plugin` | Authentication plugin class name||
+| `--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"}".||
| `--trust-cert-file` | Path for the trusted TLS certificate file||
-| `--tls-allow-insecure` | Allow insecure TLS connection|null|
-| `--tls-enable-hostname-verification` | Enable TLS hostname verification|null|
+| `--tls-allow-insecure` | Allow insecure TLS connection|false|
+| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false|
| `-c, --max-connections` | Max number of TCP connections to a single broker|1|
| `-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. The default value is 1.|1|
@@ -92,8 +90,8 @@
| `--listener-name` | Listener name for the broker.|null|
| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1|
| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000|
-| `--proxy-url` | Proxy-server URL to which to connect.|null|
-| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|null|
+| `--proxy-url` | Proxy-server URL to which to connect.||
+| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.||
| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0|
| `-t, --num-topics, --num-topic` | Number of topics. Must matchthe given number of topic arguments.|1|
| `-n, --num-consumers` | Number of consumers (per subscription), only one consumer is allowed when subscriptionType is Exclusive|1|
@@ -121,6 +119,8 @@
| `-ntxn` | The number of opened transactions, 0 means keeping open.(After --txn-enable setting to true, -ntxn takes effect.)|0|
| `-abort` | Abort the transaction. (After --txn-enable setting to true, -abort takes effect)|false|
| `--histogram-file` | HdrHistogram output file|null|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## transaction
@@ -133,14 +133,12 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Print help message|false|
-| `-cf, --conf-file` | Pulsar configuration file|null|
-| `-u, --service-url` | Pulsar Service URL|null|
-| `--auth-plugin` | Authentication plugin class name|null|
-| `--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"}".|null|
+| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/|
+| `--auth-plugin` | Authentication plugin class name||
+| `--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"}".||
| `--trust-cert-file` | Path for the trusted TLS certificate file||
-| `--tls-allow-insecure` | Allow insecure TLS connection|null|
-| `--tls-enable-hostname-verification` | Enable TLS hostname verification|null|
+| `--tls-allow-insecure` | Allow insecure TLS connection|false|
+| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false|
| `-c, --max-connections` | Max number of TCP connections to a single broker|1|
| `-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. The default value is 1.|1|
@@ -148,13 +146,13 @@
| `--listener-name` | Listener name for the broker.|null|
| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1|
| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000|
-| `--proxy-url` | Proxy-server URL to which to connect.|null|
-| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|null|
+| `--proxy-url` | Proxy-server URL to which to connect.||
+| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.||
| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0|
| `--topics-c` | All topics that need ack for a transaction|[test-consume]|
| `--topics-p` | All topics that need produce for a transaction|[test-produce]|
| `-threads, --num-test-threads` | Number of test threads.This thread is for a new transaction to ack messages from consumer topics and produce message to producer topics, and then commit or abort this transaction. Increasing the number of threads increases the parallelism of the performance test, thereby increasing the intensity of the stress test.|1|
-| `-au, --admin-url` | Pulsar Admin URL|null|
+| `-au, --admin-url` | Pulsar Admin URL|http://localhost:8080/|
| `-np, --partitions` | Create partitioned topics with a given number of partitions, 0 meansnot trying to create a topic|null|
| `-time, --test-duration` | Test duration (in second). 0 means keeping publishing|0|
| `-ss, --subscriptions` | A list of subscriptions to consume (for example, sub1,sub2)|[sub]|
@@ -170,6 +168,8 @@
| `--txn-disable` | Disable transaction|false|
| `-abort` | Abort the transaction. (After --txn-disEnable setting to false, -abort takes effect)|false|
| `-txnRate` | Set the rate of opened transaction or task. 0 means no limit|0|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## read
@@ -182,14 +182,12 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Print help message|false|
-| `-cf, --conf-file` | Pulsar configuration file|null|
-| `-u, --service-url` | Pulsar Service URL|null|
-| `--auth-plugin` | Authentication plugin class name|null|
-| `--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"}".|null|
+| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/|
+| `--auth-plugin` | Authentication plugin class name||
+| `--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"}".||
| `--trust-cert-file` | Path for the trusted TLS certificate file||
-| `--tls-allow-insecure` | Allow insecure TLS connection|null|
-| `--tls-enable-hostname-verification` | Enable TLS hostname verification|null|
+| `--tls-allow-insecure` | Allow insecure TLS connection|false|
+| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false|
| `-c, --max-connections` | Max number of TCP connections to a single broker|1|
| `-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. The default value is 1.|1|
@@ -197,8 +195,8 @@
| `--listener-name` | Listener name for the broker.|null|
| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1|
| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000|
-| `--proxy-url` | Proxy-server URL to which to connect.|null|
-| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|null|
+| `--proxy-url` | Proxy-server URL to which to connect.||
+| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.||
| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0|
| `-t, --num-topics, --num-topic` | Number of topics. Must matchthe given number of topic arguments.|1|
| `-r, --rate` | Simulate a slow message reader (rate in msg/s)|0.0|
@@ -207,6 +205,8 @@
| `-n, --num-messages` | Number of messages to consume in total. If <= 0, it will keep consuming|0|
| `--use-tls` | Use TLS encryption on the connection|false|
| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep consuming|0|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## monitor-brokers
@@ -220,9 +220,10 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Help message|false|
| `--connect-string` | Zookeeper or broker connect string|null|
| `--extensions` | true to monitor Load Balance Extensions.|false|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## simulation-client
@@ -235,10 +236,11 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Help message|false|
| `--port` | Port to listen on for controller|0|
| `--service-url` | Pulsar Service URL|null|
| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## simulation-controller
@@ -251,10 +253,11 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Help message|false|
| `--cluster` | Cluster to test on|null|
| `--clients` | Comma separated list of client hostnames|null|
| `--client-port` | Port that the clients are listening on|0|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## websocket-producer
@@ -267,7 +270,6 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Help message|false|
| `-cf, --conf-file` | Configuration file|null|
| `-u, --proxy-url` | Pulsar Proxy URL, e.g., "ws://localhost:8080/"|null|
| `-r, --rate` | Publish rate msg/s across topics|100|
@@ -281,6 +283,8 @@
| `-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|
| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep publishing|0|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
## managed-ledger
@@ -293,7 +297,6 @@
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Help message|false|
| `-r, --rate` | Write rate msg/s across managed ledgers|100|
| `-s, --size` | Message size|1024|
| `-t, --num-topic` | Number of managed ledgers|1|
@@ -307,4 +310,6 @@
| `-a, --ack-quorum` | Ledger ack quorum|1|
| `-dt, --digest-type` | BookKeeper digest type|CRC32C|
| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep publishing|0|
+| `-h, --help` | Show this help message and exit.|false|
+| `-V, --version` | Print version information and exit.|false|
