Skip to content

[FLINK-40254][docs] Document checkpoint behavior after a CLAIM-mode restore from a NATIVE savepoint #28838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snuyanzin merged 1 commit into from
Jul 30, 2026
Merged

[FLINK-40254][docs] Document checkpoint behavior after a CLAIM-mode restore from a NATIVE savepoint #28838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content.zh/docs/ops/state/savepoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ $ bin/flink run -s :savepointPath -claimMode :mode -n [:runArgs]
**注意：**
1. Retained checkpoints 被存储在 `<checkpoint_dir>/<job_id>/chk-<x>` 这样的目录中。Flink 不会接管 `<checkpoint_dir>/<job_id>` 目录的所有权，而只会接管 `chk-<x>` 的所有权。Flink 不会删除旧作业的目录。

2. [Native](#savepoint-format) 格式支持增量的 RocksDB savepoints。对于这些 savepoints，Flink 将所有 SST 存储在 savepoints 目录中。这意味着这些 savepoints 是自包含和目录可移动的。然而，在 CLAIM 模式下恢复时，后续的 checkpoints 可能会复用一些 SST 文件，这反过来会阻止在 savepoints 被清理时删除 savepoints 目录。 Flink 之后运行期间可能会删除复用的SST 文件，但不会删除 savepoints 目录。因此，如果在 CLAIM 模式下恢复，Flink 可能会留下一个空的 savepoints 目录。
2. [Native](#savepoint-format) 格式支持增量的 RocksDB savepoints。对于这些 savepoints，Flink 将所有 SST 存储在 savepoints 目录中。这意味着这些 savepoints 是自包含和目录可移动的。然而，在 CLAIM 模式下恢复时，后续的 checkpoints 可能会复用一些 SST 文件，这反过来会阻止在 savepoints 被清理时删除 savepoints 目录。这些 checkpoints 的元数据会以绝对路径引用所复用的 savepoint 文件，因此与一般的增量 checkpoints 一样，它们既不是自包含的，目录也不可移动。在所有复用这些文件的 checkpoints 被后续的 checkpoints 取代之前，savepoints 目录会一直被引用；由于在 CLAIM 模式下快照的所有权归 Flink，这些文件的生命周期由 Flink 管理。 Flink 之后运行期间可能会删除复用的SST 文件，但不会删除 savepoints 目录。因此，如果在 CLAIM 模式下恢复，Flink 可能会留下一个空的 savepoints 目录。
{{< /hint >}}

**LEGACY (已废弃)**
Expand Down
8 changes: 6 additions & 2 deletions docs/content/docs/ops/state/savepoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,12 @@ of the old job will not be deleted by Flink

2. [Native](#savepoint-format) format supports incremental RocksDB savepoints. For those savepoints Flink puts all
SST files inside the savepoints directory. This means such savepoints are self-contained and relocatable.
Please note that, when restored in CLAIM mode, subsequent checkpoints might reuse some SST files, which
might delay the deletion the savepoints directory.
Please note that, when restored in CLAIM mode, subsequent checkpoints might reuse some SST files of the
savepoint. The metadata of such checkpoints references the reused files by their absolute location in the
savepoints directory, so (like incremental checkpoints in general) these checkpoints are neither
self-contained nor relocatable. The savepoints directory remains referenced until all checkpoints reusing
its files have been subsumed; since Flink owns the snapshot in CLAIM mode, Flink manages the lifecycle of
those files, which might delay the deletion of the savepoints directory.
{{< /hint >}}

**LEGACY (deprecated)**
Expand Down