[FLINK-8475][config][docs] Integrate Environment options This closes #5468.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/39657d92 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/39657d92 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/39657d92 Branch: refs/heads/master Commit: 39657d925653926c5d68b574479e22c3cc3929ef Parents: be2b911 Author: zentol <ches...@apache.org> Authored: Tue Jan 30 14:45:10 2018 +0100 Committer: zentol <ches...@apache.org> Committed: Wed Feb 14 11:56:31 2018 +0100 ---------------------------------------------------------------------- .../generated/environment_configuration.html | 41 ++++++++++++++++++++ docs/ops/config.md | 6 +-- .../apache/flink/configuration/CoreOptions.java | 19 +++++++++ 3 files changed, 61 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/39657d92/docs/_includes/generated/environment_configuration.html ---------------------------------------------------------------------- diff --git a/docs/_includes/generated/environment_configuration.html b/docs/_includes/generated/environment_configuration.html new file mode 100644 index 0000000..d3c062b --- /dev/null +++ b/docs/_includes/generated/environment_configuration.html @@ -0,0 +1,41 @@ +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 20%">Key</th> + <th class="text-left" style="width: 15%">Default</th> + <th class="text-left" style="width: 65%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>env.java.opts</h5></td> + <td>(none)</td> + <td></td> + </tr> + <tr> + <td><h5>env.java.opts.jobmanager</h5></td> + <td>(none)</td> + <td></td> + </tr> + <tr> + <td><h5>env.java.opts.taskmanager</h5></td> + <td>(none)</td> + <td></td> + </tr> + <tr> + <td><h5>env.log.dir</h5></td> + <td>(none)</td> + <td>Defines the directory where the Flink logs are saved. It has to be an absolute path. (Defaults to the log directory under Flinkâs home)</td> + </tr> + <tr> + <td><h5>env.log.max</h5></td> + <td>5</td> + <td>The maximum number of old log files to keep.</td> + </tr> + <tr> + <td><h5>env.ssh.opts</h5></td> + <td>(none)</td> + <td>Additional command line options passed to SSH clients when starting or stopping JobManager, TaskManager, and Zookeeper services (start-cluster.sh, stop-cluster.sh, start-zookeeper-quorum.sh, stop-zookeeper-quorum.sh).</td> + </tr> + </tbody> +</table> http://git-wip-us.apache.org/repos/asf/flink/blob/39657d92/docs/ops/config.md ---------------------------------------------------------------------- diff --git a/docs/ops/config.md b/docs/ops/config.md index 3a59279..022061f 100644 --- a/docs/ops/config.md +++ b/docs/ops/config.md @@ -397,11 +397,7 @@ of the JobManager, because the same ActorSystem is used. Its not possible to use ### Environment -- `env.log.dir`: (Defaults to the `log` directory under Flink's home) Defines the directory where the Flink logs are saved. It has to be an absolute path. - -- `env.log.max`: (Default: `5`) The maximum number of old log files to keep. - -- `env.ssh.opts`: Additional command line options passed to SSH clients when starting or stopping JobManager, TaskManager, and Zookeeper services (start-cluster.sh, stop-cluster.sh, start-zookeeper-quorum.sh, stop-zookeeper-quorum.sh). +{% include generated/environment_configuration.html %} ### Checkpointing http://git-wip-us.apache.org/repos/asf/flink/blob/39657d92/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java ---------------------------------------------------------------------- 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 7f5e8da..729929f 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 @@ -27,6 +27,7 @@ import static org.apache.flink.configuration.ConfigOptions.key; */ @PublicEvolving @ConfigGroups(groups = { + @ConfigGroup(name = "Environment", keyPrefix = "env"), @ConfigGroup(name = "FileSystem", keyPrefix = "fs") }) public class CoreOptions { @@ -100,6 +101,24 @@ public class CoreOptions { .key("env.java.opts.taskmanager") .defaultValue(""); + public static final ConfigOption<String> FLINK_LOG_DIR = ConfigOptions + .key("env.log.dir") + .noDefaultValue() + .withDescription("Defines the directory where the Flink logs are saved. It has to be an absolute path." + + " (Defaults to the log directory under Flinkâs home)"); + + public static final ConfigOption<Integer> FLINK_LOG_MAX = ConfigOptions + .key("env.log.max") + .defaultValue(5) + .withDescription("The maximum number of old log files to keep."); + + public static final ConfigOption<String> FLINK_SSH_OPTIONS = ConfigOptions + .key("env.ssh.opts") + .noDefaultValue() + .withDescription("Additional command line options passed to SSH clients when starting or stopping JobManager," + + " TaskManager, and Zookeeper services (start-cluster.sh, stop-cluster.sh, start-zookeeper-quorum.sh," + + " stop-zookeeper-quorum.sh)."); + // ------------------------------------------------------------------------ // generic io // ------------------------------------------------------------------------
