[FM v0.10.0]--Support using wget to download HTTP/HTTPS packages #230
Conversation
This file contains 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
✅ Deploy Preview for function-mesh ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
docs/functions/function-crd.md
Outdated
| @@ -248,10 +248,10 @@ Function Mesh supports running Pulsar Functions in Java, Python and Go. This tab | |||
|
|
|||
| | Field | Description | | |||
| | --- | --- | | |||
| | `jarLocation` | The path to the JAR file for the function. It is only available for Pulsar functions written in Java. | | |||
| | `jarLocation` | The path to the JAR file for the function. It is only available for Pulsar functions written in Java. If the package file uses the HTTP or HTTPS protocol, you need to set `enable-init-containers` to `true` when you install the Function Mesh Operator. For details about how to configure the Function Mesh Operator, see [Function Mesh Operator configurations](/reference/function-mesh-config.md).| | |||
There was a problem hiding this comment.
it's not a requirement to use init-containers when the package file uses the HTTP or HTTPS protocol:
- if
enable-init-containersis set to true, then when the package file uses HTTP/HTTPS, it will use wget to download the package - if
enable-init-containersis set to false, then when the package file uses HTTP/HTTPS, it will use pulsar-admin to download the package
the difference is that use pulsar-admin way required pulsar admin privilege while wget doesn't
the doc update should add a field: DownloaderImage in function-crd/source-crd/sink-crd, like below:
| --- | --- |
| `DownloaderImage` | The image used to download the package, which requires [pulsarctl](https://github.com/streamnative/pulsarctl) and `wget` installed, only takes effect when `enable-init-containers` is `true`. By default, an [official pulsarctl image](https://hub.docker.com/r/streamnative/pulsarctl) is used. |
There was a problem hiding this comment.
and in here: https://functionmesh.io/docs/reference/function-mesh-config, append below content to the enable-init-containers filed's description column:
Set it to true when you want to use `wget` instead of `pulsar-admin`(requires admin authentication of pulsar) to download packages from HTTP/HTTPS.
jiangpengcheng
approved these changes
Jan 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
If the function package file uses the HTTP/HTTPS protocol, users need to have an admin access right to download them. To allow a role user to download HTTP/HTTPS package, FM v0.10.0 brings some code changes (code PR #556). Therefore, update docs accordingly.
Modification
Update the Packages section in the Function CRD configurations document.