org.apache.flink.runtime.clusterframework

Class BootstrapTools

java.lang.Object

org.apache.flink.runtime.clusterframework.BootstrapTools

public class BootstrapTools
extends Object

Tools for starting JobManager and TaskManager processes, including the Actor Systems used to run the JobManager and TaskManager actors.

Method Summary

Modifier and Type	Method and Description
static org.apache.flink.configuration.Configuration	generateTaskManagerConfiguration(org.apache.flink.configuration.Configuration baseConfig, String jobManagerHostname, int jobManagerPort, int numSlots, scala.concurrent.duration.FiniteDuration registrationTimeout) Generate a task manager configuration.
static String	getTaskManagerShellCommand(org.apache.flink.configuration.Configuration flinkConfig, ContaineredTaskManagerParameters tmParams, String configDirectory, String logDirectory, boolean hasLogback, boolean hasLog4j, Class<?> mainClass) Generates the shell command to start a task manager.
static akka.actor.ActorSystem	startActorSystem(org.apache.flink.configuration.Configuration configuration, String listeningAddress, int listeningPort, org.slf4j.Logger logger) Starts an Actor System at a specific port.
static akka.actor.ActorSystem	startActorSystem(org.apache.flink.configuration.Configuration configuration, String listeningAddress, String portRangeDefinition, org.slf4j.Logger logger) Starts an ActorSystem with the given configuration listening at the address/ports.
static WebMonitor	startWebMonitorIfConfigured(org.apache.flink.configuration.Configuration config, akka.actor.ActorSystem actorSystem, akka.actor.ActorRef jobManager, org.slf4j.Logger logger) Starts the web frontend.
static void	substituteDeprecatedConfigKey(org.apache.flink.configuration.Configuration config, String deprecated, String designated) Sets the value of a new config key to the value of a deprecated config key.
static void	substituteDeprecatedConfigPrefix(org.apache.flink.configuration.Configuration config, String deprecatedPrefix, String designatedPrefix) Sets the value of of a new config key to the value of a deprecated config key.
static void	writeConfiguration(org.apache.flink.configuration.Configuration cfg, File file) Writes a Flink YAML config file from a Flink Configuration object.

Methods inherited from class java.lang.Object

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

Method Detail

startActorSystem

public static akka.actor.ActorSystem startActorSystem(org.apache.flink.configuration.Configuration configuration,
                                                      String listeningAddress,
                                                      String portRangeDefinition,
                                                      org.slf4j.Logger logger)
                                               throws Exception

Starts an ActorSystem with the given configuration listening at the address/ports.

Parameters:

configuration - The Flink configuration

listeningAddress - The address to listen at.

portRangeDefinition - The port range to choose a port from.

logger - The logger to output log information.

Returns:

The ActorSystem which has been started

Throws:

Exception

startActorSystem

public static akka.actor.ActorSystem startActorSystem(org.apache.flink.configuration.Configuration configuration,
                                                      String listeningAddress,
                                                      int listeningPort,
                                                      org.slf4j.Logger logger)
                                               throws Exception

Starts an Actor System at a specific port.

Parameters:

configuration - The Flink configuration.

listeningAddress - The address to listen at.

listeningPort - The port to listen at.

logger - the logger to output log information.

Returns:

The ActorSystem which has been started.

Throws:

Exception

startWebMonitorIfConfigured

public static WebMonitor startWebMonitorIfConfigured(org.apache.flink.configuration.Configuration config,
                                                     akka.actor.ActorSystem actorSystem,
                                                     akka.actor.ActorRef jobManager,
                                                     org.slf4j.Logger logger)
                                              throws Exception

Starts the web frontend.

Parameters:

config - The Flink config.

actorSystem - The ActorSystem to start the web frontend in.

logger - Logger for log output

Returns:

WebMonitor instance.

Throws:

Exception

generateTaskManagerConfiguration

public static org.apache.flink.configuration.Configuration generateTaskManagerConfiguration(org.apache.flink.configuration.Configuration baseConfig,
                                                                                            String jobManagerHostname,
                                                                                            int jobManagerPort,
                                                                                            int numSlots,
                                                                                            scala.concurrent.duration.FiniteDuration registrationTimeout)

Generate a task manager configuration.

Parameters:

baseConfig - Config to start from.

jobManagerHostname - Job manager host name.

jobManagerPort - Port of the job manager.

numSlots - Number of slots to configure.

registrationTimeout - Timeout for registration

Returns:

TaskManager configuration

writeConfiguration

public static void writeConfiguration(org.apache.flink.configuration.Configuration cfg,
                                      File file)
                               throws IOException

Writes a Flink YAML config file from a Flink Configuration object.

Parameters:

cfg - The Flink config

file - The File to write to

Throws:

IOException

substituteDeprecatedConfigKey

public static void substituteDeprecatedConfigKey(org.apache.flink.configuration.Configuration config,
                                                 String deprecated,
                                                 String designated)

Sets the value of a new config key to the value of a deprecated config key.

Parameters:

config - Config to write

deprecated - The old config key

designated - The new config key

substituteDeprecatedConfigPrefix

public static void substituteDeprecatedConfigPrefix(org.apache.flink.configuration.Configuration config,
                                                    String deprecatedPrefix,
                                                    String designatedPrefix)

Sets the value of of a new config key to the value of a deprecated config key. Taking into account the changed prefix.

Parameters:

config - Config to write

deprecatedPrefix - Old prefix of key

designatedPrefix - New prefix of key

getTaskManagerShellCommand

public static String getTaskManagerShellCommand(org.apache.flink.configuration.Configuration flinkConfig,
                                                ContaineredTaskManagerParameters tmParams,
                                                String configDirectory,
                                                String logDirectory,
                                                boolean hasLogback,
                                                boolean hasLog4j,
                                                Class<?> mainClass)

Generates the shell command to start a task manager.

Parameters:

flinkConfig - The Flink configuration.

tmParams - Paramaters for the task manager.

configDirectory - The configuration directory for the flink-conf.yaml

logDirectory - The log directory.

hasLogback - Uses logback?

hasLog4j - Uses log4j?

mainClass - The main class to start with.

Returns:

A String containing the task manager startup command.