org.apache.flink.mesos.runtime.clusterframework

Class MesosTaskManagerParameters

java.lang.Object

org.apache.flink.mesos.runtime.clusterframework.MesosTaskManagerParameters

public class MesosTaskManagerParameters
extends Object

This class describes the Mesos-specific parameters for launching a TaskManager process.

These parameters are in addition to the common parameters provided by ContaineredTaskManagerParameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MesosTaskManagerParameters.ContainerType The supported containerizers.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.flink.configuration.ConfigOption<String>	MESOS_CONSTRAINTS_HARD_HOSTATTR
static String	MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE_DOCKER Value for MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE setting.
static String	MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE_MESOS Value for MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE setting.
static org.apache.flink.configuration.ConfigOption<Boolean>	MESOS_RM_CONTAINER_DOCKER_FORCE_PULL_IMAGE
static org.apache.flink.configuration.ConfigOption<String>	MESOS_RM_CONTAINER_DOCKER_PARAMETERS
static org.apache.flink.configuration.ConfigOption<String>	MESOS_RM_CONTAINER_IMAGE_NAME
static org.apache.flink.configuration.ConfigOption<String>	MESOS_RM_CONTAINER_TYPE
static org.apache.flink.configuration.ConfigOption<String>	MESOS_RM_CONTAINER_VOLUMES
static org.apache.flink.configuration.ConfigOption<Double>	MESOS_RM_TASKS_CPUS
static org.apache.flink.configuration.ConfigOption<Integer>	MESOS_RM_TASKS_GPUS
static org.apache.flink.configuration.ConfigOption<Integer>	MESOS_RM_TASKS_MEMORY_MB
static org.apache.flink.configuration.ConfigOption<Integer>	MESOS_RM_TASKS_SLOTS
static org.apache.flink.configuration.ConfigOption<String>	MESOS_TM_BOOTSTRAP_CMD
static org.apache.flink.configuration.ConfigOption<String>	MESOS_TM_CMD
static org.apache.flink.configuration.ConfigOption<String>	MESOS_TM_HOSTNAME
static org.apache.flink.configuration.ConfigOption<String>	MESOS_TM_URIS
static Pattern	TASK_ID_PATTERN Pattern replaced in the MESOS_TM_HOSTNAME by the actual task id of the Mesos task.

Constructor Summary

Constructors

Constructor and Description

MesosTaskManagerParameters(double cpus, int gpus, MesosTaskManagerParameters.ContainerType containerType, scala.Option<String> containerImageName, org.apache.flink.runtime.clusterframework.ContaineredTaskManagerParameters containeredParameters, List<org.apache.mesos.Protos.Volume> containerVolumes, List<org.apache.mesos.Protos.Parameter> dockerParameters, boolean dockerForcePullImage, List<com.netflix.fenzo.ConstraintEvaluator> constraints, String command, scala.Option<String> bootstrapCommand, scala.Option<String> taskManagerHostname, List<String> uris)

Method Summary

Modifier and Type	Method and Description
scala.Option<String>	bootstrapCommand() Get the bootstrap command.
static List<org.apache.mesos.Protos.Parameter>	buildDockerParameters(scala.Option<String> dockerParameters)
static List<String>	buildUris(scala.Option<String> uris) Build a list of URIs for providing custom artifacts to Mesos tasks.
static List<org.apache.mesos.Protos.Volume>	buildVolumes(scala.Option<String> containerVolumes) Used to build volume specs for mesos.
String	command() Get the command.
List<com.netflix.fenzo.ConstraintEvaluator>	constraints() Get the placement constraints.
org.apache.flink.runtime.clusterframework.ContaineredTaskManagerParameters	containeredParameters() Get the common containered parameters.
scala.Option<String>	containerImageName() Get the container image name.
MesosTaskManagerParameters.ContainerType	containerType() Get the container type (Mesos or Docker).
List<org.apache.mesos.Protos.Volume>	containerVolumes() Get the container volumes string.
double	cpus() Get the CPU units to use for the TaskManager process.
static MesosTaskManagerParameters	create(org.apache.flink.configuration.Configuration flinkConfig) Create the Mesos TaskManager parameters.
boolean	dockerForcePullImage() Get Docker option to force pull image.
List<org.apache.mesos.Protos.Parameter>	dockerParameters() Get Docker runtime parameters.
scala.Option<String>	getTaskManagerHostname() Get the taskManager hostname.
int	gpus() Get the GPU units to use for the TaskManager Process.
String	toString()
List<String>	uris() Get custom artifact URIs.

Methods inherited from class java.lang.Object

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

Field Detail

TASK_ID_PATTERN

public static final Pattern TASK_ID_PATTERN

Pattern replaced in the MESOS_TM_HOSTNAME by the actual task id of the Mesos task.

MESOS_RM_TASKS_SLOTS

