org.apache.flink.kubernetes.kubeclient

Interface FlinkKubeClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

Fabric8FlinkKubeClient

public interface FlinkKubeClient
extends AutoCloseable

The client to talk with kubernetes. The interfaces will be called both in Client and ResourceManager. To avoid potentially blocking the execution of RpcEndpoint's main thread, these interfaces createTaskManagerPod(KubernetesPod), stopPod(String) should be implemented asynchronously.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FlinkKubeClient.PodCallbackHandler Callback handler for kubernetes pods.

Method Summary

Modifier and Type	Method and Description
void	createJobManagerComponent(KubernetesJobManagerSpecification kubernetesJMSpec) Create the Master components, this can include the Deployment, the ConfigMap(s), and the Service(s).
CompletableFuture<Void>	createTaskManagerPod(KubernetesPod kubernetesPod) Create task manager pod.
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>	getRestService(String clusterId) Get the kubernetes rest service of the given flink clusterId.
void	handleException(Exception e) Log exceptions.
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.
KubernetesWatch	watchPodsAndDoCallback(Map<String,String> labels, FlinkKubeClient.PodCallbackHandler podCallbackHandler) Watch the pods selected by labels and do the FlinkKubeClient.PodCallbackHandler.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

createJobManagerComponent

void createJobManagerComponent(KubernetesJobManagerSpecification kubernetesJMSpec)

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

Parameters:

kubernetesJMSpec - jobmanager specification

createTaskManagerPod

CompletableFuture<Void> createTaskManagerPod(KubernetesPod kubernetesPod)

Create task manager pod.

Parameters:

kubernetesPod - taskmanager pod

Returns:

Return the taskmanager pod creation future

stopPod

CompletableFuture<Void> stopPod(String podName)

Stop a specified pod by name.

Parameters:

podName - pod name

Returns:

Return the pod stop future

stopAndCleanupCluster

void stopAndCleanupCluster(String clusterId)

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

Parameters:

clusterId - cluster id

getRestService

Optional<KubernetesService> getRestService(String clusterId)

Get the kubernetes rest service of the given flink clusterId.

Parameters:

clusterId - cluster id

Returns:

Return the optional rest service of the specified cluster id.

getRestEndpoint

Optional<Endpoint> getRestEndpoint(String clusterId)

Get the rest endpoint for access outside cluster.

Parameters:

clusterId - cluster id

Returns:

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

getPodsWithLabels

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

List the pods with specified labels.

Parameters:

labels - labels to filter the pods

Returns:

pod list

handleException

void handleException(Exception e)

Log exceptions.

watchPodsAndDoCallback

KubernetesWatch watchPodsAndDoCallback(Map<String,String> labels,
                                       FlinkKubeClient.PodCallbackHandler podCallbackHandler)

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

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.