org.apache.tez.serviceplugins.api

Class ServicePluginsDescriptor

java.lang.Object

org.apache.tez.serviceplugins.api.ServicePluginsDescriptor

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public class ServicePluginsDescriptor
extends Object

An ServicePluginsDescriptor describes the list of plugins running within the AM for sourcing resources, launching and executing work.

Method Summary

Modifier and Type	Method and Description
static ServicePluginsDescriptor	create(boolean enableUber) Create a service plugin descriptor which may have in-AM execution of tasks enabled.
static ServicePluginsDescriptor	create(boolean enableContainers, boolean enableUber, TaskSchedulerDescriptor[] taskSchedulerDescriptor, ContainerLauncherDescriptor[] containerLauncherDescriptors, TaskCommunicatorDescriptor[] taskCommunicatorDescriptors) Create a service plugin descriptor with the provided plugins.
static ServicePluginsDescriptor	create(boolean enableUber, TaskSchedulerDescriptor[] taskSchedulerDescriptor, ContainerLauncherDescriptor[] containerLauncherDescriptors, TaskCommunicatorDescriptor[] taskCommunicatorDescriptors) Create a service plugin descriptor with the provided plugins.
static ServicePluginsDescriptor	create(TaskSchedulerDescriptor[] taskSchedulerDescriptor, ContainerLauncherDescriptor[] containerLauncherDescriptors, TaskCommunicatorDescriptor[] taskCommunicatorDescriptors) Create a service plugin descriptor with the provided plugins.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ServicePluginsDescriptor create(TaskSchedulerDescriptor[] taskSchedulerDescriptor,
                                              ContainerLauncherDescriptor[] containerLauncherDescriptors,
                                              TaskCommunicatorDescriptor[] taskCommunicatorDescriptors)

Create a service plugin descriptor with the provided plugins. Regular containers will also be enabled when using this method.

Parameters:

taskSchedulerDescriptor - the task scheduler plugin descriptors

containerLauncherDescriptors - the container launcher plugin descriptors

taskCommunicatorDescriptors - the task communicator plugin descriptors

Returns:

a ServicePluginsDescriptor instance

create

public static ServicePluginsDescriptor create(boolean enableUber,
                                              TaskSchedulerDescriptor[] taskSchedulerDescriptor,
                                              ContainerLauncherDescriptor[] containerLauncherDescriptors,
                                              TaskCommunicatorDescriptor[] taskCommunicatorDescriptors)

Create a service plugin descriptor with the provided plugins. Also allows specification of whether in-AM execution is enabled. Container execution is enabled by default. Note on Uber mode: This is NOT fully supported at the moment. Tasks will be launched within the AM process itself, controlled by TezConfiguration.TEZ_AM_INLINE_TASK_EXECUTION_MAX_TASKS. The AM will need to be sized correctly for the tasks. Memory allocation to the running task cannot be controlled yet, and is the full AM heap for each task. TODO: TEZ-2722

Parameters:

enableUber - whether to enable execution in the AM or not

taskSchedulerDescriptor - the task scheduler plugin descriptors

containerLauncherDescriptors - the container launcher plugin descriptors

taskCommunicatorDescriptors - the task communicator plugin descriptors

Returns:

a ServicePluginsDescriptor instance

create

public static ServicePluginsDescriptor create(boolean enableContainers,
                                              boolean enableUber,
                                              TaskSchedulerDescriptor[] taskSchedulerDescriptor,
                                              ContainerLauncherDescriptor[] containerLauncherDescriptors,
                                              TaskCommunicatorDescriptor[] taskCommunicatorDescriptors)

Create a service plugin descriptor with the provided plugins. Also allows specification of whether container execution and in-AM execution will be enabled. Note on Uber mode: This is NOT fully supported at the moment. Tasks will be launched within the AM process itself, controlled by TezConfiguration.TEZ_AM_INLINE_TASK_EXECUTION_MAX_TASKS. The AM will need to be sized correctly for the tasks. Memory allocation to the running task cannot be controlled yet, and is the full AM heap for each task. TODO: TEZ-2722

Parameters:

enableContainers - whether to enable execution in containers

enableUber - whether to enable execution in the AM or not

taskSchedulerDescriptor - the task scheduler plugin descriptors

containerLauncherDescriptors - the container launcher plugin descriptors

taskCommunicatorDescriptors - the task communicator plugin descriptors

Returns:

a ServicePluginsDescriptor instance

create

public static ServicePluginsDescriptor create(boolean enableUber)

Create a service plugin descriptor which may have in-AM execution of tasks enabled. Container execution is enabled by default Note on Uber mode: This is NOT fully supported at the moment. Tasks will be launched within the AM process itself, controlled by TezConfiguration.TEZ_AM_INLINE_TASK_EXECUTION_MAX_TASKS. The AM will need to be sized correctly for the tasks. Memory allocation to the running task cannot be controlled yet, and is the full AM heap for each task. TODO: TEZ-2722

Parameters:

enableUber - whether to enable execution in the AM or not

Returns:

a ServicePluginsDescriptor instance

toString

public String toString()

Overrides:

toString in class Object