| <!-- |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| --> |
| # Apache YuniKorn - A Universal Scheduler |
| |
| [](https://github.com/apache/yunikorn-core/actions) |
| [](https://codecov.io/gh/apache/yunikorn-core) |
| [](https://goreportcard.com/report/github.com/apache/yunikorn-core) |
| [](https://opensource.org/licenses/Apache-2.0) |
| [](https://img.shields.io/github/repo-size/apache/yunikorn-core) |
| |
| Apache YuniKorn is a light-weight, universal resource scheduler for container orchestrator systems. |
| It is created to achieve fine-grained resource sharing for various workloads efficiently on a large scale, multi-tenant, |
| and cloud-native environment. YuniKorn brings a unified, cross-platform, scheduling experience for mixed workloads that consist |
| of stateless batch workloads and stateful services. |
| |
| YuniKorn now supports K8s and can be deployed as a custom K8s scheduler. YuniKorn's architecture design also allows adding different |
| shim layer and adopt to different ResourceManager implementation including Apache Hadoop YARN, or any other systems. |
| |
| ## Get Started |
| |
| See how to get started with running YuniKorn on Kubernetes, please read the documentation on [yunikorn.apache.org](http://yunikorn.apache.org/docs/). |
| |
| Want to know more about the value of the YuniKorn project, and what YuniKorn can do? Here are some |
| [session recordings and demos](https://yunikorn.apache.org/community/events#past-conference--meetup-recordings). |
| |
| ## Get Involved |
| |
| Please read [get involved](http://yunikorn.apache.org/community/get_involved) document if you want to discuss issues, |
| contribute your ideas, explore use cases, or participate the development. |
| |
| If you want to contribute code to this repo, please read the [developer doc](http://yunikorn.apache.org/docs/next/developer_guide/build). |
| All the design docs are available [here](http://yunikorn.apache.org/docs/next/design/architecture). |
| |
| ## Code Structure |
| |
| Apache YuniKorn project has the following git repositories: |
| |
| - [yunikorn-core](https://github.com/apache/yunikorn-core/) : the scheduler brain :round_pushpin: |
| - [yunikorn-k8shim](https://github.com/apache/yunikorn-k8shim) : the adaptor to Kubernetes |
| - [yunikorn-scheduler-interface](https://github.com/apache/yunikorn-scheduler-interface) : the common scheduling interface |
| - [yunikorn-web](https://github.com/apache/yunikorn-web) : the web UI |
| - [yunikorn-release](https://github.com/apache/yunikorn-release/): the repo manages yunikorn releases, including the helm charts |
| - [yunikorn-site](https://github.com/apache/yunikorn-site/): the source code for [yunikorn website](http://yunikorn.apache.org/) |
| |
| The `yunikorn-core` is the brain of the scheduler, which makes placement decisions (allocate container X on node Y) according |
| to the builtin rich scheduling policies. Scheduler core implementation is agnostic to the underneath resource manager system. |
