You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/08/27 03:28:06 UTC

[GitHub] [pulsar] freeznet opened a new pull request #11810: add package URL related docs

freeznet opened a new pull request #11810:
URL: https://github.com/apache/pulsar/pull/11810


   Fixes #11665
   
   ### Motivation
   
   #11666 add the implementation of package URL support, this PR works on the docs.
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   *(Please pick either of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (10MB)*
     - *Extended integration test for recovery after broker failure*
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If `yes` was chosen, please highlight the changes*
   
     - Dependencies (does it add or upgrade a dependency): (yes / no)
     - The public API: (yes / no)
     - The schema: (yes / no / don't know)
     - The default values of configurations: (yes / no)
     - The wire protocol: (yes / no)
     - The rest endpoints: (yes / no)
     - The admin cli options: (yes / no)
     - Anything that affects deployment: (yes / no / don't know)
   
   ### Documentation
   
   #### For contributor
   
   For this PR, do we need to update docs?
   
   - If yes, please update docs or create a follow-up issue if you need help.
     
   - If no, please explain why.
   
   #### For committer
   
   For this PR, do we need to update docs?
   
   - If yes,
     
     - if you update docs in this PR, label this PR with the `doc` label.
     
     - if you plan to update docs later, label this PR with the `doc-required` label.
   
     - if you need help on updating docs, create a follow-up issue with the `doc-required` label.
     
   - If no, label this PR with the `no-need-doc` label and explain why.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet commented on a change in pull request #11810: [doc] add create functions with package URL related docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #11810:
URL: https://github.com/apache/pulsar/pull/11810#discussion_r697129811



##########
File path: site2/docs/functions-deploy.md
##########
@@ -154,6 +154,25 @@ $ bin/pulsar-admin functions create \
 > #### Resources are *per instance*
 > The resources that you apply to a given Pulsar Function are applied to each instance of the function. For example, if you apply 8 GB of RAM to a function with a parallelism of 5, you are applying 40 GB of RAM for the function in total. Make sure that you take the parallelism (the number of instances) factor into your resource calculations.
 
+### Use [Package management service](admin-api-packages.md)

Review comment:
       Generally, we do not add links for headings. You can add the link to `Package management service in line 161.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet commented on a change in pull request #11810: [doc] add create functions with package URL related docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #11810:
URL: https://github.com/apache/pulsar/pull/11810#discussion_r697129968



##########
File path: site2/docs/functions-deploy.md
##########
@@ -154,6 +154,25 @@ $ bin/pulsar-admin functions create \
 > #### Resources are *per instance*
 > The resources that you apply to a given Pulsar Function are applied to each instance of the function. For example, if you apply 8 GB of RAM to a function with a parallelism of 5, you are applying 40 GB of RAM for the function in total. Make sure that you take the parallelism (the number of instances) factor into your resource calculations.
 
+### Use [Package management service](admin-api-packages.md)
+
+Package management enables version management and simplifies the upgrade and rollback processes for Functions, Sinks, and Sources. When you use the same function, sink and source in different namespaces, you can upload them to a common package management system.
+
+To use Package management service, please ensure that the package management service has been enabled in your cluster by setting following properties in `broker.conf`.

Review comment:
       ```suggestion
   To use [Package management service](admin-api-packages.md), ensure that the package management service has been enabled in your cluster by setting the following properties in `broker.conf`.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] freeznet commented on pull request #11810: [doc] add create functions with package URL related docs

Posted by GitBox <gi...@apache.org>.
freeznet commented on pull request #11810:
URL: https://github.com/apache/pulsar/pull/11810#issuecomment-907005843


   @Anonymitaet thanks for the comments, I have pushed a new commit to address your comments, PTAL when you have time, thanks.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [pulsar] Anonymitaet merged pull request #11810: [doc] add create functions with package URL related docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #11810:
URL: https://github.com/apache/pulsar/pull/11810


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org