@@ -9,11 +9,12 @@ designed to smoothly interoperate with
9
9
[ Kueue] ( https://kueue.sigs.k8s.io ) . They provide a flexible and
10
10
workload-agnostic mechanism for enabling Kueue to manage a group of
11
11
Kubernetes resources as a single logical unit without requiring any
12
- Kueue-specific support by the controllers of those resources. If the
13
- operators for some of the contained resources are Kueue-aware, the
14
- AppWrapper operator ensures that when Kueue admits an AppWrapper for
15
- execution, all of the necessary information will be propagated
16
- to cause the child's Kueue-enabled operator to admit it as well.
12
+ Kueue-specific support by the controllers of those resources.
13
+ Kueue can be configured to recognize AppWrappers as an
14
+ [ externalFramework] ( https://kueue.sigs.k8s.io/docs/tasks/dev/integrate_a_custom_job/#building-an-external-integration ) ,
15
+ thus ensuring that if you have enabled Kueue's ` manageJobsWithoutQueueName `
16
+ option, admission decisions made for the AppWrapper will be properly
17
+ propagated to its contained resources.
17
18
For a more detailed description of the overall design, see the
18
19
[ Architecture] ( https://project-codeflare.github.io/appwrapper/arch-controller/ )
19
20
section of our website.
@@ -43,6 +44,10 @@ The controller runs in the `appwrapper-system` namespace.
43
44
44
45
Read the [ Quick Start Guide] ( https://project-codeflare.github.io/appwrapper/quick-start/ ) to learn more.
45
46
47
+ If you have modified the default configuration of Kueue to set ` manageJobsWithoutQueueName ` to true,
48
+ then you must also apply [ this patch] ( ./hack/kueue-patches/02-aw-external-frameworks.txt ) to your
49
+ Kueue installation.
50
+
46
51
## Usage
47
52
48
53
For example of AppWrapper usage, browse our [ Samples] ( ./samples ) directory or
0 commit comments