tree: 40339053881b1543fc968427d266c86f6746c6f9 [path history] [tgz]
  1. CHANGELOG
  2. DISCLAIMER
  3. LICENSE
  4. Makefile
  5. NOTICE
  6. README.md
release-top-level-artifacts/README.md

Apache YuniKorn (Incubating)

Apache YuniKorn (Incubating) is a light-weight, universal resource scheduler for container orchestrator systems. It was 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 consists of stateless batch workloads and stateful services.

Build pre-requisites

These instructions provided are tailored to the source release. Details on how to set up a full development environment can be found in Building YuniKorn.

General requirement for building YuniKorn images from this release:

  • Make
  • Docker

Yunikorn Scheduler

The scheduler and shim are build as one set of artifacts and have one requirement:

  • Go 1.11 or later

Yunikorn web UI

The YuniKorn web UI uses a two stage docker build with predefined images. All dependencies are included in the image.

NOTE: the scheduler can be used without a web UI build or deployed.

Building

Run the make command to build docker images.

make

The command will generate the following three docker images in the local docker repository:

  • apache/yunikorn:scheduler-latest
  • apache/yunikorn:admission-latest
  • apache/yunikorn:web-latest

Deploying YuniKorn

The simplest way to run YuniKorn is to use the provided helm charts, you can find the templates in the release package helm-charts. There are a few prerequisites:

  1. An existing K8s cluster is up and running.
  2. Helm chart client is installed.

If you have a cluster, and the helm client you can simply run helm from the root directory:

helm install yunikorn ./helm-charts/yunikorn

Customising the build

The make command will pass on the following two variables:

  • VERSION
  • REGISTRY These variables can be used to generate customised build:
VERSION="0.9.1" REGISTRY="internal" make

The values defined in the helm charts assume a default build without changes to the VERSION or REGISTRY. Once you have built your own docker images, you will need to replace the docker image name in the helm chart templates. Open helm-charts/yunikorn/values.yaml and replace the docker image information with ones you built.

For more instructions, please refer to User Guide.

Deploying a convenience build

Apache YuniKorn (incubating) provides a convenience release with pre-build docker images and helm charts. These can be accessed via the downloads page and instructions are located in the User Guide.

Testing the build

Running the unit tests is supported via the make command. It will run the tests for all parts of YuniKorn in order:

make test

Yunikorn Scheduler

The scheduler tests runs in two parts: the core, and the k8shim. There are no tests for the scheduler-interface.

Unit testing for the scheduler has no additional pre-requisites.

Yunikorn web UI

The project requires a number of external tools to be installed for test and development. A non image build requires the following tools to be installed:

  • Node.js 10.16.2
  • Angular CLI 8.3.19
  • yarn 1.21

Running unit tests adds the following requirements:

  • Karma
  • Protractor
  • json-server

Please check the documentation for further details.