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/12/19 13:15:23 UTC

[GitHub] [pulsar] ericsyh opened a new pull request #13397: fix(docs): wrong configuration set in filesystem offloader

ericsyh opened a new pull request #13397:
URL: https://github.com/apache/pulsar/pull/13397


   Signed-off-by: Eric Shen <er...@outlook.com>
   
   <!--
   ### Contribution Checklist
     
     - Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
       Skip *Issue XYZ* if there is no associated github issue for this pull request.
       Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
     
     - Each pull request should address only one issue, not mix up code from multiple issues.
     
     - Each commit in the pull request has a meaningful commit message
   
     - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
   
   **(The sections below can be removed for hotfixes of typos)**
   -->
   
   ### Motivation
   
   The [required configurations in filesystem offloader driver](https://pulsar.apache.org/docs/en/tiered-storage-filesystem/#configure-filesystem-offloader-driver) has mistake on `offloadersDirectory`, it should be `fileSystemProfilePath`.
   
   ### Modifications
   
   Fix docs mistake.
   
   ### Verifying this change
   
   - [x] 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): (no)
     - The public API: (no)
     - The schema: (no)
     - The default values of configurations: (no)
     - The wire protocol: (no)
     - The rest endpoints: (no)
     - The admin cli options: (no)
     - Anything that affects deployment: (no)
   
   ### Documentation
   
   Check the box below and label this PR (if you have committer privilege).
   
   Need to update docs? 
   
   - [ ] `doc-required` 
     
     (If you need help on updating docs, create a doc issue)
     
   - [ ] `no-need-doc` 
     
     (Please explain why)
     
   - [x] `doc` 
     
     (If this PR contains doc changes)
   
   
   


-- 
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] zymap commented on a change in pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       So could you please keep the original field and fix its description?




-- 
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] zymap commented on a change in pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       I think we should also keep this configuration? By default, all offloaders are keeping in `offloaders` directory, but it also can configure in different directory




-- 
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 pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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


   > https://hub.streamnative.io/offloaders/filesystem/2.5.1 @Anonymitaet The doc on hub also should be updated.
   
   Hi @sijia-w can you help apply the same doc changes to the StreamNative Hub docs? Thanks
   
   Source file: https://github.com/streamnative/pulsar-hub/blob/master/offloaders/filesystem/2.5.1/filesystem.md


-- 
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 pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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


   > https://hub.streamnative.io/offloaders/filesystem/2.5.1 @Anonymitaet The doc on hub also should be updated.
   
   @hangc0276 Sure, thanks for reminding me


-- 
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] ericsyh commented on a change in pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       Other offloaders like s3/GCS docs mentioned the `offloadersDirectory` https://pulsar.apache.org/docs/en/tiered-storage-aws/#configure-aws-s3-offloader-driver. I think it will be better to keep consistent. 




-- 
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] ericsyh commented on a change in pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       i can add the `offloadersDirectory` config back, so there will be configs below on that docs:
    * managedLedgerOffloadDriver
    * fileSystemURI
    * offloadersDirectory
    * fileSystemProfilePath




-- 
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 #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml
+    `fileSystemProfilePath` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       @hangc0276 @zymap can you review this PR from the technical perspective? 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] hangc0276 commented on pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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


   https://hub.streamnative.io/offloaders/filesystem/2.5.1
   @Anonymitaet  The doc on hub also should be updated.


-- 
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] hangc0276 commented on a change in pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       The default `offloadersDirectory` is `./offloaders`, which has been mentioned on above deploy part.
   ```
   3. Copy the Pulsar offloaders as `offloaders` in the Pulsar directory.
       ```
       mv apache-pulsar-offloaders-2.5.1/offloaders apache-pulsar-2.5.1/offloaders
       ls offloaders
       ```
   ```




-- 
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 #13397: fix(docs): wrong configuration set in filesystem offloader

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


   


-- 
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] ericsyh commented on a change in pull request #13397: fix(docs): wrong configuration set in filesystem offloader

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



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -86,7 +86,8 @@ You can configure the filesystem offloader driver in the `broker.conf` or `stand
     |---|---|---
     `managedLedgerOffloadDriver` | Offloader driver name, which is case-insensitive. | filesystem
     `fileSystemURI` | Connection address, which is the URI to access the default Hadoop distributed file system. | hdfs://127.0.0.1:9000
-    `offloadersDirectory` | Hadoop profile path. The configuration file is stored in the Hadoop profile path. It contains various settings for Hadoop performance tuning. | ../conf/filesystem_offload_core_site.xml

Review comment:
       fix in https://github.com/apache/pulsar/pull/13397/commits/b8fc1a79a75790c570a54a35c7e04cb4b79e0049




-- 
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