ugm

Documentation

Index

• type GroupTracker
  • func (gt *GroupTracker) GetGroupResourceUsageDAOInfo() *dao.GroupResourceUsageDAOInfo
  • func (gt *GroupTracker) IsQueuePathTrackedCompletely(hierarchy []string) bool
  • func (gt *GroupTracker) IsUnlinkRequired(hierarchy []string) bool
  • func (gt *GroupTracker) UnlinkQT(hierarchy []string) bool
• type LimitConfig
• type Manager
  • func GetUserManager() *Manager
  • func (m *Manager) CanRunApp(queuePath, applicationID string, user security.UserGroup) bool
  • func (m *Manager) ClearConfigLimits()
  • func (m *Manager) ClearGroupTrackers()
  • func (m *Manager) ClearUserTrackers()
  • func (m *Manager) DecreaseTrackedResource(queuePath, applicationID string, usage *resources.Resource, ...) bool
  • func (m *Manager) GetGroupResources(group string) *resources.Resource
  • func (m *Manager) GetGroupTracker(group string) *GroupTracker
  • func (m *Manager) GetGroupsResources() []*GroupTracker
  • func (m *Manager) GetUserResources(user security.UserGroup) *resources.Resource
  • func (m *Manager) GetUserTracker(user string) *UserTracker
  • func (m *Manager) GetUsersResources() []*UserTracker
  • func (m *Manager) Headroom(queuePath, applicationID string, user security.UserGroup) *resources.Resource
  • func (m *Manager) IncreaseTrackedResource(queuePath, applicationID string, usage *resources.Resource, ...) bool
  • func (m *Manager) UpdateConfig(config configs.QueueConfig, queuePath string) error
• type QueueTracker
  • func (qt *QueueTracker) IsQueuePathTrackedCompletely(hierarchy []string) bool
  • func (qt *QueueTracker) IsUnlinkRequired(hierarchy []string) bool
  • func (qt *QueueTracker) UnlinkQT(hierarchy []string) bool
• type Tracker
• type UserTracker
  • func (ut *UserTracker) GetUserResourceUsageDAOInfo() *dao.UserResourceUsageDAOInfo
  • func (ut *UserTracker) IsQueuePathTrackedCompletely(hierarchy []string) bool
  • func (ut *UserTracker) IsUnlinkRequired(hierarchy []string) bool
  • func (ut *UserTracker) UnlinkQT(hierarchy []string) bool

Types

type GroupTracker

type GroupTracker struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*GroupTracker) GetGroupResourceUsageDAOInfo

func (gt *GroupTracker) GetGroupResourceUsageDAOInfo() *dao.GroupResourceUsageDAOInfo

func (*GroupTracker) IsQueuePathTrackedCompletely

func (gt *GroupTracker) IsQueuePathTrackedCompletely(hierarchy []string) bool

func (*GroupTracker) IsUnlinkRequired

func (gt *GroupTracker) IsUnlinkRequired(hierarchy []string) bool

func (*GroupTracker) UnlinkQT

func (gt *GroupTracker) UnlinkQT(hierarchy []string) bool

type LimitConfig

type LimitConfig struct {
	// contains filtered or unexported fields
}

LimitConfig Holds limit settings of wild card user/group

type Manager

type Manager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Manager implements tracker. A User Group Manager to track the usage for both user and groups. Holds object of both user and group trackers

func GetUserManager

func GetUserManager() *Manager

func (*Manager) CanRunApp

func (m *Manager) CanRunApp(queuePath, applicationID string, user security.UserGroup) bool

CanRunApp checks the maxApplications for this specific application that runs as the user and group.

func (*Manager) ClearConfigLimits

func (m *Manager) ClearConfigLimits()

ClearConfigLimits only for tests

func (*Manager) ClearGroupTrackers

func (m *Manager) ClearGroupTrackers()

ClearGroupTrackers only for tests

func (*Manager) ClearUserTrackers

func (m *Manager) ClearUserTrackers()

ClearUserTrackers only for tests

func (*Manager) DecreaseTrackedResource

func (m *Manager) DecreaseTrackedResource(queuePath, applicationID string, usage *resources.Resource, user security.UserGroup, removeApp bool) bool

