Skip to content

[FLINK-40212][docs] Add Regional Checkpoint user documentation - #28966

Open
raoraoxiong wants to merge 1 commit into
apache:masterfrom
raoraoxiong:raorao/FLINK-40212-regional-checkpoint-docs
Open

[FLINK-40212][docs] Add Regional Checkpoint user documentation#28966
raoraoxiong wants to merge 1 commit into
apache:masterfrom
raoraoxiong:raorao/FLINK-40212-regional-checkpoint-docs

Conversation

@raoraoxiong

Copy link
Copy Markdown
Contributor

Purpose

Adds user-facing documentation for the Regional Checkpoint feature (FLIP-600 Phase 10).

Changes

Commit 1: User documentation

  • Document configuration options, prerequisites, and limitations
  • Document notifyRegionalCheckpointComplete and notifyRegionalCheckpointFallback APIs with code examples
  • Document two-tier max-consecutive-failures semantics (Tier 1: force next global; Tier 2: abort + reset)
  • Document Per-Region timeout handling
  • Document bounded source forced global checkpoint behavior
  • Document metric (regional_checkpoint_count) and REST API fields
  • Document checkpoint cleanup with reference chain protection
  • Document troubleshooting guide

Testing

  • Documentation only, no code changes

Dependencies

  • No code dependencies (documentation can be merged independently)

Generated-by: CodeBuddy Code (GLM-5.2)

@flinkbot

flinkbot commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@spuru9

spuru9 commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Can you move the PR in the stack to draft till the foremost PRs in the stack are merged. As the title suggest its a doc PR. Could cause confusion.

@raoraoxiong
raoraoxiong force-pushed the raorao/FLINK-40212-regional-checkpoint-docs branch from dc06841 to 1671f19 Compare August 17, 2026 09:11
- Document configuration options, prerequisites, and limitations
- Document notifyRegionalCheckpointComplete and notifyRegionalCheckpointFallback APIs
- Document two-tier max-consecutive-failures semantics (Tier 1 + Tier 2)
- Document Per-Region timeout handling
- Document bounded source forced global checkpoint behavior
- Document metric (regional_checkpoint_count) and REST API fields
- Document checkpoint cleanup with reference chain protection

Generated-by: CodeBuddy Code (GLM-5.2)
@raoraoxiong
raoraoxiong force-pushed the raorao/FLINK-40212-regional-checkpoint-docs branch from 1671f19 to a0c0d1a Compare August 17, 2026 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants