You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by rx...@apache.org on 2020/07/29 10:48:34 UTC
[pulsar] 03/03: [Doc] Add a note about --state-storage-service-url
in localrun command of Function
This is an automated email from the ASF dual-hosted git repository.
rxl pushed a commit to branch branch-2.6
in repository https://gitbox.apache.org/repos/asf/pulsar.git
commit b10585b8a302c52fd95a5bffb18138044040cdd7
Author: HuanliMeng <48...@users.noreply.github.com>
AuthorDate: Wed Jul 1 23:50:05 2020 +0800
[Doc] Add a note about --state-storage-service-url in localrun command of Function
Signed-off-by: xiaolong.ran <rx...@apache.org>
---
site2/docs/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.3.0/reference-pulsar-admin.md | 3 +--
site2/website/versioned_docs/version-2.3.1/reference-pulsar-admin.md | 3 +--
site2/website/versioned_docs/version-2.3.2/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.4.0/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.4.1/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.4.2/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.5.0/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.5.1/reference-pulsar-admin.md | 2 +-
site2/website/versioned_docs/version-2.5.2/reference-pulsar-admin.md | 2 +-
10 files changed, 10 insertions(+), 12 deletions(-)
diff --git a/site2/docs/reference-pulsar-admin.md b/site2/docs/reference-pulsar-admin.md
index 419b507..b37d84a 100644
--- a/site2/docs/reference-pulsar-admin.md
+++ b/site2/docs/reference-pulsar-admin.md
@@ -450,7 +450,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally. ||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.3.0/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.3.0/reference-pulsar-admin.md
index 100af97..7b78821 100644
--- a/site2/website/versioned_docs/version-2.3.0/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.3.0/reference-pulsar-admin.md
@@ -425,8 +425,7 @@ Options
|`--schema-type`|Schema Type to be used for storing output messages||
|`--sliding-interval-count`|Number of messages after which the window ends||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The service URL for the function’s state storage (if the function uses a storage system different from the Apache BookKeeper cluster used by Pulsar)||
-|`--subscription-type`|The subscription type used by the function when consuming messages on the input topic(s). Can be either SHARED or EXCLUSIVE|SHARED|
+|`--state-storage-service-url`|The service URL for the function’s state storage (if the function uses a storage system different from the Apache BookKeeper cluster used by Pulsar). This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern||
|`--user-config`|A user-supplied config value, set as a key/value pair. You can set multiple user config values.||
diff --git a/site2/website/versioned_docs/version-2.3.1/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.3.1/reference-pulsar-admin.md
index 8fe1afd..9e82787 100644
--- a/site2/website/versioned_docs/version-2.3.1/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.3.1/reference-pulsar-admin.md
@@ -425,8 +425,7 @@ Options
|`--schema-type`|Schema Type to be used for storing output messages||
|`--sliding-interval-count`|Number of messages after which the window ends||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The service URL for the function’s state storage (if the function uses a storage system different from the Apache BookKeeper cluster used by Pulsar)||
-|`--subscription-type`|The subscription type used by the function when consuming messages on the input topic(s). Can be either SHARED or EXCLUSIVE|SHARED|
+|`--state-storage-service-url`|The service URL for the function’s state storage (if the function uses a storage system different from the Apache BookKeeper cluster used by Pulsar). This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern||
|`--user-config`|A user-supplied config value, set as a key/value pair. You can set multiple user config values.||
diff --git a/site2/website/versioned_docs/version-2.3.2/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.3.2/reference-pulsar-admin.md
index 50ac36c..6c2522a 100644
--- a/site2/website/versioned_docs/version-2.3.2/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.3.2/reference-pulsar-admin.md
@@ -430,7 +430,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.4.0/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.4.0/reference-pulsar-admin.md
index 2e8fe15..c128519 100644
--- a/site2/website/versioned_docs/version-2.4.0/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.4.0/reference-pulsar-admin.md
@@ -430,7 +430,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.4.1/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.4.1/reference-pulsar-admin.md
index 37a0099..1bbba00 100644
--- a/site2/website/versioned_docs/version-2.4.1/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.4.1/reference-pulsar-admin.md
@@ -434,7 +434,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.4.2/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.4.2/reference-pulsar-admin.md
index 358d931..2b761dd 100644
--- a/site2/website/versioned_docs/version-2.4.2/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.4.2/reference-pulsar-admin.md
@@ -434,7 +434,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.5.0/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.5.0/reference-pulsar-admin.md
index 422d8a5..d328503 100644
--- a/site2/website/versioned_docs/version-2.5.0/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.5.0/reference-pulsar-admin.md
@@ -451,7 +451,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.5.1/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.5.1/reference-pulsar-admin.md
index 86e1b95..0c320ee 100644
--- a/site2/website/versioned_docs/version-2.5.1/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.5.1/reference-pulsar-admin.md
@@ -451,7 +451,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||
diff --git a/site2/website/versioned_docs/version-2.5.2/reference-pulsar-admin.md b/site2/website/versioned_docs/version-2.5.2/reference-pulsar-admin.md
index d9be03a..56b7fe9 100644
--- a/site2/website/versioned_docs/version-2.5.2/reference-pulsar-admin.md
+++ b/site2/website/versioned_docs/version-2.5.2/reference-pulsar-admin.md
@@ -451,7 +451,7 @@ Options
|`--schema-type`|The builtin schema type or custom schema class name to be used for messages output by the function||
|`--sliding-interval-count`|The number of messages after which the window slides||
|`--sliding-interval-duration-ms`|The time duration after which the window slides||
-|`--state-storage-service-url`|The URL for the state storage service (by default Apache BookKeeper)||
+|`--state-storage-service-url`|The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.||
|`--tenant`|The function’s tenant||
|`--topics-pattern`|The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)||
|`--user-config`|User-defined config key/values||