From 20a066ee0159675378e059cd44941070190906b3 Mon Sep 17 00:00:00 2001 From: Dawid Wysakowicz Date: Tue, 21 Jan 2020 11:30:48 +0100 Subject: [PATCH 1/2] [FLINK-15684][docs] Add taskmanager.memory.flink.size to common options --- .../configuration/TaskManagerOptions.java | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) 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 a1a91cb8cbf41..3bc38c380d3b1 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 @@ -257,20 +257,25 @@ public class TaskManagerOptions { key("taskmanager.memory.process.size") .memoryType() .noDefaultValue() - .withDescription("Total Process Memory size for the TaskExecutors. This includes all the memory that a" - + " TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On" - + " containerized setups, this should be set to the container memory."); + .withDescription("Total Process Memory size for the TaskExecutors. This includes all the memory that a " + + "TaskExecutor consumes, consisting of Total Flink Memory (configured with " + + "'taskmanager.memory.flink.size'), JVM Metaspace, and JVM Overhead. On " + + "containerized setups, this should be set to the container memory." + ); /** * Total Flink Memory size for the TaskExecutors. */ + @Documentation.CommonOption(position = Documentation.CommonOption.POSITION_MEMORY) public static final ConfigOption TOTAL_FLINK_MEMORY = key("taskmanager.memory.flink.size") - .memoryType() - .noDefaultValue() - .withDescription("Total Flink Memory size for the TaskExecutors. This includes all the memory that a" - + " TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory," - + " Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory."); + .memoryType() + .noDefaultValue() + .withDescription(String.format("Total Flink Memory size for the TaskExecutors. This includes all the " + + "memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of " + + "Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network " + + "Memory. See also '%s' for total process memory size configuration.", + TOTAL_PROCESS_MEMORY.key())); /** * Framework Heap Memory size for TaskExecutors. From dc81015e5373355ee005921801c82cfd647ad584 Mon Sep 17 00:00:00 2001 From: Dawid Wysakowicz Date: Tue, 21 Jan 2020 13:24:34 +0100 Subject: [PATCH 2/2] [FLINK-15684][docs] Regenerate documentation --- docs/_includes/generated/common_section.html | 8 +++++++- .../generated/task_manager_memory_configuration.html | 4 ++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/_includes/generated/common_section.html b/docs/_includes/generated/common_section.html index 7b6ecbc9d545b..99a61edf86d30 100644 --- a/docs/_includes/generated/common_section.html +++ b/docs/_includes/generated/common_section.html @@ -14,11 +14,17 @@ String JVM heap size for the JobManager. + +
taskmanager.memory.flink.size
+ (none) + MemorySize + Total Flink Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory. See also 'taskmanager.memory.process.size' for total process memory size configuration. +
taskmanager.memory.process.size
(none) MemorySize - Total Process Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On containerized setups, this should be set to the container memory. + Total Process Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, consisting of Total Flink Memory (configured with 'taskmanager.memory.flink.size'), JVM Metaspace, and JVM Overhead. On containerized setups, this should be set to the container memory.
parallelism.default
diff --git a/docs/_includes/generated/task_manager_memory_configuration.html b/docs/_includes/generated/task_manager_memory_configuration.html index 501d432975c1d..7e8948980d4f3 100644 --- a/docs/_includes/generated/task_manager_memory_configuration.html +++ b/docs/_includes/generated/task_manager_memory_configuration.html @@ -12,7 +12,7 @@
taskmanager.memory.flink.size
(none) MemorySize - Total Flink Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory. + Total Flink Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory. See also 'taskmanager.memory.process.size' for total process memory size configuration.
taskmanager.memory.framework.heap.size
@@ -84,7 +84,7 @@
taskmanager.memory.process.size
(none) MemorySize - Total Process Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On containerized setups, this should be set to the container memory. + Total Process Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, consisting of Total Flink Memory (configured with 'taskmanager.memory.flink.size'), JVM Metaspace, and JVM Overhead. On containerized setups, this should be set to the container memory.
taskmanager.memory.segment-size