common

Documentation

Index

• Constants
• Variables
• func ConvertSITimeout(millis int64) time.Duration
• func ConvertSITimeoutWithAdjustment(siApp *si.AddApplicationRequest, defaultTimeout time.Duration) time.Duration
• func ConvertSITimestamp(ts string) time.Time
• func GetBoolEnvVar(key string, defaultVal bool) bool
• func GetConfigurationBool(configs map[string]string, key string, defaultValue bool) bool
• func GetConfigurationInt(configs map[string]string, key string, defaultValue int) int
• func GetConfigurationUint(configs map[string]string, key string, defaultValue uint64) uint64
• func GetNewUUID() string
• func GetNormalizedPartitionName(partitionName string, rmID string) string
• func GetPartitionNameWithoutClusterID(partitionName string) string
• func GetRMIdFromPartitionName(partitionName string) string
• func GetRequiredNodeFromTag(tags map[string]string) string
• func IsAllowPreemptOther(policy *si.PreemptionPolicy) bool
• func IsAllowPreemptSelf(policy *si.PreemptionPolicy) bool
• func IsAppCreationForced(tags map[string]string) bool
• func IsRecoveryQueue(queueName string) bool
• func ParseEndpoint(ep string) (string, string, error)
• func WaitForCondition(interval time.Duration, timeout time.Duration, eval func() bool) error
• func ZeroTimeInUnixNano(t time.Time) *int64
• type NonBlockingGRPCServer
  • func NewNonBlockingGRPCServer() NonBlockingGRPCServer

Constants

const (
	Empty = ""

	Wildcard              = "*"
	Separator             = ","
	Space                 = " "
	AnonymousUser         = "nobody"
	AnonymousGroup        = "nogroup"
	RecoveryQueue         = "@recovery@"
	RecoveryQueueFull     = "root." + RecoveryQueue
	DefaultPlacementQueue = "root.default"
)

const PreemptionDoesNotGuarantee = "Preemption queue guarantees check failed"

const PreemptionDoesNotHelp = "Preemption does not help"

const PreemptionPreconditionsFailed = "Preemption preconditions failed"

const PreemptionShortfall = "Preemption helped but short of resources"

Variables

var (
	// ErrorTimeout returned if waiting for a condition times out
	ErrorTimeout = errors.New("timeout waiting for condition")
)

var InvalidQueueName = errors.New("invalid queue name, max 64 characters consisting of alphanumeric characters and '-', '_', '#', '@', '/', ':' allowed")

InvalidQueueName returned when queue name is invalid

Functions

func ConvertSITimeout

func ConvertSITimeout(millis int64) time.Duration

ConvertSITimeout Convert a SI execution timeout, given in milliseconds into a time.Duration object. This will always return a positive value or zero (0). A negative timeout will be converted into zero (0), which means never timeout. The conversion handles overflows in the conversion by setting it to zero (0) also.

func ConvertSITimeoutWithAdjustment

func ConvertSITimeoutWithAdjustment(siApp *si.AddApplicationRequest, defaultTimeout time.Duration) time.Duration

ConvertSITimeoutWithAdjustment Similar to ConvertSITimeout, but this function also adjusts the timeout if "creationTime" is defined. It's used during Yunikorn restart, in order to properly track how long a placeholder pod should be in "Running" state.

func ConvertSITimestamp

func ConvertSITimestamp(ts string) time.Time

func GetBoolEnvVar

func GetBoolEnvVar(key string, defaultVal bool) bool

func GetConfigurationBool

func GetConfigurationBool(configs map[string]string, key string, defaultValue bool) bool

func GetConfigurationInt

func GetConfigurationInt(configs map[string]string, key string, defaultValue int) int

func GetConfigurationUint

func GetConfigurationUint(configs map[string]string, key string, defaultValue uint64) uint64

func GetNewUUID

func GetNewUUID() string

Generate a new uuid. The chance that we generate a collision is really small. As long as we check the UUID before we communicate it back to the RM we can still replace it without a problem.

func GetNormalizedPartitionName

func GetNormalizedPartitionName(partitionName string, rmID string) string

func GetPartitionNameWithoutClusterID

func GetPartitionNameWithoutClusterID(partitionName string) string

func GetRMIdFromPartitionName

func GetRMIdFromPartitionName(partitionName string) string

func GetRequiredNodeFromTag

func GetRequiredNodeFromTag(tags map[string]string) string

func IsAllowPreemptOther

func IsAllowPreemptOther(policy *si.PreemptionPolicy) bool

func IsAllowPreemptSelf

func IsAllowPreemptSelf(policy *si.PreemptionPolicy) bool

func IsAppCreationForced

func IsAppCreationForced(tags map[string]string) bool

IsAppCreationForced returns true if the application creation is triggered by the shim reporting an existing allocation. In this case, it needs to be accepted regardless of whether it maps to a valid queue.

func IsRecoveryQueue

func IsRecoveryQueue(queueName string) bool

IsRecoveryQueue returns true if the given queue represents the recovery queue

func ParseEndpoint

func ParseEndpoint(ep string) (string, string, error)

func WaitForCondition

func WaitForCondition(interval time.Duration, timeout time.Duration, eval func() bool) error

func ZeroTimeInUnixNano

func ZeroTimeInUnixNano(t time.Time) *int64

ZeroTimeInUnixNano return the unix nano or nil if the time is zero.

Types

type NonBlockingGRPCServer

type NonBlockingGRPCServer interface {
	// Start services at the endpoint
	Start(endpoint string, ss si.SchedulerServer)
	// Waits for the service to stop
	Wait()
	// Stops the service gracefully
	Stop()
	// Stops the service forcefully
	ForceStop()
}

Defines Non blocking GRPC server interfaces

func NewNonBlockingGRPCServer

func NewNonBlockingGRPCServer() NonBlockingGRPCServer