org.apache.flink.runtime.entrypoint

Class ClusterEntrypoint

java.lang.Object

org.apache.flink.runtime.entrypoint.ClusterEntrypoint

All Implemented Interfaces:

FatalErrorHandler

Direct Known Subclasses:

JobClusterEntrypoint, SessionClusterEntrypoint

public abstract class ClusterEntrypoint
extends Object
implements FatalErrorHandler

Base class for the Flink cluster entry points.

Specialization of this class can be used for the session mode and the per-job mode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterEntrypoint.ExecutionMode Execution mode of the MiniDispatcher.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.flink.configuration.ConfigOption<String>	EXECUTION_MODE
protected static org.slf4j.Logger	LOG
protected static int	RUNTIME_FAILURE_RETURN_CODE
protected static int	STARTUP_FAILURE_RETURN_CODE
protected static int	SUCCESS_RETURN_CODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClusterEntrypoint(org.apache.flink.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
protected void	configureFileSystems(org.apache.flink.configuration.Configuration configuration)
protected abstract Dispatcher	createDispatcher(org.apache.flink.configuration.Configuration configuration, RpcService rpcService, HighAvailabilityServices highAvailabilityServices, ResourceManagerGateway resourceManagerGateway, BlobServer blobServer, HeartbeatServices heartbeatServices, JobManagerMetricGroup jobManagerMetricGroup, String metricQueryServicePath, ArchivedExecutionGraphStore archivedExecutionGraphStore, FatalErrorHandler fatalErrorHandler, String restAddress, HistoryServerArchivist historyServerArchivist)
protected HighAvailabilityServices	createHaServices(org.apache.flink.configuration.Configuration configuration, Executor executor)
protected HeartbeatServices	createHeartbeatServices(org.apache.flink.configuration.Configuration configuration)
protected MetricRegistryImpl	createMetricRegistry(org.apache.flink.configuration.Configuration configuration)
protected abstract ResourceManager<?>	createResourceManager(org.apache.flink.configuration.Configuration configuration, ResourceID resourceId, RpcService rpcService, HighAvailabilityServices highAvailabilityServices, HeartbeatServices heartbeatServices, MetricRegistry metricRegistry, FatalErrorHandler fatalErrorHandler, ClusterInformation clusterInformation, String webInterfaceUrl)
protected abstract WebMonitorEndpoint<?>	createRestEndpoint(org.apache.flink.configuration.Configuration configuration, LeaderGatewayRetriever<DispatcherGateway> dispatcherGatewayRetriever, LeaderGatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Executor executor, MetricQueryServiceRetriever metricQueryServiceRetriever, LeaderElectionService leaderElectionService)
protected RpcService	createRpcService(org.apache.flink.configuration.Configuration configuration, String bindAddress, String portRange)
protected abstract ArchivedExecutionGraphStore	createSerializableExecutionGraphStore(org.apache.flink.configuration.Configuration configuration, ScheduledExecutor scheduledExecutor)
protected String	getRPCPortRange(org.apache.flink.configuration.Configuration configuration) Returns the port range for the common RpcService.
CompletableFuture<Void>	getTerminationFuture()
protected void	initializeServices(org.apache.flink.configuration.Configuration configuration)
protected SecurityContext	installSecurityContext(org.apache.flink.configuration.Configuration configuration)
protected static org.apache.flink.configuration.Configuration	loadConfiguration(EntrypointClusterConfiguration entrypointClusterConfiguration)
void	onFatalError(Throwable exception) Being called when a fatal error occurs.
protected static EntrypointClusterConfiguration	parseArguments(String[] args)
protected void	runCluster(org.apache.flink.configuration.Configuration configuration)
protected void	shutDownAndTerminate(int returnCode, ApplicationStatus applicationStatus, String diagnostics, boolean cleanupHaData)
protected void	startCluster()
protected void	startClusterComponents(org.apache.flink.configuration.Configuration configuration, RpcService rpcService, HighAvailabilityServices highAvailabilityServices, BlobServer blobServer, HeartbeatServices heartbeatServices, MetricRegistry metricRegistry)
protected CompletableFuture<Void>	stopClusterComponents()
protected CompletableFuture<Void>	stopClusterServices(boolean cleanupHaData)

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTION_MODE

public static final org.apache.flink.configuration.ConfigOption<String> EXECUTION_MODE

LOG

protected static final org.slf4j.Logger LOG

SUCCESS_RETURN_CODE

protected static final int SUCCESS_RETURN_CODE

See Also:

Constant Field Values

STARTUP_FAILURE_RETURN_CODE

protected static final int STARTUP_FAILURE_RETURN_CODE

See Also:

Constant Field Values

RUNTIME_FAILURE_RETURN_CODE

protected static final int RUNTIME_FAILURE_RETURN_CODE

See Also:

Constant Field Values

Constructor Detail

ClusterEntrypoint

protected ClusterEntrypoint(org.apache.flink.configuration.Configuration configuration)

Method Detail

getTerminationFuture

public CompletableFuture<Void> getTerminationFuture()

startCluster

protected void startCluster()

configureFileSystems

protected void configureFileSystems(org.apache.flink.configuration.Configuration configuration)
                             throws Exception

Throws:

Exception

installSecurityContext

protected SecurityContext installSecurityContext(org.apache.flink.configuration.Configuration configuration)
                                          throws Exception

Throws:

Exception

runCluster

protected void runCluster(org.apache.flink.configuration.Configuration configuration)
                   throws Exception

Throws:

Exception

initializeServices

protected void initializeServices(org.apache.flink.configuration.Configuration configuration)
                           throws Exception

Throws:

Exception

startClusterComponents

protected void startClusterComponents(org.apache.flink.configuration.Configuration configuration,
                                      RpcService rpcService,
                                      HighAvailabilityServices highAvailabilityServices,
                                      BlobServer blobServer,
                                      HeartbeatServices heartbeatServices,
                                      MetricRegistry metricRegistry)
                               throws Exception

Throws:

Exception

getRPCPortRange

protected String getRPCPortRange(org.apache.flink.configuration.Configuration configuration)

Returns the port range for the common RpcService.

Parameters:

configuration - to extract the port range from

Returns:

Port range for the common RpcService

createRpcService

protected RpcService createRpcService(org.apache.flink.configuration.Configuration configuration,
                                      String bindAddress,
                                      String portRange)
                               throws Exception

Throws:

Exception

createHaServices

protected HighAvailabilityServices createHaServices(org.apache.flink.configuration.Configuration configuration,
                                                    Executor executor)
                                             throws Exception

Throws:

Exception

createHeartbeatServices

protected HeartbeatServices createHeartbeatServices(org.apache.flink.configuration.Configuration configuration)

createMetricRegistry

protected MetricRegistryImpl createMetricRegistry(org.apache.flink.configuration.Configuration configuration)

stopClusterServices

protected CompletableFuture<Void> stopClusterServices(boolean cleanupHaData)

stopClusterComponents

protected CompletableFuture<Void> stopClusterComponents()

onFatalError

public void onFatalError(Throwable exception)

Description copied from interface: FatalErrorHandler

Being called when a fatal error occurs.

IMPORTANT: This call should never be blocking since it might be called from within the main thread of an RpcEndpoint.

Specified by:

onFatalError in interface FatalErrorHandler

Parameters:

exception - cause

shutDownAndTerminate

protected void shutDownAndTerminate(int returnCode,
                                    ApplicationStatus applicationStatus,
                                    @Nullable
                                    String diagnostics,
                                    boolean cleanupHaData)

createDispatcher

protected abstract Dispatcher createDispatcher(org.apache.flink.configuration.Configuration configuration,
                                               RpcService rpcService,
                                               HighAvailabilityServices highAvailabilityServices,
                                               ResourceManagerGateway resourceManagerGateway,
                                               BlobServer blobServer,
                                               HeartbeatServices heartbeatServices,
                                               JobManagerMetricGroup jobManagerMetricGroup,
                                               @Nullable
                                               String metricQueryServicePath,
                                               ArchivedExecutionGraphStore archivedExecutionGraphStore,
                                               FatalErrorHandler fatalErrorHandler,
                                               @Nullable
                                               String restAddress,
                                               HistoryServerArchivist historyServerArchivist)
                                        throws Exception

Throws:

Exception

createResourceManager

protected abstract ResourceManager<?> createResourceManager(org.apache.flink.configuration.Configuration configuration,
                                                            ResourceID resourceId,
                                                            RpcService rpcService,
                                                            HighAvailabilityServices highAvailabilityServices,
                                                            HeartbeatServices heartbeatServices,
                                                            MetricRegistry metricRegistry,
                                                            FatalErrorHandler fatalErrorHandler,
                                                            ClusterInformation clusterInformation,
                                                            @Nullable
                                                            String webInterfaceUrl)
                                                     throws Exception

Throws:

Exception

createRestEndpoint

protected abstract WebMonitorEndpoint<?> createRestEndpoint(org.apache.flink.configuration.Configuration configuration,
                                                            LeaderGatewayRetriever<DispatcherGateway> dispatcherGatewayRetriever,
                                                            LeaderGatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever,
                                                            TransientBlobService transientBlobService,
                                                            Executor executor,
                                                            MetricQueryServiceRetriever metricQueryServiceRetriever,
                                                            LeaderElectionService leaderElectionService)
                                                     throws Exception

Throws:

Exception

createSerializableExecutionGraphStore

protected abstract ArchivedExecutionGraphStore createSerializableExecutionGraphStore(org.apache.flink.configuration.Configuration configuration,
                                                                                     ScheduledExecutor scheduledExecutor)
                                                                              throws IOException

Throws:

IOException

parseArguments

protected static EntrypointClusterConfiguration parseArguments(String[] args)
                                                        throws FlinkParseException

Throws:

FlinkParseException

loadConfiguration

protected static org.apache.flink.configuration.Configuration loadConfiguration(EntrypointClusterConfiguration entrypointClusterConfiguration)