Skip to content

Commit

Permalink
[hotfix][doc] Minor clean-ups in memory configuration docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
xintongsong committed Jun 28, 2020
1 parent ecb73dd commit df4c7d6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
7 changes: 4 additions & 3 deletions docs/ops/memory/mem_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ to make the default memory configuration consistent.
This [spreadsheet](https://docs.google.com/spreadsheets/d/1mJaMkMPfDJJ-w6nMXALYmTc4XxiV30P5U7DzgwLkSoE) can also help
to evaluate and compare the results of the legacy and new memory computations.

## Migrate Task Executor Memory Configuration
## Migrate Task Manager Memory Configuration

### Changes in Configuration Options

Expand All @@ -79,7 +79,7 @@ The following options are completely removed. If they are still used, they will
<tr>
<td><h5>taskmanager.memory.fraction</h5></td>
<td>
Check the description of the new option <a href="../config.html#taskmanager-memory-managed-fraction)">taskmanager.memory.managed.fraction</a>.
Check the description of the new option <a href="../config.html#taskmanager-memory-managed-fraction">taskmanager.memory.managed.fraction</a>.
The new option has different semantics and the value of the deprecated option usually has to be adjusted.
See also <a href="#managed-memory">how to migrate managed memory</a>.
</td>
Expand Down Expand Up @@ -139,7 +139,7 @@ It can change if other memory components have new sizes, e.g. the total memory w
See also [new detailed memory model](mem_setup_tm.html#detailed-memory-model).

The container cut-off configuration options, `containerized.heap-cutoff-ratio` and `containerized.heap-cutoff-min`,
have no effect anymore. See also [how to migrate container cut-off](#container-cut-off-memory).
have no effect anymore for TaskManagers. See also [how to migrate container cut-off](#container-cut-off-memory).

### Total Memory (Previously Heap Memory)

Expand Down Expand Up @@ -231,6 +231,7 @@ The mentioned legacy options have been deprecated. If they are used without spec
they will be directly translated into the following new options:
* JVM Heap ([`jobmanager.memory.heap.size`](../config.html#jobmanager-memory-heap-size)) for [standalone](../deployment/cluster_setup.html) and [Mesos](../deployment/mesos.html) deployments
* Total process memory ([`jobmanager.memory.process.size`](../config.html#jobmanager-memory-process-size)) for containerized deployments ([Kubernetes](../deployment/kubernetes.html) and [Yarn](../deployment/yarn_setup.html))

It is also recommended using these new options instead of the legacy ones as they might be completely removed in the following releases.

Now, if only the *total Flink memory* or *total process memory* is configured, then the [JVM Heap]({% link ops/memory/mem_setup_jobmanager.md %}#configure-jvm-heap)
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/memory/mem_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The simplest way to setup memory in Flink is to configure either of the two foll
{:.table-bordered}
<br/>

<span class="label label-info">Note</span> For local execution, see detailed information for [TaskManager](mem_setup_tm.html#local-execution) and [JobManager]({% link ops/memory/mem_setup_jobmanager.md %}#local-execxution) processes.
<span class="label label-info">Note</span> For local execution, see detailed information for [TaskManager](mem_setup_tm.html#local-execution) and [JobManager]({% link ops/memory/mem_setup_jobmanager.md %}#local-execution) processes.

The rest of the memory components will be adjusted automatically, based on default values or additionally configured options.
See also how to set up other components for [TaskManager](mem_setup_tm.html) and [JobManager]({% link ops/memory/mem_setup_jobmanager.md %}) memory.
Expand Down
1 change: 1 addition & 0 deletions docs/ops/memory/mem_setup_jobmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ the mentioned user code.

<span class="label label-info">Note</span> If you have configured the *JVM Heap* explicitly, it is recommended to set
neither *total process memory* nor *total Flink memory*. Otherwise, it may easily lead to memory configuration conflicts.

The Flink scripts and CLI set the *JVM Heap* size via the JVM parameters *-Xms* and *-Xmx* when they start the JobManager process, see also [JVM parameters](mem_setup.html#jvm-parameters).

### Configure Off-heap Memory
Expand Down
1 change: 1 addition & 0 deletions docs/ops/memory/mem_trouble.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,5 @@ If [RocksDBStateBackend](../state/state_backends.html#the-rocksdbstatebackend) i
you can try to increase the TaskManager's [managed memory](mem_setup.html#managed-memory).

Alternatively, you can increase the [JVM Overhead](mem_setup.html#capped-fractionated-components).

See also [how to configure memory for containers](mem_tuning.html#configure-memory-for-containers).

0 comments on commit df4c7d6

Please sign in to comment.