[hotfix] [config] Minor improvements to JobManagerOptions docs and harmonization of config parameters.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/81a143f6 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/81a143f6 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/81a143f6 Branch: refs/heads/master Commit: 81a143f6b42cf39d56a36222d14b5db0cc54addb Parents: e2ca129 Author: Stephan Ewen <[email protected]> Authored: Tue Mar 21 19:46:51 2017 +0100 Committer: Stephan Ewen <[email protected]> Committed: Tue Mar 21 21:37:21 2017 +0100 ---------------------------------------------------------------------- .../flink/configuration/JobManagerOptions.java | 32 +++++++++++++++----- 1 file changed, 25 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/81a143f6/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java ---------------------------------------------------------------------- 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 index 2bc2498..6f5efe6 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java @@ -29,6 +29,12 @@ public class JobManagerOptions { /** * The config parameter defining the network address to connect to * for communication with the job manager. + * + * <p>This value is only interpreted in setups where a single JobManager with static + * name or address exists (simple standalone setups, or container setups with dynamic + * service name resolution). It is not used in many high-availability setups, when a + * leader-election service (like ZooKeeper) is used to elect and discover the JobManager + * leader from potentially multiple standby JobManagers. */ public static final ConfigOption<String> ADDRESS = ConfigOptions .key("jobmanager.rpc.address") @@ -37,12 +43,31 @@ public class JobManagerOptions { /** * The config parameter defining the network port to connect to * for communication with the job manager. + * + * <p>Like {@link JobManagerOptions#ADDRESS}, this value is only interpreted in setups where + * a single JobManager with static name/address and port exists (simple standalone setups, + * or container setups with dynamic service name resolution). + * This config option is not used in many high-availability setups, when a + * leader-election service (like ZooKeeper) is used to elect and discover the JobManager + * leader from potentially multiple standby JobManagers. */ public static final ConfigOption<Integer> PORT = ConfigOptions .key("jobmanager.rpc.port") .defaultValue(6123); /** + * The maximum number of prior execution attempts kept in history. + */ + public static final ConfigOption<Integer> MAX_ATTEMPTS_HISTORY_SIZE = ConfigOptions + .key("jobmanager.execution.attempts-history-size") + .defaultValue(16) + .withDeprecatedKeys("job-manager.max-attempts-history-size"); + + // ------------------------------------------------------------------------ + // JobManager web UI + // ------------------------------------------------------------------------ + + /** * The port for the runtime monitor web-frontend server. */ public static final ConfigOption<Integer> WEB_PORT = ConfigOptions @@ -127,13 +152,6 @@ public class JobManagerOptions { .key("jobmanager.web.backpressure.delay-between-samples") .defaultValue(50); - /** - * The maximum number of prior execution attempts kept in history. - */ - public static final ConfigOption<Integer> MAX_ATTEMPTS_HISTORY_SIZE = ConfigOptions - .key("job-manager.max-attempts-history-size") - .defaultValue(16); - // --------------------------------------------------------------------------------------------- private JobManagerOptions() {
