constants

package
v0.20.18 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// GangIdAnnotation maps to a unique id of the gang the job is part of; jobs with equal value make up a gang.
	// All jobs in a gang are guaranteed to be scheduled onto the same cluster at the same time.
	GangIdAnnotation = "armadaproject.io/gangId"
	// GangCardinalityAnnotation All jobs in a gang must specify the total number of jobs in the gang via this annotation.
	// The cardinality should be expressed as a positive integer, e.g., "3".
	GangCardinalityAnnotation = "armadaproject.io/gangCardinality"
	// The jobs that make up a gang may be constrained to be scheduled across a set of uniform nodes.
	// Specifically, if provided, all gang jobs are scheduled onto nodes for which the value of the provided label is equal.
	// Used to ensure, e.g., that all gang jobs are scheduled onto the same cluster or rack.
	GangNodeUniformityLabelAnnotation = "armadaproject.io/gangNodeUniformityLabel"

	// Environment variables injected into all jobs
	JobIdEnvVar    = internalEnvVarPrefix + "JOB_ID"
	QueueEnvVar    = internalEnvVarPrefix + "QUEUE"
	JobSetIdEnvVar = internalEnvVarPrefix + "JOB_SET_ID"

	// Additional environment variables for gang-scheduled jobs
	GangIdEnvVar                       = internalEnvVarPrefix + "GANG_ID"
	GangCardinalityEnvVar              = internalEnvVarPrefix + "GANG_CARDINALITY"
	GangNodeUniformityLabelNameEnvVar  = internalEnvVarPrefix + "GANG_NODE_UNIFORMITY_LABEL_NAME"
	GangNodeUniformityLabelValueEnvVar = internalEnvVarPrefix + "GANG_NODE_UNIFORMITY_LABEL_VALUE"

	// GangNumJobsScheduledAnnotation is set by the scheduler and indicates how many gang jobs were scheduled.
	// FailFastAnnotation, if set to true, ensures Armada does not re-schedule jobs that fail to start.
	// Instead, the job the pod is part of fails immediately.
	JobPriceBand        = "armadaproject.io/priceBand"
	FailFastAnnotation  = "armadaproject.io/failFast"
	PoolAnnotation      = "armadaproject.io/pool"
	ReservationTaintKey = "armadaproject.io/reservation"
)

Variables

This section is empty.

Functions

func IsSchedulingAnnotation

func IsSchedulingAnnotation(annotation string) bool

func SchedulingAnnotationCount

func SchedulingAnnotationCount() int

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL