This is an automated email from the ASF dual-hosted git repository.
lhotari 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 9bbad55db0b2 [improve][doc] Cleanup Subscription in functions are not
propely expl… (#867)
9bbad55db0b2 is described below
commit 9bbad55db0b2c1e120798fef1a240b547f145ec4
Author: Alvaro <[email protected]>
AuthorDate: Mon Mar 25 10:33:01 2024 +0100
[improve][doc] Cleanup Subscription in functions are not propely expl…
(#867)
* [improve][doc] Cleanup Subscription in functions are not propely
explained.
Fixes apache/pulsar#22333
Add the command argument and the default value
* Address 3.2.x version docs
---------
Co-authored-by: Lari Hotari <[email protected]>
---
docs/functions-cli.md | 2 +-
versioned_docs/version-2.11.x/functions-cli.md | 2 +-
versioned_docs/version-3.0.x/functions-cli.md | 2 +-
versioned_docs/version-3.2.x/functions-cli.md | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/functions-cli.md b/docs/functions-cli.md
index 9c85f3a75062..2a039ca278d5 100644
--- a/docs/functions-cli.md
+++ b/docs/functions-cli.md
@@ -59,7 +59,7 @@ You can configure a function by using a predefined YAML file.
The following tabl
| jar | String | `--jar` | The path of the
JAR file for a function (written in Java). It also supports URL paths that
workers can download the package from, including HTTP, HTTPS, file (file
protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
| py | String | `--py` | The path of the
main Python/Python wheel file for a function (written in Python). It also
supports URL paths that workers can download the package from, including HTTP,
HTTPS, file (file protocol assuming that file already exists on worker host),
and function (package URL from packages management service). |
| go | String | `--go` | Path to the main
Go executable binary for the function (written in Go). It also supports URL
paths that workers can download the package from, including HTTP, HTTPS, file
(file protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
-| cleanupSubscription | Boolean | N/A | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. |
+| cleanupSubscription | Boolean | `--cleanup-subscription` | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. The default value is `true` |
| customRuntimeOptions | String | `--custom-runtime-options` | A string
that encodes options to customize the runtime. |
| maxPendingAsyncRequests | Int | `--max-message-retries` | The max
number of pending async requests per instance to avoid a large number of
concurrent requests. |
| exposePulsarAdminClientEnabled | Boolean | N/A | Whether the
Pulsar admin client is exposed to function context or not. By default, it is
disabled. |
diff --git a/versioned_docs/version-2.11.x/functions-cli.md
b/versioned_docs/version-2.11.x/functions-cli.md
index ed8cc09bf2de..4d7d0450e172 100644
--- a/versioned_docs/version-2.11.x/functions-cli.md
+++ b/versioned_docs/version-2.11.x/functions-cli.md
@@ -58,7 +58,7 @@ You can configure a function by using a predefined YAML file.
The following tabl
| jar | String | `--jar` | The path of the
JAR file for a function (written in Java). It also supports URL paths that
workers can download the package from, including HTTP, HTTPS, file (file
protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
| py | String | `--py` | The path of the
main Python/Python wheel file for a function (written in Python). It also
supports URL paths that workers can download the package from, including HTTP,
HTTPS, file (file protocol assuming that file already exists on worker host),
and function (package URL from packages management service). |
| go | String | `--go` | Path to the main
Go executable binary for the function (written in Go). It also supports URL
paths that workers can download the package from, including HTTP, HTTPS, file
(file protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
-| cleanupSubscription | Boolean | N/A | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. |
+| cleanupSubscription | Boolean | `--cleanup-subscription` | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. The default value is `true` |
| customRuntimeOptions | String | `--custom-runtime-options` | A string
that encodes options to customize the runtime. |
| maxPendingAsyncRequests | Int | `--max-message-retries` | The max
number of pending async requests per instance to avoid a large number of
concurrent requests. |
| exposePulsarAdminClientEnabled | Boolean | N/A | Whether the
Pulsar admin client is exposed to function context or not. By default, it is
disabled. |
diff --git a/versioned_docs/version-3.0.x/functions-cli.md
b/versioned_docs/version-3.0.x/functions-cli.md
index 815e48e2ce70..fee3411223f2 100644
--- a/versioned_docs/version-3.0.x/functions-cli.md
+++ b/versioned_docs/version-3.0.x/functions-cli.md
@@ -58,7 +58,7 @@ You can configure a function by using a predefined YAML file.
The following tabl
| jar | String | `--jar` | The path of the
JAR file for a function (written in Java). It also supports URL paths that
workers can download the package from, including HTTP, HTTPS, file (file
protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
| py | String | `--py` | The path of the
main Python/Python wheel file for a function (written in Python). It also
supports URL paths that workers can download the package from, including HTTP,
HTTPS, file (file protocol assuming that file already exists on worker host),
and function (package URL from packages management service). |
| go | String | `--go` | Path to the main
Go executable binary for the function (written in Go). It also supports URL
paths that workers can download the package from, including HTTP, HTTPS, file
(file protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
-| cleanupSubscription | Boolean | N/A | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. |
+| cleanupSubscription | Boolean | `--cleanup-subscription` | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. The default value is `true` |
| customRuntimeOptions | String | `--custom-runtime-options` | A string
that encodes options to customize the runtime. |
| maxPendingAsyncRequests | Int | `--max-message-retries` | The max
number of pending async requests per instance to avoid a large number of
concurrent requests. |
| exposePulsarAdminClientEnabled | Boolean | N/A | Whether the
Pulsar admin client is exposed to function context or not. By default, it is
disabled. |
diff --git a/versioned_docs/version-3.2.x/functions-cli.md
b/versioned_docs/version-3.2.x/functions-cli.md
index 9c85f3a75062..2a039ca278d5 100644
--- a/versioned_docs/version-3.2.x/functions-cli.md
+++ b/versioned_docs/version-3.2.x/functions-cli.md
@@ -59,7 +59,7 @@ You can configure a function by using a predefined YAML file.
The following tabl
| jar | String | `--jar` | The path of the
JAR file for a function (written in Java). It also supports URL paths that
workers can download the package from, including HTTP, HTTPS, file (file
protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
| py | String | `--py` | The path of the
main Python/Python wheel file for a function (written in Python). It also
supports URL paths that workers can download the package from, including HTTP,
HTTPS, file (file protocol assuming that file already exists on worker host),
and function (package URL from packages management service). |
| go | String | `--go` | Path to the main
Go executable binary for the function (written in Go). It also supports URL
paths that workers can download the package from, including HTTP, HTTPS, file
(file protocol assuming that file already exists on worker host), and function
(package URL from packages management service). |
-| cleanupSubscription | Boolean | N/A | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. |
+| cleanupSubscription | Boolean | `--cleanup-subscription` | Whether the
subscriptions that a function creates or uses should be deleted or not when the
function is deleted. The default value is `true` |
| customRuntimeOptions | String | `--custom-runtime-options` | A string
that encodes options to customize the runtime. |
| maxPendingAsyncRequests | Int | `--max-message-retries` | The max
number of pending async requests per instance to avoid a large number of
concurrent requests. |
| exposePulsarAdminClientEnabled | Boolean | N/A | Whether the
Pulsar admin client is exposed to function context or not. By default, it is
disabled. |
