Package org.apache.flink.kubernetes.kubeclient

Class Fabric8FlinkKubeClient

java.lang.Object

org.apache.flink.kubernetes.kubeclient.Fabric8FlinkKubeClient

All Implemented Interfaces:

AutoCloseable, FlinkKubeClient

public class Fabric8FlinkKubeClient
extends Object
implements FlinkKubeClient

The implementation of FlinkKubeClient.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.kubernetes.kubeclient.FlinkKubeClient

FlinkKubeClient.WatchCallbackHandler<T>

Constructor Summary

Constructors

Constructor	Description
Fabric8FlinkKubeClient(org.apache.flink.configuration.Configuration flinkConfig, io.fabric8.kubernetes.client.NamespacedKubernetesClient client, ScheduledExecutorService executorService)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	checkAndUpdateConfigMap(String configMapName, Function<KubernetesConfigMap,Optional<KubernetesConfigMap>> updateFunction)	Update an existing ConfigMap with the data.
void	close()	Close the Kubernetes client with no exception.
CompletableFuture<Void>	createConfigMap(KubernetesConfigMap configMap)	Create the ConfigMap with specified content.
KubernetesConfigMapSharedWatcher	createConfigMapSharedWatcher(String name)	Create a shared watcher for ConfigMaps with specified name.
void	createJobManagerComponent(KubernetesJobManagerSpecification kubernetesJMSpec)	Create the Master components, this can include the Deployment, the ConfigMap(s), and the Service(s).
KubernetesLeaderElector	createLeaderElector(KubernetesLeaderElectionConfiguration leaderElectionConfiguration, KubernetesLeaderElector.LeaderCallbackHandler leaderCallbackHandler)	Create a leader elector service based on Kubernetes api.
CompletableFuture<Void>	createTaskManagerPod(KubernetesPod kubernetesPod)	Create task manager pod.
CompletableFuture<Void>	deleteConfigMap(String configMapName)	Delete a Kubernetes ConfigMap by name.
Optional<KubernetesConfigMap>	getConfigMap(String name)	Get the ConfigMap with specified name.
List<KubernetesPod>	getPodsWithLabels(Map<String,String> labels)	List the pods with specified labels.
Optional<Endpoint>	getRestEndpoint(String clusterId)	Get the rest endpoint for access outside cluster.
Optional<KubernetesService>	getService(String serviceName)	Get the kubernetes service of the given flink clusterId.
KubernetesPod	loadPodFromTemplateFile(File file)	Load pod from template file.
void	stopAndCleanupCluster(String clusterId)	Stop cluster and clean up all resources, include services, auxiliary services and all running pods.
CompletableFuture<Void>	stopPod(String podName)	Stop a specified pod by name.
CompletableFuture<Void>	updateServiceTargetPort(String serviceName, String portName, int targetPort)	Update the target ports of the given Kubernetes service.
CompletableFuture<KubernetesWatch>	watchPodsAndDoCallback(Map<String,String> labels, FlinkKubeClient.WatchCallbackHandler<KubernetesPod> podCallbackHandler)	Watch the pods selected by labels and do the FlinkKubeClient.WatchCallbackHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

Fabric8FlinkKubeClient

public Fabric8FlinkKubeClient(org.apache.flink.configuration.Configuration flinkConfig,
                              io.fabric8.kubernetes.client.NamespacedKubernetesClient client,
                              ScheduledExecutorService executorService)

Method Detail

createJobManagerComponent

public void createJobManagerComponent(KubernetesJobManagerSpecification kubernetesJMSpec)

Description copied from interface: FlinkKubeClient

Create the Master components, this can include the Deployment, the ConfigMap(s), and the Service(s).

Specified by:

createJobManagerComponent in interface FlinkKubeClient

Parameters:

kubernetesJMSpec - jobmanager specification

createTaskManagerPod

public CompletableFuture<Void> createTaskManagerPod(KubernetesPod kubernetesPod)

Description copied from interface: FlinkKubeClient

Create task manager pod.

Specified by:

createTaskManagerPod in interface FlinkKubeClient

Parameters:

kubernetesPod - taskmanager pod

Returns:

Return the taskmanager pod creation future

stopPod

public CompletableFuture<Void> stopPod(String podName)

Description copied from interface: FlinkKubeClient

Stop a specified pod by name.

Specified by:

stopPod in interface FlinkKubeClient

Parameters:

podName - pod name

Returns:

Return the pod stop future

getRestEndpoint

public Optional<Endpoint> getRestEndpoint(String clusterId)

Description copied from interface: FlinkKubeClient

Get the rest endpoint for access outside cluster.

Specified by:

getRestEndpoint in interface FlinkKubeClient

Parameters:

clusterId - cluster id

Returns:

Return empty if the service does not exist or could not extract the Endpoint from the service.

getPodsWithLabels

public List<KubernetesPod> getPodsWithLabels(Map<String,String> labels)

Description copied from interface: FlinkKubeClient

List the pods with specified labels.

Specified by:

getPodsWithLabels in interface FlinkKubeClient

Parameters:

labels - labels to filter the pods

Returns:

pod list

stopAndCleanupCluster

public void stopAndCleanupCluster(String clusterId)

Description copied from interface: FlinkKubeClient

Stop cluster and clean up all resources, include services, auxiliary services and all running pods.

Specified by:

stopAndCleanupCluster in interface FlinkKubeClient

Parameters:

