Skip to content

Update README for Kueue 0.11 (built-in integration) #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 21, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,14 @@
An AppWrapper contains a collection of Kubernetes resources that a
user desires to manage as a single logical workload. AppWrapper is
designed to smoothly interoperate with
[Kueue](https://kueue.sigs.k8s.io). They provide a flexible and
[Kueue](https://kueue.sigs.k8s.io). AppWrapper provides 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 AppWrapper 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.
Beginning in Kueue 0.11 (and AppWrapper v1.1), AppWrapper is a
*built-in Kueue integration* and is enabled by default. In older versions
AppWrapper was supported by Kueue as an *external framework* and needed to
be explicitly enabled via a custom Kueue configuration.

An AppWrapper can be used to harden workloads by providing an
additional level of automatic fault detection and recovery. The AppWrapper
Expand Down
Loading