Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/project-codeflare/appwrapper

AppWrapper controller for Kueue
https://github.com/project-codeflare/appwrapper

Last synced: about 1 month ago
JSON representation

AppWrapper controller for Kueue

Awesome Lists containing this project

README 

        
# AppWrapper



[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

[![Continuous Integration](https://github.com/project-codeflare/appwrapper/actions/workflows/CI.yaml/badge.svg)](https://github.com/project-codeflare/appwrapper/actions/workflows/CI.yaml)



An AppWrapper contains a collection of Kubernetes resources that a

user desires to manage as a single logical workload. AppWrappers are

designed to smoothly interoperate with

[Kueue](https://kueue.sigs.k8s.io).  They provide a flexible and

workload-agnostic mechanism for enabling Kueue to manage a group of

Kubernetes resources as a single logical unit without requiring any

Kueue-specific support by the controllers of those resources.

Kueue can be configured to recognize AppWrappers as an

[externalFramework](https://kueue.sigs.k8s.io/docs/tasks/dev/integrate_a_custom_job/#building-an-external-integration),

thus ensuring that if you have enabled Kueue's `manageJobsWithoutQueueName`

option, admission decisions made for the AppWrapper will be properly

propagated to its contained resources.

For a more detailed description of the overall design, see the

[Architecture](https://project-codeflare.github.io/appwrapper/arch-controller/)

section of our website.



AppWrappers are designed to harden workloads by providing an

additional level of automatic fault detection and recovery. The AppWrapper

controller monitors the health of the workload and if corrective actions

are not taken by the primary resource controllers within specified deadlines,

the AppWrapper controller will orchestrate workload-level retries and

resource deletion to ensure that either the workload returns to a

healthy state or is cleanly removed from the cluster and its quota

freed for use by other workloads. If [Autopilot](https://github.com/ibm/autopilot)

is also being used on the cluster, the AppWrapper controller can be configured

to automatically inject Node anti-affinities into Pods and to trigger

retries when Pods in already running workloads are using resources

that Autopilot has tagged as unhealthy. For details on customizing and

configuring these fault tolerance capabilities, please see the

[Fault Tolerance](https://project-codeflare.github.io/appwrapper/arch-fault-tolerance/)

section of our website.



AppWrappers are designed to be used as part of fully open source software stack

to run production batch workloads on Kubernetes and OpenShift. The [MLBatch](https://github.com/project-codeflare/mlbatch)

project leverages [Kueue](https://kueue.sigs.k8s.io), the [Kubeflow Training

Operator](https://www.kubeflow.org/docs/components/training/),

[KubeRay](https://docs.ray.io/en/latest/cluster/kubernetes/index.html), and the

[Codeflare Operator](https://github.com/project-codeflare/codeflare-operator)

from [Red Hat OpenShift

AI](https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-ai).

MLBatch enables [AppWrappers](https://project-codeflare.github.io/appwrapper/)

and adds

[Coscheduler](https://github.com/kubernetes-sigs/scheduler-plugins/blob/master/pkg/coscheduling/README.md).

MLBatch includes a number of configuration steps to help these components work

in harmony and support large workloads on large clusters.



## Installation



To install the latest release of AppWrapper in a Kubernetes cluster with Kueue already installed

and configured, simply run the command:



```sh

kubectl apply --server-side -f https://github.com/project-codeflare/appwrapper/releases/download/v0.27.0/install.yaml

```



The controller runs in the `appwrapper-system` namespace.



Read the [Quick Start Guide](https://project-codeflare.github.io/appwrapper/quick-start/) to learn more.



If you have modified the default configuration of Kueue to set `manageJobsWithoutQueueName` to true,

then you must also apply [this patch](./hack/kueue-patches/02-aw-external-frameworks.txt) to your

Kueue installation.



## Usage



For example of AppWrapper usage, browse our [Samples](./samples) directory or

see the [Samples](https://project-codeflare.github.io/appwrapper/samples/) section

of the project website.



## Development



To contribute to the AppWrapper project and for detailed instructions on how to

build and deploy the project from source, see the

[Development Setup](https://project-codeflare.github.io/appwrapper/dev-setup/) section

of the project website.



## License



Copyright 2024 IBM Corporation.



Licensed 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.