[FLINK-40476][docs] Clarify Changelog state backend requires CLAIM restore mode - #29025
Open
vsantwana wants to merge 1 commit into
Open
[FLINK-40476][docs] Clarify Changelog state backend requires CLAIM restore mode#29025vsantwana wants to merge 1 commit into
vsantwana wants to merge 1 commit into
Conversation
…store mode The Changelog state backend docs stated that resuming from savepoints and checkpoints is supported, without noting that NO_CLAIM restore mode (the default) is unsupported. A changelog-enabled job resumed in NO_CLAIM restores successfully but then fails on its first checkpoint with IllegalStateException: ... does not support enforcing a full snapshot. Clarify that resuming a changelog job must use CLAIM (or the deprecated LEGACY) restore mode, add a warning note describing the NO_CLAIM failure, and expand the limitation bullet. Mirror the changes in the Chinese docs.
Collaborator
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
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.
What is the purpose of the change
Clarify the Changelog state backend documentation:
NO_CLAIMrestore mode (the default) is not supported. A changelog-enabled job resumed inNO_CLAIMmode restores successfully but then fails on its first checkpoint with:The docs previously stated "Resuming from both savepoints and checkpoints is supported" without noting the required restore mode, and the
NO_CLAIMlimitation was an easily-missed bullet that contradicted that statement. This mismatch contributed to FLINK-38307 being reported as a bug.Brief change log
CLAIM(or the deprecatedLEGACY) restore mode, in both the "Enabling Changelog" and "Disabling Changelog" sections.NO_CLAIMmode.NO_CLAIMlimitation bullet to point users toCLAIM/LEGACY.docs/content.zh).Verifying this change
This change is a documentation-only change. The described behavior was verified empirically on Flink 1.19 (RocksDB + Changelog via the Kubernetes operator): resuming a changelog-enabled job in
NO_CLAIMmode restores successfully but fails on the first checkpoint with the exception above, while the same job resumed inCLAIMmode resumes and checkpoints normally.Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation