[FLINK-22963] The description of taskmanager.memory.task.heap.size in the official document is incorrect

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.14.0, 1.13.1, 1.12.4
• Fix Version/s: 1.14.0, 1.12.5, 1.13.2
• Component/s: Documentation
• Labels: documentation pull-request-available starter
• Assignee: Chuang Lee
• Reporter: Chuang Lee
• Created: 10/Jun/21 14:21
• Updated: 28/Aug/21 12:17
• Resolved: 15/Jun/21 07:27

Description

When I studied the memory model of TaskManager, I found that there is a problem in the official document, which is the description of taskmanager.memory.task.heap.size is incorrect.

According to the official memory model, I think the correct description should be that task Heap Memory size for TaskExecutors. This is the size of JVM heap memory reserved for tasks. If not specified, it will be derived as Total Flink Memory minus Framework Heap Memory, Framework Off-Heap Heap Memory, Task Off-Heap Memory, Managed Memory and Network Memory.

However, in the official document, the Framework Off-Heap Heap Memory should be subtracted.

Issue Links

• links to: GitHub Pull Request #16143
• links to: GitHub Pull Request #16152