Skip to content
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

properly configure appwrapper webhooks #4163

Merged
merged 6 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from 5 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
39 changes: 39 additions & 0 deletions charts/kueue/templates/webhook/webhook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,25 @@ metadata:
{{- end }}
namespace: '{{ .Release.Namespace }}'
webhooks:
- admissionReviewVersions:
- v1
clientConfig:
service:
name: '{{ include "kueue.fullname" . }}-webhook-service'
namespace: '{{ .Release.Namespace }}'
path: /mutate-workload-codeflare-dev-v1beta2-appwrapper
failurePolicy: Fail
name: mappwrapper.kb.io
rules:
- apiGroups:
- workload.codeflare.dev
apiVersions:
- v1beta2
operations:
- CREATE
resources:
- appwrappers
sideEffects: None
- admissionReviewVersions:
- v1
clientConfig:
Expand Down Expand Up @@ -368,6 +387,26 @@ metadata:
{{- end }}
namespace: '{{ .Release.Namespace }}'
webhooks:
- admissionReviewVersions:
- v1
clientConfig:
service:
name: '{{ include "kueue.fullname" . }}-webhook-service'
namespace: '{{ .Release.Namespace }}'
path: /validate-workload-codeflare-dev-v1beta2-appwrapper
failurePolicy: Fail
name: vappwrapper.kb.io
rules:
- apiGroups:
- workload.codeflare.dev
apiVersions:
- v1beta2
operations:
- CREATE
- UPDATE
resources:
- appwrappers
sideEffects: None
- admissionReviewVersions:
- v1
clientConfig:
Expand Down
39 changes: 39 additions & 0 deletions config/components/webhook/manifests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ kind: MutatingWebhookConfiguration
metadata:
name: mutating-webhook-configuration
webhooks:
- admissionReviewVersions:
- v1
clientConfig:
service:
name: webhook-service
namespace: system
path: /mutate-workload-codeflare-dev-v1beta2-appwrapper
failurePolicy: Fail
name: mappwrapper.kb.io
rules:
- apiGroups:
- workload.codeflare.dev
apiVersions:
- v1beta2
operations:
- CREATE
resources:
- appwrappers
sideEffects: None
- admissionReviewVersions:
- v1
clientConfig:
Expand Down Expand Up @@ -317,6 +336,26 @@ kind: ValidatingWebhookConfiguration
metadata:
name: validating-webhook-configuration
webhooks:
- admissionReviewVersions:
- v1
clientConfig:
service:
name: webhook-service
namespace: system
path: /validate-workload-codeflare-dev-v1beta2-appwrapper
failurePolicy: Fail
name: vappwrapper.kb.io
rules:
- apiGroups:
- workload.codeflare.dev
apiVersions:
- v1beta2
operations:
- CREATE
- UPDATE
resources:
- appwrappers
sideEffects: None
- admissionReviewVersions:
- v1
clientConfig:
Expand Down
4 changes: 3 additions & 1 deletion pkg/controller/jobs/appwrapper/appwrapper_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,14 @@ func init() {
// +kubebuilder:rbac:groups="",resources=events,verbs=create;watch;update
// +kubebuilder:rbac:groups=workload.codeflare.dev,resources=appwrappers,verbs=get;list;watch;update;patch
// +kubebuilder:rbac:groups=workload.codeflare.dev,resources=appwrappers/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=workload.codeflare.dev,resources=appwrappers/finalizers,verbs=get;update
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=workloads,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=workloads/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=workloads/finalizers,verbs=update
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=resourceflavors,verbs=get;list;watch
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=workloadpriorityclasses,verbs=get;list;watch
// +kubebuilder:rbac:groups=workload.codeflare.dev,resources=appwrappers/finalizers,verbs=get;update
//+kubebuilder:webhook:path=/mutate-workload-codeflare-dev-v1beta2-appwrapper,mutating=true,failurePolicy=fail,sideEffects=None,groups=workload.codeflare.dev,resources=appwrappers,verbs=create,versions=v1beta2,name=mappwrapper.kb.io,admissionReviewVersions=v1
//+kubebuilder:webhook:path=/validate-workload-codeflare-dev-v1beta2-appwrapper,mutating=false,failurePolicy=fail,sideEffects=None,groups=workload.codeflare.dev,resources=appwrappers,verbs=create;update,versions=v1beta2,name=vappwrapper.kb.io,admissionReviewVersions=v1

func NewJob() jobframework.GenericJob {
return &AppWrapper{}
Expand Down
142 changes: 142 additions & 0 deletions test/integration/singlecluster/webhook/jobs/appwrapper_webhook_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
/*
Copyright 2025 The Kubernetes Authors.

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.
*/

package jobs

import (
"github.com/onsi/ginkgo/v2"
"github.com/onsi/gomega"
awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"

"sigs.k8s.io/kueue/pkg/controller/jobframework"
"sigs.k8s.io/kueue/pkg/controller/jobs/appwrapper"
"sigs.k8s.io/kueue/pkg/util/testing"
testingaw "sigs.k8s.io/kueue/pkg/util/testingjobs/appwrapper"
"sigs.k8s.io/kueue/test/util"
)

var _ = ginkgo.Describe("AppWrapper Webhook With manageJobsWithoutQueueName enabled", ginkgo.Ordered, func() {
var ns *corev1.Namespace
var unmanagedNamespace *corev1.Namespace
ginkgo.BeforeAll(func() {
unmanagedNamespace = &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "unmanaged-",
},
}
gomega.Expect(k8sClient.Create(ctx, unmanagedNamespace)).To(gomega.Succeed())
fwk.StartManager(ctx, cfg, managerSetup(
appwrapper.SetupAppWrapperWebhook,
jobframework.WithManageJobsWithoutQueueName(true),
jobframework.WithManagedJobsNamespaceSelector(util.NewNamespaceSelectorExcluding(unmanagedNamespace.Name)),
))
})
ginkgo.BeforeEach(func() {
ns = &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "aw-",
},
}
gomega.Expect(k8sClient.Create(ctx, ns)).To(gomega.Succeed())
})

