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(TaskManagerPodParameter), 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	createConfigMap() Create kubernetes config map, include flink-conf.yaml, log4j.properties.
void	createFlinkMasterDeployment(ClusterSpecification clusterSpec) Create flink master deployment with replication of 1.
CompletableFuture<KubernetesService>	createInternalService(String clusterId) Create kubernetes service for internal use.
CompletableFuture<KubernetesService>	createRestService(String clusterId) Create kubernetes service for rest port.
CompletableFuture<Void>	createTaskManagerPod(TaskManagerPodParameter parameter) Create task manager pod.
Optional<KubernetesService>	getInternalService(String clusterId) Get the kubernetes internal service of the given flink clusterId.
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

createConfigMap

void createConfigMap()
              throws Exception

Create kubernetes config map, include flink-conf.yaml, log4j.properties.

Throws:

Exception

createInternalService

CompletableFuture<KubernetesService> createInternalService(String clusterId)
                                                    throws Exception

Create kubernetes service for internal use. This will be set to jobmanager rpc address. It is the owner of all resources. After deletion, all other resource will be deleted by gc.

Parameters:

clusterId - cluster id

Returns:

A CompletableFuture is returned and could be used to wait for service ready.

Throws:

Exception

createRestService

CompletableFuture<KubernetesService> createRestService(String clusterId)
                                                throws Exception

Create kubernetes service for rest port. This will be used by client to interact with flink cluster.

Parameters:

clusterId - cluster id

Returns:

A CompletableFuture is returned and could be used to wait for service ready.

Throws:

Exception

createFlinkMasterDeployment

void createFlinkMasterDeployment(ClusterSpecification clusterSpec)

Create flink master deployment with replication of 1.

Parameters:

clusterSpec - ClusterSpecification to create the flink master deployment.

createTaskManagerPod

CompletableFuture<Void> createTaskManagerPod(TaskManagerPodParameter parameter)

Create task manager pod.

Parameters:

parameter - TaskManagerPodParameter to create a 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

getInternalService

Optional<KubernetesService> getInternalService(String clusterId)

Get the kubernetes internal service of the given flink clusterId.

Parameters:

clusterId - cluster id

Returns:

Return the optional internal service of the specified 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.