org.apache.flink.runtime.minicluster

Class MiniCluster

java.lang.Object

org.apache.flink.runtime.minicluster.MiniCluster

public class MiniCluster
extends Object

Constructor Summary

Constructors

Constructor and Description
MiniCluster() Creates a new mini cluster with the default configuration: One JobManager One TaskManager One task slot in the TaskManager All components share the same RPC subsystem (minimizes communication overhead)
MiniCluster(Configuration config) Deprecated. Use MiniCluster(MiniClusterConfiguration) instead.
MiniCluster(Configuration config, boolean singleRpcService) Deprecated. Use MiniCluster(MiniClusterConfiguration) instead.
MiniCluster(MiniClusterConfiguration config) Creates a new Flink mini cluster based on the given configuration.

Method Summary

Methods

Modifier and Type	Method and Description
protected MetricRegistry	createMetricRegistry(Configuration config) Factory method to create the metric registry for the mini cluster
protected RpcService	createRpcService(Configuration configuration, Time askTimeout, boolean remoteEnabled, String bindAddress) Factory method to instantiate the RPC service.
boolean	isRunning() Checks if the mini cluster was started and is running.
void	runDetached(JobGraph job) This method executes a job in detached mode.
JobExecutionResult	runJobBlocking(JobGraph job) This method runs a job in blocking mode.
void	shutdown() Shuts down the mini cluster, failing all currently executing jobs.
void	start() Starts the mini cluster, based on the configured properties.
protected ResourceManagerRunner[]	startResourceManagers(Configuration configuration, HighAvailabilityServices haServices, HeartbeatServices heartbeatServices, MetricRegistry metricRegistry, int numResourceManagers, RpcService[] resourceManagerRpcServices)
protected TaskManagerRunner[]	startTaskManagers(Configuration configuration, HighAvailabilityServices haServices, MetricRegistry metricRegistry, int numTaskManagers, RpcService[] taskManagerRpcServices)
void	waitUntilTaskManagerRegistrationsComplete()

Methods inherited from class java.lang.Object

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

Constructor Detail

MiniCluster

public MiniCluster()

Creates a new mini cluster with the default configuration:

• One JobManager
• One TaskManager
• One task slot in the TaskManager
• All components share the same RPC subsystem (minimizes communication overhead)

MiniCluster

public MiniCluster(MiniClusterConfiguration config)

Creates a new Flink mini cluster based on the given configuration.

Parameters:

config - The configuration for the mini cluster

MiniCluster

@Deprecated
public MiniCluster(Configuration config)

Deprecated. Use MiniCluster(MiniClusterConfiguration) instead.

Creates a mini cluster based on the given configuration.

See Also:

MiniCluster(MiniClusterConfiguration)

MiniCluster

@Deprecated
public MiniCluster(Configuration config,
                      boolean singleRpcService)

Deprecated. Use MiniCluster(MiniClusterConfiguration) instead.

Creates a mini cluster based on the given configuration, starting one or more RPC services, depending on the given flag.

See Also:

MiniCluster(MiniClusterConfiguration)

Method Detail

isRunning

public boolean isRunning()

Checks if the mini cluster was started and is running.

start

public void start()
           throws Exception

Starts the mini cluster, based on the configured properties.

Throws:

Exception - This method passes on any exception that occurs during the startup of the mini cluster.

shutdown

public void shutdown()
              throws Exception

Shuts down the mini cluster, failing all currently executing jobs. The mini cluster can be started again by calling the start() method again.

This method shuts down all started services and components, even if an exception occurs in the process of shutting down some component.

Throws:

Exception - Thrown, if the shutdown did not complete cleanly.

waitUntilTaskManagerRegistrationsComplete

public void waitUntilTaskManagerRegistrationsComplete()
                                               throws Exception

Throws:

Exception

runDetached

public void runDetached(JobGraph job)
                 throws JobExecutionException

This method executes a job in detached mode. The method returns immediately after the job has been added to the

Parameters:

job - The Flink job to execute

Throws:

JobExecutionException - Thrown if anything went amiss during initial job launch, or if the job terminally failed.

runJobBlocking

public JobExecutionResult runJobBlocking(JobGraph job)
                                  throws JobExecutionException,
                                         InterruptedException

This method runs a job in blocking mode. The method returns only after the job completed successfully, or after it failed terminally.

Parameters:

job - The Flink job to execute

Returns:

The result of the job execution

Throws:

JobExecutionException - Thrown if anything went amiss during initial job launch, or if the job terminally failed.

InterruptedException

createMetricRegistry

protected MetricRegistry createMetricRegistry(Configuration config)

Factory method to create the metric registry for the mini cluster

Parameters:

config - The configuration of the mini cluster

createRpcService

protected RpcService createRpcService(Configuration configuration,
                          Time askTimeout,
                          boolean remoteEnabled,
                          String bindAddress)

Factory method to instantiate the RPC service.

Parameters:

configuration - The configuration of the mini cluster

askTimeout - The default RPC timeout for asynchronous "ask" requests.

remoteEnabled - True, if the RPC service should be reachable from other (remote) RPC services.

bindAddress - The address to bind the RPC service to. Only relevant when "remoteEnabled" is true.

Returns:

The instantiated RPC service

startResourceManagers

protected ResourceManagerRunner[] startResourceManagers(Configuration configuration,
                                            HighAvailabilityServices haServices,
                                            HeartbeatServices heartbeatServices,
                                            MetricRegistry metricRegistry,
                                            int numResourceManagers,
                                            RpcService[] resourceManagerRpcServices)
                                                 throws Exception

Throws:

Exception

startTaskManagers

protected TaskManagerRunner[] startTaskManagers(Configuration configuration,
                                    HighAvailabilityServices haServices,
                                    MetricRegistry metricRegistry,
                                    int numTaskManagers,
                                    RpcService[] taskManagerRpcServices)
                                         throws Exception

Throws:

Exception