Skip to content

Commit 870d410

Browse files
authored
Update AppWrapper website for Kueue 0.7 enhancements (#185)
* update architecture discussion for Kueue 0.7 * Kueue 0.7 requires go 1.22
1 parent 7b13b9d commit 870d410

File tree

3 files changed

+20
-12
lines changed

3 files changed

+20
-12
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ designed to smoothly interoperate with
99
[Kueue](https://kueue.sigs.k8s.io). They provide a flexible and
1010
workload-agnostic mechanism for enabling Kueue to manage a group of
1111
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.
1718
For a more detailed description of the overall design, see the
1819
[Architecture](https://project-codeflare.github.io/appwrapper/arch-controller/)
1920
section of our website.
@@ -43,6 +44,10 @@ The controller runs in the `appwrapper-system` namespace.
4344

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

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+
4651
## Usage
4752

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

site/_pages/arch-controller.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,16 @@ the status of the AppWrapper to the format expected by Kueue.
3535
See [workload_controller.go]({{ site.gh_main_url }}/internal/controller/workload/workload_controller.go)
3636
for the implementation.
3737

38-
A small additional piece of logic is currently needed to generalize
39-
Kueue's ability to recognize parent/children relationships and ensure
40-
that admission by Kueue of the parent AppWrapper will be propagated to
41-
its immediate children.
38+
To ensure smooth interoperation with all possible configurations of Kueue,
39+
it is recommended to register AppWrappers as an
40+
[externalFramework](https://kueue.sigs.k8s.io/docs/tasks/dev/integrate_a_custom_job/#building-an-external-integration)
41+
with Kueue. Our script [deploy-kueue.sh]({{ site.gh_main_url }}/hack/deploy-kueue.sh) automates
42+
this. The script accomplishes the following tasks:
43+
44+
1. Adds the ability to get, list, and watch AppWrappers to the RBACs for Kueue's manager role.
45+
2. Adds `"AppWrapper.v1beta2.workload.codeflare.dev"` to the list of `externalFrameworks` in
46+
Kueue's manager configuration.
4247

43-
See [child_admission_controller.go]({{ site.gh_main_url }}/internal/controller/workload/child_admission_controller.go)
44-
for the implementation.
4548

4649
#### Framework Controller
4750

site/_pages/dev-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ classes: wide
66

77
### Prerequisites
88

9-
You'll need `go` v1.21.0+ installed on your development machine.
9+
You'll need `go` v1.22.0+ installed on your development machine.
1010

1111
You'll need a container runtime and cli (eg `docker` or `rancher-desktop`).
1212

0 commit comments

Comments
 (0)