[Issue 8345][Documentation] Improve retention policy documentation - #8356
Merged
Jennifer88huang-zz merged 3 commits intoOct 26, 2020
Merged
Conversation
…ention size - explain the settings in other words to clarify the meaning
Fixes apache#8345 - the retention policy is based on both size and time - documentation was misleading and not accurate - setting either limit to 0 disables retention policy - add this also to the documentation explicitly
Member
Author
|
/pulsarbot run-failure-checks |
2 similar comments
Member
Author
|
/pulsarbot run-failure-checks |
Member
Author
|
/pulsarbot run-failure-checks |
jiazhai
added
area/admin
doc
Member
Author
|
/pulsarbot run-failure-checks |
sijie
approved these changes
Oct 23, 2020
codelipenghui
approved these changes
Oct 24, 2020
huangdx0726
pushed a commit
to huangdx0726/pulsar
that referenced
this pull request
Nov 13, 2020
…pache#8356) * Clarify javadoc documentation of ManagedLedger retention time and retention size - explain the settings in other words to clarify the meaning * Clarify retention policy documentation Fixes apache#8345 - the retention policy is based on both size and time - documentation was misleading and not accurate - setting either limit to 0 disables retention policy - add this also to the documentation explicitly * Fix checkstyle violation
flowchartsman
pushed a commit
to flowchartsman/pulsar
that referenced
this pull request
Nov 17, 2020
…pache#8356) * Clarify javadoc documentation of ManagedLedger retention time and retention size - explain the settings in other words to clarify the meaning * Clarify retention policy documentation Fixes apache#8345 - the retention policy is based on both size and time - documentation was misleading and not accurate - setting either limit to 0 disables retention policy - add this also to the documentation explicitly * Fix checkstyle violation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Fixes #8345
Motivation
See #8345, #655
Modifications
Documentation has been improved to cover the fact that retention policy is always based on both time and size limit. To make either limit ignored, it can be set to
-1. It's misleading in the current documentation to call this "infinite" limit since it simply ignores the limit when it's-1. Infinite retention can be achieved by specifying both limits to-1.If either limit is
0, it will effectively disable the retention policy. This wasn't documented before at all.Javadoc for ManagedLedgerConfig was also improved as part of the documentation changes.