KubernetesParameters (Flink : 1.20-SNAPSHOT API)

All Known Implementing Classes:

AbstractKubernetesParameters, KubernetesJobManagerParameters, KubernetesTaskManagerParameters
```
public interface KubernetesParameters
```
A common collection of parameters that is used to construct the JobManager/TaskManager Pods, including the accompanying Kubernetes resources that together represent a Flink application.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAnnotations()` A map of user-specified annotations that are set to the JobManager and TaskManager pods.
`String`	`getClusterId()`
`Map<String,String>`	`getCommonLabels()` A common collection of labels that are attached to every created Kubernetes resources.
`String`	`getConfigDirectory()`
`String`	`getContainerEntrypoint()` The docker entrypoint that starts processes in the container.
`Map<String,String>`	`getEnvironments()` A collection of customized environments that are attached to the JobManager and TaskManager Container(s).
`List<Map<String,String>>`	`getEnvironmentsFromSecrets()` A collection of customized environments that are attached to the JobManager and TaskManager container(s).
`Optional<String>`	`getExistingHadoopConfigurationConfigMap()` The existing ConfigMap containing custom Hadoop configuration.
`String`	`getFlinkConfDirInPod()` Directory in Pod that stores the config.yaml, log4j.properties, and the logback.xml.
`Optional<String>`	`getFlinkLogDirInPod()` Directory in Pod that saves the log files.
`String`	`getImage()`
`KubernetesConfigOptions.ImagePullPolicy`	`getImagePullPolicy()`
`io.fabric8.kubernetes.api.model.LocalObjectReference[]`	`getImagePullSecrets()`
`Map<String,String>`	`getLabels()` A collection of labels that are attached to the JobManager and TaskManager Pod(s).
`Optional<String>`	`getLocalHadoopConfigurationDirectory()` The local directory to locate the custom Hadoop configuration.
`String`	`getNamespace()`
`Map<String,String>`	`getNodeSelector()` A collection of node selector to constrain a pod to only be able to run on particular node(s).
`Map<String,String>`	`getSecretNamesToMountPaths()` A collection of secret and path pairs that are mounted to the JobManager and TaskManager container(s).
`Map<String,String>`	`getSelectors()` A stable subset of labels attached to the resource to select the related resources.
`List<Map<String,String>>`	`getTolerations()` A collection of tolerations that are set to the JobManager and TaskManager Pod(s).
`boolean`	`hasLog4j()` Whether the log4j.properties is located.
`boolean`	`hasLogback()` Whether the logback.xml is located.

- Method Detail
  - getConfigDirectory
```
String getConfigDirectory()
```
  - getClusterId
```
String getClusterId()
```
  - getNamespace
```
String getNamespace()
```
  - getImage
```
String getImage()
```
  - getImagePullPolicy
```
KubernetesConfigOptions.ImagePullPolicy getImagePullPolicy()
```
  - getImagePullSecrets
```
io.fabric8.kubernetes.api.model.LocalObjectReference[] getImagePullSecrets()
```
  - getCommonLabels
```
Map<String,String> getCommonLabels()
```
    A common collection of labels that are attached to every created Kubernetes resources. This can include the Deployment, the Pod(s), the ConfigMap(s), and the Service(s), etc.
  - getLabels
```
Map<String,String> getLabels()
```
    A collection of labels that are attached to the JobManager and TaskManager Pod(s).
  - getSelectors
```
Map<String,String> getSelectors()
```
    A stable subset of labels attached to the resource to select the related resources.
  - getNodeSelector
```
Map<String,String> getNodeSelector()
```
    A collection of node selector to constrain a pod to only be able to run on particular node(s).
  - getEnvironments
```
Map<String,String> getEnvironments()
```
    A collection of customized environments that are attached to the JobManager and TaskManager Container(s).
  - getAnnotations
```
Map<String,String> getAnnotations()
```
    A map of user-specified annotations that are set to the JobManager and TaskManager pods.
  - getTolerations
```
List<Map<String,String>> getTolerations()
```
    A collection of tolerations that are set to the JobManager and TaskManager Pod(s). Kubernetes taints and tolerations work together to ensure that pods are not scheduled onto inappropriate nodes.
  - getFlinkConfDirInPod
```
String getFlinkConfDirInPod()
```
    Directory in Pod that stores the config.yaml, log4j.properties, and the logback.xml.
  - getFlinkLogDirInPod
```
Optional<String> getFlinkLogDirInPod()
```
    Directory in Pod that saves the log files.
  - getContainerEntrypoint
```
String getContainerEntrypoint()
```
    The docker entrypoint that starts processes in the container.
  - hasLogback
```
boolean hasLogback()
```
    Whether the logback.xml is located.
  - hasLog4j
```
boolean hasLog4j()
```
    Whether the log4j.properties is located.
  - getExistingHadoopConfigurationConfigMap
```
Optional<String> getExistingHadoopConfigurationConfigMap()
```
    The existing ConfigMap containing custom Hadoop configuration.
  - getLocalHadoopConfigurationDirectory
```
Optional<String> getLocalHadoopConfigurationDirectory()
```
    The local directory to locate the custom Hadoop configuration.
  - getSecretNamesToMountPaths
```
Map<String,String> getSecretNamesToMountPaths()
```
    A collection of secret and path pairs that are mounted to the JobManager and TaskManager container(s).
  - getEnvironmentsFromSecrets
```
List<Map<String,String>> getEnvironmentsFromSecrets()
```
    A collection of customized environments that are attached to the JobManager and TaskManager container(s).

Back to Flink Website

Interface KubernetesParameters

Method Summary

Method Detail

getConfigDirectory

getClusterId

getNamespace

getImage

getImagePullPolicy

getImagePullSecrets

getCommonLabels

getLabels

getSelectors

getNodeSelector

getEnvironments

getAnnotations

getTolerations

getFlinkConfDirInPod

getFlinkLogDirInPod

getContainerEntrypoint

hasLogback

hasLog4j

getExistingHadoopConfigurationConfigMap

getLocalHadoopConfigurationDirectory

getSecretNamesToMountPaths

getEnvironmentsFromSecrets

Back to Flink Website