Scheduler Plugins

Repository for out-of-tree scheduler plugins based on the scheduler framework.

This repo provides scheduler plugins that are exercised in large companies. These plugins can be vendored as Golang SDK libraries or used out-of-box via the pre-built images or Helm charts. Additionally, this repo incorporates best practices and utilities to compose a high-quality scheduler plugin.

Install

Container images are available in the official scheduler-plugins k8s container registry. There are two images one for the kube-scheduler and one for the controller. See the Compatibility Matrix section for the complete list of images.

docker pull registry.k8s.io/scheduler-plugins/kube-scheduler:$TAG
docker pull registry.k8s.io/scheduler-plugins/controller:$TAG

You can find how to install release image here.

Plugins

The kube-scheduler binary includes the below list of plugins. They can be configured by creating one or more scheduler profiles.

• Capacity Scheduling
• Coscheduling
• Node Resources
• Node Resource Topology
• Preemption Toleration
• Trimaran
• Network-Aware Scheduling

Additionally, the kube-scheduler binary includes the below list of sample plugins. These plugins are not intended for use in production environments.

• Cross Node Preemption
• Pod State
• Quality of Service

Compatibility Matrix

The below compatibility matrix shows the k8s client package (client-go, apimachinery, etc) versions that the scheduler-plugins are compiled with.

The minor version of the scheduler-plugins matches the minor version of the k8s client packages that it is compiled with. For example scheduler-plugins v0.18.x releases are built with k8s v1.18.x dependencies.

The scheduler-plugins patch versions come in two different varieties (single digit or three digits). The single digit patch versions (e.g., v0.18.9) exactly align with the k8s client package versions that the scheduler plugins are built with. The three digit patch versions, which are built on demand, (e.g., v0.18.800) are used to indicated that the k8s client package versions have not changed since the previous release, and that only scheduler plugins code (features or bug fixes) was changed.

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

You can find an instruction how to build and run out-of-tree plugin here .

Code of conduct

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