asfgit closed pull request #7211: [hotfix][docs] Add and update description of
local-recovery config op…
URL: https://github.com/apache/flink/pull/7211
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/_includes/generated/checkpointing_configuration.html
b/docs/_includes/generated/checkpointing_configuration.html
index 8f5ce7b341d..6ad5eeeb091 100644
--- a/docs/_includes/generated/checkpointing_configuration.html
+++ b/docs/_includes/generated/checkpointing_configuration.html
@@ -30,7 +30,7 @@
<tr>
<td><h5>state.backend.local-recovery</h5></td>
<td style="word-wrap: break-word;">false</td>
- <td></td>
+ <td>This option configures local recovery for this state backend.
By default, local recovery is deactivated. Local recovery currently only covers
keyed state backends. Currently, MemoryStateBackend does not support local
recovery and ignore this option.</td>
</tr>
<tr>
<td><h5>state.checkpoints.dir</h5></td>
@@ -50,7 +50,7 @@
<tr>
<td><h5>taskmanager.state.local.root-dirs</h5></td>
<td style="word-wrap: break-word;">(none)</td>
- <td></td>
+ <td>The config parameter defining the root directories for storing
file-based state for local recovery. Local recovery currently only covers keyed
state backends. Currently, MemoryStateBackend does not support local recovery
and ignore this option</td>
</tr>
</tbody>
</table>
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 6557a9f7dd4..2b4bba66c5e 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
@@ -71,17 +71,31 @@
/**
* This option configures local recovery for this state backend. By
default, local recovery is deactivated.
+ *
+ * <p>Local recovery currently only covers keyed state backends.
+ * Currently, MemoryStateBackend does not support local recovery and
ignore
+ * this option.
*/
public static final ConfigOption<Boolean> LOCAL_RECOVERY = ConfigOptions
- .key("state.backend.local-recovery")
- .defaultValue(false);
+ .key("state.backend.local-recovery")
+ .defaultValue(false)
+ .withDescription("This option configures local recovery
for this state backend. By default, local recovery is " +
+ "deactivated. Local recovery currently only
covers keyed state backends. Currently, MemoryStateBackend does " +
+ "not support local recovery and ignore this
option.");
/**
* The config parameter defining the root directories for storing
file-based state for local recovery.
+ *
+ * <p>Local recovery currently only covers keyed state backends.
+ * Currently, MemoryStateBackend does not support local recovery and
ignore
+ * this option.
*/
public static final ConfigOption<String>
LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS = ConfigOptions
- .key("taskmanager.state.local.root-dirs")
- .noDefaultValue();
+ .key("taskmanager.state.local.root-dirs")
+ .noDefaultValue()
+ .withDescription("The config parameter defining the
root directories for storing file-based state for local " +
+ "recovery. Local recovery currently only covers
keyed state backends. Currently, MemoryStateBackend does " +
+ "not support local recovery and ignore this
option");
//
------------------------------------------------------------------------
// Options specific to the file-system-based state backends
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
