Package org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources

Class TrafficControlBandwidthHandlerImpl

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.TrafficControlBandwidthHandlerImpl

All Implemented Interfaces:

OutboundBandwidthResourceHandler, ResourceHandler

@Private
@Unstable
public class TrafficControlBandwidthHandlerImpl
extends Object
implements OutboundBandwidthResourceHandler

Constructor Summary

Constructors

Constructor	Description
TrafficControlBandwidthHandlerImpl(PrivilegedOperationExecutor privilegedOperationExecutor, CGroupsHandler cGroupsHandler, org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.TrafficController trafficController)

Method Summary

Modifier and Type	Method	Description
List<PrivilegedOperation>	bootstrap(org.apache.hadoop.conf.Configuration configuration)	Bootstrapping 'outbound-bandwidth' resource handler - mounts net_cls controller and bootstraps a traffic control bandwidth shaping hierarchy
Map<org.apache.hadoop.yarn.api.records.ContainerId,Integer>	getBytesSentPerContainer()	Returns total bytes sent per container to be used for metrics tracking purposes.
List<PrivilegedOperation>	postComplete(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Cleanup operations once container is completed - deletes cgroup and removes traffic shaping rule(s).
List<PrivilegedOperation>	preStart(Container container)	Pre-start hook for 'outbound-bandwidth' resource.
List<PrivilegedOperation>	reacquireContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Reacquires state for a container - reads the classid from the cgroup being used for the container being reacquired
List<PrivilegedOperation>	teardown()	Teardown environment for resource subsystem if requested.
String	toString()
List<PrivilegedOperation>	updateContainer(Container container)	Update state for container that was already launched

Methods inherited from class java.lang.Object

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

Constructor Details

TrafficControlBandwidthHandlerImpl

public TrafficControlBandwidthHandlerImpl(PrivilegedOperationExecutor privilegedOperationExecutor,
 CGroupsHandler cGroupsHandler,
 org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.TrafficController trafficController)

Method Details

bootstrap

public List<PrivilegedOperation> bootstrap(org.apache.hadoop.conf.Configuration configuration)
                                    throws ResourceHandlerException

Bootstrapping 'outbound-bandwidth' resource handler - mounts net_cls controller and bootstraps a traffic control bandwidth shaping hierarchy

Specified by:

bootstrap in interface ResourceHandler

Parameters:

configuration - yarn configuration in use

Returns:

(potentially empty) list of privileged operations to execute.

Throws:

ResourceHandlerException

preStart

public List<PrivilegedOperation> preStart(Container container)
                                   throws ResourceHandlerException

Pre-start hook for 'outbound-bandwidth' resource. A cgroup is created and a net_cls classid is generated and written to a cgroup file. A traffic control shaping rule is created in order to limit outbound bandwidth utilization.

Specified by:

preStart in interface ResourceHandler

Parameters:

container - Container being launched

Returns:

privileged operations for some cgroups/tc operations.

Throws:

ResourceHandlerException

reacquireContainer

public List<PrivilegedOperation> reacquireContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                             throws ResourceHandlerException

Reacquires state for a container - reads the classid from the cgroup being used for the container being reacquired

Specified by:

reacquireContainer in interface ResourceHandler

Parameters:

containerId - if of the container being reacquired.

Returns:

(potentially empty) list of privileged operations

Throws:

ResourceHandlerException

updateContainer

public List<PrivilegedOperation> updateContainer(Container container)
                                          throws ResourceHandlerException

Description copied from interface: ResourceHandler

Update state for container that was already launched

Specified by:

updateContainer in interface ResourceHandler

Parameters:

container - the container being updated.

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

getBytesSentPerContainer

public Map<org.apache.hadoop.yarn.api.records.ContainerId,Integer> getBytesSentPerContainer()
                                                                                     throws ResourceHandlerException

Returns total bytes sent per container to be used for metrics tracking purposes.

Returns:

a map of containerId to bytes sent

Throws:

ResourceHandlerException

postComplete

public List<PrivilegedOperation> postComplete(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                       throws ResourceHandlerException

Cleanup operations once container is completed - deletes cgroup and removes traffic shaping rule(s).

Specified by:

postComplete in interface ResourceHandler

Parameters:

containerId - of the container that was completed.

Returns:

null

Throws:

ResourceHandlerException

teardown

public List<PrivilegedOperation> teardown()
                                   throws ResourceHandlerException

Description copied from interface: ResourceHandler

Teardown environment for resource subsystem if requested. This method needs to be used with care since it could impact running containers.

Specified by:

teardown in interface ResourceHandler

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

toString

public String toString()

Overrides:

toString in class Object