constants

Documentation

Index

• Constants
• Variables

Constants

const Annotation = "annotation"

const AnnotationAllowPreemption = DomainYuniKorn + "allow-preemption"

AnnotationAllowPreemption set on PriorityClass, opt out of preemption for pods with this priority class

const AnnotationApplicationID = DomainYuniKorn + "app-id"

const AnnotationEnableYuniKorn = DomainYuniKorn + "namespace.enableYuniKorn"

AnnotationEnableYuniKorn sets the scheduler name to YuniKorn for workloads in the namespace even if not set in the admission config. Overrides the regexp behaviour if set, checked before the regexp is evaluated. true: set the scheduler name to YuniKorn false: do not do anything

const AnnotationGenerateAppID = DomainYuniKorn + "namespace.generateAppId"

AnnotationGenerateAppID adds application ID to workloads in the namespace even if not set in the admission config. Overrides the regexp behaviour if set, checked before the regexp is evaluated. true: add an application ID label false: do not add an application ID

const AnnotationIgnoreApplication = DomainYuniKorn + "ignore-application"

AnnotationIgnoreApplication set on Pod prevents by admission controller, prevents YuniKorn from honoring application ID

const AnnotationParentQueue = DomainYuniKorn + "parentqueue"

const AnnotationPlaceholderFlag = DomainYuniKornInternal + "placeholder"

const AnnotationQueueName = DomainYuniKorn + "queue"

const AnnotationSchedulingPolicyParam = DomainYuniKorn + "schedulingPolicyParameters"

const AnnotationTaskGroupName = DomainYuniKorn + "task-group-name"

const AnnotationTaskGroups = DomainYuniKorn + "task-groups"

const AppTagImagePullSecrets = "imagePullSecrets"

const AppTagNamespace = "namespace"

const AppTagNamespaceParentQueue = "namespace.parentqueue"

const ApplicationInsufficientResourcesFailure = "ResourceReservationTimeout"

const ApplicationRejectedFailure = "ApplicationRejected"

const AutoGenAppPrefix = "yunikorn"

Admission Controller pod label update constants

const AutoGenAppSuffix = "autogen"

const CPUQuota = DomainYuniKorn + "namespace.max.cpu"

namespace.max.* (Retaining for backwards compatibility. Need to be removed in next major release)

const CanonicalLabelApplicationID = DomainYuniKorn + "app-id"

const CanonicalLabelQueueName = DomainYuniKorn + "queue"

const ConfigMapName = "yunikorn-configs"

Configuration

const DaemonSetType = "DaemonSet"

OwnerReferences

const DefaultAppNamespace = "default"

const DefaultConfigMapName = "yunikorn-defaults"

const DefaultNodeAttributeHostNameKey = "si.io/hostname"

Cluster

const DefaultNodeAttributeRackNameKey = "si.io/rackname"

const DefaultNodeInstanceTypeNodeLabelKey = "node.kubernetes.io/instance-type"

const DefaultPartition = "default"

const DefaultRackName = "/rack-default"

const DefaultUser = "nobody"

const DefaultUserLabel = DomainYuniKorn + "username"

const DomainYuniKorn = siCommon.DomainYuniKorn

const DomainYuniKornInternal = siCommon.DomainYuniKornInternal

const False = "false"

const GzipSuffix = "gz"

Compression Algorithms for schedulerConfig

const Label = "label"

Kubernetes

const LabelApp = "app"

Application

const LabelApplicationID = "applicationId"

const LabelQueueName = "queue"

const MemQuota = DomainYuniKorn + "namespace.max.memory"

const NamespaceGuaranteed = DomainYuniKorn + "namespace.guaranteed"

NamespaceGuaranteed Namespace Guaranteed

const NamespaceMaxApps = DomainYuniKorn + "namespace.maxApps"

NamespaceMaxApps Namespace Max Apps

const NamespaceQuota = DomainYuniKorn + "namespace.quota"

NamespaceQuota Namespace Quota

const OldAnnotationPlaceholderFlag = DomainYuniKorn + "placeholder"

Deprecated: should remove old placeholder flags in 1.7.0

const OldLabelPlaceholderFlag = "placeholder"

Deprecated: should remove old placeholder flags in 1.7.0

const PlaceholderContainerImage = "registry.k8s.io/pause:3.7"

Gang scheduling

const PlaceholderContainerName = "pause"

const PlaceholderPodRestartPolicy = "Never"

const RootQueue = "root"

const SchedulerName = "yunikorn"

const SchedulingPolicyParamDelimiter = " "

const SchedulingPolicyStyleParam = "gangSchedulingStyle"

const SchedulingPolicyStyleParamDefault = "Soft"

const SchedulingPolicyTimeoutParam = "placeholderTimeoutInSeconds"

const SparkLabelAppID = "spark-app-selector"

Spark

const True = "true"

Common

Variables

var AppIdAnnotationKeys = []string{AnnotationApplicationID}

var AppIdLabelKeys = []string{CanonicalLabelApplicationID, SparkLabelAppID, LabelApplicationID}

The key list which are used to identify the application ID or queue name in pod.

var QueueAnnotationKeys = []string{AnnotationQueueName}

var QueueLabelKeys = []string{CanonicalLabelQueueName, LabelQueueName}

var SchedulingPolicyStyleParamValues = map[string]string{"Hard": "Hard", "Soft": "Soft"}