You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by xt...@apache.org on 2020/06/28 09:55:33 UTC

[flink] 04/06: [hotfix][doc] Minor clean-ups in memory configuration docs.

This is an automated email from the ASF dual-hosted git repository.

xtsong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit df4c7d6b9d5718c8a755bbba36ac58ae5f689b40
Author: Xintong Song <to...@gmail.com>
AuthorDate: Wed Jun 24 13:01:18 2020 +0800

    [hotfix][doc] Minor clean-ups in memory configuration docs.
---
 docs/ops/memory/mem_migration.md        | 7 ++++---
 docs/ops/memory/mem_setup.md            | 2 +-
 docs/ops/memory/mem_setup_jobmanager.md | 1 +
 docs/ops/memory/mem_trouble.md          | 1 +
 4 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/docs/ops/memory/mem_migration.md b/docs/ops/memory/mem_migration.md
index 28dff3c..94c04fe 100644
--- a/docs/ops/memory/mem_migration.md
+++ b/docs/ops/memory/mem_migration.md
@@ -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
 
@@ -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>
@@ -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)
 
@@ -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)
diff --git a/docs/ops/memory/mem_setup.md b/docs/ops/memory/mem_setup.md
index b39cdab..98ca61d 100644
--- a/docs/ops/memory/mem_setup.md
+++ b/docs/ops/memory/mem_setup.md
@@ -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.
diff --git a/docs/ops/memory/mem_setup_jobmanager.md b/docs/ops/memory/mem_setup_jobmanager.md
index 3a5ce11..379e2f7 100644
--- a/docs/ops/memory/mem_setup_jobmanager.md
+++ b/docs/ops/memory/mem_setup_jobmanager.md
@@ -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
diff --git a/docs/ops/memory/mem_trouble.md b/docs/ops/memory/mem_trouble.md
index 64c479b..1f68ccb 100644
--- a/docs/ops/memory/mem_trouble.md
+++ b/docs/ops/memory/mem_trouble.md
@@ -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).