You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2020/02/05 19:17:14 UTC
[flink] 01/04: [hotfix][docs] Improve description of
'high-availability.jobmanager.port' config option.
This is an automated email from the ASF dual-hosted git repository.
sewen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit f6f5370532c9a0e3ec1de9a0d73ac3f58669bfe6
Author: Stephan Ewen <se...@apache.org>
AuthorDate: Wed Feb 5 12:43:45 2020 +0100
[hotfix][docs] Improve description of 'high-availability.jobmanager.port' config option.
---
docs/_includes/generated/expert_high_availability_section.html | 2 +-
docs/_includes/generated/high_availability_configuration.html | 2 +-
.../org/apache/flink/configuration/HighAvailabilityOptions.java | 8 +++++++-
3 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/docs/_includes/generated/expert_high_availability_section.html b/docs/_includes/generated/expert_high_availability_section.html
index 6ddbeb5..4a571e7 100644
--- a/docs/_includes/generated/expert_high_availability_section.html
+++ b/docs/_includes/generated/expert_high_availability_section.html
@@ -12,7 +12,7 @@
<td><h5>high-availability.jobmanager.port</h5></td>
<td style="word-wrap: break-word;">"0"</td>
<td>String</td>
- <td>Optional port (range) used by the job manager in high-availability mode.</td>
+ <td>The port (range) used by the Flink Master for its RPC connections in highly-available setups. In highly-available setups, this value is used instead of 'jobmanager.rpc.port'.A value of '0' means that a random free port is chosen. TaskManagers discover this port through the high-availability services (leader election), so a random port or a port range works without requiring any additional means of service discovery.</td>
</tr>
</tbody>
</table>
diff --git a/docs/_includes/generated/high_availability_configuration.html b/docs/_includes/generated/high_availability_configuration.html
index 86573d9..cf61274 100644
--- a/docs/_includes/generated/high_availability_configuration.html
+++ b/docs/_includes/generated/high_availability_configuration.html
@@ -24,7 +24,7 @@
<td><h5>high-availability.jobmanager.port</h5></td>
<td style="word-wrap: break-word;">"0"</td>
<td>String</td>
- <td>Optional port (range) used by the job manager in high-availability mode.</td>
+ <td>The port (range) used by the Flink Master for its RPC connections in highly-available setups. In highly-available setups, this value is used instead of 'jobmanager.rpc.port'.A value of '0' means that a random free port is chosen. TaskManagers discover this port through the high-availability services (leader election), so a random port or a port range works without requiring any additional means of service discovery.</td>
</tr>
<tr>
<td><h5>high-availability.storageDir</h5></td>
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
index 8930d00..86b8232 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
@@ -79,9 +79,15 @@ public class HighAvailabilityOptions {
@Documentation.Section(Documentation.Sections.EXPERT_HIGH_AVAILABILITY)
public static final ConfigOption<String> HA_JOB_MANAGER_PORT_RANGE =
key("high-availability.jobmanager.port")
+ .stringType()
.defaultValue("0")
.withDeprecatedKeys("recovery.jobmanager.port")
- .withDescription("Optional port (range) used by the job manager in high-availability mode.");
+ .withDescription(
+ "The port (range) used by the Flink Master for its RPC connections in highly-available setups. " +
+ "In highly-available setups, this value is used instead of '" + JobManagerOptions.PORT.key() + "'." +
+ "A value of '0' means that a random free port is chosen. TaskManagers discover this port through " +
+ "the high-availability services (leader election), so a random port or a port range works " +
+ "without requiring any additional means of service discovery.");
// ------------------------------------------------------------------------
// ZooKeeper Options