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

[0.11.1] Enhance controller setup based on available CRDs #233

Merged
Merged
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions pkg/constants/constants.go
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,12 @@ const (
StateReasonCrashLoopBackOff = "CrashLoopBackOff"
)

// CRD Kinds
const (
IstioVirtualServiceKind = "VirtualService"
KnativeServiceKind = "Service"
)

// GetRawServiceLabel generate native service label
func GetRawServiceLabel(service string) string {
return "isvc." + service
Expand Down
49 changes: 36 additions & 13 deletions pkg/controller/v1alpha1/inferencegraph/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import (
"context"
"encoding/json"
"fmt"
isvcutils "github.com/kserve/kserve/pkg/controller/v1beta1/inferenceservice/utils"
appsv1 "k8s.io/api/apps/v1"
"k8s.io/client-go/util/retry"

Expand All @@ -34,13 +33,16 @@ import (
"github.com/kserve/kserve/pkg/apis/serving/v1beta1"
v1beta1api "github.com/kserve/kserve/pkg/apis/serving/v1beta1"
"github.com/kserve/kserve/pkg/constants"
isvcutils "github.com/kserve/kserve/pkg/controller/v1beta1/inferenceservice/utils"
"github.com/kserve/kserve/pkg/utils"
"github.com/pkg/errors"
v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
apierr "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/resource"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/record"
"knative.dev/pkg/apis"
knservingv1 "knative.dev/serving/pkg/apis/serving/v1"
Expand All @@ -53,9 +55,10 @@ import (
// InferenceGraphReconciler reconciles a InferenceGraph object
type InferenceGraphReconciler struct {
client.Client
Log logr.Logger
Scheme *runtime.Scheme
Recorder record.EventRecorder
ClientConfig *rest.Config
Log logr.Logger
Scheme *runtime.Scheme
Recorder record.EventRecorder
}

// InferenceGraphState describes the Readiness of the InferenceGraph
Expand Down Expand Up @@ -174,6 +177,19 @@ func (r *InferenceGraphReconciler) Reconcile(ctx context.Context, req ctrl.Reque
r.Log.Error(err, "name", graph.GetName())
return reconcile.Result{}, err
}

// Abort if Knative Services are not available
ksvcAvailable, checkKsvcErr := utils.IsCrdAvailable(r.ClientConfig, knservingv1.SchemeGroupVersion.String(), constants.KnativeServiceKind)
if err != nil {
return reconcile.Result{}, checkKsvcErr
}

if !ksvcAvailable {
r.Recorder.Event(graph, v1.EventTypeWarning, "ServerlessModeRejected",
"It is not possible to use Serverless deployment mode when Knative Services are not available")
return reconcile.Result{Requeue: false}, nil
}

//@TODO check raw deployment mode
desired := createKnativeService(graph.ObjectMeta, graph, routerConfig)
err = controllerutil.SetControllerReference(graph, desired, r.Scheme)
Expand Down Expand Up @@ -253,15 +269,22 @@ func inferenceGraphReadiness(status v1alpha1api.InferenceGraphStatus) bool {
}

func (r *InferenceGraphReconciler) SetupWithManager(mgr ctrl.Manager, deployConfig *v1beta1api.DeployConfig) error {
if deployConfig.DefaultDeploymentMode == string(constants.RawDeployment) {
return ctrl.NewControllerManagedBy(mgr).
For(&v1alpha1api.InferenceGraph{}).
Owns(&appsv1.Deployment{}).
Complete(r)
r.ClientConfig = mgr.GetConfig()

ksvcFound, err := utils.IsCrdAvailable(r.ClientConfig, knservingv1.SchemeGroupVersion.String(), constants.KnativeServiceKind)
if err != nil {
return err
}

ctrlBuilder := ctrl.NewControllerManagedBy(mgr).
For(&v1alpha1api.InferenceGraph{}).
Owns(&appsv1.Deployment{})

if ksvcFound {
ctrlBuilder = ctrlBuilder.Owns(&knservingv1.Service{})
} else {
return ctrl.NewControllerManagedBy(mgr).
For(&v1alpha1api.InferenceGraph{}).
Owns(&knservingv1.Service{}).
Complete(r)
r.Log.Info("The InferenceGraph controller won't watch serving.knative.dev/v1/Service resources because the CRD is not available.")
}

return ctrlBuilder.Complete(r)
}
73 changes: 73 additions & 0 deletions pkg/controller/v1alpha1/inferencegraph/controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"context"
"github.com/kserve/kserve/pkg/apis/serving/v1alpha1"
"github.com/kserve/kserve/pkg/constants"
"github.com/kserve/kserve/pkg/utils"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
v1 "k8s.io/api/core/v1"
Expand All @@ -30,6 +31,7 @@ import (
"knative.dev/pkg/ptr"
knservingdefaults "knative.dev/serving/pkg/apis/config"
knservingv1 "knative.dev/serving/pkg/apis/serving/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"time"
)
Expand Down Expand Up @@ -461,4 +463,75 @@ var _ = Describe("Inference Graph controller test", func() {
})
})

Context("When creating an InferenceGraph in Serverless mode", func() {
It("Should fail if Knative Serving is not installed", func() {
// Simulate Knative Serving is absent by setting to false the relevant item in utils.gvResourcesCache variable
servingResources, getServingResourcesErr := utils.GetAvailableResourcesForApi(cfg, knservingv1.SchemeGroupVersion.String())
Expect(getServingResourcesErr).To(BeNil())
defer utils.SetAvailableResourcesForApi(knservingv1.SchemeGroupVersion.String(), servingResources)
utils.SetAvailableResourcesForApi(knservingv1.SchemeGroupVersion.String(), nil)

By("By creating a new InferenceGraph")
var configMap = &v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: constants.InferenceServiceConfigMapName,
Namespace: constants.KServeNamespace,
},
Data: configs,
}
Expect(k8sClient.Create(context.TODO(), configMap)).NotTo(HaveOccurred())
defer k8sClient.Delete(context.TODO(), configMap)

graphName := "singlenode1"
var expectedRequest = reconcile.Request{NamespacedName: types.NamespacedName{Name: graphName, Namespace: "default"}}
var serviceKey = expectedRequest.NamespacedName
ctx := context.Background()
ig := &v1alpha1.InferenceGraph{
ObjectMeta: metav1.ObjectMeta{
Name: serviceKey.Name,
Namespace: serviceKey.Namespace,
Annotations: map[string]string{
"serving.kserve.io/deploymentMode": string(constants.Serverless),
},
},
Spec: v1alpha1.InferenceGraphSpec{
Nodes: map[string]v1alpha1.InferenceRouter{
v1alpha1.GraphRootNodeName: {
RouterType: v1alpha1.Sequence,
Steps: []v1alpha1.InferenceStep{
{
InferenceTarget: v1alpha1.InferenceTarget{
ServiceURL: "http://someservice.exmaple.com",
},
},
},
},
},
},
}
Expect(k8sClient.Create(ctx, ig)).Should(Succeed())
defer k8sClient.Delete(ctx, ig)

Eventually(func() bool {
events := &v1.EventList{}
err := k8sClient.List(ctx, events, client.InNamespace(serviceKey.Namespace))
if err != nil {
return false
}
if events == nil {
return false
}

for _, event := range events.Items {
if event.InvolvedObject.Kind == "InferenceGraph" &&
event.InvolvedObject.Name == serviceKey.Name &&
event.Reason == "ServerlessModeRejected" {
return true
}
}

return false
}, timeout, interval).Should(BeTrue())
})
})
})
66 changes: 46 additions & 20 deletions pkg/controller/v1beta1/inferenceservice/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/record"
"knative.dev/pkg/apis"
knservingv1 "knative.dev/serving/pkg/apis/serving/v1"
Expand Down Expand Up @@ -87,9 +88,10 @@ const (
// InferenceServiceReconciler reconciles a InferenceService object
type InferenceServiceReconciler struct {
client.Client
Log logr.Logger
Scheme *runtime.Scheme
Recorder record.EventRecorder
ClientConfig *rest.Config
Log logr.Logger
Scheme *runtime.Scheme
Recorder record.EventRecorder
}

func (r *InferenceServiceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
Expand Down Expand Up @@ -164,6 +166,21 @@ func (r *InferenceServiceReconciler) Reconcile(ctx context.Context, req ctrl.Req
return ctrl.Result{}, nil
}

// Abort early if the resolved deployment mode is Serverless, but Knative Services are not available
if deploymentMode == constants.Serverless {
ksvcAvailable, checkKsvcErr := utils.IsCrdAvailable(r.ClientConfig, knservingv1.SchemeGroupVersion.String(), constants.KnativeServiceKind)
if err != nil {
return reconcile.Result{}, checkKsvcErr
}

if !ksvcAvailable {
r.Recorder.Event(isvc, v1.EventTypeWarning, "ServerlessModeRejected",
"It is not possible to use Serverless deployment mode when Knative Services are not available")
return reconcile.Result{Requeue: false}, nil
}
}

// Setup reconcilers
r.Log.Info("Reconciling inference service", "apiVersion", isvc.APIVersion, "isvc", isvc.Name)
isvcConfig, err := v1beta1api.NewInferenceServicesConfig(r.Client)
if err != nil {
Expand Down Expand Up @@ -304,26 +321,35 @@ func inferenceServiceStatusEqual(s1, s2 v1beta1api.InferenceServiceStatus, deplo
}

func (r *InferenceServiceReconciler) SetupWithManager(mgr ctrl.Manager, deployConfig *v1beta1api.DeployConfig, ingressConfig *v1beta1api.IngressConfig) error {
if deployConfig.DefaultDeploymentMode == string(constants.RawDeployment) {
return ctrl.NewControllerManagedBy(mgr).
For(&v1beta1api.InferenceService{}).
Owns(&appsv1.Deployment{}).
Complete(r)
} else if ingressConfig.DisableIstioVirtualHost == false {
return ctrl.NewControllerManagedBy(mgr).
For(&v1beta1api.InferenceService{}).
Owns(&knservingv1.Service{}).
Owns(&v1alpha3.VirtualService{}).
Owns(&appsv1.Deployment{}).
Complete(r)
r.ClientConfig = mgr.GetConfig()

ksvcFound, err := utils.IsCrdAvailable(r.ClientConfig, knservingv1.SchemeGroupVersion.String(), constants.KnativeServiceKind)
if err != nil {
return err
}

vsFound, err := utils.IsCrdAvailable(r.ClientConfig, v1alpha3.SchemeGroupVersion.String(), constants.IstioVirtualServiceKind)
if err != nil {
return err
}

ctrlBuilder := ctrl.NewControllerManagedBy(mgr).
For(&v1beta1api.InferenceService{}).
Owns(&appsv1.Deployment{})

if ksvcFound {
ctrlBuilder = ctrlBuilder.Owns(&knservingv1.Service{})
} else {
r.Log.Info("The InferenceService controller won't watch serving.knative.dev/v1/Service resources because the CRD is not available.")
}

if vsFound && ingressConfig.DisableIstioVirtualHost == false {
ctrlBuilder = ctrlBuilder.Owns(&v1alpha3.VirtualService{})
} else {
return ctrl.NewControllerManagedBy(mgr).
For(&v1beta1api.InferenceService{}).
Owns(&knservingv1.Service{}).
Owns(&appsv1.Deployment{}).
Complete(r)
r.Log.Info("The InferenceService controller won't watch networking.istio.io/v1alpha3/VirtualService resources because the CRD is not available.")
}

return ctrlBuilder.Complete(r)
}

func (r *InferenceServiceReconciler) deleteExternalResources(isvc *v1beta1api.InferenceService) error {
Expand Down
78 changes: 78 additions & 0 deletions pkg/controller/v1beta1/inferenceservice/controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
"github.com/kserve/kserve/pkg/apis/serving/v1alpha1"
"github.com/kserve/kserve/pkg/apis/serving/v1beta1"
"github.com/kserve/kserve/pkg/constants"
"github.com/kserve/kserve/pkg/utils"
. "github.com/onsi/ginkgo/v2"
"github.com/onsi/gomega"
. "github.com/onsi/gomega"
Expand Down Expand Up @@ -383,6 +384,83 @@ var _ = Describe("v1beta1 inference service controller", func() {
Expect(updatedVirtualService.Annotations).To(gomega.Equal(annotations))
Expect(updatedVirtualService.Labels).To(gomega.Equal(labels))
})
It("Should fail if Knative Serving is not installed", func() {
// Simulate Knative Serving is absent by setting to false the relevant item in utils.gvResourcesCache variable
servingResources, getServingResourcesErr := utils.GetAvailableResourcesForApi(cfg, knservingv1.SchemeGroupVersion.String())
Expect(getServingResourcesErr).To(BeNil())
defer utils.SetAvailableResourcesForApi(knservingv1.SchemeGroupVersion.String(), servingResources)
utils.SetAvailableResourcesForApi(knservingv1.SchemeGroupVersion.String(), nil)

// Create configmap
var configMap = &v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: constants.InferenceServiceConfigMapName,
Namespace: constants.KServeNamespace,
},
Data: configs,
}
Expect(k8sClient.Create(context.TODO(), configMap)).NotTo(HaveOccurred())
defer k8sClient.Delete(context.TODO(), configMap)

// Create InferenceService
serviceName := "serverless-isvc"
var expectedRequest = reconcile.Request{NamespacedName: types.NamespacedName{Name: serviceName, Namespace: "default"}}
var serviceKey = expectedRequest.NamespacedName
var storageUri = "s3://test/mnist/export"
isvc := &v1beta1.InferenceService{
ObjectMeta: metav1.ObjectMeta{
Name: serviceKey.Name,
Namespace: serviceKey.Namespace,
Annotations: map[string]string{
"serving.kserve.io/deploymentMode": "Serverless",
},
},
Spec: v1beta1.InferenceServiceSpec{
Predictor: v1beta1.PredictorSpec{
ComponentExtensionSpec: v1beta1.ComponentExtensionSpec{
MinReplicas: v1beta1.GetIntReference(1),
MaxReplicas: 3,
},
Tensorflow: &v1beta1.TFServingSpec{
PredictorExtensionSpec: v1beta1.PredictorExtensionSpec{
StorageURI: &storageUri,
RuntimeVersion: proto.String("1.14.0"),
Container: v1.Container{
Name: constants.InferenceServiceContainerName,
Resources: defaultResource,
},
},
},
},
},
}
isvc.DefaultInferenceService(nil, nil)

ctx := context.Background()
Expect(k8sClient.Create(ctx, isvc)).Should(Succeed())
defer k8sClient.Delete(ctx, isvc)

Eventually(func() bool {
events := &v1.EventList{}
err := k8sClient.List(ctx, events, client.InNamespace(serviceKey.Namespace))
if err != nil {
return false
}
if events == nil {
return false
}

for _, event := range events.Items {
if event.InvolvedObject.Kind == "InferenceService" &&
event.InvolvedObject.Name == serviceKey.Name &&
event.Reason == "ServerlessModeRejected" {
return true
}
}

return false
}, timeout, interval).Should(BeTrue())
})
})

Context("Inference Service with transformer", func() {
Expand Down
Loading
Loading