This is an automated email from the ASF dual-hosted git repository. fanrui pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
commit 47255d6a886a5281deb693c106d12ab2c5ecf8ec Author: Rui Fan <[email protected]> AuthorDate: Wed Mar 18 15:40:44 2026 +0100 [FLINK-38541][checkpoint] Expose checkpointing during recovery config option in documentation --- docs/layouts/shortcodes/generated/checkpointing_configuration.html | 6 ++++++ docs/layouts/shortcodes/generated/common_checkpointing_section.html | 6 ++++++ .../java/org/apache/flink/configuration/CheckpointingOptions.java | 5 ++--- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/layouts/shortcodes/generated/checkpointing_configuration.html b/docs/layouts/shortcodes/generated/checkpointing_configuration.html index 6383e0bfc34..b5e40254421 100644 --- a/docs/layouts/shortcodes/generated/checkpointing_configuration.html +++ b/docs/layouts/shortcodes/generated/checkpointing_configuration.html @@ -158,6 +158,12 @@ <td>Integer</td> <td>The tolerable checkpoint consecutive failure number. If set to 0, that means we do not tolerance any checkpoint failure. This only applies to the following failure reasons: IOException on the Job Manager, failures in the async phase on the Task Managers and checkpoint expiration due to a timeout. Failures originating from the sync phase on the Task Managers are always forcing failover of an affected task. Other types of checkpoint failures (such as checkpoint being subsum [...] </tr> + <tr> + <td><h5>execution.checkpointing.during-recovery.enabled</h5></td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Whether to enable checkpointing during recovery from an unaligned checkpoint. When enabled, the job can take checkpoints while still recovering channel state (inflight data) from a previous unaligned checkpoint. This avoids the need to wait for full recovery before the first checkpoint can be triggered, which reduces the window of vulnerability to failures during recovery.<br /><br />This option requires <code class="highlighter-rouge">execution.checkpointing.unaligned.re [...] + </tr> <tr> <td><h5>execution.checkpointing.unaligned.enabled</h5></td> <td style="word-wrap: break-word;">false</td> diff --git a/docs/layouts/shortcodes/generated/common_checkpointing_section.html b/docs/layouts/shortcodes/generated/common_checkpointing_section.html index f942529b79c..938a86ddde5 100644 --- a/docs/layouts/shortcodes/generated/common_checkpointing_section.html +++ b/docs/layouts/shortcodes/generated/common_checkpointing_section.html @@ -56,6 +56,12 @@ <td>Integer</td> <td>The maximum number of completed checkpoints to retain.</td> </tr> + <tr> + <td><h5>execution.checkpointing.during-recovery.enabled</h5></td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Whether to enable checkpointing during recovery from an unaligned checkpoint. When enabled, the job can take checkpoints while still recovering channel state (inflight data) from a previous unaligned checkpoint. This avoids the need to wait for full recovery before the first checkpoint can be triggered, which reduces the window of vulnerability to failures during recovery.<br /><br />This option requires <code class="highlighter-rouge">execution.checkpointing.unaligned.re [...] + </tr> <tr> <td><h5>execution.checkpointing.unaligned.recover-output-on-downstream.enabled</h5></td> <td style="word-wrap: break-word;">false</td> diff --git a/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java index a1307b38c51..dbf9e3bb741 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java @@ -670,10 +670,9 @@ public class CheckpointingOptions { + "when job restores from the unaligned checkpoint."); @Experimental - @Documentation.ExcludeFromDocumentation( - "This option is not yet ready for public use, will be documented in a follow-up commit") + @Documentation.Section(Documentation.Sections.COMMON_CHECKPOINTING) public static final ConfigOption<Boolean> UNALIGNED_DURING_RECOVERY_ENABLED = - ConfigOptions.key("execution.checkpointing.unaligned.during-recovery.enabled") + ConfigOptions.key("execution.checkpointing.during-recovery.enabled") .booleanType() .defaultValue(false) .withDescription(