public static final org.apache.flink.configuration.ConfigOption<Integer> MESOS_RM_TASKS_SLOTS

MESOS_RM_TASKS_MEMORY_MB

public static final org.apache.flink.configuration.ConfigOption<Integer> MESOS_RM_TASKS_MEMORY_MB

MESOS_RM_TASKS_CPUS

public static final org.apache.flink.configuration.ConfigOption<Double> MESOS_RM_TASKS_CPUS

MESOS_RM_TASKS_GPUS

public static final org.apache.flink.configuration.ConfigOption<Integer> MESOS_RM_TASKS_GPUS

MESOS_RM_CONTAINER_TYPE

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

MESOS_RM_CONTAINER_IMAGE_NAME

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

MESOS_TM_HOSTNAME

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

MESOS_TM_CMD

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

MESOS_TM_BOOTSTRAP_CMD

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

MESOS_TM_URIS

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

MESOS_RM_CONTAINER_VOLUMES

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

MESOS_RM_CONTAINER_DOCKER_PARAMETERS

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

MESOS_RM_CONTAINER_DOCKER_FORCE_PULL_IMAGE

public static final org.apache.flink.configuration.ConfigOption<Boolean> MESOS_RM_CONTAINER_DOCKER_FORCE_PULL_IMAGE

MESOS_CONSTRAINTS_HARD_HOSTATTR

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

MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE_MESOS

public static final String MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE_MESOS

Value for MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE setting. Tells to use the Mesos containerizer.

See Also:

Constant Field Values

MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE_DOCKER

public static final String MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE_DOCKER

Value for MESOS_RESOURCEMANAGER_TASKS_CONTAINER_TYPE setting. Tells to use the Docker containerizer.

See Also:

Constant Field Values

Constructor Detail

MesosTaskManagerParameters

public MesosTaskManagerParameters(double cpus,
                                  int gpus,
                                  MesosTaskManagerParameters.ContainerType containerType,
                                  scala.Option<String> containerImageName,
                                  org.apache.flink.runtime.clusterframework.ContaineredTaskManagerParameters containeredParameters,
                                  List<org.apache.mesos.Protos.Volume> containerVolumes,
                                  List<org.apache.mesos.Protos.Parameter> dockerParameters,
                                  boolean dockerForcePullImage,
                                  List<com.netflix.fenzo.ConstraintEvaluator> constraints,
                                  String command,
                                  scala.Option<String> bootstrapCommand,
                                  scala.Option<String> taskManagerHostname,
                                  List<String> uris)

Method Detail

cpus

public double cpus()

Get the CPU units to use for the TaskManager process.

gpus

public int gpus()

Get the GPU units to use for the TaskManager Process.

containerType

public MesosTaskManagerParameters.ContainerType containerType()

Get the container type (Mesos or Docker). The default is Mesos.

Mesos provides a facility for a framework to specify which containerizer to use.

containerImageName

public scala.Option<String> containerImageName()

Get the container image name.

containeredParameters

public org.apache.flink.runtime.clusterframework.ContaineredTaskManagerParameters containeredParameters()

Get the common containered parameters.

containerVolumes

public List<org.apache.mesos.Protos.Volume> containerVolumes()

Get the container volumes string.

dockerParameters

public List<org.apache.mesos.Protos.Parameter> dockerParameters()

Get Docker runtime parameters.

dockerForcePullImage

public boolean dockerForcePullImage()

Get Docker option to force pull image.

constraints

public List<com.netflix.fenzo.ConstraintEvaluator> constraints()

Get the placement constraints.

getTaskManagerHostname

public scala.Option<String> getTaskManagerHostname()

Get the taskManager hostname.

command

public String command()

Get the command.

bootstrapCommand

public scala.Option<String> bootstrapCommand()

Get the bootstrap command.

uris

public List<String> uris()

Get custom artifact URIs.

toString

public String toString()

Overrides:

toString in class Object

create

public static MesosTaskManagerParameters create(org.apache.flink.configuration.Configuration flinkConfig)

Create the Mesos TaskManager parameters.

Parameters:

flinkConfig - the TM configuration.

buildVolumes

public static List<org.apache.mesos.Protos.Volume> buildVolumes(scala.Option<String> containerVolumes)

Used to build volume specs for mesos. This allows for mounting additional volumes into a container

Parameters:

containerVolumes - a comma delimited optional string of [host_path:]container_path[:RO|RW] that defines mount points for a container volume. If None or empty string, returns an empty iterator

buildDockerParameters

public static List<org.apache.mesos.Protos.Parameter> buildDockerParameters(scala.Option<String> dockerParameters)

buildUris

public static List<String> buildUris(scala.Option<String> uris)

Build a list of URIs for providing custom artifacts to Mesos tasks.

Parameters:

uris - a comma delimited optional string listing artifact URIs