[FLINK-10102][docs] Fix docs for EXECUTION_FAILOVER_STRATEGY

tongcheng-elong · Aug 8, 2018 · a9ab420 · a9ab420
1 parent c1a5ff2
commit a9ab420
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/_includes/generated/job_manager_configuration.html b/docs/_includes/generated/job_manager_configuration.html
@@ -20,7 +20,7 @@
  <tr>
  <td><h5>jobmanager.execution.failover-strategy</h5></td>
  <td style="word-wrap: break-word;">"full"</td>
- <td>The maximum number of prior execution attempts kept in history.</td>
+ <td>This option specifies how the job computation recovers from task failures.Accepted values are:<ul><li>'full': Restarts all tasks.</li><li>'individual': Restarts only the failed task. Should only be used if all tasks are independent components.</li><li>'region': Restarts all tasks that could be affected by the task failure.</li></ul></td>
  </tr>
  <tr>
  <td><h5>jobmanager.heap.size</h5></td>

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
@@ -20,8 +20,10 @@
 
 import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
+import org.apache.flink.configuration.description.Description;
 
 import static org.apache.flink.configuration.ConfigOptions.key;
+import static org.apache.flink.configuration.description.TextElement.text;
 
 /**
  * Configuration options for the JobManager.
@@ -102,12 +104,19 @@ public class JobManagerOptions {
  .withDescription("The maximum number of prior execution attempts kept in history.");
 
  /**
- * The maximum number of prior execution attempts kept in history.
+ * This option specifies the failover strategy, i.e. how the job computation recovers from task failures.
  */
  public static final ConfigOption<String> EXECUTION_FAILOVER_STRATEGY =
  key("jobmanager.execution.failover-strategy")
  .defaultValue("full")
- .withDescription("The maximum number of prior execution attempts kept in history.");
+ .withDescription(Description.builder()
+ .text("This option specifies how the job computation recovers from task failures." +
+ "Accepted values are:")
+ .list(
+ text("'full': Restarts all tasks."),
+ text("'individual': Restarts only the failed task. Should only be used if all tasks are independent components."),
+ text("'region': Restarts all tasks that could be affected by the task failure.")
+ ).build());
 
  /**
  * This option specifies the interval in order to trigger a resource manager reconnection if the connection