clusterId - cluster id

getService

public Optional<KubernetesService> getService(String serviceName)

Description copied from interface: FlinkKubeClient

Get the kubernetes service of the given flink clusterId.

Specified by:

getService in interface FlinkKubeClient

Parameters:

serviceName - the name of the service

Returns:

Return the optional kubernetes service of the specified name.

watchPodsAndDoCallback

public CompletableFuture<KubernetesWatch> watchPodsAndDoCallback(Map<String,String> labels,
                                                                 FlinkKubeClient.WatchCallbackHandler<KubernetesPod> podCallbackHandler)

Description copied from interface: FlinkKubeClient

Watch the pods selected by labels and do the FlinkKubeClient.WatchCallbackHandler.

Specified by:

watchPodsAndDoCallback in interface FlinkKubeClient

Parameters:

labels - labels to filter the pods to watch

podCallbackHandler - podCallbackHandler which reacts to pod events

Returns:

Return a watch for pods. It needs to be closed after use.

createLeaderElector

public KubernetesLeaderElector createLeaderElector(KubernetesLeaderElectionConfiguration leaderElectionConfiguration,
                                                   KubernetesLeaderElector.LeaderCallbackHandler leaderCallbackHandler)

Description copied from interface: FlinkKubeClient

Create a leader elector service based on Kubernetes api.

Specified by:

createLeaderElector in interface FlinkKubeClient

Parameters:

leaderElectionConfiguration - election configuration

leaderCallbackHandler - Callback when the current instance is leader or not.

Returns:

Return the created leader elector. It should be started manually via KubernetesLeaderElector#run.

createConfigMap

public CompletableFuture<Void> createConfigMap(KubernetesConfigMap configMap)

Description copied from interface: FlinkKubeClient

Create the ConfigMap with specified content. If the ConfigMap already exists, a KubernetesException will be thrown.

Specified by:

createConfigMap in interface FlinkKubeClient

Parameters:

configMap - ConfigMap to be created.

Returns:

Return the ConfigMap create future. The returned future will be completed exceptionally if the ConfigMap already exists.

getConfigMap

public Optional<KubernetesConfigMap> getConfigMap(String name)

Description copied from interface: FlinkKubeClient

Get the ConfigMap with specified name.

Specified by:

getConfigMap in interface FlinkKubeClient

Parameters:

name - name of the ConfigMap to retrieve.

Returns:

Return the ConfigMap, or empty if the ConfigMap does not exist.

checkAndUpdateConfigMap

public CompletableFuture<Boolean> checkAndUpdateConfigMap(String configMapName,
                                                          Function<KubernetesConfigMap,Optional<KubernetesConfigMap>> updateFunction)

Description copied from interface: FlinkKubeClient

Update an existing ConfigMap with the data. Benefit from resource version and combined with FlinkKubeClient.getConfigMap(String), we could perform a get-check-and-update transactional operation. Since concurrent modification could happen on a same ConfigMap, the update operation may fail. We need to retry internally in the implementation.

Specified by:

checkAndUpdateConfigMap in interface FlinkKubeClient

Parameters:

configMapName - configMapName specifies the name of the ConfigMap which shall be updated.

updateFunction - Function to be applied to the obtained ConfigMap and get a new updated one. If the returned optional is empty, we will not do the update.

Returns:

Return the ConfigMap update future. The boolean result indicates whether the ConfigMap is updated. The returned future will be completed exceptionally if the ConfigMap does not exist. A failure during the update operation will result in the future failing with a PossibleInconsistentStateException indicating that no clear decision can be made on whether the update was successful or not. The PossibleInconsistentStateException not being present indicates that the failure happened before writing the updated ConfigMap to Kubernetes. For the latter case, it can be assumed that the ConfigMap was not updated.

deleteConfigMap

public CompletableFuture<Void> deleteConfigMap(String configMapName)

Description copied from interface: FlinkKubeClient

Delete a Kubernetes ConfigMap by name.

Specified by:

deleteConfigMap in interface FlinkKubeClient

Parameters:

configMapName - ConfigMap name

Returns:

Return the delete future.

createConfigMapSharedWatcher

public KubernetesConfigMapSharedWatcher createConfigMapSharedWatcher(String name)

Description copied from interface: FlinkKubeClient

Create a shared watcher for ConfigMaps with specified name.

Specified by:

createConfigMapSharedWatcher in interface FlinkKubeClient

Parameters:

name - name of the ConfigMap to watch.

Returns:

Return a shared watcher.

close

public void close()

Description copied from interface: FlinkKubeClient

Close the Kubernetes client with no exception.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FlinkKubeClient

loadPodFromTemplateFile

public KubernetesPod loadPodFromTemplateFile(File file)

Description copied from interface: FlinkKubeClient

Load pod from template file.

Specified by:

loadPodFromTemplateFile in interface FlinkKubeClient

Parameters:

file - The pod template file.

Returns:

Return a Kubernetes pod loaded from the template.

updateServiceTargetPort

public CompletableFuture<Void> updateServiceTargetPort(String serviceName,
                                                       String portName,
                                                       int targetPort)

Description copied from interface: FlinkKubeClient

Update the target ports of the given Kubernetes service.

Specified by:

updateServiceTargetPort in interface FlinkKubeClient

Parameters:

serviceName - The name of the service which needs to be updated

portName - The port name which needs to be updated

targetPort - The updated target port

Returns:

Return the update service target port future