Skip to content

Conversation

@LiJie20190102
Copy link
Contributor

Purpose of this pull request

Filnk engine supports task restore from checkpoint upon startup, and issue is #10220

Does this PR introduce any user-facing change?

How was this patch tested?

Check list

@github-actions github-actions bot added the core SeaTunnel core module label Dec 23, 2025
@davidzollo
Copy link
Contributor

@yzeng1618 Please help review this PR, thx

+ "kubernetes-session, yarn-application, kubernetes-application]")
private MasterType masterType;

/** restore checkpoint path */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment is inconsistent with the actual description of the savepoint parameter.

@Parameter(
names = {"-s", "--fromSavepoint"},
description =
"Path to a savepoint to restore the job from (for example, flink run -s hdfs:///flink/checkpoints/3c298a925d9a2a7837bbf5a8e4966b4f/chk-7902).")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example describes a checkpoint, which is also inconsistent

@yzeng1618
Copy link
Contributor

Could we separately add descriptions for checkpoint and savepoint, and update the corresponding documentation appropriately?

@LiJie20190102
Copy link
Contributor Author

Could we separately add descriptions for checkpoint and savepoint, and update the corresponding documentation appropriately?

Okay, let me modify everything to checkpoint description. I copied it directly from Flink's description

Comment on lines +81 to +88
### 如何从检查点恢复任务

当你需要从检查点恢复任务时,只需启动任务时指定相关的检查点目录即可。

```
bin/start-seatunnel-flink-13-connector-v2.sh --target local --fromCheckpoint hdfs:///flink/checkpoints/3c298a925d9a2a7837bbf5a8e4966b4f/chk-7902 --deploy-mode run --config ./config/example.conf
```

Copy link
Contributor

@yzeng1618 yzeng1618 Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Flink, the -s option works for both savepoints and (externalized/retained)checkpoints. You can add a description in the documentation to indicate that recovery from both savepoints and checkpoints is supported.

@yzeng1618
Copy link
Contributor

You also need to supplement the relevant parameters in docs/zh/command/usage.mdx and docs/en/command/usage.mdx.

@yzeng1618
Copy link
Contributor

It's best to add a unit test to lock the output of buildCommands(), verifying whether -s is included when parameters are passed or not, to prevent regression during future refactoring.

}
```

### How to recover tasks from checkpoint
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How to recover tasks from savepoint / checkpoint

Comment on lines +57 to +60
@Parameter(
names = {"-s", "--fromCheckpoint"},
description =
"Path to a checkpoint to restore the job from (for example, flink run -s hdfs:///flink/checkpoints/3c298a925d9a2a7837bbf5a8e4966b4f/chk-7902).")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Path to a checkpoint/savepoint to restore the job from
@parameter( names = {"-s", "--fromSavepoint", "--fromCheckpoint"}, description = "Path to a savepoint (or an externalized checkpoint) to restore the job from (equivalent to flink run -s ).")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core SeaTunnel core module document reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants