You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by lh...@apache.org on 2024/04/03 05:54:12 UTC
(pulsar-site) branch main updated: [Doc] Use absolute path when installing functions or using localrun (#877)
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 2918119c0339 [Doc] Use absolute path when installing functions or using localrun (#877)
2918119c0339 is described below
commit 2918119c033968d12af95979313bac2b594f45f2
Author: Lari Hotari <lh...@users.noreply.github.com>
AuthorDate: Tue Apr 2 22:54:06 2024 -0700
[Doc] Use absolute path when installing functions or using localrun (#877)
* Use absolute path when installing functions
* Fix other relative paths
* Address a few more locations
* Fix even more relative paths and docs
* Address review commend: remove mandatory sentence for classname
---
docs/admin-api-functions.md | 2 +-
docs/admin-api-schemas.md | 2 +-
docs/deploy-bare-metal.md | 2 +-
docs/functions-cli.md | 6 ++--
docs/functions-deploy-arguments.md | 2 +-
docs/functions-deploy-cluster-parallelism.md | 2 +-
docs/functions-deploy-cluster-resource.md | 2 +-
docs/functions-deploy-localrun.md | 2 +-
docs/functions-develop-admin-api.md | 2 +-
docs/functions-develop-log.md | 2 +-
docs/functions-develop-tutorial.md | 2 +-
docs/functions-package-go.md | 11 ++-----
docs/functions-package-java.md | 21 +++----------
docs/functions-package-python.md | 4 +--
docs/functions-quickstart.md | 12 ++++----
docs/io-canal-source.md | 2 +-
docs/io-cdc-debezium.md | 14 ++++-----
docs/io-cli.md | 36 +++++++++++-----------
docs/io-debezium-source.md | 12 ++++----
docs/io-debug.md | 8 ++---
docs/io-elasticsearch-sink.md | 6 ++--
docs/io-kafka-source.md | 6 ++--
docs/io-netty-source.md | 8 ++---
docs/io-quickstart.md | 10 +++---
docs/io-rabbitmq-source.md | 4 +--
docs/io-redis-sink.md | 6 ++--
docs/reference-pulsar-admin.md | 26 ++++++++--------
docs/window-functions-context.md | 2 +-
.../version-3.0.x/admin-api-functions.md | 2 +-
versioned_docs/version-3.0.x/admin-api-schemas.md | 2 +-
versioned_docs/version-3.0.x/deploy-bare-metal.md | 2 +-
versioned_docs/version-3.0.x/functions-cli.md | 6 ++--
.../version-3.0.x/functions-deploy-arguments.md | 2 +-
.../functions-deploy-cluster-parallelism.md | 2 +-
.../functions-deploy-cluster-resource.md | 2 +-
.../version-3.0.x/functions-deploy-localrun.md | 2 +-
.../version-3.0.x/functions-develop-admin-api.md | 2 +-
.../version-3.0.x/functions-develop-log.md | 2 +-
.../version-3.0.x/functions-develop-tutorial.md | 2 +-
.../version-3.0.x/functions-package-go.md | 11 ++-----
.../version-3.0.x/functions-package-java.md | 21 +++----------
.../version-3.0.x/functions-package-python.md | 4 +--
.../version-3.0.x/functions-quickstart.md | 12 ++++----
versioned_docs/version-3.0.x/io-canal-source.md | 2 +-
versioned_docs/version-3.0.x/io-cdc-debezium.md | 14 ++++-----
versioned_docs/version-3.0.x/io-cli.md | 36 +++++++++++-----------
versioned_docs/version-3.0.x/io-debezium-source.md | 12 ++++----
versioned_docs/version-3.0.x/io-debug.md | 8 ++---
.../version-3.0.x/io-elasticsearch-sink.md | 6 ++--
versioned_docs/version-3.0.x/io-kafka-source.md | 6 ++--
versioned_docs/version-3.0.x/io-netty-source.md | 8 ++---
versioned_docs/version-3.0.x/io-quickstart.md | 10 +++---
versioned_docs/version-3.0.x/io-rabbitmq-source.md | 4 +--
versioned_docs/version-3.0.x/io-redis-sink.md | 6 ++--
.../version-3.0.x/reference-pulsar-admin.md | 26 ++++++++--------
.../version-3.0.x/window-functions-context.md | 2 +-
.../version-3.2.x/admin-api-functions.md | 2 +-
versioned_docs/version-3.2.x/admin-api-schemas.md | 2 +-
versioned_docs/version-3.2.x/deploy-bare-metal.md | 2 +-
versioned_docs/version-3.2.x/functions-cli.md | 6 ++--
.../version-3.2.x/functions-deploy-arguments.md | 2 +-
.../functions-deploy-cluster-parallelism.md | 2 +-
.../functions-deploy-cluster-resource.md | 2 +-
.../version-3.2.x/functions-deploy-localrun.md | 2 +-
.../version-3.2.x/functions-develop-admin-api.md | 2 +-
.../version-3.2.x/functions-develop-log.md | 2 +-
.../version-3.2.x/functions-develop-tutorial.md | 2 +-
.../version-3.2.x/functions-package-go.md | 11 ++-----
.../version-3.2.x/functions-package-java.md | 21 +++----------
.../version-3.2.x/functions-package-python.md | 4 +--
.../version-3.2.x/functions-quickstart.md | 12 ++++----
versioned_docs/version-3.2.x/io-canal-source.md | 2 +-
versioned_docs/version-3.2.x/io-cdc-debezium.md | 14 ++++-----
versioned_docs/version-3.2.x/io-cli.md | 36 +++++++++++-----------
versioned_docs/version-3.2.x/io-debezium-source.md | 12 ++++----
versioned_docs/version-3.2.x/io-debug.md | 8 ++---
.../version-3.2.x/io-elasticsearch-sink.md | 6 ++--
versioned_docs/version-3.2.x/io-kafka-source.md | 6 ++--
versioned_docs/version-3.2.x/io-netty-source.md | 8 ++---
versioned_docs/version-3.2.x/io-quickstart.md | 10 +++---
versioned_docs/version-3.2.x/io-rabbitmq-source.md | 4 +--
versioned_docs/version-3.2.x/io-redis-sink.md | 6 ++--
.../version-3.2.x/reference-pulsar-admin.md | 26 ++++++++--------
.../version-3.2.x/window-functions-context.md | 2 +-
84 files changed, 291 insertions(+), 351 deletions(-)
diff --git a/docs/admin-api-functions.md b/docs/admin-api-functions.md
index 95189c0f4995..72d925f2caed 100644
--- a/docs/admin-api-functions.md
+++ b/docs/admin-api-functions.md
@@ -46,7 +46,7 @@ pulsar-admin functions create \
--inputs test-input-topic \
--output persistent://public/default/test-output-topic \
--classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
- --jar /examples/api-examples.jar
+ --jar $PWD/examples/api-examples.jar
```
</TabItem>
diff --git a/docs/admin-api-schemas.md b/docs/admin-api-schemas.md
index d562e13a4ea2..fb8914980ff9 100644
--- a/docs/admin-api-schemas.md
+++ b/docs/admin-api-schemas.md
@@ -255,7 +255,7 @@ To extract (provide) a schema via a topic, use the following method.
Use the `extract` subcommand.
```bash
-pulsar-admin schemas extract --classname <class-name> --jar <jar-path> --type <type-name>
+pulsar-admin schemas extract --classname <class-name> --jar <absolute-jar-path> --type <type-name>
```
</TabItem>
diff --git a/docs/deploy-bare-metal.md b/docs/deploy-bare-metal.md
index 1fdc27e48751..626745f87be7 100644
--- a/docs/deploy-bare-metal.md
+++ b/docs/deploy-bare-metal.md
@@ -481,7 +481,7 @@ Create an ExclamationFunction `exclamation`.
```bash
bin/pulsar-admin functions create \
- --jar examples/api-examples.jar \
+ --jar $PWD/examples/api-examples.jar \
--classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
--inputs persistent://public/default/exclamation-input \
--output persistent://public/default/exclamation-output \
diff --git a/docs/functions-cli.md b/docs/functions-cli.md
index 2a039ca278d5..ef8b245d1a71 100644
--- a/docs/functions-cli.md
+++ b/docs/functions-cli.md
@@ -56,9 +56,9 @@ You can configure a function by using a predefined YAML file. The following tabl
| fqfn | String | `--fqfn` | The Fully Qualified Function Name (FQFN) of a function. |
| windowConfig | [WindowConfig](#windowconfig) | N/A | N/A |
| timeoutMs | Long | `--timeout-ms` | The message timeout (in milliseconds). |
-| 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). |
+| jar | String | `--jar` | The absolute 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 absolute 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` | The absolute path of 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 | `--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. |
diff --git a/docs/functions-deploy-arguments.md b/docs/functions-deploy-arguments.md
index 45bed9a2e792..2af215a79469 100644
--- a/docs/functions-deploy-arguments.md
+++ b/docs/functions-deploy-arguments.md
@@ -25,7 +25,7 @@ Take the `create` command for example. The following function has default values
```bash
bin/pulsar-admin functions create \
- --jar my-pulsar-functions.jar \
+ --jar $PWD/my-pulsar-functions.jar \
--classname org.example.MyFunction \
--inputs my-function-input-topic1,my-function-input-topic2
```
diff --git a/docs/functions-deploy-cluster-parallelism.md b/docs/functions-deploy-cluster-parallelism.md
index fef7ebcf7d4e..994ad3bbeac9 100644
--- a/docs/functions-deploy-cluster-parallelism.md
+++ b/docs/functions-deploy-cluster-parallelism.md
@@ -41,6 +41,6 @@ For an existing function, you can adjust the parallelism by using the `update` c
```bash
bin/pulsar-admin functions update \
- --function-config-file function-config.yaml
+ --function-config-file $PWD/function-config.yaml
```
diff --git a/docs/functions-deploy-cluster-resource.md b/docs/functions-deploy-cluster-resource.md
index a000982c4955..544eb4c880bd 100644
--- a/docs/functions-deploy-cluster-resource.md
+++ b/docs/functions-deploy-cluster-resource.md
@@ -19,7 +19,7 @@ For example, the following command allocates 8 cores, 8GB of RAM, and 10GB of di
```bash
bin/pulsar-admin functions create \
- --jar target/my-functions.jar \
+ --jar $PWD/target/my-functions.jar \
--classname org.example.functions.MyFunction \
--cpu 8 \
--ram 8589934592 \
diff --git a/docs/functions-deploy-localrun.md b/docs/functions-deploy-localrun.md
index 0d6fbda0c5ed..e52cf9557b75 100644
--- a/docs/functions-deploy-localrun.md
+++ b/docs/functions-deploy-localrun.md
@@ -13,7 +13,7 @@ The following is an example of how to use the `localrun` command.
```bash
bin/pulsar-admin functions localrun \
- --py myfunc.py \
+ --py $PWD/myfunc.py \
--classname myfunc.SomeFunction \
--inputs persistent://public/default/input-1 \
--output persistent://public/default/output-1
diff --git a/docs/functions-develop-admin-api.md b/docs/functions-develop-admin-api.md
index 037888082303..4273696bda7a 100644
--- a/docs/functions-develop-admin-api.md
+++ b/docs/functions-develop-admin-api.md
@@ -43,7 +43,7 @@ To enable your function to get access to the Pulsar admin client, you need to se
```bash
bin/pulsar-admin functions localrun \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.CursorManagementFunction \
--web-service-url http://pulsar-web-service:8080 \
# Other function configs
diff --git a/docs/functions-develop-log.md b/docs/functions-develop-log.md
index 77f182621e47..723888677aff 100644
--- a/docs/functions-develop-log.md
+++ b/docs/functions-develop-log.md
@@ -37,7 +37,7 @@ To enable your function to produce logs, you need to specify a log topic when cr
```bash
bin/pulsar-admin functions create \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.LoggingFunction \
--log-topic persistent://public/default/logging-function-logs \
# Other function configs
diff --git a/docs/functions-develop-tutorial.md b/docs/functions-develop-tutorial.md
index e276673debdc..84f1039bd227 100644
--- a/docs/functions-develop-tutorial.md
+++ b/docs/functions-develop-tutorial.md
@@ -42,7 +42,7 @@ To write a function for word count, complete the following steps.
```bash
bin/pulsar-admin functions create \
- --jar target/my-jar-with-dependencies.jar \
+ --jar $PWD/target/my-jar-with-dependencies.jar \
--classname org.example.functions.WordCountFunction \
--tenant public \
--namespace default \
diff --git a/docs/functions-package-go.md b/docs/functions-package-go.md
index 25eedc3a9af8..a336879f1ceb 100644
--- a/docs/functions-package-go.md
+++ b/docs/functions-package-go.md
@@ -20,18 +20,11 @@ To package a Go function, complete the following steps.
go build <your Go function filename>.go
```
-3. Copy the Go function file to the Pulsar image.
-
- ```bash
- docker exec -it [CONTAINER ID] /bin/bash
- docker cp <your go function path> CONTAINER ID:/pulsar
- ```
-
- 4. Run the Go function with the following command.
+3. Run the Go function with the following command.
```bash
bin/pulsar-admin functions localrun \
- --go [your go function path]
+ --go [absolute path to your go function]
--inputs [input topics] \
--output [output topic] \
--tenant [default:public] \
diff --git a/docs/functions-package-java.md b/docs/functions-package-java.md
index 3f227cc7a696..921b0d1b8837 100644
--- a/docs/functions-package-java.md
+++ b/docs/functions-package-java.md
@@ -93,19 +93,12 @@ To package a Java function as JAR, complete the following steps.
After the Java function is packaged, a `target` directory is created automatically. Open the `target` directory to check if there is a JAR package similar to `java-function-1.0-SNAPSHOT.jar`.
-3. Copy the packaged jar file to the Pulsar image.
-
- ```bash
- docker exec -it [CONTAINER ID] /bin/bash
- docker cp <path of java-function-1.0-SNAPSHOT.jar> CONTAINER ID:/pulsar
- ```
-
-4. Run the Java function using the following command.
+3. Run the Java function using the following command.
```bash
./bin/pulsar-admin functions localrun \
--classname org.example.test.ExclamationFunction \
- --jar java-function-1.0-SNAPSHOT.jar \
+ --jar $PWD/target/java-function-1.0-SNAPSHOT.jar \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
@@ -183,17 +176,11 @@ To package a Java function as NAR, complete the following steps.
After the Java function is packaged, a `target` directory is created automatically. Open the `target` directory to check if there is a NAR package similar to `java-function-1.0-SNAPSHOT.nar`.
-3. Copy the packaged NAR file to the Pulsar image.
-
- ```bash
- docker cp <path of java-function-1.0-SNAPSHOT.nar> CONTAINER ID:/pulsar
- ```
-
-4. Run the Java function using the following command.
+3. Run the Java function using the following command.
```bash
./bin/pulsar-admin functions localrun \
- --jar java-function-1.0-SNAPSHOT.nar \
+ --jar $PWD/target/java-function-1.0-SNAPSHOT.nar \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
diff --git a/docs/functions-package-python.md b/docs/functions-package-python.md
index c5d056be6218..91a324ecd567 100644
--- a/docs/functions-package-python.md
+++ b/docs/functions-package-python.md
@@ -58,7 +58,7 @@ To package a Python function into **one Python file**, complete the following st
```bash
./bin/pulsar-admin functions localrun \
--classname <Python Function file name>.<Python Function class name> \
- --py <path of Python Function file> \
+ --py <absolute path of Python Function file> \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
@@ -109,7 +109,7 @@ To package a Python function into a **ZIP file**, complete the following steps.
```shell
./bin/pulsar-admin functions localrun \
--classname exclamation \
- --py <path of ZIP file> \
+ --py <absolute path of ZIP file> \
--inputs persistent://public/default/in-topic \
--output persistent://public/default/out-topic \
--tenant public \
diff --git a/docs/functions-quickstart.md b/docs/functions-quickstart.md
index 29ef7cf25c94..bd0939345c9c 100644
--- a/docs/functions-quickstart.md
+++ b/docs/functions-quickstart.md
@@ -129,8 +129,8 @@ Before starting functions, you need to [start Pulsar](#start-standalone-pulsar)
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
@@ -295,8 +295,8 @@ The following example provides instructions to start a stateful function to vali
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-stateful-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-stateful-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
@@ -480,8 +480,8 @@ The following example provides instructions to start a window function to calcul
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-window-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-window-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
diff --git a/docs/io-canal-source.md b/docs/io-canal-source.md
index fae275a65bf7..40b107a93ad6 100644
--- a/docs/io-canal-source.md
+++ b/docs/io-canal-source.md
@@ -169,7 +169,7 @@ Here is an example of storing MySQL data using the configuration file as above.
docker exec -it pulsar-standalone /bin/bash
wget https://archive.apache.org/dist/pulsar/pulsar-2.3.0/connectors/pulsar-io-canal-2.3.0.nar -P connectors
./bin/pulsar-admin source localrun \
- --archive ./connectors/pulsar-io-canal-2.3.0.nar \
+ --archive $PWD/connectors/pulsar-io-canal-2.3.0.nar \
--classname org.apache.pulsar.io.canal.CanalStringSource \
--tenant public \
--namespace default \
diff --git a/docs/io-cdc-debezium.md b/docs/io-cdc-debezium.md
index cd9a7370e647..04e356664f4f 100644
--- a/docs/io-cdc-debezium.md
+++ b/docs/io-cdc-debezium.md
@@ -31,7 +31,7 @@ The configuration of the Debezium source connector has the following properties.
| `database.history` | true | null | The name of the database history class. |
| `database.history.pulsar.topic` | true | null | The name of the database history topic where the connector writes and recovers DDL statements. <br /><br />**Note: this topic is for internal use only and should not be used by consumers.** |
| `database.history.pulsar.service.url` | false| null | Pulsar cluster service URL for history topic. <br /><br />**Note**: If `database.history.pulsar.service.url` is not set, then the database history Pulsar client will use the same client settings as those of the source connector, such as `client_auth_plugin` and `client_auth_params`.|
-| `pulsar.service.url` | true | null | Pulsar cluster service URL for the offset topic used in Debezium. You can use the `bin/pulsar-admin --admin-url http://pulsar:8080 sources localrun --source-config-file configs/pg-pulsar-config.yaml` command to point to the target Pulsar cluster.|
+| `pulsar.service.url` | true | null | Pulsar cluster service URL for the offset topic used in Debezium. You can use the `bin/pulsar-admin --admin-url http://pulsar:8080 sources localrun --source-config-file $PWD/configs/pg-pulsar-config.yaml` command to point to the target Pulsar cluster.|
| `offset.storage.topic` | true | null | Record the last committed offsets that the connector successfully completes. |
| `mongodb.hosts` | true | null | The comma-separated list of hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB servers in the replica set. The list contains a single hostname and a port pair. If mongodb.members.auto.discover is set to false, the host and port pair are prefixed with the replica set name (e.g., rs0/localhost:27017). |
| `mongodb.name` | true | null | A unique name that identifies the connector and/or MongoDB replica set or shared cluster that this connector monitors. Each server should be monitored by at most one Debezium connector, since this server name prefixes all persisted Kafka topics emanating from the MongoDB replica set or cluster. |
@@ -138,7 +138,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
--name debezium-mysql-source \
--tenant public \
--namespace default \
@@ -149,7 +149,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mysql-source-config.yaml
+ --source-config-file $PWD/debezium-mysql-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the table _inventory.products_.
@@ -289,7 +289,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
--name debezium-postgres-source \
--tenant public \
--namespace default \
@@ -300,7 +300,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-postgres-source-config.yaml
+ --source-config-file $PWD/debezium-postgres-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
@@ -431,7 +431,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
--name debezium-mongodb-source \
--tenant public \
--namespace default \
@@ -442,7 +442,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mongodb-source-config.yaml
+ --source-config-file $PWD/debezium-mongodb-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
diff --git a/docs/io-cli.md b/docs/io-cli.md
index bdde2dd29563..3d978052780e 100644
--- a/docs/io-cli.md
+++ b/docs/io-cli.md
@@ -49,8 +49,8 @@ pulsar-admin sources create options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
-| `--classname` | The source's class name if `archive` is file-url-path (file://).
+| `-a`, `--archive` | The absolute path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `--classname` | The source's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).
| `--deserialization-classname` | The SerDe classname for the source.
| `--destination-topic-name` | The Pulsar topic to which data is sent.
@@ -62,7 +62,7 @@ pulsar-admin sources create options
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance (applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
| `--source-config` | Source config key/values.
-| `--source-config-file` | The path to a YAML config file specifying the source's configuration.
+| `--source-config-file` | The absolute path to a YAML config file specifying the source's configuration.
| `-t`, `--source-type` | The source's connector provider.
| `--tenant` | The source's tenant.
|`--producer-config`| The custom producer configuration (as a JSON string).
@@ -81,8 +81,8 @@ pulsar-admin sources update options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
-| `--classname` | The source's class name if `archive` is file-url-path (file://).
+| `-a`, `--archive` | The absolute path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `--classname` | The source's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).
| `--deserialization-classname` | The SerDe classname for the source.
| `--destination-topic-name` | The Pulsar topic to which data is sent.
@@ -94,7 +94,7 @@ pulsar-admin sources update options
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance (applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
| `--source-config` | Source config key/values.
-| `--source-config-file` | The path to a YAML config file specifying the source's configuration.
+| `--source-config-file` | The absolute path to a YAML config file specifying the source's configuration.
| `-t`, `--source-type` | The source's connector provider. The `source-type` parameter of the currently built-in connectors is determined by the setting of the `name` parameter specified in the pulsar-io.yaml file.
| `--tenant` | The source's tenant.
| `--update-auth-data` | Whether or not to update the auth data.<br />**Default value: false.**
@@ -245,9 +245,9 @@ pulsar-admin sources localrun options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the Source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the NAR archive for the Source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--broker-service-url` | The URL for the Pulsar broker.
-|`--classname`|The source's class name if `archive` is file-url-path (file://).
+|`--classname`|The source's class name.
| `--client-auth-params` | Client authentication parameter.
| `--client-auth-plugin` | Client authentication plugin using which function-process can connect to broker.
|`--cpu`|The CPU (in cores) that needs to be allocated per source instance (applicable only to the Docker runtime).|
@@ -262,7 +262,7 @@ pulsar-admin sources localrun options
|`--ram`|The RAM (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime).|
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
|`--source-config`|Source config key/values.
-|`--source-config-file`|The path to a YAML config file specifying the source's configuration.
+|`--source-config-file`|The absolute path to a YAML config file specifying the source's configuration.
|`--source-type`|The source's connector provider.
|`--tenant`|The source's tenant.
|`--tls-allow-insecure`|Allow insecure tls connection.<br />**Default value: false**.
@@ -326,9 +326,9 @@ pulsar-admin sinks create options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
-| `--classname` | The sink's class name if `archive` is file-url-path (file://).
+| `--classname` | The sink's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).
| `--custom-schema-inputs` | The map of input topics to schema types or class names (as a JSON string).
| `--custom-serde-inputs` | The map of input topics to SerDe class names (as a JSON string).
@@ -341,7 +341,7 @@ pulsar-admin sinks create options
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
-| `--sink-config-file` | The path to a YAML config file specifying the sink's configuration.
+| `--sink-config-file` | The absolute path to a YAML config file specifying the sink's configuration.
| `-t`, `--sink-type` | The sink's connector provider. The `sink-type` parameter of the currently built-in connectors is determined by the setting of the `name` parameter specified in the pulsar-io.yaml file.
| `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
| `--tenant` | The sink's tenant.
@@ -362,9 +362,9 @@ pulsar-admin sinks update options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
-| `--classname` | The sink's class name if `archive` is file-url-path (file://).
+| `--classname` | The sink's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).
| `--custom-schema-inputs` | The map of input topics to schema types or class names (as a JSON string).
| `--custom-serde-inputs` | The map of input topics to SerDe class names (as a JSON string).
@@ -377,7 +377,7 @@ pulsar-admin sinks update options
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
-| `--sink-config-file` | The path to a YAML config file specifying the sink's configuration.
+| `--sink-config-file` | The absolute path to a YAML config file specifying the sink's configuration.
| `-t`, `--sink-type` | The sink's connector provider.
| `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
| `--tenant` | The sink's tenant.
@@ -532,10 +532,10 @@ pulsar-admin sinks localrun options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
| `--broker-service-url` | The URL for the Pulsar broker.
-|`--classname`|The sink's class name if `archive` is file-url-path (file://).
+|`--classname`|The sink's class name.
| `--client-auth-params` | Client authentication parameter.
| `--client-auth-plugin` | Client authentication plugin using which function-process can connect to broker.
|`--cpu`|The CPU (in cores) that needs to be allocated per sink instance (applicable only to the Docker runtime).
@@ -553,7 +553,7 @@ pulsar-admin sinks localrun options
|`--ram`|The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime).|
|`--retain-ordering` | Sink consumes and sinks messages in order.
|`--sink-config`|sink config key/values.
-|`--sink-config-file`|The path to a YAML config file specifying the sink's configuration.
+|`--sink-config-file`|The absolute path to a YAML config file specifying the sink's configuration.
|`--sink-type`|The sink's connector provider.
|`--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
|`--tenant`|The sink's tenant.
diff --git a/docs/io-debezium-source.md b/docs/io-debezium-source.md
index 68759ad8772c..f5fdce1a4bee 100644
--- a/docs/io-debezium-source.md
+++ b/docs/io-debezium-source.md
@@ -175,7 +175,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
--name debezium-mysql-source \
--tenant public \
--namespace default \
@@ -199,7 +199,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mysql-source-config.yaml
+ --source-config-file $PWD/debezium-mysql-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the table _inventory.products_.
@@ -345,7 +345,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
--name debezium-postgres-source \
--tenant public \
--namespace default \
@@ -369,7 +369,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-postgres-source-config.yaml
+ --source-config-file $PWD/debezium-postgres-source-config.yaml
```
4. Subscribe to the topic _sub-users_ for the _public.users_ table.
@@ -505,7 +505,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
--name debezium-mongodb-source \
--tenant public \
--namespace default \
@@ -529,7 +529,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mongodb-source-config.yaml
+ --source-config-file $PWD/debezium-mongodb-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
diff --git a/docs/io-debug.md b/docs/io-debug.md
index 5ffacbeb53bc..dce82f0bf322 100644
--- a/docs/io-debug.md
+++ b/docs/io-debug.md
@@ -65,11 +65,11 @@ For more information about the `localrun` command, see [`localrun`](reference-co
```bash
./bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-mongo-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-mongo-@pulsar:version@.nar \
--tenant public --namespace default \
--inputs test-mongo \
--name pulsar-mongo-sink \
- --sink-config-file mongo-sink-config.yaml \
+ --sink-config-file $PWD/mongo-sink-config.yaml \
--parallelism 1
```
@@ -216,12 +216,12 @@ Pulsar admin CLI helps you debug Pulsar connectors with the following subcommand
```bash
./bin/pulsar-admin sinks create \
- --archive pulsar-io-mongo-2.4.0.nar \
+ --archive $PWD/pulsar-io-mongo-2.4.0.nar \
--tenant public \
--namespace default \
--inputs test-mongo \
--name pulsar-mongo-sink \
- --sink-config-file mongo-sink-config.yaml \
+ --sink-config-file $PWD/mongo-sink-config.yaml \
--parallelism 1
```
diff --git a/docs/io-elasticsearch-sink.md b/docs/io-elasticsearch-sink.md
index f0023975f2ae..efa3f6899f22 100644
--- a/docs/io-elasticsearch-sink.md
+++ b/docs/io-elasticsearch-sink.md
@@ -190,7 +190,7 @@ Before using the Elasticsearch sink connector, you need to create a configuratio
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name elasticsearch-test-sink \
@@ -202,11 +202,11 @@ Before using the Elasticsearch sink connector, you need to create a configuratio
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name elasticsearch-test-sink \
- --sink-config-file elasticsearch-sink.yml \
+ --sink-config-file $PWD/elasticsearch-sink.yml \
--inputs elasticsearch_test
```
diff --git a/docs/io-kafka-source.md b/docs/io-kafka-source.md
index 890edecd94dd..dd03175f5b7d 100644
--- a/docs/io-kafka-source.md
+++ b/docs/io-kafka-source.md
@@ -164,12 +164,12 @@ This example describes how to use the Kafka source connector to feed data from K
docker exec -it pulsar-kafka-standalone /bin/bash
./bin/pulsar-admin source localrun \
- --archive ./pulsar-io-kafka.nar \
+ --archive $PWD/pulsar-io-kafka.nar \
--tenant public \
--namespace default \
--name kafka \
--destination-topic-name my-topic \
- --source-config-file ./conf/kafkaSourceConfig.yaml \
+ --source-config-file $PWD/conf/kafkaSourceConfig.yaml \
--parallelism 1
```
@@ -217,6 +217,6 @@ This example explains how to create a Kafka source connector in an on-premises c
```bash
PULSAR_HOME/bin/pulsar-admin sources create \
- --source-config-file <kafka-source-config.yaml>
+ --source-config-file <absolute path to kafka-source-config.yaml>
```
diff --git a/docs/io-netty-source.md b/docs/io-netty-source.md
index fca711173772..8b125705eeb9 100644
--- a/docs/io-netty-source.md
+++ b/docs/io-netty-source.md
@@ -96,12 +96,12 @@ The following examples show how to use the Netty source connector with TCP and H
```bash
./bin/pulsar-admin sources localrun \
- --archive pulsar-io-@pulsar:version@.nar \
+ --archive $PWD/pulsar-io-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name netty \
--destination-topic-name netty-topic \
- --source-config-file netty-source-config.yaml \
+ --source-config-file $PWD/netty-source-config.yaml \
--parallelism 1
```
@@ -172,12 +172,12 @@ The following examples show how to use the Netty source connector with TCP and H
```bash
./bin/pulsar-admin sources localrun \
- --archive pulsar-io-@pulsar:version@.nar \
+ --archive $PWD/pulsar-io-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name netty \
--destination-topic-name netty-topic \
- --source-config-file netty-source-config.yaml \
+ --source-config-file $PWD/netty-source-config.yaml \
--parallelism 1
```
diff --git a/docs/io-quickstart.md b/docs/io-quickstart.md
index e40e6ee1ceb0..9c482fbca477 100644
--- a/docs/io-quickstart.md
+++ b/docs/io-quickstart.md
@@ -244,7 +244,7 @@ bin/pulsar-admin sinks create \
--namespace default \
--name cassandra-test-sink \
--sink-type cassandra \
- --sink-config-file examples/cassandra-sink.yml \
+ --sink-config-file $PWD/examples/cassandra-sink.yml \
--inputs test_cassandra
```
@@ -551,10 +551,10 @@ This example creates a sink connector and specifies the desired information.
```bash
bin/pulsar-admin sinks create \
- --archive ./connectors/pulsar-io-jdbc-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-jdbc-postgres-@pulsar:version@.nar \
--inputs pulsar-postgres-jdbc-sink-topic \
--name pulsar-postgres-jdbc-sink \
- --sink-config-file ./connectors/pulsar-postgres-jdbc-sink.yaml \
+ --sink-config-file $PWD/connectors/pulsar-postgres-jdbc-sink.yaml \
--parallelism 1
```
@@ -566,10 +566,10 @@ This sink connector runs as a Pulsar Function and writes the messages produced i
Flag | Description | Example
---|---|---|
- `--archive` | The path to the archive file for the sink. | pulsar-io-jdbc-postgres-@pulsar:version@.nar |
+ `--archive` | The absolute path to the archive file for the sink. | $PWD/pulsar-io-jdbc-postgres-@pulsar:version@.nar |
`--inputs` | The input topic(s) of the sink. <br /><br /> Multiple topics can be specified as a comma-separated list.||
`--name` | The name of the sink. | pulsar-postgres-jdbc-sink |
- `--sink-config-file` | The path to a YAML config file specifying the configuration of the sink. | pulsar-postgres-jdbc-sink.yaml |
+ `--sink-config-file` | The absolute path to a YAML config file specifying the configuration of the sink. | $PWD/pulsar-postgres-jdbc-sink.yaml |
`--parallelism` | The parallelism factor of the sink. <br /><br /> For example, the number of sink instances to run. | 1 |
:::tip
diff --git a/docs/io-rabbitmq-source.md b/docs/io-rabbitmq-source.md
index 284529ef6657..70342ddc29ae 100644
--- a/docs/io-rabbitmq-source.md
+++ b/docs/io-rabbitmq-source.md
@@ -150,8 +150,8 @@ This example describes how to use the RabbitMQ source connector to feed data fro
```bash
./bin/pulsar-admin source localrun \
- --source-config-file conf/rabbitmq-source-queue-name.yaml \
- --archive connectors/pulsar-io-rabbitmq-@pulsar:version@.nar \
+ --source-config-file $PWD/conf/rabbitmq-source-queue-name.yaml \
+ --archive $PWD/connectors/pulsar-io-rabbitmq-@pulsar:version@.nar \
--name rabbitmq-source \
--destination-topic-name pulsar-rabbitmq-test-topic \
--broker-service-url pulsar://{ip}:{port}
diff --git a/docs/io-redis-sink.md b/docs/io-redis-sink.md
index 69b8545f9add..594e3a84f222 100644
--- a/docs/io-redis-sink.md
+++ b/docs/io-redis-sink.md
@@ -96,7 +96,7 @@ This example shows how to write records to a Redis database using the Pulsar Red
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-redis-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-redis-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name my-redis-sink \
@@ -108,11 +108,11 @@ This example shows how to write records to a Redis database using the Pulsar Red
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-redis-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-redis-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name my-redis-sink \
- --sink-config-file redis-sink-config.yaml \
+ --sink-config-file $PWD/redis-sink-config.yaml \
--inputs my-redis-topic
```
diff --git a/docs/reference-pulsar-admin.md b/docs/reference-pulsar-admin.md
index a8f2c5a4c423..bb1e7aea3d81 100644
--- a/docs/reference-pulsar-admin.md
+++ b/docs/reference-pulsar-admin.md
@@ -505,20 +505,20 @@ Options
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
|`--client-auth-params`|Client authentication param||
|`--client-auth-plugin`|Client authentication plugin using which function-process can connect to broker||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--hostname-verification-enabled`|Enable hostname verification|false|
|`--instance-id-offset`|Start the instanceIds from this offset|0|
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -561,18 +561,18 @@ Options
|`--classname`|The function's class name||
|`--custom-serde-inputs`|The map of input topics to SerDe class names (as a JSON string)||
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -630,18 +630,18 @@ Options
|`--classname`|The function's class name||
|`--custom-serde-inputs`|The map of input topics to SerDe class names (as a JSON string)||
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -3017,5 +3017,5 @@ Options
|Flag|Description|Default|
|----|---|---|
|`-c`, `--classname`|The Java class name||
-|`-j`, `--jar`|A path to the JAR file which contains the above Java class||
+|`-j`, `--jar`|Absolute path to the JAR file which contains the above Java class||
|`-t`, `--type`|The type of the schema (avro or json)||
diff --git a/docs/window-functions-context.md b/docs/window-functions-context.md
index a7d0d1948bae..b2213b930e85 100644
--- a/docs/window-functions-context.md
+++ b/docs/window-functions-context.md
@@ -259,7 +259,7 @@ If you need your function to produce logs, specify a log topic when creating or
```bash
bin/pulsar-admin functions create \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.LoggingFunction \
--log-topic persistent://public/default/logging-function-logs \
# Other function configs
diff --git a/versioned_docs/version-3.0.x/admin-api-functions.md b/versioned_docs/version-3.0.x/admin-api-functions.md
index 72750f69d819..5784fcd694ad 100644
--- a/versioned_docs/version-3.0.x/admin-api-functions.md
+++ b/versioned_docs/version-3.0.x/admin-api-functions.md
@@ -45,7 +45,7 @@ pulsar-admin functions create \
--inputs test-input-topic \
--output persistent://public/default/test-output-topic \
--classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
- --jar /examples/api-examples.jar
+ --jar $PWD/examples/api-examples.jar
```
</TabItem>
diff --git a/versioned_docs/version-3.0.x/admin-api-schemas.md b/versioned_docs/version-3.0.x/admin-api-schemas.md
index b330ded56446..041eddfd68f4 100644
--- a/versioned_docs/version-3.0.x/admin-api-schemas.md
+++ b/versioned_docs/version-3.0.x/admin-api-schemas.md
@@ -247,7 +247,7 @@ To extract (provide) a schema via a topic, use the following method.
Use the `extract` subcommand.
```bash
-pulsar-admin schemas extract --classname <class-name> --jar <jar-path> --type <type-name>
+pulsar-admin schemas extract --classname <class-name> --jar <absolute-jar-path> --type <type-name>
```
</TabItem>
diff --git a/versioned_docs/version-3.0.x/deploy-bare-metal.md b/versioned_docs/version-3.0.x/deploy-bare-metal.md
index 8c13b8883275..c4d9ecd240a4 100644
--- a/versioned_docs/version-3.0.x/deploy-bare-metal.md
+++ b/versioned_docs/version-3.0.x/deploy-bare-metal.md
@@ -473,7 +473,7 @@ Create an ExclamationFunction `exclamation`.
```bash
bin/pulsar-admin functions create \
- --jar examples/api-examples.jar \
+ --jar $PWD/examples/api-examples.jar \
--classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
--inputs persistent://public/default/exclamation-input \
--output persistent://public/default/exclamation-output \
diff --git a/versioned_docs/version-3.0.x/functions-cli.md b/versioned_docs/version-3.0.x/functions-cli.md
index fee3411223f2..c4ce42ebe847 100644
--- a/versioned_docs/version-3.0.x/functions-cli.md
+++ b/versioned_docs/version-3.0.x/functions-cli.md
@@ -55,9 +55,9 @@ You can configure a function by using a predefined YAML file. The following tabl
| fqfn | String | `--fqfn` | The Fully Qualified Function Name (FQFN) of a function. |
| windowConfig | [WindowConfig](#windowconfig) | N/A | N/A |
| timeoutMs | Long | `--timeout-ms` | The message timeout (in milliseconds). |
-| 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). |
+| jar | String | `--jar` | The absolute 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 absolute 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` | The absolute path of 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 | `--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. |
diff --git a/versioned_docs/version-3.0.x/functions-deploy-arguments.md b/versioned_docs/version-3.0.x/functions-deploy-arguments.md
index 9271d5dc238b..7d93b606980d 100644
--- a/versioned_docs/version-3.0.x/functions-deploy-arguments.md
+++ b/versioned_docs/version-3.0.x/functions-deploy-arguments.md
@@ -24,7 +24,7 @@ Take the `create` command for example. The following function has default values
```bash
bin/pulsar-admin functions create \
- --jar my-pulsar-functions.jar \
+ --jar $PWD/my-pulsar-functions.jar \
--classname org.example.MyFunction \
--inputs my-function-input-topic1,my-function-input-topic2
```
diff --git a/versioned_docs/version-3.0.x/functions-deploy-cluster-parallelism.md b/versioned_docs/version-3.0.x/functions-deploy-cluster-parallelism.md
index 3620f042cd25..7179872f9dd8 100644
--- a/versioned_docs/version-3.0.x/functions-deploy-cluster-parallelism.md
+++ b/versioned_docs/version-3.0.x/functions-deploy-cluster-parallelism.md
@@ -40,6 +40,6 @@ For an existing function, you can adjust the parallelism by using the `update` c
```bash
bin/pulsar-admin functions update \
- --function-config-file function-config.yaml
+ --function-config-file $PWD/function-config.yaml
```
diff --git a/versioned_docs/version-3.0.x/functions-deploy-cluster-resource.md b/versioned_docs/version-3.0.x/functions-deploy-cluster-resource.md
index 98b1c765f6a0..06bc69806346 100644
--- a/versioned_docs/version-3.0.x/functions-deploy-cluster-resource.md
+++ b/versioned_docs/version-3.0.x/functions-deploy-cluster-resource.md
@@ -18,7 +18,7 @@ For example, the following command allocates 8 cores, 8GB of RAM, and 10GB of di
```bash
bin/pulsar-admin functions create \
- --jar target/my-functions.jar \
+ --jar $PWD/target/my-functions.jar \
--classname org.example.functions.MyFunction \
--cpu 8 \
--ram 8589934592 \
diff --git a/versioned_docs/version-3.0.x/functions-deploy-localrun.md b/versioned_docs/version-3.0.x/functions-deploy-localrun.md
index 3e05f0e86cb8..eef144ec2881 100644
--- a/versioned_docs/version-3.0.x/functions-deploy-localrun.md
+++ b/versioned_docs/version-3.0.x/functions-deploy-localrun.md
@@ -12,7 +12,7 @@ The following is an example of how to use the `localrun` command.
```bash
bin/pulsar-admin functions localrun \
- --py myfunc.py \
+ --py $PWD/myfunc.py \
--classname myfunc.SomeFunction \
--inputs persistent://public/default/input-1 \
--output persistent://public/default/output-1
diff --git a/versioned_docs/version-3.0.x/functions-develop-admin-api.md b/versioned_docs/version-3.0.x/functions-develop-admin-api.md
index 4dc123c7961c..cb8cbe647e9a 100644
--- a/versioned_docs/version-3.0.x/functions-develop-admin-api.md
+++ b/versioned_docs/version-3.0.x/functions-develop-admin-api.md
@@ -42,7 +42,7 @@ To enable your function to get access to the Pulsar admin client, you need to se
```bash
bin/pulsar-admin functions localrun \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.CursorManagementFunction \
--web-service-url http://pulsar-web-service:8080 \
# Other function configs
diff --git a/versioned_docs/version-3.0.x/functions-develop-log.md b/versioned_docs/version-3.0.x/functions-develop-log.md
index 331136b5165e..5290b786f834 100644
--- a/versioned_docs/version-3.0.x/functions-develop-log.md
+++ b/versioned_docs/version-3.0.x/functions-develop-log.md
@@ -36,7 +36,7 @@ To enable your function to produce logs, you need to specify a log topic when cr
```bash
bin/pulsar-admin functions create \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.LoggingFunction \
--log-topic persistent://public/default/logging-function-logs \
# Other function configs
diff --git a/versioned_docs/version-3.0.x/functions-develop-tutorial.md b/versioned_docs/version-3.0.x/functions-develop-tutorial.md
index 439d470629aa..fe5caf0700df 100644
--- a/versioned_docs/version-3.0.x/functions-develop-tutorial.md
+++ b/versioned_docs/version-3.0.x/functions-develop-tutorial.md
@@ -39,7 +39,7 @@ The following example is a stateful function. By default, the state of a functio
```bash
bin/pulsar-admin functions create \
- --jar target/my-jar-with-dependencies.jar \
+ --jar $PWD/target/my-jar-with-dependencies.jar \
--classname org.example.functions.WordCountFunction \
--tenant public \
--namespace default \
diff --git a/versioned_docs/version-3.0.x/functions-package-go.md b/versioned_docs/version-3.0.x/functions-package-go.md
index 127807a2b332..96cf2a79d16c 100644
--- a/versioned_docs/version-3.0.x/functions-package-go.md
+++ b/versioned_docs/version-3.0.x/functions-package-go.md
@@ -19,18 +19,11 @@ To package a Go function, complete the following steps.
go build <your Go function filename>.go
```
-3. Copy the Go function file to the Pulsar image.
-
- ```bash
- docker exec -it [CONTAINER ID] /bin/bash
- docker cp <your go function path> CONTAINER ID:/pulsar
- ```
-
- 4. Run the Go function with the following command.
+3. Run the Go function with the following command.
```bash
bin/pulsar-admin functions localrun \
- --go [your go function path]
+ --go [absolute path to your go function]
--inputs [input topics] \
--output [output topic] \
--tenant [default:public] \
diff --git a/versioned_docs/version-3.0.x/functions-package-java.md b/versioned_docs/version-3.0.x/functions-package-java.md
index c14306ea4a83..b4d9d32ce698 100644
--- a/versioned_docs/version-3.0.x/functions-package-java.md
+++ b/versioned_docs/version-3.0.x/functions-package-java.md
@@ -92,19 +92,12 @@ To package a Java function as JAR, complete the following steps.
After the Java function is packaged, a `target` directory is created automatically. Open the `target` directory to check if there is a JAR package similar to `java-function-1.0-SNAPSHOT.jar`.
-3. Copy the packaged jar file to the Pulsar image.
-
- ```bash
- docker exec -it [CONTAINER ID] /bin/bash
- docker cp <path of java-function-1.0-SNAPSHOT.jar> CONTAINER ID:/pulsar
- ```
-
-4. Run the Java function using the following command.
+3. Run the Java function using the following command.
```bash
./bin/pulsar-admin functions localrun \
--classname org.example.test.ExclamationFunction \
- --jar java-function-1.0-SNAPSHOT.jar \
+ --jar $PWD/target/java-function-1.0-SNAPSHOT.jar \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
@@ -182,17 +175,11 @@ To package a Java function as NAR, complete the following steps.
After the Java function is packaged, a `target` directory is created automatically. Open the `target` directory to check if there is a NAR package similar to `java-function-1.0-SNAPSHOT.nar`.
-3. Copy the packaged NAR file to the Pulsar image.
-
- ```bash
- docker cp <path of java-function-1.0-SNAPSHOT.nar> CONTAINER ID:/pulsar
- ```
-
-4. Run the Java function using the following command.
+3. Run the Java function using the following command.
```bash
./bin/pulsar-admin functions localrun \
- --jar java-function-1.0-SNAPSHOT.nar \
+ --jar $PWD/target/java-function-1.0-SNAPSHOT.nar \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
diff --git a/versioned_docs/version-3.0.x/functions-package-python.md b/versioned_docs/version-3.0.x/functions-package-python.md
index 49feed9818e6..58456b1e3a37 100644
--- a/versioned_docs/version-3.0.x/functions-package-python.md
+++ b/versioned_docs/version-3.0.x/functions-package-python.md
@@ -60,7 +60,7 @@ To package a Python function into **one Python file**, complete the following st
```bash
./bin/pulsar-admin functions localrun \
--classname <Python Function file name>.<Python Function class name> \
- --py <path of Python Function file> \
+ --py <absolute path of Python Function file> \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
@@ -111,7 +111,7 @@ To package a Python function into a **ZIP file**, complete the following steps.
```shell
./bin/pulsar-admin functions localrun \
--classname exclamation \
- --py <path of ZIP file> \
+ --py <absolute path of ZIP file> \
--inputs persistent://public/default/in-topic \
--output persistent://public/default/out-topic \
--tenant public \
diff --git a/versioned_docs/version-3.0.x/functions-quickstart.md b/versioned_docs/version-3.0.x/functions-quickstart.md
index e3d839310d5f..6a1ec8170e5d 100644
--- a/versioned_docs/version-3.0.x/functions-quickstart.md
+++ b/versioned_docs/version-3.0.x/functions-quickstart.md
@@ -128,8 +128,8 @@ Before starting functions, you need to [start Pulsar](#start-standalone-pulsar)
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
@@ -294,8 +294,8 @@ Before starting stateful functions, you need to [start Pulsar](#start-standalone
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-stateful-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-stateful-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
@@ -479,8 +479,8 @@ Before starting window functions, you need to [start Pulsar](#start-standalone-p
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-window-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-window-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
diff --git a/versioned_docs/version-3.0.x/io-canal-source.md b/versioned_docs/version-3.0.x/io-canal-source.md
index fae275a65bf7..40b107a93ad6 100644
--- a/versioned_docs/version-3.0.x/io-canal-source.md
+++ b/versioned_docs/version-3.0.x/io-canal-source.md
@@ -169,7 +169,7 @@ Here is an example of storing MySQL data using the configuration file as above.
docker exec -it pulsar-standalone /bin/bash
wget https://archive.apache.org/dist/pulsar/pulsar-2.3.0/connectors/pulsar-io-canal-2.3.0.nar -P connectors
./bin/pulsar-admin source localrun \
- --archive ./connectors/pulsar-io-canal-2.3.0.nar \
+ --archive $PWD/connectors/pulsar-io-canal-2.3.0.nar \
--classname org.apache.pulsar.io.canal.CanalStringSource \
--tenant public \
--namespace default \
diff --git a/versioned_docs/version-3.0.x/io-cdc-debezium.md b/versioned_docs/version-3.0.x/io-cdc-debezium.md
index cd9a7370e647..04e356664f4f 100644
--- a/versioned_docs/version-3.0.x/io-cdc-debezium.md
+++ b/versioned_docs/version-3.0.x/io-cdc-debezium.md
@@ -31,7 +31,7 @@ The configuration of the Debezium source connector has the following properties.
| `database.history` | true | null | The name of the database history class. |
| `database.history.pulsar.topic` | true | null | The name of the database history topic where the connector writes and recovers DDL statements. <br /><br />**Note: this topic is for internal use only and should not be used by consumers.** |
| `database.history.pulsar.service.url` | false| null | Pulsar cluster service URL for history topic. <br /><br />**Note**: If `database.history.pulsar.service.url` is not set, then the database history Pulsar client will use the same client settings as those of the source connector, such as `client_auth_plugin` and `client_auth_params`.|
-| `pulsar.service.url` | true | null | Pulsar cluster service URL for the offset topic used in Debezium. You can use the `bin/pulsar-admin --admin-url http://pulsar:8080 sources localrun --source-config-file configs/pg-pulsar-config.yaml` command to point to the target Pulsar cluster.|
+| `pulsar.service.url` | true | null | Pulsar cluster service URL for the offset topic used in Debezium. You can use the `bin/pulsar-admin --admin-url http://pulsar:8080 sources localrun --source-config-file $PWD/configs/pg-pulsar-config.yaml` command to point to the target Pulsar cluster.|
| `offset.storage.topic` | true | null | Record the last committed offsets that the connector successfully completes. |
| `mongodb.hosts` | true | null | The comma-separated list of hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB servers in the replica set. The list contains a single hostname and a port pair. If mongodb.members.auto.discover is set to false, the host and port pair are prefixed with the replica set name (e.g., rs0/localhost:27017). |
| `mongodb.name` | true | null | A unique name that identifies the connector and/or MongoDB replica set or shared cluster that this connector monitors. Each server should be monitored by at most one Debezium connector, since this server name prefixes all persisted Kafka topics emanating from the MongoDB replica set or cluster. |
@@ -138,7 +138,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
--name debezium-mysql-source \
--tenant public \
--namespace default \
@@ -149,7 +149,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mysql-source-config.yaml
+ --source-config-file $PWD/debezium-mysql-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the table _inventory.products_.
@@ -289,7 +289,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
--name debezium-postgres-source \
--tenant public \
--namespace default \
@@ -300,7 +300,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-postgres-source-config.yaml
+ --source-config-file $PWD/debezium-postgres-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
@@ -431,7 +431,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
--name debezium-mongodb-source \
--tenant public \
--namespace default \
@@ -442,7 +442,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mongodb-source-config.yaml
+ --source-config-file $PWD/debezium-mongodb-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
diff --git a/versioned_docs/version-3.0.x/io-cli.md b/versioned_docs/version-3.0.x/io-cli.md
index bdde2dd29563..3d978052780e 100644
--- a/versioned_docs/version-3.0.x/io-cli.md
+++ b/versioned_docs/version-3.0.x/io-cli.md
@@ -49,8 +49,8 @@ pulsar-admin sources create options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
-| `--classname` | The source's class name if `archive` is file-url-path (file://).
+| `-a`, `--archive` | The absolute path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `--classname` | The source's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).
| `--deserialization-classname` | The SerDe classname for the source.
| `--destination-topic-name` | The Pulsar topic to which data is sent.
@@ -62,7 +62,7 @@ pulsar-admin sources create options
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance (applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
| `--source-config` | Source config key/values.
-| `--source-config-file` | The path to a YAML config file specifying the source's configuration.
+| `--source-config-file` | The absolute path to a YAML config file specifying the source's configuration.
| `-t`, `--source-type` | The source's connector provider.
| `--tenant` | The source's tenant.
|`--producer-config`| The custom producer configuration (as a JSON string).
@@ -81,8 +81,8 @@ pulsar-admin sources update options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
-| `--classname` | The source's class name if `archive` is file-url-path (file://).
+| `-a`, `--archive` | The absolute path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `--classname` | The source's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).
| `--deserialization-classname` | The SerDe classname for the source.
| `--destination-topic-name` | The Pulsar topic to which data is sent.
@@ -94,7 +94,7 @@ pulsar-admin sources update options
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance (applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
| `--source-config` | Source config key/values.
-| `--source-config-file` | The path to a YAML config file specifying the source's configuration.
+| `--source-config-file` | The absolute path to a YAML config file specifying the source's configuration.
| `-t`, `--source-type` | The source's connector provider. The `source-type` parameter of the currently built-in connectors is determined by the setting of the `name` parameter specified in the pulsar-io.yaml file.
| `--tenant` | The source's tenant.
| `--update-auth-data` | Whether or not to update the auth data.<br />**Default value: false.**
@@ -245,9 +245,9 @@ pulsar-admin sources localrun options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the Source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the NAR archive for the Source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--broker-service-url` | The URL for the Pulsar broker.
-|`--classname`|The source's class name if `archive` is file-url-path (file://).
+|`--classname`|The source's class name.
| `--client-auth-params` | Client authentication parameter.
| `--client-auth-plugin` | Client authentication plugin using which function-process can connect to broker.
|`--cpu`|The CPU (in cores) that needs to be allocated per source instance (applicable only to the Docker runtime).|
@@ -262,7 +262,7 @@ pulsar-admin sources localrun options
|`--ram`|The RAM (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime).|
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
|`--source-config`|Source config key/values.
-|`--source-config-file`|The path to a YAML config file specifying the source's configuration.
+|`--source-config-file`|The absolute path to a YAML config file specifying the source's configuration.
|`--source-type`|The source's connector provider.
|`--tenant`|The source's tenant.
|`--tls-allow-insecure`|Allow insecure tls connection.<br />**Default value: false**.
@@ -326,9 +326,9 @@ pulsar-admin sinks create options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
-| `--classname` | The sink's class name if `archive` is file-url-path (file://).
+| `--classname` | The sink's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).
| `--custom-schema-inputs` | The map of input topics to schema types or class names (as a JSON string).
| `--custom-serde-inputs` | The map of input topics to SerDe class names (as a JSON string).
@@ -341,7 +341,7 @@ pulsar-admin sinks create options
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
-| `--sink-config-file` | The path to a YAML config file specifying the sink's configuration.
+| `--sink-config-file` | The absolute path to a YAML config file specifying the sink's configuration.
| `-t`, `--sink-type` | The sink's connector provider. The `sink-type` parameter of the currently built-in connectors is determined by the setting of the `name` parameter specified in the pulsar-io.yaml file.
| `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
| `--tenant` | The sink's tenant.
@@ -362,9 +362,9 @@ pulsar-admin sinks update options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
-| `--classname` | The sink's class name if `archive` is file-url-path (file://).
+| `--classname` | The sink's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).
| `--custom-schema-inputs` | The map of input topics to schema types or class names (as a JSON string).
| `--custom-serde-inputs` | The map of input topics to SerDe class names (as a JSON string).
@@ -377,7 +377,7 @@ pulsar-admin sinks update options
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
-| `--sink-config-file` | The path to a YAML config file specifying the sink's configuration.
+| `--sink-config-file` | The absolute path to a YAML config file specifying the sink's configuration.
| `-t`, `--sink-type` | The sink's connector provider.
| `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
| `--tenant` | The sink's tenant.
@@ -532,10 +532,10 @@ pulsar-admin sinks localrun options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
| `--broker-service-url` | The URL for the Pulsar broker.
-|`--classname`|The sink's class name if `archive` is file-url-path (file://).
+|`--classname`|The sink's class name.
| `--client-auth-params` | Client authentication parameter.
| `--client-auth-plugin` | Client authentication plugin using which function-process can connect to broker.
|`--cpu`|The CPU (in cores) that needs to be allocated per sink instance (applicable only to the Docker runtime).
@@ -553,7 +553,7 @@ pulsar-admin sinks localrun options
|`--ram`|The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime).|
|`--retain-ordering` | Sink consumes and sinks messages in order.
|`--sink-config`|sink config key/values.
-|`--sink-config-file`|The path to a YAML config file specifying the sink's configuration.
+|`--sink-config-file`|The absolute path to a YAML config file specifying the sink's configuration.
|`--sink-type`|The sink's connector provider.
|`--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
|`--tenant`|The sink's tenant.
diff --git a/versioned_docs/version-3.0.x/io-debezium-source.md b/versioned_docs/version-3.0.x/io-debezium-source.md
index 68759ad8772c..f5fdce1a4bee 100644
--- a/versioned_docs/version-3.0.x/io-debezium-source.md
+++ b/versioned_docs/version-3.0.x/io-debezium-source.md
@@ -175,7 +175,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
--name debezium-mysql-source \
--tenant public \
--namespace default \
@@ -199,7 +199,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mysql-source-config.yaml
+ --source-config-file $PWD/debezium-mysql-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the table _inventory.products_.
@@ -345,7 +345,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
--name debezium-postgres-source \
--tenant public \
--namespace default \
@@ -369,7 +369,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-postgres-source-config.yaml
+ --source-config-file $PWD/debezium-postgres-source-config.yaml
```
4. Subscribe to the topic _sub-users_ for the _public.users_ table.
@@ -505,7 +505,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
--name debezium-mongodb-source \
--tenant public \
--namespace default \
@@ -529,7 +529,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mongodb-source-config.yaml
+ --source-config-file $PWD/debezium-mongodb-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
diff --git a/versioned_docs/version-3.0.x/io-debug.md b/versioned_docs/version-3.0.x/io-debug.md
index 304a47f82aca..114ca2d657d0 100644
--- a/versioned_docs/version-3.0.x/io-debug.md
+++ b/versioned_docs/version-3.0.x/io-debug.md
@@ -64,11 +64,11 @@ For more information about the `localrun` command, see [`localrun`](reference-co
```bash
./bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-mongo-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-mongo-@pulsar:version@.nar \
--tenant public --namespace default \
--inputs test-mongo \
--name pulsar-mongo-sink \
- --sink-config-file mongo-sink-config.yaml \
+ --sink-config-file $PWD/mongo-sink-config.yaml \
--parallelism 1
```
@@ -215,12 +215,12 @@ Pulsar admin CLI helps you debug Pulsar connectors with the following subcommand
```bash
./bin/pulsar-admin sinks create \
- --archive pulsar-io-mongo-2.4.0.nar \
+ --archive $PWD/pulsar-io-mongo-2.4.0.nar \
--tenant public \
--namespace default \
--inputs test-mongo \
--name pulsar-mongo-sink \
- --sink-config-file mongo-sink-config.yaml \
+ --sink-config-file $PWD/mongo-sink-config.yaml \
--parallelism 1
```
diff --git a/versioned_docs/version-3.0.x/io-elasticsearch-sink.md b/versioned_docs/version-3.0.x/io-elasticsearch-sink.md
index f0023975f2ae..efa3f6899f22 100644
--- a/versioned_docs/version-3.0.x/io-elasticsearch-sink.md
+++ b/versioned_docs/version-3.0.x/io-elasticsearch-sink.md
@@ -190,7 +190,7 @@ Before using the Elasticsearch sink connector, you need to create a configuratio
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name elasticsearch-test-sink \
@@ -202,11 +202,11 @@ Before using the Elasticsearch sink connector, you need to create a configuratio
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name elasticsearch-test-sink \
- --sink-config-file elasticsearch-sink.yml \
+ --sink-config-file $PWD/elasticsearch-sink.yml \
--inputs elasticsearch_test
```
diff --git a/versioned_docs/version-3.0.x/io-kafka-source.md b/versioned_docs/version-3.0.x/io-kafka-source.md
index 890edecd94dd..dd03175f5b7d 100644
--- a/versioned_docs/version-3.0.x/io-kafka-source.md
+++ b/versioned_docs/version-3.0.x/io-kafka-source.md
@@ -164,12 +164,12 @@ This example describes how to use the Kafka source connector to feed data from K
docker exec -it pulsar-kafka-standalone /bin/bash
./bin/pulsar-admin source localrun \
- --archive ./pulsar-io-kafka.nar \
+ --archive $PWD/pulsar-io-kafka.nar \
--tenant public \
--namespace default \
--name kafka \
--destination-topic-name my-topic \
- --source-config-file ./conf/kafkaSourceConfig.yaml \
+ --source-config-file $PWD/conf/kafkaSourceConfig.yaml \
--parallelism 1
```
@@ -217,6 +217,6 @@ This example explains how to create a Kafka source connector in an on-premises c
```bash
PULSAR_HOME/bin/pulsar-admin sources create \
- --source-config-file <kafka-source-config.yaml>
+ --source-config-file <absolute path to kafka-source-config.yaml>
```
diff --git a/versioned_docs/version-3.0.x/io-netty-source.md b/versioned_docs/version-3.0.x/io-netty-source.md
index fca711173772..8b125705eeb9 100644
--- a/versioned_docs/version-3.0.x/io-netty-source.md
+++ b/versioned_docs/version-3.0.x/io-netty-source.md
@@ -96,12 +96,12 @@ The following examples show how to use the Netty source connector with TCP and H
```bash
./bin/pulsar-admin sources localrun \
- --archive pulsar-io-@pulsar:version@.nar \
+ --archive $PWD/pulsar-io-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name netty \
--destination-topic-name netty-topic \
- --source-config-file netty-source-config.yaml \
+ --source-config-file $PWD/netty-source-config.yaml \
--parallelism 1
```
@@ -172,12 +172,12 @@ The following examples show how to use the Netty source connector with TCP and H
```bash
./bin/pulsar-admin sources localrun \
- --archive pulsar-io-@pulsar:version@.nar \
+ --archive $PWD/pulsar-io-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name netty \
--destination-topic-name netty-topic \
- --source-config-file netty-source-config.yaml \
+ --source-config-file $PWD/netty-source-config.yaml \
--parallelism 1
```
diff --git a/versioned_docs/version-3.0.x/io-quickstart.md b/versioned_docs/version-3.0.x/io-quickstart.md
index fc086da7822a..de547b91fbbe 100644
--- a/versioned_docs/version-3.0.x/io-quickstart.md
+++ b/versioned_docs/version-3.0.x/io-quickstart.md
@@ -241,7 +241,7 @@ bin/pulsar-admin sinks create \
--namespace default \
--name cassandra-test-sink \
--sink-type cassandra \
- --sink-config-file examples/cassandra-sink.yml \
+ --sink-config-file $PWD/examples/cassandra-sink.yml \
--inputs test_cassandra
```
@@ -547,10 +547,10 @@ This example creates a sink connector and specifies the desired information.
```bash
bin/pulsar-admin sinks create \
- --archive ./connectors/pulsar-io-jdbc-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-jdbc-postgres-@pulsar:version@.nar \
--inputs pulsar-postgres-jdbc-sink-topic \
--name pulsar-postgres-jdbc-sink \
- --sink-config-file ./connectors/pulsar-postgres-jdbc-sink.yaml \
+ --sink-config-file $PWD/connectors/pulsar-postgres-jdbc-sink.yaml \
--parallelism 1
```
@@ -562,10 +562,10 @@ This sink connector runs as a Pulsar Function and writes the messages produced i
Flag | Description | Example
---|---|---|
- `--archive` | The path to the archive file for the sink. | pulsar-io-jdbc-postgres-@pulsar:version@.nar |
+ `--archive` | The absolute path to the archive file for the sink. | $PWD/pulsar-io-jdbc-postgres-@pulsar:version@.nar |
`--inputs` | The input topic(s) of the sink. <br /><br /> Multiple topics can be specified as a comma-separated list.||
`--name` | The name of the sink. | pulsar-postgres-jdbc-sink |
- `--sink-config-file` | The path to a YAML config file specifying the configuration of the sink. | pulsar-postgres-jdbc-sink.yaml |
+ `--sink-config-file` | The absolute path to a YAML config file specifying the configuration of the sink. | $PWD/pulsar-postgres-jdbc-sink.yaml |
`--parallelism` | The parallelism factor of the sink. <br /><br /> For example, the number of sink instances to run. | 1 |
:::tip
diff --git a/versioned_docs/version-3.0.x/io-rabbitmq-source.md b/versioned_docs/version-3.0.x/io-rabbitmq-source.md
index 65845ce309cd..d0c35b6d2072 100644
--- a/versioned_docs/version-3.0.x/io-rabbitmq-source.md
+++ b/versioned_docs/version-3.0.x/io-rabbitmq-source.md
@@ -150,8 +150,8 @@ This example describes how to use the RabbitMQ source connector to feed data fro
```bash
./bin/pulsar-admin source localrun \
- --source-config-file conf/rabbitmq-source-queue-name.yaml \
- --archive connectors/pulsar-io-rabbitmq-@pulsar:version@.nar \
+ --source-config-file $PWD/conf/rabbitmq-source-queue-name.yaml \
+ --archive $PWD/connectors/pulsar-io-rabbitmq-@pulsar:version@.nar \
--name rabbitmq-source \
--destination-topic-name pulsar-rabbitmq-test-topic \
--broker-service-url pulsar://{ip}:{port}
diff --git a/versioned_docs/version-3.0.x/io-redis-sink.md b/versioned_docs/version-3.0.x/io-redis-sink.md
index 69b8545f9add..594e3a84f222 100644
--- a/versioned_docs/version-3.0.x/io-redis-sink.md
+++ b/versioned_docs/version-3.0.x/io-redis-sink.md
@@ -96,7 +96,7 @@ This example shows how to write records to a Redis database using the Pulsar Red
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-redis-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-redis-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name my-redis-sink \
@@ -108,11 +108,11 @@ This example shows how to write records to a Redis database using the Pulsar Red
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-redis-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-redis-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name my-redis-sink \
- --sink-config-file redis-sink-config.yaml \
+ --sink-config-file $PWD/redis-sink-config.yaml \
--inputs my-redis-topic
```
diff --git a/versioned_docs/version-3.0.x/reference-pulsar-admin.md b/versioned_docs/version-3.0.x/reference-pulsar-admin.md
index a8f2c5a4c423..bb1e7aea3d81 100644
--- a/versioned_docs/version-3.0.x/reference-pulsar-admin.md
+++ b/versioned_docs/version-3.0.x/reference-pulsar-admin.md
@@ -505,20 +505,20 @@ Options
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
|`--client-auth-params`|Client authentication param||
|`--client-auth-plugin`|Client authentication plugin using which function-process can connect to broker||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--hostname-verification-enabled`|Enable hostname verification|false|
|`--instance-id-offset`|Start the instanceIds from this offset|0|
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -561,18 +561,18 @@ Options
|`--classname`|The function's class name||
|`--custom-serde-inputs`|The map of input topics to SerDe class names (as a JSON string)||
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -630,18 +630,18 @@ Options
|`--classname`|The function's class name||
|`--custom-serde-inputs`|The map of input topics to SerDe class names (as a JSON string)||
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -3017,5 +3017,5 @@ Options
|Flag|Description|Default|
|----|---|---|
|`-c`, `--classname`|The Java class name||
-|`-j`, `--jar`|A path to the JAR file which contains the above Java class||
+|`-j`, `--jar`|Absolute path to the JAR file which contains the above Java class||
|`-t`, `--type`|The type of the schema (avro or json)||
diff --git a/versioned_docs/version-3.0.x/window-functions-context.md b/versioned_docs/version-3.0.x/window-functions-context.md
index a2e0145a85e4..e5ee99402150 100644
--- a/versioned_docs/version-3.0.x/window-functions-context.md
+++ b/versioned_docs/version-3.0.x/window-functions-context.md
@@ -258,7 +258,7 @@ If you need your function to produce logs, specify a log topic when creating or
```bash
bin/pulsar-admin functions create \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.LoggingFunction \
--log-topic persistent://public/default/logging-function-logs \
# Other function configs
diff --git a/versioned_docs/version-3.2.x/admin-api-functions.md b/versioned_docs/version-3.2.x/admin-api-functions.md
index 95189c0f4995..72d925f2caed 100644
--- a/versioned_docs/version-3.2.x/admin-api-functions.md
+++ b/versioned_docs/version-3.2.x/admin-api-functions.md
@@ -46,7 +46,7 @@ pulsar-admin functions create \
--inputs test-input-topic \
--output persistent://public/default/test-output-topic \
--classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
- --jar /examples/api-examples.jar
+ --jar $PWD/examples/api-examples.jar
```
</TabItem>
diff --git a/versioned_docs/version-3.2.x/admin-api-schemas.md b/versioned_docs/version-3.2.x/admin-api-schemas.md
index d562e13a4ea2..fb8914980ff9 100644
--- a/versioned_docs/version-3.2.x/admin-api-schemas.md
+++ b/versioned_docs/version-3.2.x/admin-api-schemas.md
@@ -255,7 +255,7 @@ To extract (provide) a schema via a topic, use the following method.
Use the `extract` subcommand.
```bash
-pulsar-admin schemas extract --classname <class-name> --jar <jar-path> --type <type-name>
+pulsar-admin schemas extract --classname <class-name> --jar <absolute-jar-path> --type <type-name>
```
</TabItem>
diff --git a/versioned_docs/version-3.2.x/deploy-bare-metal.md b/versioned_docs/version-3.2.x/deploy-bare-metal.md
index 1fdc27e48751..626745f87be7 100644
--- a/versioned_docs/version-3.2.x/deploy-bare-metal.md
+++ b/versioned_docs/version-3.2.x/deploy-bare-metal.md
@@ -481,7 +481,7 @@ Create an ExclamationFunction `exclamation`.
```bash
bin/pulsar-admin functions create \
- --jar examples/api-examples.jar \
+ --jar $PWD/examples/api-examples.jar \
--classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
--inputs persistent://public/default/exclamation-input \
--output persistent://public/default/exclamation-output \
diff --git a/versioned_docs/version-3.2.x/functions-cli.md b/versioned_docs/version-3.2.x/functions-cli.md
index 2a039ca278d5..ef8b245d1a71 100644
--- a/versioned_docs/version-3.2.x/functions-cli.md
+++ b/versioned_docs/version-3.2.x/functions-cli.md
@@ -56,9 +56,9 @@ You can configure a function by using a predefined YAML file. The following tabl
| fqfn | String | `--fqfn` | The Fully Qualified Function Name (FQFN) of a function. |
| windowConfig | [WindowConfig](#windowconfig) | N/A | N/A |
| timeoutMs | Long | `--timeout-ms` | The message timeout (in milliseconds). |
-| 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). |
+| jar | String | `--jar` | The absolute 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 absolute 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` | The absolute path of 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 | `--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. |
diff --git a/versioned_docs/version-3.2.x/functions-deploy-arguments.md b/versioned_docs/version-3.2.x/functions-deploy-arguments.md
index 45bed9a2e792..2af215a79469 100644
--- a/versioned_docs/version-3.2.x/functions-deploy-arguments.md
+++ b/versioned_docs/version-3.2.x/functions-deploy-arguments.md
@@ -25,7 +25,7 @@ Take the `create` command for example. The following function has default values
```bash
bin/pulsar-admin functions create \
- --jar my-pulsar-functions.jar \
+ --jar $PWD/my-pulsar-functions.jar \
--classname org.example.MyFunction \
--inputs my-function-input-topic1,my-function-input-topic2
```
diff --git a/versioned_docs/version-3.2.x/functions-deploy-cluster-parallelism.md b/versioned_docs/version-3.2.x/functions-deploy-cluster-parallelism.md
index fef7ebcf7d4e..994ad3bbeac9 100644
--- a/versioned_docs/version-3.2.x/functions-deploy-cluster-parallelism.md
+++ b/versioned_docs/version-3.2.x/functions-deploy-cluster-parallelism.md
@@ -41,6 +41,6 @@ For an existing function, you can adjust the parallelism by using the `update` c
```bash
bin/pulsar-admin functions update \
- --function-config-file function-config.yaml
+ --function-config-file $PWD/function-config.yaml
```
diff --git a/versioned_docs/version-3.2.x/functions-deploy-cluster-resource.md b/versioned_docs/version-3.2.x/functions-deploy-cluster-resource.md
index a000982c4955..544eb4c880bd 100644
--- a/versioned_docs/version-3.2.x/functions-deploy-cluster-resource.md
+++ b/versioned_docs/version-3.2.x/functions-deploy-cluster-resource.md
@@ -19,7 +19,7 @@ For example, the following command allocates 8 cores, 8GB of RAM, and 10GB of di
```bash
bin/pulsar-admin functions create \
- --jar target/my-functions.jar \
+ --jar $PWD/target/my-functions.jar \
--classname org.example.functions.MyFunction \
--cpu 8 \
--ram 8589934592 \
diff --git a/versioned_docs/version-3.2.x/functions-deploy-localrun.md b/versioned_docs/version-3.2.x/functions-deploy-localrun.md
index 0d6fbda0c5ed..e52cf9557b75 100644
--- a/versioned_docs/version-3.2.x/functions-deploy-localrun.md
+++ b/versioned_docs/version-3.2.x/functions-deploy-localrun.md
@@ -13,7 +13,7 @@ The following is an example of how to use the `localrun` command.
```bash
bin/pulsar-admin functions localrun \
- --py myfunc.py \
+ --py $PWD/myfunc.py \
--classname myfunc.SomeFunction \
--inputs persistent://public/default/input-1 \
--output persistent://public/default/output-1
diff --git a/versioned_docs/version-3.2.x/functions-develop-admin-api.md b/versioned_docs/version-3.2.x/functions-develop-admin-api.md
index 037888082303..4273696bda7a 100644
--- a/versioned_docs/version-3.2.x/functions-develop-admin-api.md
+++ b/versioned_docs/version-3.2.x/functions-develop-admin-api.md
@@ -43,7 +43,7 @@ To enable your function to get access to the Pulsar admin client, you need to se
```bash
bin/pulsar-admin functions localrun \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.CursorManagementFunction \
--web-service-url http://pulsar-web-service:8080 \
# Other function configs
diff --git a/versioned_docs/version-3.2.x/functions-develop-log.md b/versioned_docs/version-3.2.x/functions-develop-log.md
index 77f182621e47..723888677aff 100644
--- a/versioned_docs/version-3.2.x/functions-develop-log.md
+++ b/versioned_docs/version-3.2.x/functions-develop-log.md
@@ -37,7 +37,7 @@ To enable your function to produce logs, you need to specify a log topic when cr
```bash
bin/pulsar-admin functions create \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.LoggingFunction \
--log-topic persistent://public/default/logging-function-logs \
# Other function configs
diff --git a/versioned_docs/version-3.2.x/functions-develop-tutorial.md b/versioned_docs/version-3.2.x/functions-develop-tutorial.md
index e276673debdc..84f1039bd227 100644
--- a/versioned_docs/version-3.2.x/functions-develop-tutorial.md
+++ b/versioned_docs/version-3.2.x/functions-develop-tutorial.md
@@ -42,7 +42,7 @@ To write a function for word count, complete the following steps.
```bash
bin/pulsar-admin functions create \
- --jar target/my-jar-with-dependencies.jar \
+ --jar $PWD/target/my-jar-with-dependencies.jar \
--classname org.example.functions.WordCountFunction \
--tenant public \
--namespace default \
diff --git a/versioned_docs/version-3.2.x/functions-package-go.md b/versioned_docs/version-3.2.x/functions-package-go.md
index 25eedc3a9af8..a336879f1ceb 100644
--- a/versioned_docs/version-3.2.x/functions-package-go.md
+++ b/versioned_docs/version-3.2.x/functions-package-go.md
@@ -20,18 +20,11 @@ To package a Go function, complete the following steps.
go build <your Go function filename>.go
```
-3. Copy the Go function file to the Pulsar image.
-
- ```bash
- docker exec -it [CONTAINER ID] /bin/bash
- docker cp <your go function path> CONTAINER ID:/pulsar
- ```
-
- 4. Run the Go function with the following command.
+3. Run the Go function with the following command.
```bash
bin/pulsar-admin functions localrun \
- --go [your go function path]
+ --go [absolute path to your go function]
--inputs [input topics] \
--output [output topic] \
--tenant [default:public] \
diff --git a/versioned_docs/version-3.2.x/functions-package-java.md b/versioned_docs/version-3.2.x/functions-package-java.md
index 3f227cc7a696..921b0d1b8837 100644
--- a/versioned_docs/version-3.2.x/functions-package-java.md
+++ b/versioned_docs/version-3.2.x/functions-package-java.md
@@ -93,19 +93,12 @@ To package a Java function as JAR, complete the following steps.
After the Java function is packaged, a `target` directory is created automatically. Open the `target` directory to check if there is a JAR package similar to `java-function-1.0-SNAPSHOT.jar`.
-3. Copy the packaged jar file to the Pulsar image.
-
- ```bash
- docker exec -it [CONTAINER ID] /bin/bash
- docker cp <path of java-function-1.0-SNAPSHOT.jar> CONTAINER ID:/pulsar
- ```
-
-4. Run the Java function using the following command.
+3. Run the Java function using the following command.
```bash
./bin/pulsar-admin functions localrun \
--classname org.example.test.ExclamationFunction \
- --jar java-function-1.0-SNAPSHOT.jar \
+ --jar $PWD/target/java-function-1.0-SNAPSHOT.jar \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
@@ -183,17 +176,11 @@ To package a Java function as NAR, complete the following steps.
After the Java function is packaged, a `target` directory is created automatically. Open the `target` directory to check if there is a NAR package similar to `java-function-1.0-SNAPSHOT.nar`.
-3. Copy the packaged NAR file to the Pulsar image.
-
- ```bash
- docker cp <path of java-function-1.0-SNAPSHOT.nar> CONTAINER ID:/pulsar
- ```
-
-4. Run the Java function using the following command.
+3. Run the Java function using the following command.
```bash
./bin/pulsar-admin functions localrun \
- --jar java-function-1.0-SNAPSHOT.nar \
+ --jar $PWD/target/java-function-1.0-SNAPSHOT.nar \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
diff --git a/versioned_docs/version-3.2.x/functions-package-python.md b/versioned_docs/version-3.2.x/functions-package-python.md
index c5d056be6218..91a324ecd567 100644
--- a/versioned_docs/version-3.2.x/functions-package-python.md
+++ b/versioned_docs/version-3.2.x/functions-package-python.md
@@ -58,7 +58,7 @@ To package a Python function into **one Python file**, complete the following st
```bash
./bin/pulsar-admin functions localrun \
--classname <Python Function file name>.<Python Function class name> \
- --py <path of Python Function file> \
+ --py <absolute path of Python Function file> \
--inputs persistent://public/default/my-topic-1 \
--output persistent://public/default/test-1 \
--tenant public \
@@ -109,7 +109,7 @@ To package a Python function into a **ZIP file**, complete the following steps.
```shell
./bin/pulsar-admin functions localrun \
--classname exclamation \
- --py <path of ZIP file> \
+ --py <absolute path of ZIP file> \
--inputs persistent://public/default/in-topic \
--output persistent://public/default/out-topic \
--tenant public \
diff --git a/versioned_docs/version-3.2.x/functions-quickstart.md b/versioned_docs/version-3.2.x/functions-quickstart.md
index 29ef7cf25c94..bd0939345c9c 100644
--- a/versioned_docs/version-3.2.x/functions-quickstart.md
+++ b/versioned_docs/version-3.2.x/functions-quickstart.md
@@ -129,8 +129,8 @@ Before starting functions, you need to [start Pulsar](#start-standalone-pulsar)
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
@@ -295,8 +295,8 @@ The following example provides instructions to start a stateful function to vali
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-stateful-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-stateful-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
@@ -480,8 +480,8 @@ The following example provides instructions to start a window function to calcul
```bash
bin/pulsar-admin functions create \
- --function-config-file examples/example-window-function-config.yaml \
- --jar examples/api-examples.jar
+ --function-config-file $PWD/examples/example-window-function-config.yaml \
+ --jar $PWD/examples/api-examples.jar
```
**Output**
diff --git a/versioned_docs/version-3.2.x/io-canal-source.md b/versioned_docs/version-3.2.x/io-canal-source.md
index fae275a65bf7..40b107a93ad6 100644
--- a/versioned_docs/version-3.2.x/io-canal-source.md
+++ b/versioned_docs/version-3.2.x/io-canal-source.md
@@ -169,7 +169,7 @@ Here is an example of storing MySQL data using the configuration file as above.
docker exec -it pulsar-standalone /bin/bash
wget https://archive.apache.org/dist/pulsar/pulsar-2.3.0/connectors/pulsar-io-canal-2.3.0.nar -P connectors
./bin/pulsar-admin source localrun \
- --archive ./connectors/pulsar-io-canal-2.3.0.nar \
+ --archive $PWD/connectors/pulsar-io-canal-2.3.0.nar \
--classname org.apache.pulsar.io.canal.CanalStringSource \
--tenant public \
--namespace default \
diff --git a/versioned_docs/version-3.2.x/io-cdc-debezium.md b/versioned_docs/version-3.2.x/io-cdc-debezium.md
index cd9a7370e647..04e356664f4f 100644
--- a/versioned_docs/version-3.2.x/io-cdc-debezium.md
+++ b/versioned_docs/version-3.2.x/io-cdc-debezium.md
@@ -31,7 +31,7 @@ The configuration of the Debezium source connector has the following properties.
| `database.history` | true | null | The name of the database history class. |
| `database.history.pulsar.topic` | true | null | The name of the database history topic where the connector writes and recovers DDL statements. <br /><br />**Note: this topic is for internal use only and should not be used by consumers.** |
| `database.history.pulsar.service.url` | false| null | Pulsar cluster service URL for history topic. <br /><br />**Note**: If `database.history.pulsar.service.url` is not set, then the database history Pulsar client will use the same client settings as those of the source connector, such as `client_auth_plugin` and `client_auth_params`.|
-| `pulsar.service.url` | true | null | Pulsar cluster service URL for the offset topic used in Debezium. You can use the `bin/pulsar-admin --admin-url http://pulsar:8080 sources localrun --source-config-file configs/pg-pulsar-config.yaml` command to point to the target Pulsar cluster.|
+| `pulsar.service.url` | true | null | Pulsar cluster service URL for the offset topic used in Debezium. You can use the `bin/pulsar-admin --admin-url http://pulsar:8080 sources localrun --source-config-file $PWD/configs/pg-pulsar-config.yaml` command to point to the target Pulsar cluster.|
| `offset.storage.topic` | true | null | Record the last committed offsets that the connector successfully completes. |
| `mongodb.hosts` | true | null | The comma-separated list of hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB servers in the replica set. The list contains a single hostname and a port pair. If mongodb.members.auto.discover is set to false, the host and port pair are prefixed with the replica set name (e.g., rs0/localhost:27017). |
| `mongodb.name` | true | null | A unique name that identifies the connector and/or MongoDB replica set or shared cluster that this connector monitors. Each server should be monitored by at most one Debezium connector, since this server name prefixes all persisted Kafka topics emanating from the MongoDB replica set or cluster. |
@@ -138,7 +138,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
--name debezium-mysql-source \
--tenant public \
--namespace default \
@@ -149,7 +149,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mysql-source-config.yaml
+ --source-config-file $PWD/debezium-mysql-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the table _inventory.products_.
@@ -289,7 +289,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
--name debezium-postgres-source \
--tenant public \
--namespace default \
@@ -300,7 +300,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-postgres-source-config.yaml
+ --source-config-file $PWD/debezium-postgres-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
@@ -431,7 +431,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
--name debezium-mongodb-source \
--tenant public \
--namespace default \
@@ -442,7 +442,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mongodb-source-config.yaml
+ --source-config-file $PWD/debezium-mongodb-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
diff --git a/versioned_docs/version-3.2.x/io-cli.md b/versioned_docs/version-3.2.x/io-cli.md
index bdde2dd29563..3d978052780e 100644
--- a/versioned_docs/version-3.2.x/io-cli.md
+++ b/versioned_docs/version-3.2.x/io-cli.md
@@ -49,8 +49,8 @@ pulsar-admin sources create options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
-| `--classname` | The source's class name if `archive` is file-url-path (file://).
+| `-a`, `--archive` | The absolute path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `--classname` | The source's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).
| `--deserialization-classname` | The SerDe classname for the source.
| `--destination-topic-name` | The Pulsar topic to which data is sent.
@@ -62,7 +62,7 @@ pulsar-admin sources create options
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance (applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
| `--source-config` | Source config key/values.
-| `--source-config-file` | The path to a YAML config file specifying the source's configuration.
+| `--source-config-file` | The absolute path to a YAML config file specifying the source's configuration.
| `-t`, `--source-type` | The source's connector provider.
| `--tenant` | The source's tenant.
|`--producer-config`| The custom producer configuration (as a JSON string).
@@ -81,8 +81,8 @@ pulsar-admin sources update options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
-| `--classname` | The source's class name if `archive` is file-url-path (file://).
+| `-a`, `--archive` | The absolute path to the NAR archive for the source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `--classname` | The source's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).
| `--deserialization-classname` | The SerDe classname for the source.
| `--destination-topic-name` | The Pulsar topic to which data is sent.
@@ -94,7 +94,7 @@ pulsar-admin sources update options
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance (applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
| `--source-config` | Source config key/values.
-| `--source-config-file` | The path to a YAML config file specifying the source's configuration.
+| `--source-config-file` | The absolute path to a YAML config file specifying the source's configuration.
| `-t`, `--source-type` | The source's connector provider. The `source-type` parameter of the currently built-in connectors is determined by the setting of the `name` parameter specified in the pulsar-io.yaml file.
| `--tenant` | The source's tenant.
| `--update-auth-data` | Whether or not to update the auth data.<br />**Default value: false.**
@@ -245,9 +245,9 @@ pulsar-admin sources localrun options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the NAR archive for the Source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the NAR archive for the Source. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--broker-service-url` | The URL for the Pulsar broker.
-|`--classname`|The source's class name if `archive` is file-url-path (file://).
+|`--classname`|The source's class name.
| `--client-auth-params` | Client authentication parameter.
| `--client-auth-plugin` | Client authentication plugin using which function-process can connect to broker.
|`--cpu`|The CPU (in cores) that needs to be allocated per source instance (applicable only to the Docker runtime).|
@@ -262,7 +262,7 @@ pulsar-admin sources localrun options
|`--ram`|The RAM (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime).|
| `-st`, `--schema-type` | The schema type.<br /> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.
|`--source-config`|Source config key/values.
-|`--source-config-file`|The path to a YAML config file specifying the source's configuration.
+|`--source-config-file`|The absolute path to a YAML config file specifying the source's configuration.
|`--source-type`|The source's connector provider.
|`--tenant`|The source's tenant.
|`--tls-allow-insecure`|Allow insecure tls connection.<br />**Default value: false**.
@@ -326,9 +326,9 @@ pulsar-admin sinks create options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
-| `--classname` | The sink's class name if `archive` is file-url-path (file://).
+| `--classname` | The sink's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).
| `--custom-schema-inputs` | The map of input topics to schema types or class names (as a JSON string).
| `--custom-serde-inputs` | The map of input topics to SerDe class names (as a JSON string).
@@ -341,7 +341,7 @@ pulsar-admin sinks create options
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
-| `--sink-config-file` | The path to a YAML config file specifying the sink's configuration.
+| `--sink-config-file` | The absolute path to a YAML config file specifying the sink's configuration.
| `-t`, `--sink-type` | The sink's connector provider. The `sink-type` parameter of the currently built-in connectors is determined by the setting of the `name` parameter specified in the pulsar-io.yaml file.
| `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
| `--tenant` | The sink's tenant.
@@ -362,9 +362,9 @@ pulsar-admin sinks update options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
-| `--classname` | The sink's class name if `archive` is file-url-path (file://).
+| `--classname` | The sink's class name.
| `--cpu` | The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).
| `--custom-schema-inputs` | The map of input topics to schema types or class names (as a JSON string).
| `--custom-serde-inputs` | The map of input topics to SerDe class names (as a JSON string).
@@ -377,7 +377,7 @@ pulsar-admin sinks update options
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
-| `--sink-config-file` | The path to a YAML config file specifying the sink's configuration.
+| `--sink-config-file` | The absolute path to a YAML config file specifying the sink's configuration.
| `-t`, `--sink-type` | The sink's connector provider.
| `--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
| `--tenant` | The sink's tenant.
@@ -532,10 +532,10 @@ pulsar-admin sinks localrun options
|Flag|Description|
|----|---|
-| `-a`, `--archive` | The path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
+| `-a`, `--archive` | The absolute path to the archive file for the sink. <br /> It also supports url-path (http/https/file [file protocol assumes that file already exists on worker host]) from which worker can download the package.
| `--auto-ack` | Whether or not the framework will automatically acknowledge messages.
| `--broker-service-url` | The URL for the Pulsar broker.
-|`--classname`|The sink's class name if `archive` is file-url-path (file://).
+|`--classname`|The sink's class name.
| `--client-auth-params` | Client authentication parameter.
| `--client-auth-plugin` | Client authentication plugin using which function-process can connect to broker.
|`--cpu`|The CPU (in cores) that needs to be allocated per sink instance (applicable only to the Docker runtime).
@@ -553,7 +553,7 @@ pulsar-admin sinks localrun options
|`--ram`|The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime).|
|`--retain-ordering` | Sink consumes and sinks messages in order.
|`--sink-config`|sink config key/values.
-|`--sink-config-file`|The path to a YAML config file specifying the sink's configuration.
+|`--sink-config-file`|The absolute path to a YAML config file specifying the sink's configuration.
|`--sink-type`|The sink's connector provider.
|`--subs-name` | Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer.
|`--tenant`|The sink's tenant.
diff --git a/versioned_docs/version-3.2.x/io-debezium-source.md b/versioned_docs/version-3.2.x/io-debezium-source.md
index 272d23cc48a5..0cd8d61d213d 100644
--- a/versioned_docs/version-3.2.x/io-debezium-source.md
+++ b/versioned_docs/version-3.2.x/io-debezium-source.md
@@ -175,7 +175,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mysql-@pulsar:version@.nar \
--name debezium-mysql-source \
--tenant public \
--namespace default \
@@ -199,7 +199,7 @@ This example shows how to change the data of a MySQL table using the Pulsar Debe
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mysql-source-config.yaml
+ --source-config-file $PWD/debezium-mysql-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the table _inventory.products_.
@@ -345,7 +345,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-postgres-@pulsar:version@.nar \
--name debezium-postgres-source \
--tenant public \
--namespace default \
@@ -369,7 +369,7 @@ This example shows how to change the data of a PostgreSQL table using the Pulsar
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-postgres-source-config.yaml
+ --source-config-file $PWD/debezium-postgres-source-config.yaml
```
4. Subscribe to the topic _sub-users_ for the _public.users_ table.
@@ -505,7 +505,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --archive connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-debezium-mongodb-@pulsar:version@.nar \
--name debezium-mongodb-source \
--tenant public \
--namespace default \
@@ -529,7 +529,7 @@ This example shows how to change the data of a MongoDB table using the Pulsar De
```bash
bin/pulsar-admin source localrun \
- --source-config-file debezium-mongodb-source-config.yaml
+ --source-config-file $PWD/debezium-mongodb-source-config.yaml
```
4. Subscribe to the topic _sub-products_ for the _inventory.products_ table.
diff --git a/versioned_docs/version-3.2.x/io-debug.md b/versioned_docs/version-3.2.x/io-debug.md
index 5ffacbeb53bc..dce82f0bf322 100644
--- a/versioned_docs/version-3.2.x/io-debug.md
+++ b/versioned_docs/version-3.2.x/io-debug.md
@@ -65,11 +65,11 @@ For more information about the `localrun` command, see [`localrun`](reference-co
```bash
./bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-mongo-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-mongo-@pulsar:version@.nar \
--tenant public --namespace default \
--inputs test-mongo \
--name pulsar-mongo-sink \
- --sink-config-file mongo-sink-config.yaml \
+ --sink-config-file $PWD/mongo-sink-config.yaml \
--parallelism 1
```
@@ -216,12 +216,12 @@ Pulsar admin CLI helps you debug Pulsar connectors with the following subcommand
```bash
./bin/pulsar-admin sinks create \
- --archive pulsar-io-mongo-2.4.0.nar \
+ --archive $PWD/pulsar-io-mongo-2.4.0.nar \
--tenant public \
--namespace default \
--inputs test-mongo \
--name pulsar-mongo-sink \
- --sink-config-file mongo-sink-config.yaml \
+ --sink-config-file $PWD/mongo-sink-config.yaml \
--parallelism 1
```
diff --git a/versioned_docs/version-3.2.x/io-elasticsearch-sink.md b/versioned_docs/version-3.2.x/io-elasticsearch-sink.md
index f0023975f2ae..efa3f6899f22 100644
--- a/versioned_docs/version-3.2.x/io-elasticsearch-sink.md
+++ b/versioned_docs/version-3.2.x/io-elasticsearch-sink.md
@@ -190,7 +190,7 @@ Before using the Elasticsearch sink connector, you need to create a configuratio
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name elasticsearch-test-sink \
@@ -202,11 +202,11 @@ Before using the Elasticsearch sink connector, you need to create a configuratio
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-elastic-search-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name elasticsearch-test-sink \
- --sink-config-file elasticsearch-sink.yml \
+ --sink-config-file $PWD/elasticsearch-sink.yml \
--inputs elasticsearch_test
```
diff --git a/versioned_docs/version-3.2.x/io-kafka-source.md b/versioned_docs/version-3.2.x/io-kafka-source.md
index 890edecd94dd..dd03175f5b7d 100644
--- a/versioned_docs/version-3.2.x/io-kafka-source.md
+++ b/versioned_docs/version-3.2.x/io-kafka-source.md
@@ -164,12 +164,12 @@ This example describes how to use the Kafka source connector to feed data from K
docker exec -it pulsar-kafka-standalone /bin/bash
./bin/pulsar-admin source localrun \
- --archive ./pulsar-io-kafka.nar \
+ --archive $PWD/pulsar-io-kafka.nar \
--tenant public \
--namespace default \
--name kafka \
--destination-topic-name my-topic \
- --source-config-file ./conf/kafkaSourceConfig.yaml \
+ --source-config-file $PWD/conf/kafkaSourceConfig.yaml \
--parallelism 1
```
@@ -217,6 +217,6 @@ This example explains how to create a Kafka source connector in an on-premises c
```bash
PULSAR_HOME/bin/pulsar-admin sources create \
- --source-config-file <kafka-source-config.yaml>
+ --source-config-file <absolute path to kafka-source-config.yaml>
```
diff --git a/versioned_docs/version-3.2.x/io-netty-source.md b/versioned_docs/version-3.2.x/io-netty-source.md
index fca711173772..8b125705eeb9 100644
--- a/versioned_docs/version-3.2.x/io-netty-source.md
+++ b/versioned_docs/version-3.2.x/io-netty-source.md
@@ -96,12 +96,12 @@ The following examples show how to use the Netty source connector with TCP and H
```bash
./bin/pulsar-admin sources localrun \
- --archive pulsar-io-@pulsar:version@.nar \
+ --archive $PWD/pulsar-io-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name netty \
--destination-topic-name netty-topic \
- --source-config-file netty-source-config.yaml \
+ --source-config-file $PWD/netty-source-config.yaml \
--parallelism 1
```
@@ -172,12 +172,12 @@ The following examples show how to use the Netty source connector with TCP and H
```bash
./bin/pulsar-admin sources localrun \
- --archive pulsar-io-@pulsar:version@.nar \
+ --archive $PWD/pulsar-io-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name netty \
--destination-topic-name netty-topic \
- --source-config-file netty-source-config.yaml \
+ --source-config-file $PWD/netty-source-config.yaml \
--parallelism 1
```
diff --git a/versioned_docs/version-3.2.x/io-quickstart.md b/versioned_docs/version-3.2.x/io-quickstart.md
index e40e6ee1ceb0..9c482fbca477 100644
--- a/versioned_docs/version-3.2.x/io-quickstart.md
+++ b/versioned_docs/version-3.2.x/io-quickstart.md
@@ -244,7 +244,7 @@ bin/pulsar-admin sinks create \
--namespace default \
--name cassandra-test-sink \
--sink-type cassandra \
- --sink-config-file examples/cassandra-sink.yml \
+ --sink-config-file $PWD/examples/cassandra-sink.yml \
--inputs test_cassandra
```
@@ -551,10 +551,10 @@ This example creates a sink connector and specifies the desired information.
```bash
bin/pulsar-admin sinks create \
- --archive ./connectors/pulsar-io-jdbc-postgres-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-jdbc-postgres-@pulsar:version@.nar \
--inputs pulsar-postgres-jdbc-sink-topic \
--name pulsar-postgres-jdbc-sink \
- --sink-config-file ./connectors/pulsar-postgres-jdbc-sink.yaml \
+ --sink-config-file $PWD/connectors/pulsar-postgres-jdbc-sink.yaml \
--parallelism 1
```
@@ -566,10 +566,10 @@ This sink connector runs as a Pulsar Function and writes the messages produced i
Flag | Description | Example
---|---|---|
- `--archive` | The path to the archive file for the sink. | pulsar-io-jdbc-postgres-@pulsar:version@.nar |
+ `--archive` | The absolute path to the archive file for the sink. | $PWD/pulsar-io-jdbc-postgres-@pulsar:version@.nar |
`--inputs` | The input topic(s) of the sink. <br /><br /> Multiple topics can be specified as a comma-separated list.||
`--name` | The name of the sink. | pulsar-postgres-jdbc-sink |
- `--sink-config-file` | The path to a YAML config file specifying the configuration of the sink. | pulsar-postgres-jdbc-sink.yaml |
+ `--sink-config-file` | The absolute path to a YAML config file specifying the configuration of the sink. | $PWD/pulsar-postgres-jdbc-sink.yaml |
`--parallelism` | The parallelism factor of the sink. <br /><br /> For example, the number of sink instances to run. | 1 |
:::tip
diff --git a/versioned_docs/version-3.2.x/io-rabbitmq-source.md b/versioned_docs/version-3.2.x/io-rabbitmq-source.md
index b926dcee5852..caf60c28b5ec 100644
--- a/versioned_docs/version-3.2.x/io-rabbitmq-source.md
+++ b/versioned_docs/version-3.2.x/io-rabbitmq-source.md
@@ -150,8 +150,8 @@ This example describes how to use the RabbitMQ source connector to feed data fro
```bash
./bin/pulsar-admin source localrun \
- --source-config-file conf/rabbitmq-source-queue-name.yaml \
- --archive connectors/pulsar-io-rabbitmq-@pulsar:version@.nar \
+ --source-config-file $PWD/conf/rabbitmq-source-queue-name.yaml \
+ --archive $PWD/connectors/pulsar-io-rabbitmq-@pulsar:version@.nar \
--name rabbitmq-source \
--destination-topic-name pulsar-rabbitmq-test-topic \
--broker-service-url pulsar://{ip}:{port}
diff --git a/versioned_docs/version-3.2.x/io-redis-sink.md b/versioned_docs/version-3.2.x/io-redis-sink.md
index 69b8545f9add..594e3a84f222 100644
--- a/versioned_docs/version-3.2.x/io-redis-sink.md
+++ b/versioned_docs/version-3.2.x/io-redis-sink.md
@@ -96,7 +96,7 @@ This example shows how to write records to a Redis database using the Pulsar Red
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-redis-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-redis-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name my-redis-sink \
@@ -108,11 +108,11 @@ This example shows how to write records to a Redis database using the Pulsar Red
```bash
bin/pulsar-admin sinks localrun \
- --archive connectors/pulsar-io-redis-@pulsar:version@.nar \
+ --archive $PWD/connectors/pulsar-io-redis-@pulsar:version@.nar \
--tenant public \
--namespace default \
--name my-redis-sink \
- --sink-config-file redis-sink-config.yaml \
+ --sink-config-file $PWD/redis-sink-config.yaml \
--inputs my-redis-topic
```
diff --git a/versioned_docs/version-3.2.x/reference-pulsar-admin.md b/versioned_docs/version-3.2.x/reference-pulsar-admin.md
index a8f2c5a4c423..bb1e7aea3d81 100644
--- a/versioned_docs/version-3.2.x/reference-pulsar-admin.md
+++ b/versioned_docs/version-3.2.x/reference-pulsar-admin.md
@@ -505,20 +505,20 @@ Options
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
|`--client-auth-params`|Client authentication param||
|`--client-auth-plugin`|Client authentication plugin using which function-process can connect to broker||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--hostname-verification-enabled`|Enable hostname verification|false|
|`--instance-id-offset`|Start the instanceIds from this offset|0|
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -561,18 +561,18 @@ Options
|`--classname`|The function's class name||
|`--custom-serde-inputs`|The map of input topics to SerDe class names (as a JSON string)||
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -630,18 +630,18 @@ Options
|`--classname`|The function's class name||
|`--custom-serde-inputs`|The map of input topics to SerDe class names (as a JSON string)||
|`--custom-schema-inputs`|The map of input topics to Schema class names (as a JSON string)||
-|`--function-config-file`|The path to a YAML config file specifying the function's configuration||
+|`--function-config-file`|The absolute path to a YAML config file specifying the function's configuration||
|`--inputs`|The function's input topic or topics (multiple topics can be specified as a comma-separated list)||
|`--log-topic`|The topic to which the function's logs are produced||
-|`--jar`|Path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--jar`|Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--name`|The function's name||
|`--namespace`|The function's namespace||
|`--output`|The function's output topic (If none is specified, no output is written)||
|`--output-serde-classname`|The SerDe class to be used for messages output by the function||
|`--parallelism`|The function's parallelism factor, i.e. the number of instances of the function to run|1|
|`--processing-guarantees`|The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]|ATLEAST_ONCE|
-|`--py`|Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
-|`--go`|Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--py`|Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
+|`--go`|Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package.||
|`--schema-type`|The built-in 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||
@@ -3017,5 +3017,5 @@ Options
|Flag|Description|Default|
|----|---|---|
|`-c`, `--classname`|The Java class name||
-|`-j`, `--jar`|A path to the JAR file which contains the above Java class||
+|`-j`, `--jar`|Absolute path to the JAR file which contains the above Java class||
|`-t`, `--type`|The type of the schema (avro or json)||
diff --git a/versioned_docs/version-3.2.x/window-functions-context.md b/versioned_docs/version-3.2.x/window-functions-context.md
index a7d0d1948bae..b2213b930e85 100644
--- a/versioned_docs/version-3.2.x/window-functions-context.md
+++ b/versioned_docs/version-3.2.x/window-functions-context.md
@@ -259,7 +259,7 @@ If you need your function to produce logs, specify a log topic when creating or
```bash
bin/pulsar-admin functions create \
- --jar my-functions.jar \
+ --jar $PWD/my-functions.jar \
--classname my.package.LoggingFunction \
--log-topic persistent://public/default/logging-function-logs \
# Other function configs