Yunikorn History Server is an ancillary service for K8S Clusters using the Yunikorn Scheduler to persist the state of a Yunikorn-managed cluster to a database, allowing for long-term access to historical data of the cluster's operations (e.g. to view past Applications, resource usage, etc.).

Make sure you have the following dependencies installed:

• PostgreSQL - open-source relational database
• Go v1.22+ (only needed for local development) - programming language used to build the Yunikorn History Server

Use the following make commands to build and run the Yunikorn History Server locally:

# start all dependencies
make kind-all
# build and run YHS
make run

Please feel free to contribute bug-reports or ideas for enhancements via GitHub's issue system.

Code contributions are also welcome. When submitting a pull-request please ensure it references a relevant issue as well as making sure all CI checks pass.

Please test contributions thoroughly before requesting reviews. At a minimum:

# Lint code
make lint
# Run tests
make tests

should all succeed without error.

Add and change appropriate unit and integration tests to ensure your changes are covered by automated tests and appear to be correct.

See the LICENSE file for licensing information.