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 2024/03/23 01:29:48 UTC
(pulsar-site) branch main updated: Docs sync done from apache/pulsar (#0b5d9ab)
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 6450ecac43d5 Docs sync done from apache/pulsar (#0b5d9ab)
6450ecac43d5 is described below
commit 6450ecac43d5f9230daa63c6e7dc1ba4ac78ccf0
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Sat Mar 23 01:29:43 2024 +0000
Docs sync done from apache/pulsar (#0b5d9ab)
---
static/reference/next/pulsar/broker-tool.md | 3 ++-
static/reference/next/pulsar/broker.md | 9 ++++-----
static/reference/next/pulsar/compact-topic.md | 4 ++--
.../next/pulsar/delete-cluster-metadata.md | 8 ++++----
static/reference/next/pulsar/functions-worker.md | 6 +++---
.../next/pulsar/initialize-cluster-metadata.md | 22 +++++++++-------------
.../reference/next/pulsar/initialize-namespace.md | 8 ++++----
.../initialize-transaction-coordinator-metadata.md | 10 +++++-----
static/reference/next/pulsar/proxy.md | 12 ++++++------
static/reference/next/pulsar/standalone.md | 20 +++++++++-----------
static/reference/next/pulsar/tokens.md | 10 +++++-----
static/reference/next/pulsar/version.md | 2 +-
static/reference/next/pulsar/websocket.md | 2 +-
13 files changed, 55 insertions(+), 61 deletions(-)
diff --git a/static/reference/next/pulsar/broker-tool.md b/static/reference/next/pulsar/broker-tool.md
index 763f7bab2132..1a96b7ef6b4f 100644
--- a/static/reference/next/pulsar/broker-tool.md
+++ b/static/reference/next/pulsar/broker-tool.md
@@ -1,5 +1,6 @@
# broker-tool
+broker-tool is used for operations on a specific broker
```shell
@@ -10,12 +11,12 @@ $ pulsar broker-tool subcommand
## load-report
+Collect the load report of a specific broker
```shell
$ pulsar broker-tool load-report options
```
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Display help information|false|
| `-i, --interval-ms` | Interval to collect load report, in milliseconds|100|
diff --git a/static/reference/next/pulsar/broker.md b/static/reference/next/pulsar/broker.md
index 8d45d51391a9..86c987fe34a6 100644
--- a/static/reference/next/pulsar/broker.md
+++ b/static/reference/next/pulsar/broker.md
@@ -1,6 +1,5 @@
# broker
-Options
```shell
@@ -9,12 +8,12 @@ $ pulsar broker options
|Flag|Description|Default|
|---|---|---|
-| `-bc, --bookie-conf` | Configuration file for Bookie|conf/bookkeeper.conf|
| `-c, --broker-conf` | Configuration file for Broker|conf/broker.conf|
-| `-fwc, --functions-worker-conf` | Configuration file for Functions Worker|conf/functions_worker.yml|
-| `-g, --generate-docs` | Generate docs|true|
-| `-h, --help` | Show this help message|false|
| `-rb, --run-bookie` | Run Bookie together with Broker|false|
| `-ra, --run-bookie-autorecovery` | Run Bookie Autorecovery together with broker|false|
+| `-bc, --bookie-conf` | Configuration file for Bookie|conf/bookkeeper.conf|
| `-rfw, --run-functions-worker` | Run functions worker with Broker|false|
+| `-fwc, --functions-worker-conf` | Configuration file for Functions Worker|conf/functions_worker.yml|
+| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/compact-topic.md b/static/reference/next/pulsar/compact-topic.md
index 6afe5280217d..ce2d0b241c3c 100644
--- a/static/reference/next/pulsar/compact-topic.md
+++ b/static/reference/next/pulsar/compact-topic.md
@@ -9,7 +9,7 @@ $ pulsar compact-topic options
|Flag|Description|Default|
|---|---|---|
| `-c, --broker-conf` | Configuration file for Broker|conf/broker.conf|
-| `-g, --generate-docs` | Generate docs|true|
-| `-h, --help` | Show this help message|false|
| `-t, --topic` | Topic to compact|tmp|
+| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|true|
diff --git a/static/reference/next/pulsar/delete-cluster-metadata.md b/static/reference/next/pulsar/delete-cluster-metadata.md
index a69972c0f613..0957b96c6c81 100644
--- a/static/reference/next/pulsar/delete-cluster-metadata.md
+++ b/static/reference/next/pulsar/delete-cluster-metadata.md
@@ -8,11 +8,11 @@ $ pulsar delete-cluster-metadata options
|Flag|Description|Default|
|---|---|---|
-| `--bookkeeper-metadata-service-uri` | Metadata service uri of BookKeeper|null|
+| `-zk, --zookeeper` | Local ZooKeeper quorum connection string|null|
+| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
| `-c, -cluster, --cluster` | Cluster name|null|
| `-cs, --configuration-store` | Configuration Store connection string|null|
-| `-g, --generate-docs` | Generate docs|true|
+| `--bookkeeper-metadata-service-uri` | Metadata service uri of BookKeeper|null|
| `-h, --help` | Show this help message|false|
-| `-zk, --zookeeper` | Local ZooKeeper quorum connection string|zk|
-| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/functions-worker.md b/static/reference/next/pulsar/functions-worker.md
index 1638bc2895cd..bd72b43a1dc3 100644
--- a/static/reference/next/pulsar/functions-worker.md
+++ b/static/reference/next/pulsar/functions-worker.md
@@ -3,12 +3,12 @@
```shell
-$ pulsar functions-worker options
+$ pulsar FunctionWorkerStarter options
```
|Flag|Description|Default|
|---|---|---|
-| `-c, --conf` | Configuration File for Function Worker|conf/functions_worker.yml|
-| `-g, --generate-docs` | Generate docs|true|
+| `-c, --conf` | Configuration File for Function Worker|null|
| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/initialize-cluster-metadata.md b/static/reference/next/pulsar/initialize-cluster-metadata.md
index db9c8040db0f..3bdee456b585 100644
--- a/static/reference/next/pulsar/initialize-cluster-metadata.md
+++ b/static/reference/next/pulsar/initialize-cluster-metadata.md
@@ -8,24 +8,20 @@ $ pulsar initialize-cluster-metadata options
|Flag|Description|Default|
|---|---|---|
-| `--bookkeeper-metadata-service-uri` | The metadata service URI of the existing BookKeeper cluster that you want to use|null|
+| `-c, --cluster` | Cluster name|null|
+| `-bn, --default-namespace-bundle-number` | The bundle numbers for the default namespaces(public/default), default is 16|0|
+| `-uw, --web-service-url` | Web-service URL for new cluster|null|
+| `-tw, --web-service-url-tls` | Web-service URL for new cluster with TLS encryption|null|
| `-ub, --broker-service-url` | Broker-service URL for new cluster|null|
| `-tb, --broker-service-url-tls` | Broker-service URL for new cluster with TLS encryption|null|
-| `-c, --cluster` | Cluster name|c|
+| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181|null|
+| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
| `-cms, --configuration-metadata-store` | Configuration Metadata Store connection string|null|
-| `-cs, --configuration-store` | Configuration Store connection string|cs|
-| `-bn, --default-namespace-bundle-number` | The bundle numbers for the default namespaces(public/default), default is 16|0|
-| `--existing-bk-metadata-service-uri` | The metadata service URI of the existing BookKeeper cluster that you want to use|null|
-| `-g, --generate-docs` | Generate docs|true|
-| `-gzk, --global-zookeeper` | Global ZooKeeper quorum connection string|null|
-| `-h, --help` | Show this help message|false|
| `--initial-num-stream-storage-containers` | Num storage containers of BookKeeper stream storage|16|
| `--initial-num-transaction-coordinators` | Num transaction coordinators will assigned in cluster|16|
-| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181|null|
+| `--existing-bk-metadata-service-uri` | The metadata service URI of the existing BookKeeper cluster that you want to use|null|
| `-pp, --proxy-protocol` | Proxy protocol to select type of routing at proxy. Possible Values: [SNI]|null|
| `-pu, --proxy-url` | Proxy-server URL to which to connect.|null|
-| `-uw, --web-service-url` | Web-service URL for new cluster|uw|
-| `-tw, --web-service-url-tls` | Web-service URL for new cluster with TLS encryption|null|
-| `-zk, --zookeeper` | Local ZooKeeper quorum connection string|zk|
-| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
+| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/initialize-namespace.md b/static/reference/next/pulsar/initialize-namespace.md
index 9b885abb9400..46f56043a2b9 100644
--- a/static/reference/next/pulsar/initialize-namespace.md
+++ b/static/reference/next/pulsar/initialize-namespace.md
@@ -8,9 +8,9 @@ $ pulsar initialize-namespace options
|Flag|Description|Default|
|---|---|---|
-| `-c, --cluster` | Cluster name|c|
-| `-cs, --configuration-store` | Configuration Store connection string|cs|
-| `-g, --generate-docs` | Generate docs|true|
-| `-h, --help` | Show this help message|false|
+| `-c, --cluster` | Cluster name|null|
+| `-cs, --configuration-store` | Configuration Store connection string|null|
| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
+| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/initialize-transaction-coordinator-metadata.md b/static/reference/next/pulsar/initialize-transaction-coordinator-metadata.md
index 7bffcf218350..c309fe94e0ed 100644
--- a/static/reference/next/pulsar/initialize-transaction-coordinator-metadata.md
+++ b/static/reference/next/pulsar/initialize-transaction-coordinator-metadata.md
@@ -8,10 +8,10 @@ $ pulsar initialize-transaction-coordinator-metadata options
|Flag|Description|Default|
|---|---|---|
-| `-c, --cluster` | Cluster name|c|
-| `-cs, --configuration-store` | Configuration Store connection string|cs|
-| `-g, --generate-docs` | Generate docs|true|
-| `-h, --help` | Show this help message|false|
-| `--initial-num-transaction-coordinators` | Num transaction coordinators will assigned in cluster|16|
+| `-c, --cluster` | Cluster name|null|
+| `-cs, --configuration-store` | Configuration Store connection string|null|
| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
+| `--initial-num-transaction-coordinators` | Num transaction coordinators will assigned in cluster|16|
+| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/proxy.md b/static/reference/next/pulsar/proxy.md
index 75d504895d11..7b30291e1134 100644
--- a/static/reference/next/pulsar/proxy.md
+++ b/static/reference/next/pulsar/proxy.md
@@ -8,12 +8,12 @@ $ pulsar proxy options
|Flag|Description|Default|
|---|---|---|
-| `-c, --config` | Configuration file path|conf/proxy.conf|
-| `-cms, --configuration-metadata-store` | The metadata store URL for the configuration data||
-| `-cs, --configuration-store-servers` | Configuration store connection string, please use --configuration-metadata-store instead||
-| `-g, --generate-docs` | Generate docs|true|
+| `-c, --config` | Configuration file path|null|
+| `-zk, --zookeeper-servers` | Local zookeeper connection string, please use --metadata-store instead||
+| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181||
| `-gzk, --global-zookeeper-servers` | Global zookeeper connection string, please use --configuration-metadata-store instead||
+| `-cs, --configuration-store-servers` | Configuration store connection string, please use --configuration-metadata-store instead||
+| `-cms, --configuration-metadata-store` | The metadata store URL for the configuration data||
| `-h, --help` | Show this help message|false|
-| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181||
-| `-zk, --zookeeper-servers` | Local zookeeper connection string, please use --metadata-store instead||
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/standalone.md b/static/reference/next/pulsar/standalone.md
index f36386a1868e..ed6cea9d6c43 100644
--- a/static/reference/next/pulsar/standalone.md
+++ b/static/reference/next/pulsar/standalone.md
@@ -8,22 +8,20 @@ $ pulsar standalone options
|Flag|Description|Default|
|---|---|---|
-| `-a, --advertised-address` | Standalone broker advertised address|null|
-| `--bookkeeper-dir` | Local bookies base data directory|data/standalone/bookkeeper|
-| `--bookkeeper-port` | Local bookies base port|3181|
| `-c, --config` | Configuration file path|conf/standalone.conf|
-| `-fwc, --functions-worker-conf` | Configuration file for Functions Worker|conf/functions_worker.yml|
-| `-g, --generate-docs` | Generate docs|true|
-| `-h, --help` | Show this help message|false|
+| `--wipe-data` | Clean up previous ZK/BK data|false|
+| `--num-bookies` | Number of local Bookies|1|
| `--metadata-dir` | Directory for storing metadata|data/metadata|
| `--metadata-url` | Metadata store url||
+| `--bookkeeper-port` | Local bookies base port|3181|
+| `--bookkeeper-dir` | Local bookies base data directory|data/standalone/bookkeeper|
| `--no-broker` | Only start ZK and BK services, no broker|false|
+| `--only-broker` | Only start Pulsar broker service (no ZK, BK)|false|
| `-nfw, --no-functions-worker` | Run functions worker with Broker|false|
+| `-fwc, --functions-worker-conf` | Configuration file for Functions Worker|conf/functions_worker.yml|
| `-nss, --no-stream-storage` | Disable stream storage|false|
-| `--num-bookies` | Number of local Bookies|1|
-| `--only-broker` | Only start Pulsar broker service (no ZK, BK)|false|
| `--stream-storage-port` | Local bookies stream storage port|4181|
-| `--wipe-data` | Clean up previous ZK/BK data|false|
-| `--zookeeper-dir` | Local zooKeeper's data directory|data/standalone/zookeeper|
-| `--zookeeper-port` | Local zookeeper's port|2181|
+| `-a, --advertised-address` | Standalone broker advertised address|null|
+| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|true|
diff --git a/static/reference/next/pulsar/tokens.md b/static/reference/next/pulsar/tokens.md
index 6c2e19af0f6d..1cf27d237267 100644
--- a/static/reference/next/pulsar/tokens.md
+++ b/static/reference/next/pulsar/tokens.md
@@ -45,11 +45,11 @@ $ pulsar tokens create options
|Flag|Description|Default|
|---|---|---|
+| `-a, --signature-algorithm` | The signature algorithm for the new key pair.|RS256|
| `-s, --subject` | Specify the 'subject' or 'principal' associate with this token|null|
-| `-pk, --private-key` | Pass the private key for signing the token. This can either be: data:, file:, etc..|null|
| `-e, --expiry-time` | Relative expiry time for the token (eg: 1h, 3d, 10y). (m=minutes) Default: no expiration|null|
| `-sk, --secret-key` | Pass the secret key for signing the token. This can either be: data:, file:, etc..|null|
-| `-a, --signature-algorithm` | The signature algorithm for the new key pair.|RS256|
+| `-pk, --private-key` | Pass the private key for signing the token. This can either be: data:, file:, etc..|null|
## show
@@ -74,9 +74,9 @@ $ pulsar tokens validate options
|Flag|Description|Default|
|---|---|---|
-| `-f, --token-file` | Read token from a file|null|
-| `-pk, --public-key` | Pass the public key for validating the token. This can either be: data:, file:, etc..|null|
+| `-a, --signature-algorithm` | The signature algorithm for the key pair if using public key.|RS256|
| `-i, --stdin` | Read token from standard input|false|
+| `-f, --token-file` | Read token from a file|null|
| `-sk, --secret-key` | Pass the secret key for validating the token. This can either be: data:, file:, etc..|null|
-| `-a, --signature-algorithm` | The signature algorithm for the key pair if using public key.|RS256|
+| `-pk, --public-key` | Pass the public key for validating the token. This can either be: data:, file:, etc..|null|
diff --git a/static/reference/next/pulsar/version.md b/static/reference/next/pulsar/version.md
index 237e04b9b370..110a5ca84f93 100644
--- a/static/reference/next/pulsar/version.md
+++ b/static/reference/next/pulsar/version.md
@@ -8,6 +8,6 @@ $ pulsar version options
|Flag|Description|Default|
|---|---|---|
-| `-g, --generate-docs` | Generate docs|true|
| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|
diff --git a/static/reference/next/pulsar/websocket.md b/static/reference/next/pulsar/websocket.md
index 5992b279d0e5..b2ab4447f158 100644
--- a/static/reference/next/pulsar/websocket.md
+++ b/static/reference/next/pulsar/websocket.md
@@ -8,6 +8,6 @@ $ pulsar websocket options
|Flag|Description|Default|
|---|---|---|
-| `-g, --generate-docs` | Generate docs|true|
| `-h, --help` | Show this help message|false|
+| `-g, --generate-docs` | Generate docs|false|