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/07/21 06:01:17 UTC

[flink] 03/04: [hotfix][doc] Enhance the description of options for External Resources page.

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

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

commit fa6ace3edff9949566f4e2b8206afbd75c65f024
Author: Yangze Guo <ka...@gmail.com>
AuthorDate: Mon Jul 20 18:46:35 2020 +0800

    [hotfix][doc] Enhance the description of options for External Resources page.
---
 docs/ops/external_resources.md    | 5 +++--
 docs/ops/external_resources.zh.md | 5 +++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/docs/ops/external_resources.md b/docs/ops/external_resources.md
index 46948d3..879e435 100644
--- a/docs/ops/external_resources.md
+++ b/docs/ops/external_resources.md
@@ -86,7 +86,8 @@ corresponds to the name listed in the **external resource list**:
 
   - **Driver Factory** (`external-resource.<resource_name>.driver-factory.class`): *optional*. Defines the factory class
   name for the external resource identified by **\<resource_name\>**. If configured, the factory will be used to instantiate
-  *drivers* in the external resource framework.
+  *drivers* in the external resource framework. If not configured, the requested resource will still exist in the `TaskManager`
+  as long as the relevant options are configured. However, the operator will not get any information of the resource from `RuntimeContext` in that case.
 
   - **Driver Parameters** (`external-resource.<resource_name>.param.<param>`): *optional*. The naming pattern of custom
   config options for the external resource specified by **\<resource_name\>**. Only the configurations that follow this pattern
@@ -338,7 +339,7 @@ For standalone mode, multiple TaskManagers might be co-located on the same machi
 the TaskManagers. The default discovery script supports a coordination mode, in which it leverages a coordination file to
 synchronize the allocation state of GPU devices and ensure each GPU device can only be used by one TaskManager process. The relevant arguments are:
 
-  - `--enable-coordination-mode`: Enable the coordination mode.
+  - `--enable-coordination-mode`: Enable the coordination mode. By default the coordination mode is disabled.
 
   - `--coordination-file filePath`: The path of the coordination file used to synchronize the allocation state of GPU resources. The default path is `/var/tmp/flink-gpu-coordination`.
 
diff --git a/docs/ops/external_resources.zh.md b/docs/ops/external_resources.zh.md
index 30c9691..74b9a4c 100644
--- a/docs/ops/external_resources.zh.md
+++ b/docs/ops/external_resources.zh.md
@@ -86,7 +86,8 @@ corresponds to the name listed in the **external resource list**:
 
   - **Driver Factory** (`external-resource.<resource_name>.driver-factory.class`): *optional*. Defines the factory class
   name for the external resource identified by **\<resource_name\>**. If configured, the factory will be used to instantiate
-  *drivers* in the external resource framework.
+  *drivers* in the external resource framework. If not configured, the requested resource will still exist in the `TaskManager`
+  as long as the relevant options are configured. However, the operator will not get any information of the resource from `RuntimeContext` in that case.
 
   - **Driver Parameters** (`external-resource.<resource_name>.param.<param>`): *optional*. The naming pattern of custom
   config options for the external resource specified by **\<resource_name\>**. Only the configurations that follow this pattern
@@ -338,7 +339,7 @@ For standalone mode, multiple TaskManagers might be co-located on the same machi
 the TaskManagers. The default discovery script supports a coordination mode, in which it leverages a coordination file to
 synchronize the allocation state of GPU devices and ensure each GPU device can only be used by one TaskManager process. The relevant arguments are:
 
-  - `--enable-coordination-mode`: Enable the coordination mode.
+  - `--enable-coordination-mode`: Enable the coordination mode. By default the coordination mode is disabled.
 
   - `--coordination-file filePath`: The path of the coordination file used to synchronize the allocation state of GPU resources. The default path is `/var/tmp/flink-gpu-coordination`.