tillrohrmann commented on a change in pull request #10999: [FLINK-15143] Docs for FLIP-49 TM memory model and configuration guide URL: https://github.com/apache/flink/pull/10999#discussion_r376522355
########## File path: docs/ops/memory/mem_setup.md ########## @@ -0,0 +1,133 @@ +--- +title: "Setup Task Executor Memory" +nav-parent_id: ops_mem +nav-pos: 1 +--- +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +Apache Flink provides efficient workloads on top of the JVM by tightly controlling the memory usage of its various components. +While the community strives to offer sensible defaults to all configurations, the full breadth of applications +that users deploy on Flink means this isn't always possible. To provide the most production value to our users, +Flink allows both high level and fine-grained tuning of memory allocation within clusters. + +* toc +{:toc} + +The further described memory configuration is applicable starting with the release version *1.10*. If you upgrade Flink +from earlier versions, check the [migration guide](mem_migration.html) because many changes were introduced with the 1.10 release. + +<span class="label label-info">Note</span> This memory setup guide is relevant <strong>only for task executors</strong>! +Check [job manager related configuration options](../config.html#jobmanager-heap-size) for the memory setup of job manager. + +## Configure Total Memory + +The *total process memory* of Flink JVM processes consists of memory consumed by Flink application (*total Flink memory*) +and by the JVM to run the process. The *total Flink memory* consumption includes usage of JVM heap, +*managed memory* (managed by Flink) and other direct (or native) memory. + +<center> + <img src="{{ site.baseurl }}/fig/simple_mem_model.svg" width="300px" alt="Simple memory model" usemap="#simple-mem-model"> +</center> +<br /> + +If you run FIink locally (e.g. from your IDE) without creating a cluster, then only a subset of the memory configuration +options are relevant, see also [local execution](mem_detail.html#local-execution) for more details. + +Otherwise, the simplest way to setup memory in Flink is to configure either of the two following options: +* Total Flink memory ([`taskmanager.memory.flink.size`](../config.html#taskmanager-memory-flink-size)) +* Total process memory ([`taskmanager.memory.process.size`](../config.html#taskmanager-memory-process-size)) + +The rest of the memory components will be adjusted automatically, based on default values or additionally configured options. +[Here](mem_detail.html#detailed-memory-model) are more details about the other memory components. + +Configuring *total Flink memory* is better suited for standalone deployments where you want to declare how much memory +is given to Flink itself. The *total Flink memory* splits up into JVM heap, [managed memory size](#managed-memory) +and *direct memory*. + +If you configure *total process memory* you declare how much memory in total should be assigned to the Flink *JVM process*. +For the containerized deployments it corresponds to the size of the requested container, see also +[how to configure memory for containers](mem_tuning.html#configure-memory-for-containers) +([Kubernetes](../deployment/kubernetes.html), [Yarn](../deployment/yarn_setup.html) or [Mesos](../deployment/mesos.html)). + +Another way to setup the memory is to set [task heap](#task-operator-heap-memory) and [managed memory](#managed-memory) +([`taskmanager.memory.task.heap.size`](../config.html#taskmanager-memory-task-heap-size) and [`taskmanager.memory.managed.size`](../config.html#taskmanager-memory-managed-size)). +This more fine-grained approach is described in more detail [here](#configure-heap-and-managed-memory). + +<span class="label label-info">Note</span> One of the three mentioned ways has to be used to configure Flink’s memory (except for local execution), or the Flink startup will fail. +This means that one of the following option subsets, which do not have default values, have to be configured explicitly: +* [`taskmanager.memory.flink.size`](../config.html#taskmanager-memory-flink-size) +* [`taskmanager.memory.process.size`](../config.html#taskmanager-memory-process-size) +* [`taskmanager.memory.task.heap.size`](../config.html#taskmanager-memory-task-heap-size) and [`taskmanager.memory.managed.size`](../config.html#taskmanager-memory-managed-size) + +<span class="label label-info">Note</span> Explicitly configuring both *total process memory* and *total Flink memory* is not recommended. +It may lead to deployment failures due to potential memory configuration conflicts. Additional configuration +of other memory components also requires caution as it can produce further configuration conflicts. + +## Configure Heap and Managed Memory + +As mentioned before in [total memory description](#configure-total-memory), another way to setup memory in Flink is +to specify explicitly both [task heap](#task-operator-heap-memory) and [managed memory](#managed-memory). Review comment: ```suggestion to specify [task heap](#task-operator-heap-memory) and [managed memory](#managed-memory) explicitly. ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