DecreaseTrackedResource Decrease the resource usage for the given user group and queue path combination. As and when every allocation or asks release happens, corresponding user and group resource usage would be decreased against specific application. When the final asks release happens, removeApp should be set to true and application itself would be removed from the tracker and no more usage would be tracked further for that specific application.

func (*Manager) GetGroupResources

func (m *Manager) GetGroupResources(group string) *resources.Resource

GetGroupResources only for tests

func (*Manager) GetGroupTracker

func (m *Manager) GetGroupTracker(group string) *GroupTracker

GetGroupTracker returns the GroupTracker object if defined for the group and a nil otherwise.

func (*Manager) GetGroupsResources

func (m *Manager) GetGroupsResources() []*GroupTracker

func (*Manager) GetUserResources

func (m *Manager) GetUserResources(user security.UserGroup) *resources.Resource

GetUserResources only for tests

func (*Manager) GetUserTracker

func (m *Manager) GetUserTracker(user string) *UserTracker

GetUserTracker returns the UserTracker object if defined for the user and a nil otherwise.

func (*Manager) GetUsersResources

func (m *Manager) GetUsersResources() []*UserTracker

func (*Manager) Headroom

func (m *Manager) Headroom(queuePath, applicationID string, user security.UserGroup) *resources.Resource

Headroom calculates the headroom for this specific application that runs as the user and group.

func (*Manager) IncreaseTrackedResource

func (m *Manager) IncreaseTrackedResource(queuePath, applicationID string, usage *resources.Resource, user security.UserGroup) bool

IncreaseTrackedResource Increase the resource usage for the given user group and queue path combination. As and when every allocation or asks requests fulfilled on application, corresponding user and group resource usage would be increased against specific application.

func (*Manager) UpdateConfig

func (m *Manager) UpdateConfig(config configs.QueueConfig, queuePath string) error

type QueueTracker

type QueueTracker struct {
	// contains filtered or unexported fields
}

func (*QueueTracker) IsQueuePathTrackedCompletely

func (qt *QueueTracker) IsQueuePathTrackedCompletely(hierarchy []string) bool

IsQueuePathTrackedCompletely Traverse queue path upto the end queue through its linkage to confirm entire queuePath has been tracked completely or not

func (*QueueTracker) IsUnlinkRequired

func (qt *QueueTracker) IsUnlinkRequired(hierarchy []string) bool

IsUnlinkRequired Traverse queue path upto the leaf queue and decide whether linkage needs to be removed or not based on the running applications. If there are any running applications in end leaf queue, we should remove the linkage between the leaf and its parent queue using UnlinkQT method. Otherwise, we should leave as it is.

func (*QueueTracker) UnlinkQT

func (qt *QueueTracker) UnlinkQT(hierarchy []string) bool

UnlinkQT Traverse queue path upto the end queue. If end queue has any more child queue trackers, then goes upto each child queue and removes the linkage with its immediate parent

type Tracker

type Tracker interface {
	GetUserResources(user security.UserGroup) *resources.Resource
	GetGroupResources(group string) *resources.Resource

	GetUsersResources() []*UserTracker
	GetGroupsResources() []*GroupTracker

	IncreaseTrackedResource(queuePath, applicationID string, usage *resources.Resource, user security.UserGroup) bool
	DecreaseTrackedResource(queuePath, applicationID string, usage *resources.Resource, user security.UserGroup, removeApp bool) bool
}

Tracker Defines a set of interfaces to track and retrieve the user group resource usage

type UserTracker

type UserTracker struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*UserTracker) GetUserResourceUsageDAOInfo

func (ut *UserTracker) GetUserResourceUsageDAOInfo() *dao.UserResourceUsageDAOInfo

func (*UserTracker) IsQueuePathTrackedCompletely

func (ut *UserTracker) IsQueuePathTrackedCompletely(hierarchy []string) bool

func (*UserTracker) IsUnlinkRequired

func (ut *UserTracker) IsUnlinkRequired(hierarchy []string) bool

func (*UserTracker) UnlinkQT

func (ut *UserTracker) UnlinkQT(hierarchy []string) bool