You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by gi...@apache.org on 2026/10/01 01:39:29 UTC
(pulsar-site) branch main updated: Docs sync done from apache/pulsar (#99afb59)
This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] 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 ef25adc7971 Docs sync done from apache/pulsar (#99afb59)
ef25adc7971 is described below
commit ef25adc7971f40436d5ccc52d4ca0b7124b2497d
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Thu Oct 1 01:39:22 2026 +0000
Docs sync done from apache/pulsar (#99afb59)
---
static/openapi/master/openapifunctions.json | 7 +++++++
static/openapi/master/openapisink.json | 7 +++++++
static/openapi/master/openapisource.json | 7 +++++++
static/openapi/master/v3/openapifunctions.json | 7 +++++++
static/openapi/master/v3/openapisink.json | 7 +++++++
static/openapi/master/v3/openapisource.json | 7 +++++++
static/reference/next/config/reference-configuration-broker.md | 2 +-
static/reference/next/config/reference-configuration-standalone.md | 2 +-
static/reference/next/pulsar-admin/functions.md | 3 +++
static/reference/next/pulsar-admin/sinks.md | 3 +++
static/reference/next/pulsar-admin/sources.md | 3 +++
static/reference/next/pulsar/standalone.md | 1 +
12 files changed, 54 insertions(+), 2 deletions(-)
diff --git a/static/openapi/master/openapifunctions.json b/static/openapi/master/openapifunctions.json
index fb2b9745633..5fded15cf09 100644
--- a/static/openapi/master/openapifunctions.json
+++ b/static/openapi/master/openapifunctions.json
@@ -187,6 +187,13 @@
"cleanupSubscription": {
"type": "boolean"
},
+ "clientApi": {
+ "enum": [
+ "V4",
+ "V5"
+ ],
+ "type": "string"
+ },
"customRuntimeOptions": {
"type": "string"
},
diff --git a/static/openapi/master/openapisink.json b/static/openapi/master/openapisink.json
index 1d3d2a3bca6..929ecbec28d 100644
--- a/static/openapi/master/openapisink.json
+++ b/static/openapi/master/openapisink.json
@@ -208,6 +208,13 @@
"cleanupSubscription": {
"type": "boolean"
},
+ "clientApi": {
+ "enum": [
+ "V4",
+ "V5"
+ ],
+ "type": "string"
+ },
"configs": {
"additionalProperties": {
"type": "object"
diff --git a/static/openapi/master/openapisource.json b/static/openapi/master/openapisource.json
index 0e9e982e931..3f3abc66356 100644
--- a/static/openapi/master/openapisource.json
+++ b/static/openapi/master/openapisource.json
@@ -231,6 +231,13 @@
"className": {
"type": "string"
},
+ "clientApi": {
+ "enum": [
+ "V4",
+ "V5"
+ ],
+ "type": "string"
+ },
"configs": {
"additionalProperties": {
"type": "object"
diff --git a/static/openapi/master/v3/openapifunctions.json b/static/openapi/master/v3/openapifunctions.json
index fb2b9745633..5fded15cf09 100644
--- a/static/openapi/master/v3/openapifunctions.json
+++ b/static/openapi/master/v3/openapifunctions.json
@@ -187,6 +187,13 @@
"cleanupSubscription": {
"type": "boolean"
},
+ "clientApi": {
+ "enum": [
+ "V4",
+ "V5"
+ ],
+ "type": "string"
+ },
"customRuntimeOptions": {
"type": "string"
},
diff --git a/static/openapi/master/v3/openapisink.json b/static/openapi/master/v3/openapisink.json
index 1d3d2a3bca6..929ecbec28d 100644
--- a/static/openapi/master/v3/openapisink.json
+++ b/static/openapi/master/v3/openapisink.json
@@ -208,6 +208,13 @@
"cleanupSubscription": {
"type": "boolean"
},
+ "clientApi": {
+ "enum": [
+ "V4",
+ "V5"
+ ],
+ "type": "string"
+ },
"configs": {
"additionalProperties": {
"type": "object"
diff --git a/static/openapi/master/v3/openapisource.json b/static/openapi/master/v3/openapisource.json
index 0e9e982e931..3f3abc66356 100644
--- a/static/openapi/master/v3/openapisource.json
+++ b/static/openapi/master/v3/openapisource.json
@@ -231,6 +231,13 @@
"className": {
"type": "string"
},
+ "clientApi": {
+ "enum": [
+ "V4",
+ "V5"
+ ],
+ "type": "string"
+ },
"configs": {
"additionalProperties": {
"type": "object"
diff --git a/static/reference/next/config/reference-configuration-broker.md b/static/reference/next/config/reference-configuration-broker.md
index f56a24b9dea..a349f31e6e1 100644
--- a/static/reference/next/config/reference-configuration-broker.md
+++ b/static/reference/next/config/reference-configuration-broker.md
@@ -4698,7 +4698,7 @@ Amount of seconds to timeout when loading a topic. In situations with many geo-r
**Default**: `60`
-**Dynamic**: `false`
+**Dynamic**: `true`
**Category**: Server
diff --git a/static/reference/next/config/reference-configuration-standalone.md b/static/reference/next/config/reference-configuration-standalone.md
index f56a24b9dea..a349f31e6e1 100644
--- a/static/reference/next/config/reference-configuration-standalone.md
+++ b/static/reference/next/config/reference-configuration-standalone.md
@@ -4698,7 +4698,7 @@ Amount of seconds to timeout when loading a topic. In situations with many geo-r
**Default**: `60`
-**Dynamic**: `false`
+**Dynamic**: `true`
**Category**: Server
diff --git a/static/reference/next/pulsar-admin/functions.md b/static/reference/next/pulsar-admin/functions.md
index 38cebe4c71e..c73877b245f 100644
--- a/static/reference/next/pulsar-admin/functions.md
+++ b/static/reference/next/pulsar-admin/functions.md
@@ -56,6 +56,7 @@ $ pulsar-admin functions localrun options
| `[--subs-name]` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer|null|Java, Python, Go|
| `[--subs-position]` | Pulsar source subscription position if user wants to consume messages from the specified location|null|Java|
| `[--skip-to-latest]` | Whether or not the consumer skip to latest message upon function instance restart|null||
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|Java|
| `[--parallelism]` | The parallelism factor of a Pulsar Function (i.e. the number of function instances to run)|null|Java|
| `[--cpu]` | The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)|null|Java(Process & K8s),Python(K8s),Go(K8s)|
| `[--ram]` | The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)|null|Java(Process & K8s),Python(K8s),Go(K8s)|
@@ -136,6 +137,7 @@ $ pulsar-admin functions create options
| `[--subs-name]` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer|null|Java, Python, Go|
| `[--subs-position]` | Pulsar source subscription position if user wants to consume messages from the specified location|null|Java|
| `[--skip-to-latest]` | Whether or not the consumer skip to latest message upon function instance restart|null||
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|Java|
| `[--parallelism]` | The parallelism factor of a Pulsar Function (i.e. the number of function instances to run)|null|Java|
| `[--cpu]` | The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)|null|Java(Process & K8s),Python(K8s),Go(K8s)|
| `[--ram]` | The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)|null|Java(Process & K8s),Python(K8s),Go(K8s)|
@@ -224,6 +226,7 @@ $ pulsar-admin functions update options
| `[--subs-name]` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer|null|Java, Python, Go|
| `[--subs-position]` | Pulsar source subscription position if user wants to consume messages from the specified location|null|Java|
| `[--skip-to-latest]` | Whether or not the consumer skip to latest message upon function instance restart|null||
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|Java|
| `[--parallelism]` | The parallelism factor of a Pulsar Function (i.e. the number of function instances to run)|null|Java|
| `[--cpu]` | The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)|null|Java(Process & K8s),Python(K8s),Go(K8s)|
| `[--ram]` | The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)|null|Java(Process & K8s),Python(K8s),Go(K8s)|
diff --git a/static/reference/next/pulsar-admin/sinks.md b/static/reference/next/pulsar-admin/sinks.md
index f925f710161..0bb0cf51049 100644
--- a/static/reference/next/pulsar-admin/sinks.md
+++ b/static/reference/next/pulsar-admin/sinks.md
@@ -57,6 +57,7 @@ $ pulsar-admin sinks create options
| `[--transform-function-classname]` | The transform function class name|null|
| `[--transform-function-config]` | Configuration of the transform function applied before the Sink|null|
| `[--log-topic]` | The topic to which the logs of a Pulsar Sink are produced|null|
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|
| `[--runtime-flags]` | Any flags that you want to pass to a runtime (for process & Kubernetes runtime only).|null|
| `[-h, --help]` | Show this help message and exit.|false|
| `[-v, --version]` | Print version information and exit.|false|
@@ -110,6 +111,7 @@ $ pulsar-admin sinks update options
| `[--transform-function-classname]` | The transform function class name|null|
| `[--transform-function-config]` | Configuration of the transform function applied before the Sink|null|
| `[--log-topic]` | The topic to which the logs of a Pulsar Sink are produced|null|
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|
| `[--runtime-flags]` | Any flags that you want to pass to a runtime (for process & Kubernetes runtime only).|null|
| `[--update-auth-data]` | Whether or not to update the auth data|false|
| `[-h, --help]` | Show this help message and exit.|false|
@@ -336,6 +338,7 @@ $ pulsar-admin sinks localrun options
| `[--transform-function-classname]` | The transform function class name|null|
| `[--transform-function-config]` | Configuration of the transform function applied before the Sink|null|
| `[--log-topic]` | The topic to which the logs of a Pulsar Sink are produced|null|
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|
| `[--runtime-flags]` | Any flags that you want to pass to a runtime (for process & Kubernetes runtime only).|null|
| `[--state-storage-service-url]` | The URL for the state storage service (the default is Apache BookKeeper)|null|
| `[--broker-service-url]` | The URL for the Pulsar broker|null|
diff --git a/static/reference/next/pulsar-admin/sources.md b/static/reference/next/pulsar-admin/sources.md
index 05e723489f0..50e3bc43d10 100644
--- a/static/reference/next/pulsar-admin/sources.md
+++ b/static/reference/next/pulsar-admin/sources.md
@@ -45,6 +45,7 @@ $ pulsar-admin sources create options
| `[--custom-runtime-options]` | A string that encodes options to customize the runtime, see docs for configured runtime for details|null|
| `[--secrets]` | The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider|null|
| `[--log-topic]` | The topic to which the logs of a Pulsar Sink are produced|null|
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|
| `[--runtime-flags]` | Any flags that you want to pass to a runtime (for process & Kubernetes runtime only).|null|
| `[-h, --help]` | Show this help message and exit.|false|
| `[-v, --version]` | Print version information and exit.|false|
@@ -86,6 +87,7 @@ $ pulsar-admin sources update options
| `[--custom-runtime-options]` | A string that encodes options to customize the runtime, see docs for configured runtime for details|null|
| `[--secrets]` | The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider|null|
| `[--log-topic]` | The topic to which the logs of a Pulsar Sink are produced|null|
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|
| `[--runtime-flags]` | Any flags that you want to pass to a runtime (for process & Kubernetes runtime only).|null|
| `[--update-auth-data]` | Whether or not to update the auth data|false|
| `[-h, --help]` | Show this help message and exit.|false|
@@ -300,6 +302,7 @@ $ pulsar-admin sources localrun options
| `[--custom-runtime-options]` | A string that encodes options to customize the runtime, see docs for configured runtime for details|null|
| `[--secrets]` | The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider|null|
| `[--log-topic]` | The topic to which the logs of a Pulsar Sink are produced|null|
+| `[--client-api]` | Pulsar client API that the Java runtime uses for the component's topics: V4, V5. Defaults to V5 when the topics are topic:// (scalable) topics and to V4 otherwise. Use V5 to drive persistent:// topics with the V5 client|null|
| `[--runtime-flags]` | Any flags that you want to pass to a runtime (for process & Kubernetes runtime only).|null|
| `[--state-storage-service-url]` | The URL for the state storage service (the default is Apache BookKeeper)|null|
| `[--broker-service-url]` | The URL for the Pulsar broker|null|
diff --git a/static/reference/next/pulsar/standalone.md b/static/reference/next/pulsar/standalone.md
index 16d407eed12..10ae58176e2 100644
--- a/static/reference/next/pulsar/standalone.md
+++ b/static/reference/next/pulsar/standalone.md
@@ -13,6 +13,7 @@ $ pulsar standalone options
| `--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 (bookie i uses base + i); 0 selects kernel-assigned ports. Legacy data uses the port recorded in its bookie ID instead.|0|
| `--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|