kserve/pkg/apis/serving/v1alpha1/llm_inference_service_config_validation.go

/*
Copyright 2025 The KServe 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 v1alpha1

import (
	"context"
	"fmt"

	"k8s.io/apimachinery/pkg/api/equality"
	apierrors "k8s.io/apimachinery/pkg/api/errors"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/util/validation/field"
	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/log"
	"sigs.k8s.io/controller-runtime/pkg/webhook"
	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"

	"github.com/kserve/kserve/pkg/constants"
	"github.com/kserve/kserve/pkg/utils"
)

// +kubebuilder:webhook:path=/validate-serving-kserve-io-v1alpha1-llminferenceserviceconfig,mutating=false,failurePolicy=fail,sideEffects=None,groups=serving.kserve.io,resources=llminferenceserviceconfigs,verbs=create;update,versions=v1alpha1,name=llminferenceserviceconfig.kserve-webhook-server.v1alpha1.validator,admissionReviewVersions=v1

// LLMInferenceServiceConfigValidator is responsible for validating the LLMInferenceServiceConfig resource
// when it is created, updated, or deleted.
// +kubebuilder:object:generate=false
type LLMInferenceServiceConfigValidator struct {
	// ConfigValidationFunc is an optional function for additional validation logic.
	// This can be set by the controller to inject validation that depends on controller packages.
	ConfigValidationFunc func(ctx context.Context, config *LLMInferenceServiceConfig) error
	// WellKnownConfigChecker is an optional function to check if a config name is a well-known config.
	// This is used to emit warnings when modifying or deleting well-known configs.
	WellKnownConfigChecker func(name string) bool

	// PreventWellKnownConfigDeletion prevents _active_ well-known configs from being deleted.
	PreventWellKnownConfigDeletion bool
}

var _ webhook.CustomValidator = &LLMInferenceServiceConfigValidator{}

func (l *LLMInferenceServiceConfigValidator) SetupWithManager(mgr ctrl.Manager) error {
	return ctrl.NewWebhookManagedBy(mgr).
		For(&LLMInferenceServiceConfig{}).
		WithValidator(l).
		Complete()
}

func (l *LLMInferenceServiceConfigValidator) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
	warnings := admission.Warnings{}
	config, err := utils.Convert[*LLMInferenceServiceConfig](obj)
	if err != nil {
		return warnings, err
	}

	return warnings, l.validate(ctx, config)
}

func (l *LLMInferenceServiceConfigValidator) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
	logger := log.FromContext(ctx)
	warnings := admission.Warnings{}

	oldConfig, err := utils.Convert[*LLMInferenceServiceConfig](oldObj)
	if err != nil {
		return warnings, err
	}
	newConfig, err := utils.Convert[*LLMInferenceServiceConfig](newObj)
	if err != nil {
		return warnings, err
	}
	if newConfig.GetDeletionTimestamp() != nil {
		return warnings, nil
	}

	// Warn if modifying a well-known config
	if l.WellKnownConfigChecker != nil && l.WellKnownConfigChecker(oldConfig.Name) &&
		!equality.Semantic.DeepDerivative(oldConfig.Spec, newConfig.Spec) {
		warning := fmt.Sprintf("modifying well-known config %s/%s is not recommended. Consider creating a custom config instead",
			oldConfig.Namespace, oldConfig.Name)
		logger.Info(warning)
		warnings = append(warnings, warning)
	}

	return warnings, l.validate(ctx, newConfig)
}

func (l *LLMInferenceServiceConfigValidator) ValidateDelete(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
	logger := log.FromContext(ctx)
	warnings := admission.Warnings{}

	config, err := utils.Convert[*LLMInferenceServiceConfig](obj)
	if err != nil {
		return warnings, err
	}

	// Warn if deleting a well-known config
	if l.WellKnownConfigChecker != nil && l.WellKnownConfigChecker(config.Name) && constants.KServeNamespace == config.Namespace {
		if l.PreventWellKnownConfigDeletion {
			return warnings, fmt.Errorf("well-known config %s/%s cannot be deleted", config.Namespace, config.Name)
		}
		warning := fmt.Sprintf("deleting well-known config %s/%s is not recommended", config.Namespace, config.Name)
		logger.Info(warning)
		warnings = append(warnings, warning)
	}

	return warnings, nil
}

func (l *LLMInferenceServiceConfigValidator) validate(ctx context.Context, config *LLMInferenceServiceConfig) error {
	logger := log.FromContext(ctx)
	logger.Info("Validating LLMInferenceServiceConfig v1alpha1", "name", config.Name, "namespace", config.Namespace)

	var allErrs field.ErrorList

	// BaseRefs is not permitted in LLMInferenceServiceConfig
	if len(config.Spec.BaseRefs) > 0 {
		allErrs = append(allErrs, field.Forbidden(
			field.NewPath("spec").Child("baseRefs"),
			"baseRefs is not a permitted field in LLMInferenceServiceConfig, support for recursive refs has been disabled",
		))
	}

	allErrs = append(allErrs, l.validateScheduler(config)...)

	if len(allErrs) > 0 {
		return apierrors.NewInvalid(
			LLMInferenceServiceConfigGVK.GroupKind(),
			config.Name, allErrs)
	}

	// Run additional validation if configured
	if l.ConfigValidationFunc != nil {
		if err := l.ConfigValidationFunc(ctx, config); err != nil {
			return err
		}
	}

	logger.V(2).Info("LLMInferenceServiceConfig v1alpha1 is valid", "config", config)
	return nil
}

func (l *LLMInferenceServiceConfigValidator) validateScheduler(config *LLMInferenceServiceConfig) []*field.Error {
	var allErrs field.ErrorList

	if config.Spec.Router == nil || config.Spec.Router.Scheduler == nil {
		return nil
	}

	schedulerPath := field.NewPath("spec").Child("router").Child("scheduler")

	if config.Spec.Router.Scheduler.Replicas != nil && *config.Spec.Router.Scheduler.Replicas <= 0 {
		allErrs = append(allErrs, field.Invalid(schedulerPath.Child("replicas"), *config.Spec.Router.Scheduler.Replicas, "scheduler replicas must be greater than zero"))
	}

	return allErrs
}