Skip to content

Commit

Permalink
[FLINK-15684][docs] Add taskmanager.memory.flink.size to common options
Browse files Browse the repository at this point in the history
This closes apache#10916
  • Loading branch information
dawidwys authored and Oleksandr Nitavskyi committed Feb 20, 2020
1 parent e8cc882 commit e081fb4
Showing 1 changed file with 13 additions and 8 deletions.
Expand Up @@ -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, JVM Metaspace, and JVM Overhead. On "
+ "containerized setups, this should be set to the container memory. See also "
+ "'taskmanager.memory.flink.size' for total Flink memory size configuration."
);

/**
* Total Flink Memory size for the TaskExecutors.
*/
@Documentation.CommonOption(position = Documentation.CommonOption.POSITION_MEMORY)
public static final ConfigOption<MemorySize> 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.
Expand Down

0 comments on commit e081fb4

Please sign in to comment.