public abstract class FlinkYarnClientBase extends AbstractFlinkYarnClient
Modifier and Type | Class and Description |
---|---|
static class |
FlinkYarnClientBase.YarnDeploymentException |
Modifier and Type | Field and Description |
---|---|
static String |
ENV_APP_ID |
static String |
ENV_CLIENT_HOME_DIR |
static String |
ENV_CLIENT_SHIP_FILES |
static String |
ENV_CLIENT_USERNAME |
static String |
ENV_DETACHED |
static String |
ENV_DYNAMIC_PROPERTIES |
static String |
ENV_SLOTS |
static String |
ENV_STREAMING_MODE |
static String |
ENV_TM_COUNT |
static String |
ENV_TM_MEMORY
Constants,
all starting with ENV_ are used as environment variables to pass values from the Client
to the Application Master.
|
static String |
FLINK_JAR_PATH |
Constructor and Description |
---|
FlinkYarnClientBase() |
Modifier and Type | Method and Description |
---|---|
static boolean |
allocateResource(int[] nodeManagers,
int toAllocate) |
AbstractFlinkYarnCluster |
deploy()
Trigger the deployment to YARN.
|
protected AbstractFlinkYarnCluster |
deployInternal()
This method will block until the ApplicationMaster/JobManager have been
deployed on YARN.
|
protected abstract Class<?> |
getApplicationMasterClass() |
String |
getClusterDescription()
Returns a String containing details about the cluster (NodeManagers, available memory, ...)
|
String |
getDynamicPropertiesEncoded() |
Configuration |
getFlinkConfiguration() |
org.apache.hadoop.fs.Path |
getFlinkLoggingConfigurationPath() |
String |
getSessionFilesDir() |
int |
getTaskManagerCount() |
int |
getTaskManagerSlots() |
boolean |
isDetached() |
void |
isReadyForDeployment() |
void |
setConfigurationDirectory(String configurationDirectory) |
void |
setConfigurationFilePath(org.apache.hadoop.fs.Path confPath) |
void |
setDetachedMode(boolean detachedMode) |
void |
setDynamicPropertiesEncoded(String dynamicPropertiesEncoded) |
void |
setFlinkConfiguration(Configuration conf)
Flink configuration
|
void |
setFlinkLoggingConfigurationPath(org.apache.hadoop.fs.Path logConfPath) |
void |
setJobManagerMemory(int memoryMb) |
void |
setLocalJarPath(org.apache.hadoop.fs.Path localJarPath) |
void |
setName(String name)
Set a name for the YARN application
|
void |
setQueue(String queue) |
void |
setShipFiles(List<File> shipFiles)
List of files to transfer to the YARN containers.
|
void |
setTaskManagerCount(int tmCount) |
void |
setTaskManagerMemory(int memoryMb) |
void |
setTaskManagerSlots(int slots) |
public static final String ENV_TM_MEMORY
public static final String ENV_TM_COUNT
public static final String ENV_APP_ID
public static final String FLINK_JAR_PATH
public static final String ENV_CLIENT_HOME_DIR
public static final String ENV_CLIENT_SHIP_FILES
public static final String ENV_CLIENT_USERNAME
public static final String ENV_SLOTS
public static final String ENV_DETACHED
public static final String ENV_STREAMING_MODE
public static final String ENV_DYNAMIC_PROPERTIES
protected abstract Class<?> getApplicationMasterClass()
public void setJobManagerMemory(int memoryMb)
setJobManagerMemory
in class AbstractFlinkYarnClient
memoryMb
- The amount of memory for the JobManager (in MB)public void setTaskManagerMemory(int memoryMb)
setTaskManagerMemory
in class AbstractFlinkYarnClient
memoryMb
- The memory per TaskManager (in MB)public void setFlinkConfiguration(Configuration conf)
AbstractFlinkYarnClient
setFlinkConfiguration
in class AbstractFlinkYarnClient
public Configuration getFlinkConfiguration()
getFlinkConfiguration
in class AbstractFlinkYarnClient
public void setTaskManagerSlots(int slots)
setTaskManagerSlots
in class AbstractFlinkYarnClient
slots
- The number of TaskManager slots per TaskManager.public int getTaskManagerSlots()
getTaskManagerSlots
in class AbstractFlinkYarnClient
public void setQueue(String queue)
setQueue
in class AbstractFlinkYarnClient
queue
- Name of the YARN queuepublic void setLocalJarPath(org.apache.hadoop.fs.Path localJarPath)
setLocalJarPath
in class AbstractFlinkYarnClient
localJarPath
- Local Path to the Flink uberjarpublic void setConfigurationFilePath(org.apache.hadoop.fs.Path confPath)
setConfigurationFilePath
in class AbstractFlinkYarnClient
confPath
- local path to the Flink configuration filepublic void setConfigurationDirectory(String configurationDirectory)
setConfigurationDirectory
in class AbstractFlinkYarnClient
configurationDirectory
- Path to config directory.public void setFlinkLoggingConfigurationPath(org.apache.hadoop.fs.Path logConfPath)
setFlinkLoggingConfigurationPath
in class AbstractFlinkYarnClient
logConfPath
- local path to the flink logging configurationpublic org.apache.hadoop.fs.Path getFlinkLoggingConfigurationPath()
getFlinkLoggingConfigurationPath
in class AbstractFlinkYarnClient
public void setTaskManagerCount(int tmCount)
setTaskManagerCount
in class AbstractFlinkYarnClient
tmCount
- number of TaskManagers to startpublic int getTaskManagerCount()
getTaskManagerCount
in class AbstractFlinkYarnClient
public void setShipFiles(List<File> shipFiles)
AbstractFlinkYarnClient
setShipFiles
in class AbstractFlinkYarnClient
public void setDynamicPropertiesEncoded(String dynamicPropertiesEncoded)
setDynamicPropertiesEncoded
in class AbstractFlinkYarnClient
dynamicPropertiesEncoded
- Encoded String of the dynamic properties (-D configuration values of the Flink configuration)public String getDynamicPropertiesEncoded()
getDynamicPropertiesEncoded
in class AbstractFlinkYarnClient
public void isReadyForDeployment() throws FlinkYarnClientBase.YarnDeploymentException
public static boolean allocateResource(int[] nodeManagers, int toAllocate)
public void setDetachedMode(boolean detachedMode)
setDetachedMode
in class AbstractFlinkYarnClient
detachedMode
- If true, the Flink YARN client is non-blocking. That means it returns
once Flink has been started successfully on YARN.public boolean isDetached()
isDetached
in class AbstractFlinkYarnClient
public AbstractFlinkYarnCluster deploy() throws Exception
AbstractFlinkYarnClient
deploy
in class AbstractFlinkYarnClient
Exception
protected AbstractFlinkYarnCluster deployInternal() throws Exception
Exception
public String getClusterDescription() throws Exception
AbstractFlinkYarnClient
getClusterDescription
in class AbstractFlinkYarnClient
Exception
public String getSessionFilesDir()
getSessionFilesDir
in class AbstractFlinkYarnClient
public void setName(String name)
AbstractFlinkYarnClient
setName
in class AbstractFlinkYarnClient
Copyright © 2014–2017 The Apache Software Foundation. All rights reserved.