[GitHub] [flink] zhuzhurk commented on a change in pull request #9113: [FLINK-13222] [runtime] Add documentation for failover strategy option

[GitBox <gi...@apache.org>]

zhuzhurk commented on a change in pull request #9113: [FLINK-13222] [runtime] Add documentation for failover strategy option
URL: https://github.com/apache/flink/pull/9113#discussion_r303808332
 
 

 ##########
 File path: flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
 ##########
 @@ -106,17 +106,21 @@
 	/**
 	 * This option specifies the failover strategy, i.e. how the job computation recovers from task failures.
 	 */
-	@Documentation.ExcludeFromDocumentation("The failover strategy feature is highly experimental.")
 	public static final ConfigOption<String> EXECUTION_FAILOVER_STRATEGY =
 		key("jobmanager.execution.failover-strategy")
 			.defaultValue("full")
 			.withDescription(Description.builder()
-				.text("This option specifies how the job computation recovers from task failures. " +
+				.text("This option specifies the failover strategy, i.e. " +
+					"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.")
+					text("'full': Use RestartAllStrategy to restarts all tasks to recover the job."),
+					text("'region': Use AdaptedRestartPipelinedRegionStrategyNG to restart all tasks " +
 
 Review comment:
   Ok. Let's remove the class name and just describe the behavior here.
   
   I think adding more information for different failover strategies is a very good idea. In this PR I'm trying to make the documentation easy to understand, but seems it's a bit hard to make it very clear if we do not want to add too many words for the option documentation.
   Just not sure if the RestartStrategy page is the proper place? As the failover strategy and restart strategy are somehow independent.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services