[FLINK-8475][config][docs] Integrate RM options This closes #5470.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/4bbe2dc1 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/4bbe2dc1 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/4bbe2dc1 Branch: refs/heads/master Commit: 4bbe2dc146d0e24ceb9f6a6ae829c88962173a9d Parents: 39657d9 Author: zentol <ches...@apache.org> Authored: Tue Jan 30 14:49:13 2018 +0100 Committer: zentol <ches...@apache.org> Committed: Wed Feb 14 11:56:33 2018 +0100 ---------------------------------------------------------------------- .../resource_manager_configuration.html | 36 ++++++++++++++++++++ docs/ops/config.md | 3 +- .../configuration/ResourceManagerOptions.java | 15 +++++--- 3 files changed, 48 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/4bbe2dc1/docs/_includes/generated/resource_manager_configuration.html ---------------------------------------------------------------------- diff --git a/docs/_includes/generated/resource_manager_configuration.html b/docs/_includes/generated/resource_manager_configuration.html new file mode 100644 index 0000000..3dc3a3e --- /dev/null +++ b/docs/_includes/generated/resource_manager_configuration.html @@ -0,0 +1,36 @@ +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 20%">Key</th> + <th class="text-left" style="width: 15%">Default</th> + <th class="text-left" style="width: 65%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>containerized.heap-cutoff-min</h5></td> + <td>600</td> + <td>Minimum amount of heap memory to remove in containers, as a safety margin.</td> + </tr> + <tr> + <td><h5>containerized.heap-cutoff-ratio</h5></td> + <td>0.25</td> + <td>Percentage of heap space to remove from containers (YARN / Mesos), to compensate for other JVM memory usage.</td> + </tr> + <tr> + <td><h5>local.number-resourcemanager</h5></td> + <td>1</td> + <td></td> + </tr> + <tr> + <td><h5>resourcemanager.job.timeout</h5></td> + <td>"5 minutes"</td> + <td>Timeout for jobs which don't have a job manager as leader assigned.</td> + </tr> + <tr> + <td><h5>resourcemanager.rpc.port</h5></td> + <td>0</td> + <td>Defines the network port to connect to for communication with the resource manager. By default, the port of the JobManager, because the same ActorSystem is used. Its not possible to use this configuration key to define port ranges.</td> + </tr> + </tbody> +</table> http://git-wip-us.apache.org/repos/asf/flink/blob/4bbe2dc1/docs/ops/config.md ---------------------------------------------------------------------- diff --git a/docs/ops/config.md b/docs/ops/config.md index 022061f..41d73c4 100644 --- a/docs/ops/config.md +++ b/docs/ops/config.md @@ -364,8 +364,7 @@ These parameters allow for advanced tuning. The default values are sufficient wh The configuration keys in this section are independent of the used resource management framework (YARN, Mesos, Standalone, ...) -- `resourcemanager.rpc.port`: The config parameter defining the network port to connect to for communication with the resource manager. By default, the port -of the JobManager, because the same ActorSystem is used. Its not possible to use this configuration key to define port ranges. +{% include generated/resource_manager_configuration.html %} ### YARN http://git-wip-us.apache.org/repos/asf/flink/blob/4bbe2dc1/flink-core/src/main/java/org/apache/flink/configuration/ResourceManagerOptions.java ---------------------------------------------------------------------- diff --git a/flink-core/src/main/java/org/apache/flink/configuration/ResourceManagerOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/ResourceManagerOptions.java index 7d0f405..dfaf89f 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/ResourceManagerOptions.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/ResourceManagerOptions.java @@ -34,7 +34,8 @@ public class ResourceManagerOptions { */ public static final ConfigOption<String> JOB_TIMEOUT = ConfigOptions .key("resourcemanager.job.timeout") - .defaultValue("5 minutes"); + .defaultValue("5 minutes") + .withDescription("Timeout for jobs which don't have a job manager as leader assigned."); public static final ConfigOption<Integer> LOCAL_NUMBER_RESOURCE_MANAGER = ConfigOptions .key("local.number-resourcemanager") @@ -42,7 +43,10 @@ public class ResourceManagerOptions { public static final ConfigOption<Integer> IPC_PORT = ConfigOptions .key("resourcemanager.rpc.port") - .defaultValue(0); + .defaultValue(0) + .withDescription("Defines the network port to connect to for communication with the resource manager. By" + + " default, the port of the JobManager, because the same ActorSystem is used." + + " Its not possible to use this configuration key to define port ranges."); /** * Percentage of heap space to remove from containers (YARN / Mesos), to compensate @@ -51,7 +55,9 @@ public class ResourceManagerOptions { public static final ConfigOption<Float> CONTAINERIZED_HEAP_CUTOFF_RATIO = ConfigOptions .key("containerized.heap-cutoff-ratio") .defaultValue(0.25f) - .withDeprecatedKeys("yarn.heap-cutoff-ratio"); + .withDeprecatedKeys("yarn.heap-cutoff-ratio") + .withDescription("Percentage of heap space to remove from containers (YARN / Mesos), to compensate" + + " for other JVM memory usage."); /** * Minimum amount of heap memory to remove in containers, as a safety margin. @@ -59,7 +65,8 @@ public class ResourceManagerOptions { public static final ConfigOption<Integer> CONTAINERIZED_HEAP_CUTOFF_MIN = ConfigOptions .key("containerized.heap-cutoff-min") .defaultValue(600) - .withDeprecatedKeys("yarn.heap-cutoff-min"); + .withDeprecatedKeys("yarn.heap-cutoff-min") + .withDescription("Minimum amount of heap memory to remove in containers, as a safety margin."); /** * The timeout for a slot request to be discarded, in milliseconds.