ginkgo.AfterEach(func() {
gomega.Expect(util.DeleteNamespace(ctx, k8sClient, ns)).To(gomega.Succeed())
})
ginkgo.AfterAll(func() {
gomega.Expect(util.DeleteNamespace(ctx, k8sClient, unmanagedNamespace)).To(gomega.Succeed())
fwk.StopManager(ctx)
})

ginkgo.It("Should suspend an AppWrapper even no queue name specified", func() {
appwrapper := testingaw.MakeAppWrapper("aw-without-queue-name", ns.Name).Suspend(false).Obj()
gomega.Expect(k8sClient.Create(ctx, appwrapper)).Should(gomega.Succeed())

lookupKey := types.NamespacedName{Name: appwrapper.Name, Namespace: appwrapper.Namespace}
createdAppWrapper := &awv1beta2.AppWrapper{}
gomega.Eventually(func(g gomega.Gomega) {
g.Expect(k8sClient.Get(ctx, lookupKey, createdAppWrapper)).Should(gomega.Succeed())
g.Expect(createdAppWrapper.Spec.Suspend).Should(gomega.BeTrue())
}, util.Timeout, util.Interval).Should(gomega.Succeed())
})

ginkgo.It("Should not suspend an AppWrapper with no queue name specified in an unmanaged namespace", func() {
appwrapper := testingaw.MakeAppWrapper("aw-without-queue-name", unmanagedNamespace.Name).Suspend(false).Obj()
gomega.Expect(k8sClient.Create(ctx, appwrapper)).Should(gomega.Succeed())

lookupKey := types.NamespacedName{Name: appwrapper.Name, Namespace: appwrapper.Namespace}
createdAppWrapper := &awv1beta2.AppWrapper{}
gomega.Eventually(func(g gomega.Gomega) {
g.Expect(k8sClient.Get(ctx, lookupKey, createdAppWrapper)).Should(gomega.Succeed())
g.Expect(createdAppWrapper.Spec.Suspend).Should(gomega.BeFalse())
}, util.Timeout, util.Interval).Should(gomega.Succeed())
})
})

var _ = ginkgo.Describe("AppWrapper Webhook with manageJobsWithoutQueueName disabled", ginkgo.Ordered, func() {
var ns *corev1.Namespace
ginkgo.BeforeAll(func() {
fwk.StartManager(ctx, cfg, managerSetup(appwrapper.SetupAppWrapperWebhook, jobframework.WithManageJobsWithoutQueueName(false)))
})
ginkgo.BeforeEach(func() {
ns = &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "aw-",
},
}
gomega.Expect(k8sClient.Create(ctx, ns)).To(gomega.Succeed())
})
ginkgo.AfterEach(func() {
gomega.Expect(util.DeleteNamespace(ctx, k8sClient, ns)).To(gomega.Succeed())
})
ginkgo.AfterAll(func() {
fwk.StopManager(ctx)
})

ginkgo.It("should suspend an AppWrapper when created in unsuspend state", func() {
appwrapper := testingaw.MakeAppWrapper("aw-with-queue-name", ns.Name).Suspend(false).Queue("default").Obj()
gomega.Expect(k8sClient.Create(ctx, appwrapper)).Should(gomega.Succeed())

lookupKey := types.NamespacedName{Name: appwrapper.Name, Namespace: appwrapper.Namespace}
createdAppWrapper := &awv1beta2.AppWrapper{}
gomega.Eventually(func(g gomega.Gomega) {
g.Expect(k8sClient.Get(ctx, lookupKey, createdAppWrapper)).Should(gomega.Succeed())
g.Expect(createdAppWrapper.Spec.Suspend).Should(gomega.BeTrue())
}, util.Timeout, util.Interval).Should(gomega.Succeed())
})

ginkgo.It("should not suspend an AppWrapper when no queue name specified", func() {
appwrapper := testingaw.MakeAppWrapper("aw-without-queue-name", ns.Name).Suspend(false).Obj()
gomega.Expect(k8sClient.Create(ctx, appwrapper)).Should(gomega.Succeed())

lookupKey := types.NamespacedName{Name: appwrapper.Name, Namespace: appwrapper.Namespace}
createdAppWrapper := &awv1beta2.AppWrapper{}
gomega.Eventually(func(g gomega.Gomega) {
g.Expect(k8sClient.Get(ctx, lookupKey, createdAppWrapper)).Should(gomega.Succeed())
g.Expect(createdAppWrapper.Spec.Suspend).Should(gomega.BeFalse())
}, util.Timeout, util.Interval).Should(gomega.Succeed())
})

ginkgo.It("the creation doesn't succeed if the queue name is invalid", func() {
appwrapper := testingaw.MakeAppWrapper("aw-with-invalid-queue", ns.Name).Queue("indexed_job").Obj()
err := k8sClient.Create(ctx, appwrapper)
gomega.Expect(err).Should(gomega.HaveOccurred())
gomega.Expect(err).Should(testing.BeForbiddenError())
})
})
1 change: 1 addition & 0 deletions test/integration/singlecluster/webhook/jobs/suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ var _ = ginkgo.BeforeSuite(func() {
util.JobsetCrds,
util.RayOperatorCrds,
util.TrainingOperatorCrds,
util.AppWrapperCrds,
},
WebhookPath: util.WebhookPath,
}
Expand Down