Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity

Class UsersManager

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.UsersManager

All Implemented Interfaces:

AbstractUsersManager

@Private
public class UsersManager
extends java.lang.Object
implements AbstractUsersManager

UsersManager tracks users in the system and its respective data structures.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsersManager.User	User class stores all user related resource usage, application details.

Constructor Summary

Constructors

Constructor	Description
UsersManager(QueueMetrics metrics, AbstractLeafQueue lQueue, RMNodeLabelsManager labelManager, org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator)	UsersManager Constructor.

Method Summary

Modifier and Type	Method	Description
void	activateApplication(java.lang.String user, org.apache.hadoop.yarn.api.records.ApplicationId applicationId)	An application has new outstanding requests.
void	deactivateApplication(java.lang.String user, org.apache.hadoop.yarn.api.records.ApplicationId applicationId)	An application has no more outstanding requests.
org.apache.hadoop.yarn.api.records.Resource	getComputedResourceLimitForActiveUsers(java.lang.String userName, org.apache.hadoop.yarn.api.records.Resource clusterResource, java.lang.String nodePartition, SchedulingMode schedulingMode)	Get computed user-limit for all ACTIVE users in this queue.
org.apache.hadoop.yarn.api.records.Resource	getComputedResourceLimitForAllUsers(java.lang.String userName, org.apache.hadoop.yarn.api.records.Resource clusterResource, java.lang.String nodePartition, SchedulingMode schedulingMode)	Get computed user-limit for all users in this queue.
protected long	getLatestVersionOfUsersState()
int	getNumActiveUsers()	Get number of active users i.e.
int	getNumActiveUsersWithOnlyPendingApps()
float	getUsageRatio(java.lang.String label)
UsersManager.User	getUser(java.lang.String userName)	Get user object for given user name.
UsersManager.User	getUserAndAddIfAbsent(java.lang.String userName)	Get and add user if absent.
float	getUserLimit()	Get configured user-limit.
float	getUserLimitFactor()	Get configured user-limit factor.
java.util.Map<java.lang.String,UsersManager.User>	getUsers()
java.util.ArrayList<UserInfo>	getUsersInfo()
void	removeUser(java.lang.String userName)	Remove user.
void	setUserLimit(float userLimit)	Set configured user-limit.
void	setUserLimitFactor(float userLimitFactor)	Set configured user-limit factor.
void	updateUsageRatio(java.lang.String partition, org.apache.hadoop.yarn.api.records.Resource clusterResource)	Update new usage ratio.
UsersManager.User	updateUserResourceUsage(java.lang.String userName, org.apache.hadoop.yarn.api.records.Resource resource, org.apache.hadoop.yarn.api.records.Resource clusterResource, java.lang.String nodePartition, boolean isAllocate)	During container allocate/release, ensure that all user specific data structures are updated.
void	updateUserWeights()
void	userLimitNeedsRecompute()	Force UsersManager to recompute userlimit.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersManager

public UsersManager(QueueMetrics metrics,
                    AbstractLeafQueue lQueue,
                    RMNodeLabelsManager labelManager,
                    org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator)

UsersManager Constructor.

Parameters:

metrics - Queue Metrics

lQueue - Leaf Queue Object

labelManager - Label Manager instance

resourceCalculator - rc

Method Detail

getUserLimit

public float getUserLimit()

Get configured user-limit.

Returns:

user limit

setUserLimit

public void setUserLimit(float userLimit)

Set configured user-limit.

Parameters:

userLimit - user limit

getUserLimitFactor

public float getUserLimitFactor()

Get configured user-limit factor.

Returns:

user-limit factor

setUserLimitFactor

public void setUserLimitFactor(float userLimitFactor)

Set configured user-limit factor.

Parameters:

userLimitFactor - User Limit factor.

getUsageRatio

@VisibleForTesting
public float getUsageRatio(java.lang.String label)

userLimitNeedsRecompute

public void userLimitNeedsRecompute()

Force UsersManager to recompute userlimit.

getUsers

public java.util.Map<java.lang.String,UsersManager.User> getUsers()

