Kueue Configuration API

usageHalfLifeTime indicates the time after which the current usage will decay by a half If set to 0, usage will be reset to 0 immediately.

usageSamplingInterval indicates how often Kueue updates consumedResources in FairSharingStatus Defaults to 5min.

resourceWeights assigns weights to resources which then are used to calculate LocalQueue's resource usage and order Workloads. Defaults to 1.

QPS controls the number of queries per second allowed for K8S api server connection.

Setting this to a negative value will disable client-side ratelimiting.

Burst allows extra queries to accumulate when a client is exceeding its rate.

MaxCount indicates the maximal number of pending workloads exposed in the cluster queue status. When the value is set to 0, then ClusterQueue visibility updates are disabled. The maximal value is 4000. Defaults to 10.

GroupKindConcurrency is a map from a Kind to the number of concurrent reconciliation allowed for that controller.

When a controller is registered within this manager using the builder utilities, users have to specify the type the controller reconciles in the For(...) call. If the object's kind passed matches one of the keys in this map, the concurrency for that controller is set to the number specified.

The key is expected to be consistent in form with GroupKind.String(), e.g. ReplicaSet in apps group (regardless of version) would be ReplicaSet.apps.

CacheSyncTimeout refers to the time limit set to wait for syncing caches. Defaults to 2 minutes if not set.

HealthProbeBindAddress is the TCP address that the controller should bind to for serving health probes It can be set to "0" or "" to disable serving the health probe.

ReadinessEndpointName, defaults to "readyz"

LivenessEndpointName, defaults to "healthz"

Webhook contains the controllers webhook configuration

LeaderElection is the LeaderElection config to be used when configuring the manager.Manager leader election

Metrics contains the controller metrics configuration

Health contains the controller health configuration

PprofBindAddress is the TCP address that the controller should bind to for serving pprof. It can be set to "" or "0" to disable the pprof serving. Since pprof may contain sensitive information, make sure to protect it before exposing it to public.

Controller contains global configuration options for controllers registered within this manager.

BindAddress is the TCP address that the controller should bind to for serving prometheus metrics. It can be set to "0" to disable the metrics serving.

EnableClusterQueueResources, if true the cluster queue resource usage and quotas metrics will be reported.

Port is the port that the webhook server serves at. It is used to set webhook.Server.Port.

Host is the hostname that the webhook server binds to. It is used to set webhook.Server.Host.

CertDir is the directory that contains the server key and certificate. if not set, webhook server would look up the server key and certificate in {TempDir}/k8s-webhook-server/serving-certs. The server key and certificate must be named tls.key and tls.crt, respectively.

Name is referenced in ClusterQueue.nominalQuota and Workload status. Must be a valid fully qualified name consisting of an optional DNS subdomain prefix followed by a slash and a DNS label, or just a DNS label. DNS labels consist of lower-case alphanumeric characters or hyphens, and must start and end with an alphanumeric character. DNS subdomain prefixes follow the same rules as DNS labels but can contain periods. The total length must not exceed 253 characters.

DeviceClassNames enumerates the DeviceClasses represented by this resource name. Each device class name must be a valid qualified name consisting of an optional DNS subdomain prefix followed by a slash and a DNS label, or just a DNS label. DNS labels consist of lower-case alphanumeric characters or hyphens, and must start and end with an alphanumeric character. DNS subdomain prefixes follow the same rules as DNS labels but can contain periods. The total length of each name must not exceed 253 characters.

enable indicates whether to enable Fair Sharing for all cohorts. Defaults to false.

preemptionStrategies indicates which constraints should a preemption satisfy. The preemption algorithm will only use the next strategy in the list if the incoming workload (preemptor) doesn't fit after using the previous strategies. Possible values are:

• LessThanOrEqualToFinalShare: Only preempt a workload if the share of the preemptor CQ with the preemptor workload is less than or equal to the share of the preemptee CQ without the workload to be preempted. This strategy might favor preemption of smaller workloads in the preemptee CQ, regardless of priority or start time, in an effort to keep the share of the CQ as high as possible.
• LessThanInitialShare: Only preempt a workload if the share of the preemptor CQ with the incoming workload is strictly less than the share of the preemptee CQ. This strategy doesn't depend on the share usage of the workload being preempted. As a result, the strategy chooses to preempt workloads with the lowest priority and newest start time first. The default strategy is ["LessThanOrEqualToFinalShare", "LessThanInitialShare"].

List of framework names to be enabled. Possible options:

• "batch/job"
• "kubeflow.org/mpijob"
• "ray.io/rayjob"
• "ray.io/raycluster"
• "jobset.x-k8s.io/jobset"
• "kubeflow.org/paddlejob"
• "kubeflow.org/pytorchjob"
• "kubeflow.org/tfjob"
• "kubeflow.org/xgboostjob"
• "kubeflow.org/jaxjob"
• "trainer.kubeflow.org/trainjob"
• "workload.codeflare.dev/appwrapper"
• "pod"
• "deployment" (requires enabling pod integration)
• "statefulset" (requires enabling pod integration)
• "leaderworkerset.x-k8s.io/leaderworkerset" (requires enabling pod integration)

List of GroupVersionKinds that are managed for Kueue by external controllers; the expected format is Kind.version.group.com.

