[Doc] Add descriptions for function runtime and context #9516
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
@freeznet could you please help review? Thanks. |
zymap
added
the
doc
Huanli-Meng
reviewed
Feb 8, 2021
Contributor
Huanli-Meng
left a comment
Huanli-Meng
left a comment
There was a problem hiding this comment.
Look Good to me and only leave a minor comment. PTAL
site2/docs/functions-runtime.md
Outdated
| Pulsar includes a built-in implementation. To use the basic implementation, set `runtimeCustomizerClassName` to `org.apache.pulsar.functions.runtime.kubernetes.BasicKubernetesManifestCustomizer`. The built-in implementation enables you to pass a JSON document with certain properties to augment how the manifests are generated. The following is an example. | ||
| To initialize the `KubernetesManifestCustomizer`, you can provide `runtimeCustomizerConfig` in the `functions-worker.yml` file. `runtimeCustomizerConfig` is passed to the `public void initialize(Map<String, Object> config)` function of the interface. `runtimeCustomizerConfig`is different from the `customRuntimeOptions` as `runtimeCustomizerConfig` is the same across all functions. If you provide both `runtimeCustomizerConfig` and `customRuntimeOptions`, you need to decide how to manage these two configurations in your implementation of `KubernetesManifestCustomizer`. | ||
|
|
||
| Pulsar includes a built-in implementation. To use the basic implementation, set `runtimeCustomizerClassName` to `org.apache.pulsar.functions.runtime.kubernetes.BasicKubernetesManifestCustomizer`. The built-in implementation initialized with `runtimeCustomizerConfig` defined in the `functions-worker.yml` file enables you pass a JSON document as `customRuntimeOptions` with certain properties to augment to decide how the manifests are generated. If both `runtimeCustomizerConfig` and `customRuntimeOptions` are provided, `BasicKubernetesManifestCustomizer` uses `customRuntimeOptions` to override the configuration if there are conflicts in these two configurations. |
Contributor
There was a problem hiding this comment.
The built-in implementation initialized with runtimeCustomizerConfig defined in the functions-worker.yml file enables you pass a JSON document as customRuntimeOptions with certain properties to augment to decide how the manifests are generated.
For easy of read, it's better to break these long sentence into several short sentences.
Contributor
There was a problem hiding this comment.
- I have the same concern on the long sentences.
- "enables you pass..." --> "enables you to pass..."
Member
Author
There was a problem hiding this comment.
@Huanli-Meng @jennifer88huang thanks for your comments. Updated, PTAL.
sijie
approved these changes
Feb 8, 2021
added 2 commits
February 8, 2021 12:36
Huanli-Meng
approved these changes
Feb 9, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document features introduced in #9445 and #9246.