blob: 84712c412cd828502457f9d865f8f0c85936fa1b [file] [log] [blame]
<table class="configuration 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: 10%">Type</th>
<th class="text-left" style="width: 55%">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><h5>env.hadoop.conf.dir</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Path to hadoop configuration directory. It is required to read HDFS and/or YARN configuration. You can also set it via environment variable.</td>
</tr>
<tr>
<td><h5>env.hbase.conf.dir</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Path to hbase configuration directory. It is required to read HBASE configuration. You can also set it via environment variable.</td>
</tr>
<tr>
<td><h5>env.java.default-opts.all</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>A string of default JVM options to prepend to <code class="highlighter-rouge">env.java.opts.all</code>. This is intended to be set by administrators.</td>
</tr>
<tr>
<td><h5>env.java.default-opts.jobmanager</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>A string of default JVM options to prepend to <code class="highlighter-rouge">env.java.opts.jobmanager</code>. This is intended to be set by administrators.</td>
</tr>
<tr>
<td><h5>env.java.default-opts.taskmanager</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>A string of default JVM options to prepend to <code class="highlighter-rouge">env.java.opts.taskmanager</code>. This is intended to be set by administrators.</td>
</tr>
<tr>
<td><h5>env.java.home</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Location where Java is installed. If not specified, Flink will use your default Java installation.</td>
</tr>
<tr>
<td><h5>env.java.opts.all</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Java options to start the JVM of all Flink processes with.</td>
</tr>
<tr>
<td><h5>env.java.opts.client</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Java options to start the JVM of the Flink Client with.</td>
</tr>
<tr>
<td><h5>env.java.opts.historyserver</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Java options to start the JVM of the HistoryServer with.</td>
</tr>
<tr>
<td><h5>env.java.opts.jobmanager</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Java options to start the JVM of the JobManager with.</td>
</tr>
<tr>
<td><h5>env.java.opts.sql-gateway</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Java options to start the JVM of the Flink SQL Gateway with.</td>
</tr>
<tr>
<td><h5>env.java.opts.taskmanager</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Java options to start the JVM of the TaskManager with.</td>
</tr>
<tr>
<td><h5>env.log.dir</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</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.level</h5></td>
<td style="word-wrap: break-word;">"INFO"</td>
<td>String</td>
<td>Defines the level of the root logger.</td>
</tr>
<tr>
<td><h5>env.log.max</h5></td>
<td style="word-wrap: break-word;">10</td>
<td>Integer</td>
<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>
<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>
<tr>
<td><h5>env.stdout-err.redirect-to-file</h5></td>
<td style="word-wrap: break-word;">false</td>
<td>Boolean</td>
<td>Whether redirect stdout and stderr to files when running foreground. If enabled, logs won't append the console too. Note that redirected files do not support rolling rotate.</td>
</tr>
<tr>
<td><h5>env.yarn.conf.dir</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Path to yarn configuration directory. It is required to run flink on YARN. You can also set it via environment variable.</td>
</tr>
</tbody>
</table>