From 011b6b44074bad6b5f6db416f77a15c83a47ccc2 Mon Sep 17 00:00:00 2001 From: Zhanghao Chen Date: Sun, 8 Oct 2023 13:53:13 +0800 Subject: [PATCH] [FLINK-33204][doc] Add JM/TM bind-adddress and RPC bind-port to relevant sections in documentation. This closes #23493 --- .../generated/all_jobmanager_section.html | 12 ++++++++++ .../generated/all_taskmanager_section.html | 12 ++++++++++ .../generated/common_host_port_section.html | 24 +++++++++++++++++++ .../configuration/JobManagerOptions.java | 8 +++++++ .../configuration/TaskManagerOptions.java | 8 +++++++ 5 files changed, 64 insertions(+) diff --git a/docs/layouts/shortcodes/generated/all_jobmanager_section.html b/docs/layouts/shortcodes/generated/all_jobmanager_section.html index af5f4e5327baa..5bcb175141750 100644 --- a/docs/layouts/shortcodes/generated/all_jobmanager_section.html +++ b/docs/layouts/shortcodes/generated/all_jobmanager_section.html @@ -32,6 +32,12 @@ String Directory for JobManager to store the archives of completed jobs. + +
jobmanager.bind-host
+ (none) + String + The local address of the network interface that the job manager binds to. If not configured, '0.0.0.0' will be used. +
jobmanager.execution.attempts-history-size
16 @@ -86,6 +92,12 @@ String The config parameter defining the network address to connect to for communication with the job manager. 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. + +
jobmanager.rpc.bind-port
+ (none) + Integer + The local RPC port that the JobManager binds to. If not configured, the external port (configured by 'jobmanager.rpc.port') will be used. +
jobmanager.rpc.port
6123 diff --git a/docs/layouts/shortcodes/generated/all_taskmanager_section.html b/docs/layouts/shortcodes/generated/all_taskmanager_section.html index 6bd871ecdf0a1..bde8c250bdf89 100644 --- a/docs/layouts/shortcodes/generated/all_taskmanager_section.html +++ b/docs/layouts/shortcodes/generated/all_taskmanager_section.html @@ -26,6 +26,12 @@ Long Time we wait for the timers in milliseconds to finish all pending timer threads when the stream task is cancelled. + +
taskmanager.bind-host
+ (none) + String + The local address of the network interface that the task manager binds to. If not configured, '0.0.0.0' will be used. +
taskmanager.data.bind-port
(none) @@ -105,6 +111,12 @@ String The TaskManager's ResourceID. If not configured, the ResourceID will be generated with the "RpcAddress:RpcPort" and a 6-character random string. Notice that this option is not valid in Yarn and Native Kubernetes mode. + +
taskmanager.rpc.bind-port
+ (none) + Integer + The local RPC port that the TaskManager binds to. If not configured, the external port (configured by 'taskmanager.rpc.port') will be used. +
taskmanager.rpc.port
"0" diff --git a/docs/layouts/shortcodes/generated/common_host_port_section.html b/docs/layouts/shortcodes/generated/common_host_port_section.html index 624278f7fb410..160cdd5328d8e 100644 --- a/docs/layouts/shortcodes/generated/common_host_port_section.html +++ b/docs/layouts/shortcodes/generated/common_host_port_section.html @@ -8,12 +8,24 @@ + +
jobmanager.bind-host
+ (none) + String + The local address of the network interface that the job manager binds to. If not configured, '0.0.0.0' will be used. +
jobmanager.rpc.address
(none) String The config parameter defining the network address to connect to for communication with the job manager. 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. + +
jobmanager.rpc.bind-port
+ (none) + Integer + The local RPC port that the JobManager binds to. If not configured, the external port (configured by 'jobmanager.rpc.port') will be used. +
jobmanager.rpc.port
6123 @@ -56,6 +68,12 @@ Integer The port that the client connects to. If rest.bind-port has not been specified, then the REST server will bind to this port. Attention: This option is respected only if the high-availability configuration is NONE. + +
taskmanager.bind-host
+ (none) + String + The local address of the network interface that the task manager binds to. If not configured, '0.0.0.0' will be used. +
taskmanager.data.bind-port
(none) @@ -74,6 +92,12 @@ String The external address of the network interface where the TaskManager is exposed. Because different TaskManagers need different values for this option, usually it is specified in an additional non-shared TaskManager-specific config file. + +
taskmanager.rpc.bind-port
+ (none) + Integer + The local RPC port that the TaskManager binds to. If not configured, the external port (configured by 'taskmanager.rpc.port') will be used. +
taskmanager.rpc.port
"0" 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 04b964e55d32f..1da99be996670 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 @@ -66,6 +66,10 @@ public class JobManagerOptions { + " leader from potentially multiple standby JobManagers."); /** The local address of the network interface that the job manager binds to. */ + @Documentation.Section({ + Documentation.Sections.COMMON_HOST_PORT, + Documentation.Sections.ALL_JOB_MANAGER + }) public static final ConfigOption BIND_HOST = key("jobmanager.bind-host") .stringType() @@ -105,6 +109,10 @@ public class JobManagerOptions { + " leader from potentially multiple standby JobManagers."); /** The local port that the job manager binds to. */ + @Documentation.Section({ + Documentation.Sections.COMMON_HOST_PORT, + Documentation.Sections.ALL_JOB_MANAGER + }) public static final ConfigOption RPC_BIND_PORT = key("jobmanager.rpc.bind-port") .intType() diff --git a/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java index 944ee96ed22be..8f4a836d4f338 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java @@ -126,6 +126,10 @@ public class TaskManagerOptions { + " additional non-shared TaskManager-specific config file."); /** The local address of the network interface that the task manager binds to. */ + @Documentation.Section({ + Documentation.Sections.COMMON_HOST_PORT, + Documentation.Sections.ALL_TASK_MANAGER + }) public static final ConfigOption BIND_HOST = key("taskmanager.bind-host") .stringType() @@ -152,6 +156,10 @@ public class TaskManagerOptions { + " range of ports to avoid collisions when multiple TaskManagers are running on the same machine."); /** The local port that the task manager binds to. */ + @Documentation.Section({ + Documentation.Sections.COMMON_HOST_PORT, + Documentation.Sections.ALL_TASK_MANAGER + }) public static final ConfigOption RPC_BIND_PORT = key("taskmanager.rpc.bind-port") .intType()