Package org.apache.flink.kubernetes.kubeclient.parameters

Class AbstractKubernetesParameters

java.lang.Object

org.apache.flink.kubernetes.kubeclient.parameters.AbstractKubernetesParameters

All Implemented Interfaces:

KubernetesParameters

Direct Known Subclasses:

KubernetesJobManagerParameters, KubernetesTaskManagerParameters

public abstract class AbstractKubernetesParameters
extends Object
implements KubernetesParameters

Abstract class for the KubernetesParameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.flink.configuration.Configuration	flinkConfig

Constructor Summary

Constructors

Constructor	Description
AbstractKubernetesParameters(org.apache.flink.configuration.Configuration flinkConfig)

Method Summary

Modifier and Type	Method	Description
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.
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.
org.apache.flink.configuration.Configuration	getFlinkConfiguration()
Optional<String>	getFlinkLogDirInPod()	Directory in Pod that saves the log files.
String	getImage()
KubernetesConfigOptions.ImagePullPolicy	getImagePullPolicy()
io.fabric8.kubernetes.api.model.LocalObjectReference[]	getImagePullSecrets()
Optional<String>	getLocalHadoopConfigurationDirectory()	The local directory to locate the custom Hadoop configuration.
String	getNamespace()
Map<String,String>	getSecretNamesToMountPaths()	A collection of secret and path pairs that are mounted to the JobManager and TaskManager container(s).
boolean	hasLog4j()	Whether the log4j.properties is located.
boolean	hasLogback()	Whether the logback.xml is located.
boolean	isHostNetworkEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.kubernetes.kubeclient.parameters.KubernetesParameters

getAnnotations, getEnvironments, getLabels, getNodeSelector, getSelectors, getTolerations

Field Details

flinkConfig

protected final org.apache.flink.configuration.Configuration flinkConfig

Constructor Details

AbstractKubernetesParameters

public AbstractKubernetesParameters(org.apache.flink.configuration.Configuration flinkConfig)

Method Details

getFlinkConfiguration

public org.apache.flink.configuration.Configuration getFlinkConfiguration()

getConfigDirectory

public String getConfigDirectory()

Specified by:

getConfigDirectory in interface KubernetesParameters

getClusterId

public String getClusterId()

Specified by:

getClusterId in interface KubernetesParameters

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface KubernetesParameters

getImage

public String getImage()

Specified by:

getImage in interface KubernetesParameters

getImagePullPolicy

public KubernetesConfigOptions.ImagePullPolicy getImagePullPolicy()

Specified by:

getImagePullPolicy in interface KubernetesParameters

getImagePullSecrets

public io.fabric8.kubernetes.api.model.LocalObjectReference[] getImagePullSecrets()

Specified by:

getImagePullSecrets in interface KubernetesParameters

getCommonLabels

public Map<String,String> getCommonLabels()

Description copied from interface: KubernetesParameters

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.

Specified by:

getCommonLabels in interface KubernetesParameters

getFlinkConfDirInPod

public String getFlinkConfDirInPod()

Description copied from interface: KubernetesParameters

Directory in Pod that stores the config.yaml, log4j.properties, and the logback.xml.

Specified by:

getFlinkConfDirInPod in interface KubernetesParameters

getFlinkLogDirInPod

public Optional<String> getFlinkLogDirInPod()

Description copied from interface: KubernetesParameters

Directory in Pod that saves the log files.

Specified by:

getFlinkLogDirInPod in interface KubernetesParameters

getContainerEntrypoint

public String getContainerEntrypoint()

Description copied from interface: KubernetesParameters

The docker entrypoint that starts processes in the container.

Specified by:

getContainerEntrypoint in interface KubernetesParameters

hasLogback

public boolean hasLogback()

Description copied from interface: KubernetesParameters

Whether the logback.xml is located.

Specified by:

hasLogback in interface KubernetesParameters

hasLog4j

public boolean hasLog4j()

Description copied from interface: KubernetesParameters

Whether the log4j.properties is located.

Specified by:

hasLog4j in interface KubernetesParameters

getExistingHadoopConfigurationConfigMap

public Optional<String> getExistingHadoopConfigurationConfigMap()

Description copied from interface: KubernetesParameters

The existing ConfigMap containing custom Hadoop configuration.

Specified by:

getExistingHadoopConfigurationConfigMap in interface KubernetesParameters

getLocalHadoopConfigurationDirectory

public Optional<String> getLocalHadoopConfigurationDirectory()

Description copied from interface: KubernetesParameters

The local directory to locate the custom Hadoop configuration.

Specified by:

getLocalHadoopConfigurationDirectory in interface KubernetesParameters

getSecretNamesToMountPaths

public Map<String,String> getSecretNamesToMountPaths()

Description copied from interface: KubernetesParameters

A collection of secret and path pairs that are mounted to the JobManager and TaskManager container(s).

Specified by:

getSecretNamesToMountPaths in interface KubernetesParameters

getEnvironmentsFromSecrets

public List<Map<String,String>> getEnvironmentsFromSecrets()

Description copied from interface: KubernetesParameters

A collection of customized environments that are attached to the JobManager and TaskManager container(s).

Specified by:

getEnvironmentsFromSecrets in interface KubernetesParameters

isHostNetworkEnabled

public boolean isHostNetworkEnabled()