Skip to content

Fix function mesh doc errors #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Huanli-Meng merged 1 commit into from
Oct 18, 2021
Merged

Fix function mesh doc errors #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/connectors/io-crd-config/sink-crd-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This table lists sink configurations.
| `classname` | The class name of a sink connector. |
| `tenant` | The tenant of a sink connector. |
| `namespace` | The Pulsar namespace of a sink connector. |
| `ClusterName` | The Pulsar cluster of a sink connector. |
| `Replicas`| The number of instances that you want to run this sink connector. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this sink connector. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the sink controller automatically scales the sink connector based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `SinkConfig` | The sink connector configurations in YAML format.|
Expand Down
1 change: 1 addition & 0 deletions docs/connectors/io-crd-config/source-crd-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This table lists source configurations.
| `classname` | The class name of a source connector. |
| `tenant` | The tenant of a source connector. |
| `namespace` | The Pulsar namespace of a source connector. |
| `ClusterName` | The Pulsar cluster of a source connector. |
| `Replicas`| The number of instances that you want to run this source connector. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this source connector. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the source controller automatically scales the source connector based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `SourceConfig` | The source connector configurations in YAML format. |
Expand Down
12 changes: 6 additions & 6 deletions docs/connectors/run-connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ For Pulsar built-in connectors and StreamNative-managed connectors, you can crea
pulsarConfig: "test-sink"
resources:
limits:
cpu: "0.2"
memory: 1.1G
cpu: "0.2"
memory: 1.1G
requests:
cpu: "0.1"
memory: 1G
cpu: "0.1"
memory: 1G
java:
extraDependenciesDir: random-dir/
jar: connectors/pulsar-io-elastic-search-2.7.1.nar # the NAR location in image
Expand Down Expand Up @@ -217,7 +217,7 @@ For self-built connectors, you can create them based on how you package them.
image: streamnative/pulsar-functions-java-runner:2.7.1 # using java function runner
className: org.example.MySink
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 1
input:
Expand Down Expand Up @@ -245,7 +245,7 @@ For self-built connectors, you can create them based on how you package them.
spec:
image: myorg/pulsar-io-my-sink:2.7.1 # using self built image
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 1
input:
Expand Down
1 change: 1 addition & 0 deletions docs/functions/function-crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This table lists Pulsar Function configurations.
| `classname` | The class name of a Pulsar Function. |
| `tenant` | The tenant of a Pulsar Function. |
| `namespace` | The Pulsar namespace of a Pulsar Function. |
| `ClusterName` | The Pulsar cluster of a Pulsar Function. |
| `Replicas`| The number of instances that you want to run this Pulsar Function. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this Pulsar Function. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the Functions controller automatically scales the Pulsar Functions based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `Timeout` | The message timeout in milliseconds. |
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/function-debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ As shown in the example above, you can get the logger via `context.getLogger()`
spec:
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 2 additions & 2 deletions docs/functions/run-function/run-go-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ After packaging your Pulsar Go Functions, you can submit your Go Functions to a
image: streamnative/pulsar-functions-go-runner:2.7.1 # using go function runner
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -177,7 +177,7 @@ After packaging your Pulsar Go Functions, you can submit your Go Functions to a
image: streamnative/example-function-image:latest # using function image here
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 2 additions & 2 deletions docs/functions/run-function/run-java-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/pulsar-functions-java-runner:2.7.1 # using java function runner
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -205,7 +205,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/example-function-image:latest # using function image here
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 2 additions & 2 deletions docs/functions/run-function/run-python-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/pulsar-functions-python-runner:2.7.1 # using python function runner
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -170,7 +170,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/example-function-image:latest # using function image here
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
6 changes: 3 additions & 3 deletions docs/scaling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ These examples describe how to auto-scale the number of Pods running Pulsar Func
spec:
className: org.apache.pulsar.functions.api.examples.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 8
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -114,7 +114,7 @@ These examples describe how to auto-scale the number of Pods running Pulsar Func
spec:
className: org.apache.pulsar.functions.api.examples.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 4
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -151,7 +151,7 @@ These examples describe how to auto-scale the number of Pods running Pulsar Func
spec:
className: org.apache.pulsar.functions.api.examples.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 4
logTopic: persistent://public/default/logging-function-logs
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.1.4/connectors/io-crd-config/sink-crd-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This table lists sink configurations.
| `name` | The name of a sink connector. |
| `classname` | The class name of a sink connector. |
| `tenant` | The tenant of a sink connector. |
| `ClusterName` | The Pulsar cluster of a sink connector. |
| `Replicas`| The number of instances that you want to run this sink connector. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this sink connector. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the sink controller automatically scales the sink connector based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `SinkConfig` | The map to a ConfigMap specifying the configuration of a sink connector. |
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.1.4/connectors/io-crd-config/source-crd-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This table lists source configurations.
| `name` | The name of a source connector. |
| `classname` | The class name of a source connector. |
| `tenant` | The tenant of a source connector. |
| `ClusterName` | The Pulsar cluster of a source connector. |
| `Replicas`| The number of instances that you want to run this source connector. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this source connector. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the source controller automatically scales the source connector based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `SourceConfig` | The map to a ConfigMap specifying the configuration of a source connector. |
Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-0.1.4/connectors/run-connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ For Pulsar built-in connectors and StreamNative-managed connectors, you can crea
pulsarConfig: "test-sink"
resources:
limits:
cpu: "0.2"
memory: 1.1G
cpu: "0.2"
memory: 1.1G
requests:
cpu: "0.1"
memory: 1G
cpu: "0.1"
memory: 1G
java:
jar: connectors/pulsar-io-elastic-search-2.7.1.nar # the NAR location in image
jarLocation: "" # leave empty since we will not download package from Pulsar Packages
Expand Down Expand Up @@ -212,7 +212,7 @@ For self-built connectors, you can create them based on how you package them.
image: streamnative/pulsar-functions-java-runner:2.7.1 # using java function runner
className: org.example.MySink
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 1
input:
Expand All @@ -239,7 +239,7 @@ For self-built connectors, you can create them based on how you package them.
spec:
image: myorg/pulsar-io-my-sink:2.7.1 # using self built image
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 1
input:
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.1.4/functions/function-crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This table lists Pulsar Function configurations.
| `classname` | The class name of a Pulsar Function. |
| `tenant` | The tenant of a Pulsar Function. |
| `namespace` | The namespace of a Pulsar Function. |
| `ClusterName` | The Pulsar cluster of a Pulsar Function. |
| `Replicas`| The number of instances that you want to run this Pulsar Function. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this Pulsar Function. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the Functions controller automatically scales the Pulsar Functions based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `Timeout` | The message timeout in milliseconds. |
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-0.1.4/functions/function-debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ As shown in the example above, you can get the logger via `context.getLogger()`
spec:
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.1.4/functions/run-function/run-go-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ After packaging your Pulsar Go Functions, you can submit your Go Functions to a
image: streamnative/pulsar-functions-go-runner:2.7.1 # using go function runner
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -173,7 +173,7 @@ After packaging your Pulsar Go Functions, you can submit your Go Functions to a
image: streamnative/example-function-image:latest # using function image here
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.1.4/functions/run-function/run-java-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/pulsar-functions-java-runner:2.7.1 # using java function runner
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -200,7 +200,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/example-function-image:latest # using function image here
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.1.4/functions/run-function/run-python-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/pulsar-functions-python-runner:2.7.1 # using python function runner
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -166,7 +166,7 @@ After packaging your Pulsar Functions, you can submit your Pulsar Functions to a
image: streamnative/example-function-image:latest # using function image here
className: exclamation_function.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 5
logTopic: persistent://public/default/logging-function-logs
Expand Down
4 changes: 1 addition & 3 deletions versioned_docs/version-0.1.4/scaling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This example shows how to auto-scale the number of Pods running Pulsar Functions
spec:
className: org.apache.pulsar.functions.api.examples.ExclamationFunction
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 8
logTopic: persistent://public/default/logging-function-logs
Expand Down Expand Up @@ -84,8 +84,6 @@ This example shows how to auto-scale the number of Pods for running a Pulsar sou
className: org.apache.pulsar.io.debezium.mongodb.DebeziumMongoDbSource
replicas: 1
maxReplicas: 5
replicas: 1
maxReplicas: 1
output:
producerConf:
maxPendingMessages: 1000
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.1.5/connectors/io-crd-config/sink-crd-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This table lists sink configurations.
| `name` | The name of a sink connector. |
| `classname` | The class name of a sink connector. |
| `tenant` | The tenant of a sink connector. |
| `ClusterName` | The Pulsar cluster of a sink connector. |
| `Replicas`| The number of instances that you want to run this sink connector. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this sink connector. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the sink controller automatically scales the sink connector based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `SinkConfig` | The map to a ConfigMap specifying the configuration of a sink connector. |
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.1.5/connectors/io-crd-config/source-crd-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This table lists source configurations.
| `name` | The name of a source connector. |
| `classname` | The class name of a source connector. |
| `tenant` | The tenant of a source connector. |
| `ClusterName` | The Pulsar cluster of a source connector. |
| `Replicas`| The number of instances that you want to run this source connector. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this source connector. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the source controller automatically scales the source connector based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `SourceConfig` | The map to a ConfigMap specifying the configuration of a source connector. |
Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-0.1.5/connectors/run-connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ For Pulsar built-in connectors and StreamNative-managed connectors, you can crea
pulsarConfig: "test-sink"
resources:
limits:
cpu: "0.2"
memory: 1.1G
cpu: "0.2"
memory: 1.1G
requests:
cpu: "0.1"
memory: 1G
cpu: "0.1"
memory: 1G
java:
extraDependenciesDir: random-dir/
jar: connectors/pulsar-io-elastic-search-2.7.1.nar # the NAR location in image
Expand Down Expand Up @@ -213,7 +213,7 @@ For self-built connectors, you can create them based on how you package them.
image: streamnative/pulsar-functions-java-runner:2.7.1 # using java function runner
className: org.example.MySink
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 1
input:
Expand Down Expand Up @@ -241,7 +241,7 @@ For self-built connectors, you can create them based on how you package them.
spec:
image: myorg/pulsar-io-my-sink:2.7.1 # using self built image
forwardSourceMessageProperty: true
MaxPendingAsyncRequests: 1000
maxPendingAsyncRequests: 1000
replicas: 1
maxReplicas: 1
input:
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.1.5/functions/function-crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This table lists Pulsar Function configurations.
| `classname` | The class name of a Pulsar Function. |
| `tenant` | The tenant of a Pulsar Function. |
| `namespace` | The namespace of a Pulsar Function. |
| `ClusterName` | The Pulsar cluster of a Pulsar Function. |
| `Replicas`| The number of instances that you want to run this Pulsar Function. By default, the `Replicas` is set to `1`. |
| `MaxReplicas`| The maximum number of Pulsar instances that you want to run for this Pulsar Function. When the value of the `maxReplicas` parameter is greater than the value of `replicas`, it indicates that the Functions controller automatically scales the Pulsar Functions based on the CPU usage. By default, `maxReplicas` is set to 0, which indicates that auto-scaling is disabled. |
| `Timeout` | The message timeout in milliseconds. |
Expand Down
Loading