GJL 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_r303794812
##########
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:
I would avoid using class names, such as
`AdaptedRestartPipelinedRegionStrategyNG`, here. We should describe their
behavior only.
Another idea that @zentol had, is to extend the section about restart
strategies [1] with more detailed information about the failover strategies
(`full` and `region`).
[1]
https://ci.apache.org/projects/flink/flink-docs-master/dev/restart_strategies.html
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