PodOptions defines kueue controller behaviour for pod objects Deprecated: This field will be removed on v1beta2, use ManagedJobsNamespaceSelector (https://kueue.sigs.k8s.io/docs/tasks/run/plain_pods/) instead.

labelKeysToCopy is a list of label keys that should be copied from the job into the workload object. It is not required for the job to have all the labels from this list. If a job does not have some label with the given key from this list, the constructed workload object will be created without this label. In the case of creating a workload from a composable job (pod group), if multiple objects have labels with some key from the list, the values of these labels must match or otherwise the workload creation would fail. The labels are copied only during the workload creation and are not updated even if the labels of the underlying job are changed.

Enable controls the use of internal cert management for the webhook, metrics and visibility endpoints. When enabled Kueue is using libraries to generate and self-sign the certificates. When disabled, you need to provide the certificates for the webhooks, metrics and visibility through a third party certificate This secret is mounted to the kueue controller manager pod. The mount path for webhooks is /tmp/k8s-webhook-server/serving-certs, for metrics endpoint the expected path is /etc/kueue/metrics/certs and for visibility endpoint the expected path is /visibility. The keys and certs are named tls.key and tls.crt.

WebhookServiceName is the name of the Service used as part of the DNSName. Defaults to kueue-webhook-service.

WebhookSecretName is the name of the Secret used to store CA and server certs. Defaults to kueue-webhook-server-cert.

GCInterval defines the time interval between two consecutive garbage collection runs. Defaults to 1min. If 0, the garbage collection is disabled.

Origin defines a label value used to track the creator of workloads in the worker clusters. This is used by multikueue in components like its garbage collector to identify remote objects that ware created by this multikueue manager cluster and delete them if their local counterpart no longer exists.

WorkerLostTimeout defines the time a local workload's multikueue admission check state is kept Ready if the connection with its reserving worker cluster is lost.

Defaults to 15 minutes.

DispatcherName defines the dispatcher responsible for selecting worker clusters to handle the workload.

• If specified, the workload will be handled by the named dispatcher.
• If not specified, the workload will be handled by the default ("kueue.x-k8s.io/multikueue-dispatcher-all-at-once") dispatcher.

ExternalFrameworks defines a list of external frameworks that should be supported by the generic MultiKueue adapter. Each entry defines how to handle a specific GroupVersionKind (GVK) for MultiKueue operations.

Name is the GVK of the resource that are managed by external controllers the expected format is kind.version.group.

Workloads configures retention for Workloads. A nil value disables automatic deletion of Workloads.

NamespaceSelector can be used to omit some namespaces from pod reconciliation

PodSelector can be used to choose what pods to reconcile

ClusterQueues is configuration to expose the information about the top pending workloads in the cluster queue.

UpdateIntervalSeconds specifies the time interval for updates to the structure of the top pending workloads in the queues. The minimum value is 1. Defaults to 5.

Timestamp defines the timestamp used for re-queuing a Workload that was evicted due to Pod readiness. The possible values are:

• Eviction (default) indicates from Workload Evicted condition with PodsReadyTimeout reason.
• Creation indicates from Workload .metadata.creationTimestamp.

BackoffLimitCount defines the maximum number of re-queuing retries. Once the number is reached, the workload is deactivated (.spec.activate=false). When it is null, the workloads will repeatedly and endless re-queueing.

Every backoff duration is about "b*2^(n-1)+Rand" where:

• "b" represents the base set by "BackoffBaseSeconds" parameter,
• "n" represents the "workloadStatus.requeueState.count",
• "Rand" represents the random jitter. During this time, the workload is taken as an inadmissible and other workloads will have a chance to be admitted. By default, the consecutive requeue delays are around: (60s, 120s, 240s, ...).

Defaults to null.

BackoffBaseSeconds defines the base for the exponential backoff for re-queuing an evicted workload.

Defaults to 60.

BackoffMaxSeconds defines the maximum backoff time to re-queue an evicted workload.

Defaults to 3600.

Input is the name of the input resource.

Strategy specifies if the input resource should be replaced or retained. Defaults to Retain

Outputs specifies the output resources and quantities per unit of input resource. An empty Outputs combined with a Replace Strategy causes the Input resource to be ignored by Kueue.

ExcludedResourcePrefixes defines which resources should be ignored by Kueue

Transformations defines how to transform PodSpec resources into Workload resource requests. This is intended to be a map with Input as the key (enforced by validation code)

DeviceClassMappings defines mappings from device classes to logical resources for Dynamic Resource Allocation support.

Enable indicates whether to enable wait for pods ready feature. Defaults to false.

Timeout defines the time for an admitted workload to reach the PodsReady=true condition. When the timeout is exceeded, the workload evicted and requeued in the same cluster queue. Defaults to 5min.

BlockAdmission when true, cluster queue will block admissions for all subsequent jobs until the jobs reach the PodsReady=true condition. This setting is only honored when Enable is set to true.

RequeuingStrategy defines the strategy for requeuing a Workload.

RecoveryTimeout defines an opt-in timeout, measured since the last transition to the PodsReady=false condition after a Workload is Admitted and running. Such a transition may happen when a Pod failed and the replacement Pod is awaited to be scheduled. After exceeding the timeout the corresponding job gets suspended again and requeued after the backoff delay. The timeout is enforced only if waitForPodsReady.enable=true. If not set, there is no timeout.

AfterFinished is the duration to wait after a Workload finishes before deleting it. A duration of 0 will delete immediately. A nil value disables automatic deletion. Represented using metav1.Duration (e.g. "10m", "1h30m").

AfterDeactivatedByKueue is the duration to wait after any Kueue-managed Workload (such as a Job, JobSet, or other custom workload types) has been marked as deactivated by Kueue before automatically deleting it. Deletion of deactivated workloads may cascade to objects not created by Kueue, since deleting the parent Workload owner (e.g. JobSet) can trigger garbage-collection of dependent resources. A duration of 0 will delete immediately. A nil value disables automatic deletion. Represented using metav1.Duration (e.g. "10m", "1h30m").