From 81a143f6b42cf39d56a36222d14b5db0cc54addb Mon Sep 17 00:00:00 2001
From: Stephan Ewen <sewen@apache.org>
Date: Tue, 21 Mar 2017 19:46:51 +0100
Subject: [PATCH] [hotfix] [config] Minor improvements to JobManagerOptions
 docs and harmonization of config parameters.

---
 .../configuration/JobManagerOptions.java      | 32 +++++++++++++++----
 1 file changed, 25 insertions(+), 7 deletions(-)

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 2bc2498e9aa..6f5efe64a63 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,11 +43,30 @@ 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.
 	 */
@@ -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() {
-- 
GitLab