getUser

public UsersManager.User getUser(java.lang.String userName)

Get user object for given user name.

Parameters:

userName - User Name

Returns:

User object

removeUser

public void removeUser(java.lang.String userName)

Remove user.

Parameters:

userName - User Name

getUserAndAddIfAbsent

public UsersManager.User getUserAndAddIfAbsent(java.lang.String userName)

Get and add user if absent.

Parameters:

userName - User Name

Returns:

User object

getUsersInfo

public java.util.ArrayList<UserInfo> getUsersInfo()

Returns:

an ArrayList of UserInfo objects who are active in this queue

getComputedResourceLimitForActiveUsers

public org.apache.hadoop.yarn.api.records.Resource getComputedResourceLimitForActiveUsers(java.lang.String userName,
                                                                                          org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                                                                          java.lang.String nodePartition,
                                                                                          SchedulingMode schedulingMode)

Get computed user-limit for all ACTIVE users in this queue. If cached data is invalidated due to resource change, this method also enforce to recompute user-limit.

Parameters:

userName - Name of user who has submitted one/more app to given queue.

clusterResource - total cluster resource

nodePartition - partition name

schedulingMode - scheduling mode RESPECT_PARTITION_EXCLUSIVITY/IGNORE_PARTITION_EXCLUSIVITY

Returns:

Computed User Limit

getComputedResourceLimitForAllUsers

public org.apache.hadoop.yarn.api.records.Resource getComputedResourceLimitForAllUsers(java.lang.String userName,
                                                                                       org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                                                                       java.lang.String nodePartition,
                                                                                       SchedulingMode schedulingMode)

Get computed user-limit for all users in this queue. If cached data is invalidated due to resource change, this method also enforce to recompute user-limit.

Parameters:

userName - Name of user who has submitted one/more app to given queue.

clusterResource - total cluster resource

nodePartition - partition name

schedulingMode - scheduling mode RESPECT_PARTITION_EXCLUSIVITY/IGNORE_PARTITION_EXCLUSIVITY

Returns:

Computed User Limit

getLatestVersionOfUsersState

protected long getLatestVersionOfUsersState()

updateUsageRatio

public void updateUsageRatio(java.lang.String partition,
                             org.apache.hadoop.yarn.api.records.Resource clusterResource)

Update new usage ratio.

Parameters:

partition - Node partition

clusterResource - cluster resource

activateApplication

public void activateApplication(java.lang.String user,
                                org.apache.hadoop.yarn.api.records.ApplicationId applicationId)

Description copied from interface: AbstractUsersManager

An application has new outstanding requests.

Specified by:

activateApplication in interface AbstractUsersManager

Parameters:

user - application user

applicationId - activated application

deactivateApplication

public void deactivateApplication(java.lang.String user,
                                  org.apache.hadoop.yarn.api.records.ApplicationId applicationId)

Description copied from interface: AbstractUsersManager

An application has no more outstanding requests.

Specified by:

deactivateApplication in interface AbstractUsersManager

Parameters:

user - application user

applicationId - deactivated application

getNumActiveUsers

public int getNumActiveUsers()

Description copied from interface: AbstractUsersManager

Get number of active users i.e. users with applications which have pending resource requests.

Specified by:

getNumActiveUsers in interface AbstractUsersManager

Returns:

number of active users

updateUserResourceUsage

public UsersManager.User updateUserResourceUsage(java.lang.String userName,
                                                 org.apache.hadoop.yarn.api.records.Resource resource,
                                                 org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                                 java.lang.String nodePartition,
                                                 boolean isAllocate)

During container allocate/release, ensure that all user specific data structures are updated.

Parameters:

userName - Name of the user

resource - Resource to increment/decrement

clusterResource - Cluster resource (for testing purposes only)

nodePartition - Node label

isAllocate - Indicate whether to allocate or release resource

Returns:

user

updateUserWeights

public void updateUserWeights()

getNumActiveUsersWithOnlyPendingApps

@VisibleForTesting
public int getNumActiveUsersWithOnlyPendingApps()