org.apache.flink.kubernetes.kubeclient

接口 FlinkKubeClient

所有超级接口:

AutoCloseable

所有已知实现类:

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.

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	FlinkKubeClient.PodCallbackHandler Callback handler for kubernetes pods.

方法概要

限定符和类型	方法和说明
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.

从接口继承的方法 java.lang.AutoCloseable

close

方法详细资料

createJobManagerComponent

void createJobManagerComponent(KubernetesJobManagerSpecification kubernetesJMSpec)

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

参数:

kubernetesJMSpec - jobmanager specification

createTaskManagerPod

CompletableFuture<Void> createTaskManagerPod(KubernetesPod kubernetesPod)

Create task manager pod.

参数:

kubernetesPod - taskmanager pod

返回:

Return the taskmanager pod creation future

stopPod

CompletableFuture<Void> stopPod(String podName)

Stop a specified pod by name.

参数:

podName - pod name

返回:

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.

参数:

clusterId - cluster id

getRestService

Optional<KubernetesService> getRestService(String clusterId)

Get the kubernetes rest service of the given flink clusterId.

参数:

clusterId - cluster id

返回:

Return the optional rest service of the specified cluster id.

getRestEndpoint

Optional<Endpoint> getRestEndpoint(String clusterId)

Get the rest endpoint for access outside cluster.

参数:

clusterId - cluster id

返回:

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.

参数:

labels - labels to filter the pods

返回:

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.

参数:

labels - labels to filter the pods to watch

podCallbackHandler - podCallbackHandler which reacts to pod events

返回:

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