base on Kubernetes-native Job Queueing # Kueue [![GoReport Widget]][GoReport Status] [](https://github.com/kubernetes-sigs/kueue/releases/latest) [GoReport Widget]: https://goreportcard.com/badge/github.com/kubernetes-sigs/kueue [GoReport Status]: https://goreportcard.com/report/github.com/kubernetes-sigs/kueue <img src="https://github.com/kubernetes-sigs/kueue/blob/main/site/static/images/logo.svg" width="100" alt="kueue logo"> Kueue is a set of APIs and controller for [job](https://kueue.sigs.k8s.io/docs/concepts/workload) [queueing](https://kueue.sigs.k8s.io/docs/concepts#queueing). It is a job-level manager that decides when a job should be [admitted](https://kueue.sigs.k8s.io/docs/concepts#admission) to start (as in pods can be created) and when it should stop (as in active pods should be deleted). Read the [overview](https://kueue.sigs.k8s.io/docs/overview/) to learn more. ## Features overview - **Job management:** Support job queueing based on [priorities](https://kueue.sigs.k8s.io/docs/concepts/workload/#priority) with different [strategies](https://kueue.sigs.k8s.io/docs/concepts/cluster_queue/#queueing-strategy): `StrictFIFO` and `BestEffortFIFO`. - **Resource management:** Support resource fair sharing and [preemption](https://kueue.sigs.k8s.io/docs/concepts/cluster_queue/#preemption) with a variety of policies between different tenants. - **Dynamic resource reclaim:** A mechanism to [release](https://kueue.sigs.k8s.io/docs/concepts/workload/#dynamic-reclaim) quota as the pods of a Job complete. - **Resource flavor fungibility:** Quota [borrowing or preemption](https://kueue.sigs.k8s.io/docs/concepts/cluster_queue/#flavorfungibility) in ClusterQueue and Cohort. - **Integrations:** Built-in support for popular jobs, e.g. [BatchJob](https://kueue.sigs.k8s.io/docs/tasks/run/jobs/), [Kubeflow training jobs](https://kueue.sigs.k8s.io/docs/tasks/run/kubeflow/), [RayJob](https://kueue.sigs.k8s.io/docs/tasks/run/rayjobs/), [RayCluster](https://kueue.sigs.k8s.io/docs/tasks/run/rayclusters/), [JobSet](https://kueue.sigs.k8s.io/docs/tasks/run/jobsets/), [plain Pod](https://kueue.sigs.k8s.io/docs/tasks/run/plain_pods/). - **System insight:** Build-in [prometheus metrics](https://kueue.sigs.k8s.io/docs/reference/metrics/) to help monitor the state of the system, as well as Conditions. - **AdmissionChecks:** A mechanism for internal or external components to influence whether a workload can be [admitted](https://kueue.sigs.k8s.io/docs/concepts/admission_check/). - **Advanced autoscaling support:** Integration with cluster-autoscaler's [provisioningRequest](https://kueue.sigs.k8s.io/docs/admission-check-controllers/provisioning/#job-using-a-provisioningrequest) via admissionChecks. - **All-or-nothing with ready Pods:** A timeout-based implementation of [All-or-nothing scheduling](https://kueue.sigs.k8s.io/docs/tasks/manage/setup_wait_for_pods_ready/). - **Partial admission:** Allows jobs to run with a [smaller parallelism](https://kueue.sigs.k8s.io/docs/tasks/run/jobs/#partial-admission), based on available quota, if the application supports it. ## Production Readiness status - ✔️ API version: v1beta1, respecting [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) - ✔️ Up-to-date [documentation](https://kueue.sigs.k8s.io/docs). - ✔️ Test Coverage: - ✔️ Unit Test [testgrid](https://testgrid.k8s.io/sig-scheduling#periodic-kueue-test-unit-main). - ✔️ Integration Test [testgrid](https://testgrid.k8s.io/sig-scheduling#periodic-kueue-test-integration-main) - ✔️ E2E Tests for Kubernetes [1.28](https://testgrid.k8s.io/sig-scheduling#periodic-kueue-test-e2e-main-1-28), [1.29](https://testgrid.k8s.io/sig-scheduling#periodic-kueue-test-e2e-main-1-29), [1.30](https://testgrid.k8s.io/sig-scheduling#periodic-kueue-test-e2e-main-1-30), [1.31](https://testgrid.k8s.io/sig-scheduling#periodic-kueue-test-e2e-main-1-31), on Kind. - ✔️ Scalability verification via [performance tests](https://github.com/kubernetes-sigs/kueue/tree/main/test/performance). - ✔️ Monitoring via [metrics](https://kueue.sigs.k8s.io/docs/reference/metrics). - ✔️ Security: RBAC based accessibility. - ✔️ Stable release cycle(2-3 months) for new features, bugfixes, cleanups. - ✔️ [Adopters](https://kueue.sigs.k8s.io/docs/adopters/) running on production. _Based on community feedback, we continue to simplify and evolve the API to address new use cases_. ## Installation **Requires Kubernetes 1.25 or newer**. To install the latest release of Kueue in your cluster, run the following command: ```shell kubectl apply --server-side -f https://github.com/kubernetes-sigs/kueue/releases/download/v0.9.1/manifests.yaml ``` The controller runs in the `kueue-system` namespace. Read the [installation guide](https://kueue.sigs.k8s.io/docs/installation/) to learn more. ## Usage A minimal configuration can be set by running the [examples](examples): ```shell kubectl apply -f examples/admin/single-clusterqueue-setup.yaml ``` Then you can run a job with: ```shell kubectl create -f examples/jobs/sample-job.yaml ``` Learn more about: - Kueue [concepts](https://kueue.sigs.k8s.io/docs/concepts). - Common and advanced [tasks](https://kueue.sigs.k8s.io/docs/tasks). ## Architecture <!-- TODO(#64) Remove links to google docs once the contents have been migrated to this repo --> Learn more about the architecture of Kueue with the following design docs: - [bit.ly/kueue-apis](https://bit.ly/kueue-apis) discusses the API proposal and a high level description of how Kueue operates. Join the [mailing list](https://groups.google.com/a/kubernetes.io/g/wg-batch) to get document access. - [bit.ly/kueue-controller-design](https://bit.ly/kueue-controller-design) presents the detailed design of the controller. ## Roadmap This is a high-level overview of the main priorities for 2023, in expected order of release: - Cooperative preemption support for workloads that implement checkpointing [#477](https://github.com/kubernetes-sigs/kueue/issues/477) - Flavor assignment strategies, e.g. _minimizing cost_ vs _minimizing borrowing_ [#312](https://github.com/kubernetes-sigs/kueue/issues/312) - Integration with cluster-autoscaler for guaranteed resource provisioning - Integration with common custom workloads [#74](https://github.com/kubernetes-sigs/kueue/issues/74): - Kubeflow (TFJob, MPIJob, etc.) - Spark - Ray - Workflows (Tekton, Argo, etc.) These are features that we aim to have in the long-term, in no particular order: - Budget support [#28](https://github.com/kubernetes-sigs/kueue/issues/28) - Dashboard for management and monitoring for administrators - Multi-cluster support ## Community, discussion, contribution, and support Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/) and the [contributor's guide](CONTRIBUTING.md). You can reach the maintainers of this project at: - [Slack](https://kubernetes.slack.com/messages/wg-batch) - [Mailing List](https://groups.google.com/a/kubernetes.io/g/wg-batch) ### Code of conduct Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). ", Assign "at most 3 tags" to the expected json: {"id":"5751","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"