blob: d63b2418764d6657781f1f36869647245fdc8047 [file] [log] [blame]
<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>kubernetes.cluster-id</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>The custom name for the Flink cluster on Kubernetes. It could be specified by -nm argument. If it's not set, the client will generate a random UUID name</td>
</tr>
<tr>
<td><h5>kubernetes.connection.retry.interval.ms</h5></td>
<td style="word-wrap: break-word;">1000</td>
<td>The retry interval in milliseconds for RM talking to kubernetes.</td>
</tr>
<tr>
<td><h5>kubernetes.connection.retry.times</h5></td>
<td style="word-wrap: break-word;">120</td>
<td>The max retry attempts for RM talking to kubernetes.</td>
</tr>
<tr>
<td><h5>kubernetes.container-start-command-template</h5></td>
<td style="word-wrap: break-word;">"%java% %classpath% %jvmmem% %jvmopts% %logging% %class%"</td>
<td>Template for the kubernetes container start invocation</td>
</tr>
<tr>
<td><h5>kubernetes.container.files</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>Files to be used for Flink containers, will be transferred to flink conf directory and appended to classpath in containers.</td>
</tr>
<tr>
<td><h5>kubernetes.container.image</h5></td>
<td style="word-wrap: break-word;">"flink-k8s:latest"</td>
<td>Container image to use for Flink containers. Individual container types (e.g. jobmanager or taskmanager) can also be configured to use different images if desired, by setting the container type-specific image name.</td>
</tr>
<tr>
<td><h5>kubernetes.container.image.pullPolicy</h5></td>
<td style="word-wrap: break-word;">"IfNotPresent"</td>
<td>Kubernetes image pull policy. Valid values are Always, Never, and IfNotPresent.</td>
</tr>
<tr>
<td><h5>kubernetes.destroy-perjob-cluster.after-job-finished</h5></td>
<td style="word-wrap: break-word;">true</td>
<td>Whether to kill perjob-cluster on kubernetes after job finished.If you want to check logs and view dashboard after job finished, set this to false.</td>
</tr>
<tr>
<td><h5>kubernetes.flink.conf.dir</h5></td>
<td style="word-wrap: break-word;">"/etc/flink/conf"</td>
<td>The conf dir will be mounted in pod.</td>
</tr>
<tr>
<td><h5>kubernetes.jobmanager.container.image</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>Container image to use for the jobmanager.</td>
</tr>
<tr>
<td><h5>kubernetes.jobmanager.container.name</h5></td>
<td style="word-wrap: break-word;">"flink-kubernetes-jobmanager"</td>
<td>Name of the jobmanager container.</td>
</tr>
<tr>
<td><h5>kubernetes.jobmanager.cpu</h5></td>
<td style="word-wrap: break-word;">1.0</td>
<td>The number of cpu used by job manager</td>
</tr>
<tr>
<td><h5>kubernetes.jobmanager.pod.name</h5></td>
<td style="word-wrap: break-word;">"jobmanager"</td>
<td>Name of the jobmanager pod.</td>
</tr>
<tr>
<td><h5>kubernetes.jobmanager.service-account</h5></td>
<td style="word-wrap: break-word;">"default"</td>
<td>Service account that is used by jobmanager within kubernetes cluster. The job manager uses this service account when requesting taskmanager pods from the API server.</td>
</tr>
<tr>
<td><h5>kubernetes.master.url</h5></td>
<td style="word-wrap: break-word;">"localhost:8080"</td>
<td>The kubernetes master url.</td>
</tr>
<tr>
<td><h5>kubernetes.namespace</h5></td>
<td style="word-wrap: break-word;">"default"</td>
<td>The namespace that will be used for running the jobmanager and taskmanager pods.</td>
</tr>
<tr>
<td><h5>kubernetes.program.args</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>Arguments specified for user program.</td>
</tr>
<tr>
<td><h5>kubernetes.program.entrypoint.class</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>Class with the program entry point ("main" method or "getPlan()" method. Only needed if the JAR file does not specify the class in its manifest.</td>
</tr>
<tr>
<td><h5>kubernetes.service.exposed.type</h5></td>
<td style="word-wrap: break-word;">"CLUSTER_IP"</td>
<td>It could be CLUSTER_IP(default)/NODE_PORT/LOAD_BALANCER/EXTERNAL_NAME.</td>
</tr>
<tr>
<td><h5>kubernetes.service.external.address</h5></td>
<td style="word-wrap: break-word;">"localhost"</td>
<td>The exposed address of kubernetes service to submit job and view dashboard.</td>
</tr>
<tr>
<td><h5>kubernetes.taskmanager.count</h5></td>
<td style="word-wrap: break-word;">1</td>
<td>The task manager count for session cluster.</td>
</tr>
<tr>
<td><h5>kubernetes.taskmanager.register-timeout</h5></td>
<td style="word-wrap: break-word;">120</td>
<td>The register timeout for a task manager before released by resource manager. In seconds.In case of a task manager took very long time to be launched.</td>
</tr>
<tr>
<td><h5>kubernetes.workernode.max-failed-attempts</h5></td>
<td style="word-wrap: break-word;">100</td>
<td>The max failed attempts for work node.</td>
</tr>
</tbody>
</table>