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 2022/01/27 12:32:03 UTC
[GitHub] [pulsar] zhaoyajun2009 opened a new pull request #13987: Considerations when deploying Bookkeeper
zhaoyajun2009 opened a new pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987
<!--
### 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)**
-->
*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
Fixes #13936
*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
Master Issue: #13936
### Motivation
*Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
### Modifications
*Describe the modifications you've done.*
### 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
Check the box below or label this PR directly (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)
-
- [ v ] `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] imaffe commented on a change in pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r800467323
##########
File path: site2/website-next/versioned_docs/version-2.6.3/administration-zk-bk.md
##########
@@ -205,6 +210,9 @@ ledgerDirectories=data/bookkeeper/ledgers
# Point to local ZK quorum
zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+#This parameter best be set, otherwise，the Bookkeeper can't start normally in special environment
Review comment:
Cool ~ Maybe We can say "...the Bookkeeper can't start normally in Huawei Cloud for now"? What do you think ~
--
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 #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1039795888
Hi @imaffe, @zhaoyajun2009 has incorporated our comments, any other thoughts on this PR? 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] github-actions[bot] commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1023894976
@zhaoyajun2009:Thanks for providing doc info!
--
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] github-actions[bot] commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1023902514
@zhaoyajun2009:Thanks for providing doc info!
--
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] imaffe commented on a change in pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r800465381
##########
File path: site2/docs/administration-zk-bk.md
##########
@@ -180,6 +180,13 @@ You can configure BookKeeper bookies using the [`conf/bookkeeper.conf`](referenc
The minimum configuration changes required in `conf/bookkeeper.conf` are as follows:
+> **Note**
+> The configuration of journalDirectory and ledgerDirectories needs to be considered clearly, and it is very troublesome to change later.
Review comment:
I think it might be better to keep the description aligned across different files. Maybe considering use global replacement to change the description in all docs ? 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] imaffe commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1038546388
@jianyun8023 Looks good to me and ok to be merged, but I don't have write access to this repository, @Anonymitaet would you mind approve this PR ? Thank you ~
--
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 #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1031182687
@zhaoyajun2009 please tick the box `doc` in the [PR description](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation)? So that Bot can recognize and label your PR correspondingly. Or else Bot labels your PR with `doc-info-missing`.
Instructions of doc labels: https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#bookmark=id.5d66olk7l4oz
--
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] github-actions[bot] commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1023895586
@zhaoyajun2009:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? 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] imaffe commented on a change in pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r800408700
##########
File path: site2/website/versioned_docs/version-2.6.0/administration-zk-bk.md
##########
@@ -189,6 +193,12 @@ ledgerDirectories=data/bookkeeper/ledgers
# Point to local ZK quorum
zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+
+#This parameter best be set, otherwise，the Bookkeeper can't start normally in special environment
+advertisedAddress=localhost or hostname or 127.0.0.1
Review comment:
Wondering why we have two duplicate lines ?
--
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] imaffe commented on a change in pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r800410644
##########
File path: site2/website-next/versioned_docs/version-2.6.3/administration-zk-bk.md
##########
@@ -205,6 +210,9 @@ ledgerDirectories=data/bookkeeper/ledgers
# Point to local ZK quorum
zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+#This parameter best be set, otherwise，the Bookkeeper can't start normally in special environment
Review comment:
Curious what the special environment is, is it possible to describe the special environment in a few sentences ? Also if not set will there be a default value for this `advertisedAddress` ?
##########
File path: site2/website-next/versioned_docs/version-2.6.3/administration-zk-bk.md
##########
@@ -194,6 +194,11 @@ You can configure BookKeeper bookies using the [`conf/bookkeeper.conf`](referenc
The minimum configuration changes required in `conf/bookkeeper.conf` are as follows:
+> **Note**
+> The configuration of journalDirectory and ledgerDirectories needs to be considered clearly, and it is very troublesome to change later.
Review comment:
nit: "needs to be chosen carefully, as it is troublesome to change later"
##########
File path: site2/website/versioned_docs/version-2.6.3/administration-zk-bk.md
##########
@@ -156,11 +170,12 @@ The [`conf/zookeeper.conf`](reference-configuration.md#zookeeper) file handles t
The [`conf/global-zookeeper.conf`](reference-configuration.md#configuration-store) file handles the configuration for configuration store. The table below shows the available parameters:
+
## BookKeeper
BookKeeper stores all durable message in Pulsar. BookKeeper is a distributed [write-ahead log](https://en.wikipedia.org/wiki/Write-ahead_logging) WAL system that guarantees read consistency of independent message logs calls ledgers. Individual BookKeeper servers are also called *bookies*.
-> To manage message persistence, retention, and expiry in Pulsar, refer to [cookbook](cookbooks-retention-expiry.md).
+> To manage message persistence, retention, and expiry in Pulsar, refer to [cookbook](cookbooks-retention-expiry).
Review comment:
is it because the file does not have a .md postfix or the markdown doesn't need the .md postfix
--
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] github-actions[bot] commented on pull request #13987: Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1023159159
@zhaoyajun2009:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? 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] zhaoyajun2009 closed pull request #13987: Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
zhaoyajun2009 closed pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987
--
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 #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987
--
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] zhaoyajun2009 commented on a change in pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
zhaoyajun2009 commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r800431510
##########
File path: site2/website-next/versioned_docs/version-2.6.3/administration-zk-bk.md
##########
@@ -205,6 +210,9 @@ ledgerDirectories=data/bookkeeper/ledgers
# Point to local ZK quorum
zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+#This parameter best be set, otherwise，the Bookkeeper can't start normally in special environment
Review comment:
As far as I know, Huawei Cloud has this problem, and other special scenarios are unknown.In the Huawei Cloud environment, if it is not configured, bookkeeper cannot be started normally.
--
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 edited a comment on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet edited a comment on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1031182687
@zhaoyajun2009 please tick the box `doc` in the [PR description](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), so that Bot can recognize and label your PR correspondingly. Or else Bot labels your PR with `doc-info-missing`.
Instructions of doc labels: https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#bookmark=id.5d66olk7l4oz
--
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] imaffe commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1038546388
@jianyun8023 Looks good to me and ok to be merged, but I don't have write access to this repository, @Anonymitaet would you mind approve this PR ? Thank you ~
--
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 #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r805481129
##########
File path: site2/docs/administration-zk-bk.md
##########
@@ -180,6 +180,9 @@ You can configure BookKeeper bookies using the [`conf/bookkeeper.conf`](referenc
The minimum configuration changes required in `conf/bookkeeper.conf` are as follows:
+> **Note**
+> The configuration of journalDirectory and ledgerDirectories need to be chosen carefully，as it is very troublesome to change later.
Review comment:
```suggestion
> Set `journalDirectory` and `ledgerDirectories` carefully. It is difficilt to change them later.
```
##########
File path: site2/docs/administration-zk-bk.md
##########
@@ -189,6 +192,9 @@ ledgerDirectories=data/bookkeeper/ledgers
# Point to local ZK quorum
zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+
+#This parameter best be set, otherwise，the BookKeeper can't start normally in special environment, for example, Huawei Cloud.
Review comment:
```suggestion
# It is recommended to set this parameter. Otherwise, BookKeeper can't start normally in certain environments （for example, Huawei Cloud).
```
--
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 #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#discussion_r805481477
##########
File path: site2/docs/administration-zk-bk.md
##########
@@ -189,6 +192,9 @@ ledgerDirectories=data/bookkeeper/ledgers
# Point to local ZK quorum
zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181
+
+#This parameter best be set, otherwise，the BookKeeper can't start normally in special environment, for example, Huawei Cloud.
Review comment:
```suggestion
# It is recommended to set this parameter. Otherwise, BookKeeper can't start normally in certain environments (for example, Huawei Cloud).
```
--
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] imaffe commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1039862003
> Hi @imaffe, @zhaoyajun2009 has incorporated our comments, any other thoughts on this PR? Thanks
LGTM
--
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] imaffe commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
imaffe commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1039862003
> Hi @imaffe, @zhaoyajun2009 has incorporated our comments, any other thoughts on this PR? Thanks
LGTM
--
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 #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1039795888
Hi @imaffe, @zhaoyajun2009 has incorporated our comments, any other thoughts on this PR? 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 commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1023993553
@imaffe could you please 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] github-actions[bot] commented on pull request #13987: [doc] Considerations when deploying Bookkeeper
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13987:
URL: https://github.com/apache/pulsar/pull/13987#issuecomment-1031168366
@zhaoyajun2009:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? 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