[flink] branch master updated: [FLINK-10274][conf][docs] Document env.pid.dir

[chesnay]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 9b5d50c  [FLINK-10274][conf][docs] Document env.pid.dir
9b5d50c is described below

commit 9b5d50c3d9542572d5b33b8bbf1f40594d466ed6
Author: bytesmithing <261807...@qq.com>
AuthorDate: Fri Dec 18 06:11:06 2020 +0800

    [FLINK-10274][conf][docs] Document env.pid.dir
---
 docs/_includes/generated/environment_configuration.html        |  6 ++++++
 .../main/java/org/apache/flink/configuration/CoreOptions.java  | 10 ++++++++++
 2 files changed, 16 insertions(+)

diff --git a/docs/_includes/generated/environment_configuration.html 
b/docs/_includes/generated/environment_configuration.html
index 0fffb88..773dbc4 100644
--- a/docs/_includes/generated/environment_configuration.html
+++ b/docs/_includes/generated/environment_configuration.html
@@ -63,6 +63,12 @@
             <td>The maximum number of old log files to keep.</td>
         </tr>
         <tr>
+            <td><h5>env.pid.dir</h5></td>
+            <td style="word-wrap: break-word;">"/tmp"</td>
+            <td>String</td>
+            <td>Defines the directory where the 
flink-&lt;host&gt;-&lt;process&gt;.pid files are saved.</td>
+        </tr>
+        <tr>
             <td><h5>env.ssh.opts</h5></td>
             <td style="word-wrap: break-word;">(none)</td>
             <td>String</td>
diff --git 
a/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java 
b/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java
index 0ae8e66..4e3d081 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java
@@ -219,6 +219,16 @@ public class CoreOptions {
                        " (Defaults to the log directory under Flink’s home)");
 
        /**
+        * The config parameter defining the directory for Flink PID file.
+        * see: {@code bin/config.sh#KEY_ENV_PID_DIR} and {@code 
bin/config.sh#DEFAULT_ENV_PID_DIR}
+        */
+       public static final ConfigOption<String> FLINK_PID_DIR = ConfigOptions
+               .key("env.pid.dir")
+               .defaultValue("/tmp")
+               .withDescription(
+                       "Defines the directory where the 
flink-<host>-<process>.pid files are saved.");
+
+       /**
         * This options is here only for documentation generation, it is only
         * evaluated in the shell scripts.
         */