Skip to content

Commit

Permalink
Add README docs
Browse files Browse the repository at this point in the history
Signed-off-by: Siyu Wang <[email protected]>
  • Loading branch information
FillZpp committed Mar 16, 2022
1 parent 1632a34 commit ac0d789
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

Koordinator follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
8 changes: 8 additions & 0 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# See: https://go.k8s.io/owners

approvers:
- hormes

reviewers:
- hormes
- FillZpp
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Koordinator

[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

## Introduction

Koordinator is a QoS based scheduling system for hybrid orchestration workloads on Kubernetes.
It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs,
simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.

Koordinator enhances the kubernetes user experiences in the workload management by providing the following:

- Well-designed priority and QoS mechanism to co-locate different types of workloads in a cluster, a node.
- Allowing for resource overcommitments to achieve high resource utilizations but still satisfying the QoS guarantees by leveraging an application profiling mechanism.
- Fine-grained resource orchestration and isolation mechanism to improve the efficiency of latency-sensitive workloads and batch jobs.
- Flexible job scheduling mechanism to support workloads in specific areas, e.g., big data, AI, audio and video.
- A set of tools for monitoring, troubleshooting and operations.

## Quick Start

...

## Contributing

...

## License

Koordinator is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE.md) for the full license text.

0 comments on commit ac0d789

Please sign in to comment.