kueue

module
v0.11.0-rc.1 Latest Latest
Warning

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

Go to latest
Published: Mar 17, 2025 License: Apache-2.0

README

Kueue

GoReport Widget Latest Release

kueue logo

Kueue is a set of APIs and controller for job queueing. It is a job-level manager that decides when a job should be admitted to start (as in pods can be created) and when it should stop (as in active pods should be deleted).

Read the overview and watch the Kueue-related talks & presentations to learn more.

Features overview

Production Readiness status

Installation

Requires Kubernetes 1.25 or newer.

To install the latest release of Kueue in your cluster, run the following command:

kubectl apply --server-side -f https://github.com/kubernetes-sigs/kueue/releases/download/v0.10.2/manifests.yaml

The controller runs in the kueue-system namespace.

Read the installation guide to learn more.

Usage

A minimal configuration can be set by running the examples:

kubectl apply -f examples/admin/single-clusterqueue-setup.yaml

Then you can run a job with:

kubectl create -f examples/jobs/sample-job.yaml

Learn more about:

Architecture

Learn more about the architecture of Kueue with the following design docs:

Roadmap

High-level overview of the main priorities for 2025:

  • Improve user experience for MultiKueue - multi-cluster Job dispatching, in particular:
    • sequential attempts to try worker clusters #3757
    • log retrieval from worker clusters 3526
  • Improve user experience for Topology Aware Scheduling, in particular:
    • make Topology Aware Scheduling compatible with cohorts and preemption #3761
    • optimize the algorithm to minimize fragmentation #3756
    • better accuracy of scheduling by tighter integration with kube-scheduler #3755
    • reduce friction by defaulting the PodSet annotations #3754
  • Productization of the Kueue dashboard #940
  • Support Hierarchical Cohorts with FairSharing #3759
  • Improved support for AI inference, including:
    • partial preemption of serving workloads #3762
    • LeaderWorkerSet support #3232
  • Progress towards the stable API (v1beta2) #768

Long-term aspirational goals:

  • Integration with workflow frameworks #74
  • Support dynamically-sized Jobs #77
  • Budget support #28
  • Flavor assignment strategies, e.g. minimizing cost vs minimizing borrowing #312
  • Cooperative preemption support for workloads that implement checkpointing #477
  • Delayed preemption for two-stage admission #3758
  • Support Structured Parameters (DRA) in Kueue #2941
  • Graduate the API to v1 #3476

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page and the contributor's guide.

You can reach the maintainers of this project at:

Graphic assets
Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

Directories

Path Synopsis
apis
config/v1beta1
Package v1beta1 contains API Schema definitions for the config v1beta1 API group +kubebuilder:object:generate=true +groupName=config.kueue.x-k8s.io
Package v1beta1 contains API Schema definitions for the config v1beta1 API group +kubebuilder:object:generate=true +groupName=config.kueue.x-k8s.io
kueue/v1alpha1
Package v1alpha1 contains API Schema definitions for the kueue v1alpha1 API group +kubebuilder:object:generate=true +groupName=kueue.x-k8s.io
Package v1alpha1 contains API Schema definitions for the kueue v1alpha1 API group +kubebuilder:object:generate=true +groupName=kueue.x-k8s.io
kueue/v1beta1
Package v1beta1 contains API Schema definitions for the kueue v1beta1 API group +kubebuilder:object:generate=true +groupName=kueue.x-k8s.io
Package v1beta1 contains API Schema definitions for the kueue v1beta1 API group +kubebuilder:object:generate=true +groupName=kueue.x-k8s.io
client-go
clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
clientset/versioned/typed/kueue/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientset/versioned/typed/kueue/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
clientset/versioned/typed/kueue/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientset/versioned/typed/kueue/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
clientset/versioned/typed/visibility/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientset/versioned/typed/visibility/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
cmd
pkg
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