You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by sr...@apache.org on 2018/12/10 14:51:47 UTC
[flink] branch release-1.7 updated: [hotfix][docs] Add and update
description of local-recovery config options
This is an automated email from the ASF dual-hosted git repository.
srichter pushed a commit to branch release-1.7
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/release-1.7 by this push:
new 63c5d5e [hotfix][docs] Add and update description of local-recovery config options
63c5d5e is described below
commit 63c5d5effbb72abc8489c91dd6ead5172a455ae9
Author: KarmaGYZ <ka...@gmail.com>
AuthorDate: Sun Dec 2 09:49:23 2018 +0100
[hotfix][docs] Add and update description of local-recovery config options
This closes #7211.
---
.../generated/checkpointing_configuration.html | 4 ++--
.../flink/configuration/CheckpointingOptions.java | 22 ++++++++++++++++++----
2 files changed, 20 insertions(+), 6 deletions(-)
diff --git a/docs/_includes/generated/checkpointing_configuration.html b/docs/_includes/generated/checkpointing_configuration.html
index 8f5ce7b..6ad5eee 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 6557a9f..2b4bba6 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 @@ public class CheckpointingOptions {
/**
* 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