kueue

README

Kueue

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).

The main design principle for Kueue is to avoid duplicating mature functionality in Kubernetes components and well-established third-party controllers. Autoscaling, pod-to-node scheduling and job lifecycle management are the responsibility of cluster-autoscaler, kube-scheduler and kube-controller-manager, respectively. Advanced admission control can be delegated to controllers such as gatekeeper.

Learn more by reading the design docs:

• bit.ly/kueue-apis (please join the mailing list to get access) discusses the API proposal and a high-level description of how it operates.
• bit.ly/kueue-controller-design presents the detailed design of the controller.

Installation

Requires Kubernetes 1.22 or newer.

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

kubectl apply -k github.com/kubernetes-sigs/kueue/config/default

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 samples:

kubectl apply -f config/samples/single-clusterqueue-setup.yaml

Then you can run a job with:

kubectl create -f config/samples/sample-job.yaml

Learn more about:

• Kueue concepts.
• Common and advanced tasks.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

• Slack
• Mailing List

Code of conduct

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