Package org.apache.pulsar.functions.runtime.kubernetes

Class KubernetesRuntime

java.lang.Object

org.apache.pulsar.functions.runtime.kubernetes.KubernetesRuntime

All Implemented Interfaces:

Runtime

public class KubernetesRuntime
extends Object
implements Runtime

Kubernetes based runtime for running functions. This runtime provides the usual methods to start/stop/getfunctionstatus interfaces to control the kubernetes job running function. We first create a headless service and then a statefulset for starting function pods Each function instance runs as a pod itself. The reason using statefulset as opposed to a regular deployment is that functions require a unique instance_id for each instance. The service abstraction is used for getting functionstatus.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	VALID_POD_NAME_REGEX

Method Summary

Modifier and Type	Method	Description
static String	createJobName(org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails, String jobName)
void	deleteService()
void	deleteStatefulSet()
static void	doChecks(org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails, String overridenJobName)
CompletableFuture<org.apache.pulsar.functions.proto.InstanceCommunication.MetricsData>	getAndResetMetrics()
Throwable	getDeathException()
protected List<String>	getExecutorCommand()
CompletableFuture<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus>	getFunctionStatus(int instanceId)
CompletableFuture<org.apache.pulsar.functions.proto.InstanceCommunication.MetricsData>	getMetrics(int instanceId)
String	getPrometheusMetrics()
boolean	isAlive()
void	join()
void	reinitialize()
CompletableFuture<Void>	resetMetrics()
void	start()	The core logic that creates a service first followed by statefulset.
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.functions.runtime.Runtime

terminate

Field Details

VALID_POD_NAME_REGEX

public static final Pattern VALID_POD_NAME_REGEX

Method Details

start

public void start()
           throws Exception

The core logic that creates a service first followed by statefulset.

Specified by:

start in interface Runtime

Throws:

Exception

reinitialize

public void reinitialize()

Specified by:

reinitialize in interface Runtime

join

public void join()
          throws Exception

Specified by:

join in interface Runtime

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface Runtime

Throws:

Exception

getDeathException

public Throwable getDeathException()

Specified by:

getDeathException in interface Runtime

getFunctionStatus

public CompletableFuture<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus> getFunctionStatus(int instanceId)

Specified by:

getFunctionStatus in interface Runtime

getAndResetMetrics

public CompletableFuture<org.apache.pulsar.functions.proto.InstanceCommunication.MetricsData> getAndResetMetrics()

Specified by:

getAndResetMetrics in interface Runtime

resetMetrics

public CompletableFuture<Void> resetMetrics()

Specified by:

resetMetrics in interface Runtime

getMetrics

public CompletableFuture<org.apache.pulsar.functions.proto.InstanceCommunication.MetricsData> getMetrics(int instanceId)

Specified by:

getMetrics in interface Runtime

getPrometheusMetrics

public String getPrometheusMetrics()
                            throws IOException

Specified by:

getPrometheusMetrics in interface Runtime

Throws:

IOException

isAlive

public boolean isAlive()

Specified by:

isAlive in interface Runtime

deleteStatefulSet

public void deleteStatefulSet()
                       throws InterruptedException

Throws:

InterruptedException

deleteService

public void deleteService()
                   throws InterruptedException

Throws:

InterruptedException

getExecutorCommand

protected List<String> getExecutorCommand()

createJobName

public static String createJobName(org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails,
 String jobName)

doChecks

public static void doChecks(org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails,
 String overridenJobName)