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 9df01d3efce Docs sync done from apache/pulsar (#efea294)
9df01d3efce is described below
commit 9df01d3efce9c59f13e0e676d9b5fe49954d41a8
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Jul 5 01:41:37 2023 +0000
Docs sync done from apache/pulsar (#efea294)
---
.../next/config/reference-configuration-broker.md | 24 +++++++++++++++++++-
.../config/reference-configuration-standalone.md | 24 +++++++++++++++++++-
static/reference/next/pulsar-admin/topics.md | 2 +-
static/reference/next/pulsar/broker.md | 10 ++++-----
static/reference/next/pulsar/compact-topic.md | 2 +-
.../next/pulsar/delete-cluster-metadata.md | 8 +++----
static/reference/next/pulsar/functions-worker.md | 4 ++--
.../next/pulsar/initialize-cluster-metadata.md | 26 +++++++++++-----------
.../reference/next/pulsar/initialize-namespace.md | 4 ++--
.../initialize-transaction-coordinator-metadata.md | 8 +++----
static/reference/next/pulsar/proxy.md | 8 +++----
static/reference/next/pulsar/standalone.md | 22 +++++++++---------
static/reference/next/pulsar/version.md | 2 +-
static/reference/next/pulsar/websocket.md | 2 +-
static/swagger/master/swagger.json | 4 ++--
static/swagger/master/v2/swagger.json | 4 ++--
16 files changed, 99 insertions(+), 55 deletions(-)
diff --git a/static/reference/next/config/reference-configuration-broker.md
b/static/reference/next/config/reference-configuration-broker.md
index 4c0714ded43..e33101c8b4e 100644
--- a/static/reference/next/config/reference-configuration-broker.md
+++ b/static/reference/next/config/reference-configuration-broker.md
@@ -1150,6 +1150,17 @@ Supported algorithms name for namespace bundle split
**Category**: Load Balancer
+### topicBundleAssignmentStrategy
+Name of topic bundle assignment strategy to use
+
+**Type**: `java.lang.String`
+
+**Default**:
`org.apache.pulsar.common.naming.ConsistentHashingTopicBundleAssigner`
+
+**Dynamic**: `false`
+
+**Category**: Load Balancer
+
### aggregatePublisherStatsByProducerName
If true, aggregate publisher stats of PartitionedTopicStats by producerName
@@ -2580,6 +2591,17 @@ Interval between checks to see if cluster is migrated
and marks topic migrated
**Category**: Server
+### compactionServiceFactoryClassName
+The class name of the factory that implements the topic compaction service.
+
+**Type**: `java.lang.String`
+
+**Default**: `org.apache.pulsar.compaction.PulsarCompactionServiceFactory`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### configurationMetadataStoreUrl
The metadata store URL for the configuration data. If empty, we fall back to
use metadataStoreUrl
@@ -2704,7 +2726,7 @@ If value is
"org.apache.pulsar.broker.delayed.BucketDelayedDeliveryTrackerFactor
**Category**: Server
### disableBrokerInterceptors
-Enable or disable the broker interceptor
+Enable or disable the broker interceptor, which is only used for testing for
now
**Type**: `boolean`
diff --git a/static/reference/next/config/reference-configuration-standalone.md
b/static/reference/next/config/reference-configuration-standalone.md
index 4c0714ded43..e33101c8b4e 100644
--- a/static/reference/next/config/reference-configuration-standalone.md
+++ b/static/reference/next/config/reference-configuration-standalone.md
@@ -1150,6 +1150,17 @@ Supported algorithms name for namespace bundle split
**Category**: Load Balancer
+### topicBundleAssignmentStrategy
+Name of topic bundle assignment strategy to use
+
+**Type**: `java.lang.String`
+
+**Default**:
`org.apache.pulsar.common.naming.ConsistentHashingTopicBundleAssigner`
+
+**Dynamic**: `false`
+
+**Category**: Load Balancer
+
### aggregatePublisherStatsByProducerName
If true, aggregate publisher stats of PartitionedTopicStats by producerName
@@ -2580,6 +2591,17 @@ Interval between checks to see if cluster is migrated
and marks topic migrated
**Category**: Server
+### compactionServiceFactoryClassName
+The class name of the factory that implements the topic compaction service.
+
+**Type**: `java.lang.String`
+
+**Default**: `org.apache.pulsar.compaction.PulsarCompactionServiceFactory`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### configurationMetadataStoreUrl
The metadata store URL for the configuration data. If empty, we fall back to
use metadataStoreUrl
@@ -2704,7 +2726,7 @@ If value is
"org.apache.pulsar.broker.delayed.BucketDelayedDeliveryTrackerFactor
**Category**: Server
### disableBrokerInterceptors
-Enable or disable the broker interceptor
+Enable or disable the broker interceptor, which is only used for testing for
now
**Type**: `boolean`
diff --git a/static/reference/next/pulsar-admin/topics.md
b/static/reference/next/pulsar-admin/topics.md
index f7fb7574275..cbbcc9b3f67 100644
--- a/static/reference/next/pulsar-admin/topics.md
+++ b/static/reference/next/pulsar-admin/topics.md
@@ -243,7 +243,7 @@ $ pulsar-admin topics create-subscription options
|Flag|Description|Default|
|---|---|---|
-| `-s, --subscription` | Subscription to reset position on|null||
+| `-s, --subscription` | Name of subscription to be created|null||
| `-m, --messageId` | messageId where to create the subscription. It can be
either 'latest', 'earliest' or (ledgerId:entryId)|latest||
| `-r, --replicated` | replicated subscriptions|false||
| `--property, -p` | key value pair properties(-p a=b -p c=d)|null||
diff --git a/static/reference/next/pulsar/broker.md
b/static/reference/next/pulsar/broker.md
index d664bf9e26e..8d45d51391a 100644
--- a/static/reference/next/pulsar/broker.md
+++ b/static/reference/next/pulsar/broker.md
@@ -9,12 +9,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|
-| `-g, --generate-docs` | Generate docs|true|
| `-rfw, --run-functions-worker` | Run functions worker with Broker|false|
-| `-c, --broker-conf` | Configuration file for Broker|conf/broker.conf|
-| `-rb, --run-bookie` | Run Bookie together with Broker|false|
-| `-bc, --bookie-conf` | Configuration file for Bookie|conf/bookkeeper.conf|
-| `-fwc, --functions-worker-conf` | Configuration file for Functions
Worker|conf/functions_worker.yml|
diff --git a/static/reference/next/pulsar/compact-topic.md
b/static/reference/next/pulsar/compact-topic.md
index b3465142ae0..6afe5280217 100644
--- a/static/reference/next/pulsar/compact-topic.md
+++ b/static/reference/next/pulsar/compact-topic.md
@@ -8,8 +8,8 @@ $ pulsar compact-topic options
|Flag|Description|Default|
|---|---|---|
-| `-g, --generate-docs` | Generate docs|true|
| `-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|
diff --git a/static/reference/next/pulsar/delete-cluster-metadata.md
b/static/reference/next/pulsar/delete-cluster-metadata.md
index d0fffa4a7a4..a69972c0f61 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|
|---|---|---|
-| `-cs, --configuration-store` | Configuration Store connection string|null|
-| `-zk, --zookeeper` | Local ZooKeeper quorum connection string|zk|
+| `--bookkeeper-metadata-service-uri` | Metadata service uri of
BookKeeper|null|
| `-c, -cluster, --cluster` | Cluster name|null|
+| `-cs, --configuration-store` | Configuration Store connection string|null|
| `-g, --generate-docs` | Generate docs|true|
-| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
| `-h, --help` | Show this help message|false|
-| `--bookkeeper-metadata-service-uri` | Metadata service uri of
BookKeeper|null|
+| `-zk, --zookeeper` | Local ZooKeeper quorum connection string|zk|
+| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
diff --git a/static/reference/next/pulsar/functions-worker.md
b/static/reference/next/pulsar/functions-worker.md
index 49189d47280..1638bc2895c 100644
--- a/static/reference/next/pulsar/functions-worker.md
+++ b/static/reference/next/pulsar/functions-worker.md
@@ -8,7 +8,7 @@ $ pulsar functions-worker options
|Flag|Description|Default|
|---|---|---|
-| `-h, --help` | Show this help message|false|
-| `-g, --generate-docs` | Generate docs|true|
| `-c, --conf` | Configuration File for Function
Worker|conf/functions_worker.yml|
+| `-g, --generate-docs` | Generate docs|true|
+| `-h, --help` | Show this help message|false|
diff --git a/static/reference/next/pulsar/initialize-cluster-metadata.md
b/static/reference/next/pulsar/initialize-cluster-metadata.md
index 94138f5c3ae..db9c8040db0 100644
--- a/static/reference/next/pulsar/initialize-cluster-metadata.md
+++ b/static/reference/next/pulsar/initialize-cluster-metadata.md
@@ -8,24 +8,24 @@ $ pulsar initialize-cluster-metadata options
|Flag|Description|Default|
|---|---|---|
-| `-tb, --broker-service-url-tls` | Broker-service URL for new cluster with
TLS encryption|null|
-| `-bn, --default-namespace-bundle-number` | The bundle numbers for the
default namespaces(public/default), default is 16|0|
-| `-cs, --configuration-store` | Configuration Store connection string|cs|
-| `-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|
-| `--initial-num-transaction-coordinators` | Num transaction coordinators will
assigned in cluster|16|
-| `-uw, --web-service-url` | Web-service URL for new cluster|uw|
| `--bookkeeper-metadata-service-uri` | The metadata service URI of the
existing BookKeeper cluster that you want to use|null|
-| `-h, --help` | Show this help message|false|
-| `--existing-bk-metadata-service-uri` | The metadata service URI of the
existing BookKeeper cluster that you want to use|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|
| `-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|
-| `-tw, --web-service-url-tls` | Web-service URL for new cluster with TLS
encryption|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|
-| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
+| `-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|
-| `-c, --cluster` | Cluster name|c|
-| `--initial-num-stream-storage-containers` | Num storage containers of
BookKeeper stream storage|16|
+| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
diff --git a/static/reference/next/pulsar/initialize-namespace.md
b/static/reference/next/pulsar/initialize-namespace.md
index 597b4d37b0b..9b885abb940 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|
-| `-h, --help` | Show this help message|false|
| `-g, --generate-docs` | Generate docs|true|
-| `-c, --cluster` | Cluster name|c|
+| `-h, --help` | Show this help message|false|
| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
diff --git
a/static/reference/next/pulsar/initialize-transaction-coordinator-metadata.md
b/static/reference/next/pulsar/initialize-transaction-coordinator-metadata.md
index b3391f9cf38..7bffcf21835 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|
|---|---|---|
-| `-cs, --configuration-store` | Configuration Store connection string|cs|
-| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
-| `--initial-num-transaction-coordinators` | Num transaction coordinators will
assigned in cluster|16|
| `-c, --cluster` | Cluster name|c|
-| `-h, --help` | Show this help message|false|
+| `-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|
+| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000|
diff --git a/static/reference/next/pulsar/proxy.md
b/static/reference/next/pulsar/proxy.md
index 026b5fad9da..75d504895d1 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|
|---|---|---|
-| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181||
-| `-h, --help` | Show this help message|false|
| `-c, --config` | Configuration file path|conf/proxy.conf|
-| `-g, --generate-docs` | Generate docs|true|
-| `-zk, --zookeeper-servers` | Local zookeeper connection string, please use
--metadata-store instead||
| `-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|
| `-gzk, --global-zookeeper-servers` | Global zookeeper connection string,
please use --configuration-metadata-store instead||
+| `-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||
diff --git a/static/reference/next/pulsar/standalone.md
b/static/reference/next/pulsar/standalone.md
index b225c367841..f36386a1868 100644
--- a/static/reference/next/pulsar/standalone.md
+++ b/static/reference/next/pulsar/standalone.md
@@ -8,22 +8,22 @@ $ pulsar standalone options
|Flag|Description|Default|
|---|---|---|
-| `--num-bookies` | Number of local Bookies|1|
+| `-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|
-| `-fwc, --functions-worker-conf` | Configuration file for Functions
Worker|conf/functions_worker.yml|
-| `-nss, --no-stream-storage` | Disable stream storage|false|
+| `--metadata-dir` | Directory for storing metadata|data/metadata|
| `--metadata-url` | Metadata store url||
| `--no-broker` | Only start ZK and BK services, no broker|false|
-| `--zookeeper-dir` | Local zooKeeper's data
directory|data/standalone/zookeeper|
-| `--only-broker` | Only start Pulsar broker service (no ZK, BK)|false|
| `-nfw, --no-functions-worker` | Run functions worker with Broker|false|
-| `--metadata-dir` | Directory for storing metadata|data/metadata|
+| `-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|
-| `-a, --advertised-address` | Standalone broker advertised address|null|
-| `-c, --config` | Configuration file path|conf/standalone.conf|
+| `--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|
-| `--bookkeeper-port` | Local bookies base port|3181|
-| `--bookkeeper-dir` | Local bookies base data
directory|data/standalone/bookkeeper|
diff --git a/static/reference/next/pulsar/version.md
b/static/reference/next/pulsar/version.md
index ba4152d3fdf..237e04b9b37 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|
|---|---|---|
-| `-h, --help` | Show this help message|false|
| `-g, --generate-docs` | Generate docs|true|
+| `-h, --help` | Show this help message|false|
diff --git a/static/reference/next/pulsar/websocket.md
b/static/reference/next/pulsar/websocket.md
index 62bcadf6afe..5992b279d0e 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|
|---|---|---|
-| `-h, --help` | Show this help message|false|
| `-g, --generate-docs` | Generate docs|true|
+| `-h, --help` | Show this help message|false|
diff --git a/static/swagger/master/swagger.json
b/static/swagger/master/swagger.json
index cafa16f8a02..0e01c98d019 100644
--- a/static/swagger/master/swagger.json
+++ b/static/swagger/master/swagger.json
@@ -21055,7 +21055,7 @@
"type": "string"
},
{
- "description": "Subscription to create position on",
+ "description": "Name of subscription to be created",
"in": "path",
"name": "subscriptionName",
"required": true,
@@ -30888,7 +30888,7 @@
"type": "string"
},
{
- "description": "Subscription to create position on",
+ "description": "Name of subscription to be created",
"in": "path",
"name": "subscriptionName",
"required": true,
diff --git a/static/swagger/master/v2/swagger.json
b/static/swagger/master/v2/swagger.json
index cafa16f8a02..0e01c98d019 100644
--- a/static/swagger/master/v2/swagger.json
+++ b/static/swagger/master/v2/swagger.json
@@ -21055,7 +21055,7 @@
"type": "string"
},
{
- "description": "Subscription to create position on",
+ "description": "Name of subscription to be created",
"in": "path",
"name": "subscriptionName",
"required": true,
@@ -30888,7 +30888,7 @@
"type": "string"
},
{
- "description": "Subscription to create position on",
+ "description": "Name of subscription to be created",
"in": "path",
"name": "subscriptionName",
"required": true,
