Enabled the multiple domains support on an inference service (kserve#…

…3615) * Added the field AdditionalIngressDomains into the struct IngressConfig Signed-off-by: Vincent Hou <[email protected]> * Added the additional ingress domains into the hosts Signed-off-by: Vincent Hou <[email protected]> * Fixed the indentation Signed-off-by: Vincent Hou <[email protected]> * Added isvc name and namespace into the domain name * Added the validation for the URLs Signed-off-by: Vincent Hou <[email protected]> * Validate the domain in the additionalIngressDomains Signed-off-by: Vincent Hou <[email protected]> * Create the hosts from the list of additionalIngressDomains Signed-off-by: Vincent Hou <[email protected]> * Change the way to validate the host Signed-off-by: Vincent Hou <[email protected]> * Change the validation error message Signed-off-by: Vincent Hou <[email protected]> * Revert the name to url Signed-off-by: Vincent Hou <[email protected]> * Get all the available domain list Signed-off-by: Vincent Hou <[email protected]> * gofmt -s -w the file Signed-off-by: Vincent Hou <[email protected]> * Add additionalIngressDomains into the charts Signed-off-by: Vincent Hou <[email protected]> * Added the comments and refactor the tests Signed-off-by: Vincent Hou <[email protected]> * Regenerate the manifests Signed-off-by: Vincent Hou <[email protected]> * Modify createHTTPMatchRequest, the charts and the test cases Signed-off-by: Vincent Hou <[email protected]> * Run make generate Signed-off-by: Vincent Hou <[email protected]> --------- Signed-off-by: Vincent Hou <[email protected]>
rchincha · Apr 30, 2024 · 36a3e6d · 36a3e6d
1 parent f717e12
commit 36a3e6d
Show file tree

Hide file tree

Showing 15 changed files with 601 additions and 80 deletions.
diff --git a/charts/kserve-resources/README.md b/charts/kserve-resources/README.md
@@ -20,6 +20,7 @@ $ helm install kserve oci://ghcr.io/kserve/charts/kserve --version v0.12.1
 | kserve.agent.tag | string | `"v0.12.1"` |  |
 | kserve.controller.affinity | object | `{}` |  |
 | kserve.controller.deploymentMode | string | `"Serverless"` |  |
+| kserve.controller.gateway.additionalIngressDomains | list | `[]` |  |
 | kserve.controller.gateway.disableIngressCreation | bool | `false` |  |
 | kserve.controller.gateway.disableIstioVirtualHost | bool | `false` |  |
 | kserve.controller.gateway.domain | string | `"example.com"` |  |

diff --git a/charts/kserve-resources/templates/configmap.yaml b/charts/kserve-resources/templates/configmap.yaml
@@ -185,6 +185,7 @@ data:
            "localGateway" : "knative-serving/knative-local-gateway",
            "localGatewayService" : "knative-local-gateway.istio-system.svc.cluster.local",
            "ingressDomain"  : "example.com",
+           "additionalIngressDomains": ["additional-example.com", "additional-example-1.com"],
            "ingressClassName" : "istio",
            "domainTemplate": "{{ .Name }}-{{ .Namespace }}.{{ .IngressDomain }}",
            "urlScheme": "http",
@@ -215,6 +216,9 @@ data:
            # NOTE: This configuration only applicable for raw deployment.
            "ingressDomain"  : "example.com",
 
+           # additionalIngressDomains specifies the additional domain names which are used for creating the url.
+           "additionalIngressDomains": ["additional-example.com", "additional-example-1.com"]
+
            # ingressClassName specifies the ingress controller to use for ingress traffic.
            # This is optional and if omitted the default ingress in the cluster is used.
            # https://kubernetes.io/docs/concepts/services-networking/ingress/#default-ingress-class
@@ -496,6 +500,11 @@ data:
         "localGatewayService" : "{{ .Values.kserve.controller.gateway.localGateway.gatewayService }}",
         "ingressClassName" : "{{ .Values.kserve.controller.gateway.ingressGateway.className }}",
         "ingressDomain"  : "{{ .Values.kserve.controller.gateway.domain }}",
+        "additionalIngressDomains": [
+            {{- range $index, $flag := .Values.kserve.controller.gateway.additionalIngressDomains }}
+              {{ $flag | quote }} {{ if ne $index (sub (len $.Values.kserve.controller.gateway.additionalIngressDomains) 1)}}, {{ end }}
+            {{- end}}
+        ],
         "domainTemplate": "{{ .Values.kserve.controller.gateway.domainTemplate }}",
         "urlScheme": "{{ .Values.kserve.controller.gateway.urlScheme }}",
         "disableIstioVirtualHost": {{ .Values.kserve.controller.gateway.disableIstioVirtualHost }},

diff --git a/charts/kserve-resources/values.yaml b/charts/kserve-resources/values.yaml
@@ -35,6 +35,7 @@ kserve:
     rbacProxyImage: gcr.io/kubebuilder/kube-rbac-proxy:v0.13.1
     gateway:
       domain: example.com
+      additionalIngressDomains: []
       domainTemplate: "{{ .Name }}-{{ .Namespace }}.{{ .IngressDomain }}"
       urlScheme: http
       disableIstioVirtualHost: false

diff --git a/config/configmap/inferenceservice.yaml b/config/configmap/inferenceservice.yaml
@@ -196,6 +196,7 @@ data:
            "localGateway" : "knative-serving/knative-local-gateway",
            "localGatewayService" : "knative-local-gateway.istio-system.svc.cluster.local",
            "ingressDomain"  : "example.com",
+           "additionalIngressDomains": ["additional-example.com", "additional-example-1.com"],
            "ingressClassName" : "istio",
            "domainTemplate": "{{ .Name }}-{{ .Namespace }}.{{ .IngressDomain }}",
            "urlScheme": "http",
@@ -225,7 +226,10 @@ data:
            # If ingressDomain is empty then example.com is used as default domain.
            # NOTE: This configuration only applicable for raw deployment.
            "ingressDomain"  : "example.com",
-     
+
+           # additionalIngressDomains specifies the additional domain names which are used for creating the url.
+           "additionalIngressDomains": ["additional-example.com", "additional-example-1.com"]
+
            # ingressClassName specifies the ingress controller to use for ingress traffic.
            # This is optional and if omitted the default ingress in the cluster is used.
            # https://kubernetes.io/docs/concepts/services-networking/ingress/#default-ingress-class

diff --git a/go.sum b/go.sum
diff --git a/pkg/apis/serving/v1beta1/configmap.go b/pkg/apis/serving/v1beta1/configmap.go
@@ -65,17 +65,18 @@ type InferenceServicesConfig struct {
 
 // +kubebuilder:object:generate=false
 type IngressConfig struct {
-	IngressGateway          string  `json:"ingressGateway,omitempty"`
-	IngressServiceName      string  `json:"ingressService,omitempty"`
-	LocalGateway            string  `json:"localGateway,omitempty"`
-	LocalGatewayServiceName string  `json:"localGatewayService,omitempty"`
-	IngressDomain           string  `json:"ingressDomain,omitempty"`
-	IngressClassName        *string `json:"ingressClassName,omitempty"`
-	DomainTemplate          string  `json:"domainTemplate,omitempty"`
-	UrlScheme               string  `json:"urlScheme,omitempty"`
-	DisableIstioVirtualHost bool    `json:"disableIstioVirtualHost,omitempty"`
-	PathTemplate            string  `json:"pathTemplate,omitempty"`
-	DisableIngressCreation  bool    `json:"disableIngressCreation,omitempty"`
+	IngressGateway           string    `json:"ingressGateway,omitempty"`
+	IngressServiceName       string    `json:"ingressService,omitempty"`
+	LocalGateway             string    `json:"localGateway,omitempty"`
+	LocalGatewayServiceName  string    `json:"localGatewayService,omitempty"`
+	IngressDomain            string    `json:"ingressDomain,omitempty"`
+	IngressClassName         *string   `json:"ingressClassName,omitempty"`
+	AdditionalIngressDomains *[]string `json:"additionalIngressDomains,omitempty"`
+	DomainTemplate           string    `json:"domainTemplate,omitempty"`
+	UrlScheme                string    `json:"urlScheme,omitempty"`
+	DisableIstioVirtualHost  bool      `json:"disableIstioVirtualHost,omitempty"`
+	PathTemplate             string    `json:"pathTemplate,omitempty"`
+	DisableIngressCreation   bool      `json:"disableIngressCreation,omitempty"`
 }
 
 // +kubebuilder:object:generate=false

diff --git a/pkg/apis/serving/v1beta1/configmap_test.go b/pkg/apis/serving/v1beta1/configmap_test.go
@@ -17,61 +17,36 @@ limitations under the License.
 package v1beta1
 
 import (
-	ctx "context"
-	logger "log"
+	"fmt"
 	"testing"
 
 	"github.com/kserve/kserve/pkg/constants"
 	"github.com/onsi/gomega"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	fakeclientset "k8s.io/client-go/kubernetes/fake"
-	"sigs.k8s.io/controller-runtime/pkg/client"
-	fakeclient "sigs.k8s.io/controller-runtime/pkg/client/fake"
 )
 
-func createFakeClient() client.WithWatch {
-	clientBuilder := fakeclient.NewClientBuilder()
-	fakeClient := clientBuilder.Build()
-	configMap := &v1.ConfigMap{
-		TypeMeta: metav1.TypeMeta{
-			Kind:       "ConfigMap",
-			APIVersion: "",
-		},
-		ObjectMeta: metav1.ObjectMeta{
-			Name:      constants.InferenceServiceConfigMapName,
-			Namespace: constants.KServeNamespace,
-		},
-		Immutable: nil,
-		Data:      map[string]string{},
-		BinaryData: map[string][]byte{
-			ExplainerConfigKeyName: []byte(`{                                                                                                                                                                                               │
-				     "art": {                                                                                                                                                                                                    │
-				         "image" : "kserve/art-explainer",                                                                                                                                                                       │
-				         "defaultImageVersion": "latest"                                                                                                                                                                         │
-				     }                                                                                                                                                                                                           │
-			}`),
-			IngressConfigKeyName: []byte(`{                                                                                                                                                                                                               │
-     				"ingressGateway" : "knative-serving/knative-ingress-gateway",                                                                                                                                               │
-     				"ingressService" : "istio-ingressgateway.istio-system.svc.cluster.local",                                                                                                                                   │
-     				"localGateway" : "knative-serving/knative-local-gateway",                                                                                                                                                   │
-     				"localGatewayService" : "knative-local-gateway.istio-system.svc.cluster.local",                                                                                                                             │
-     				"ingressDomain"  : "example.com",                                                                                                                                                                           │
-     				"ingressClassName" : "istio",                                                                                                                                                                               │
-     				"domainTemplate": "{{ .Name }}-{{ .Namespace }}.{{ .IngressDomain }}",                                                                                                                                      │
-     				"urlScheme": "http"                                                                                                                                                                                         │
- 			}`),
-			DeployConfigName: []byte(`{                                                                                                                                                                                                               │
-   				"defaultDeploymentMode": "Serverless"                                                                                                                                                                         │
- 			}`),
-		},
-	}
-	err := fakeClient.Create(ctx.TODO(), configMap)
-	if err != nil {
-		logger.Fatalf("Unable to create configmap: %v", err)
-	}
-	return fakeClient
-}
+var (
+	KnativeIngressGateway = "knative-serving/knative-ingress-gateway"
+	IngressService        = "test-destination"
+	KnativeLocalGateway   = "knative-serving/knative-local-gateway"
+	LocalGatewayService   = "knative-local-gateway.istio-system.svc.cluster.local"
+	UrlScheme             = "https"
+	IngressDomain         = "example.com"
+	AdditionalDomain      = "additional-example.com"
+	AdditionalDomainExtra = "additional-example-extra.com"
+	IngressConfigData     = fmt.Sprintf(`{
+		"ingressGateway" : "%s",
+		"ingressService" : "%s",
+		"localGateway" : "%s",
+		"localGatewayService" : "%s",
+		"ingressDomain": "%s",
+		"urlScheme": "https",
+        "additionalIngressDomains": ["%s","%s"]
+	}`, KnativeIngressGateway, IngressService, KnativeLocalGateway, LocalGatewayService, IngressDomain,
+		AdditionalDomain, AdditionalDomainExtra)
+)
 
 func TestNewInferenceServiceConfig(t *testing.T) {
 	g := gomega.NewGomegaWithT(t)
@@ -87,10 +62,21 @@ func TestNewIngressConfig(t *testing.T) {
 	g := gomega.NewGomegaWithT(t)
 	clientset := fakeclientset.NewSimpleClientset(&v1.ConfigMap{
 		ObjectMeta: metav1.ObjectMeta{Name: constants.InferenceServiceConfigMapName, Namespace: constants.KServeNamespace},
+		Data: map[string]string{
+			IngressConfigKeyName: IngressConfigData,
+		},
 	})
 	ingressCfg, err := NewIngressConfig(clientset)
 	g.Expect(err).Should(gomega.BeNil())
 	g.Expect(ingressCfg).ShouldNot(gomega.BeNil())
+
+	g.Expect(ingressCfg.IngressGateway).To(gomega.Equal(KnativeIngressGateway))
+	g.Expect(ingressCfg.IngressServiceName).To(gomega.Equal(IngressService))
+	g.Expect(ingressCfg.LocalGateway).To(gomega.Equal(KnativeLocalGateway))
+	g.Expect(ingressCfg.LocalGatewayServiceName).To(gomega.Equal(LocalGatewayService))
+	g.Expect(ingressCfg.UrlScheme).To(gomega.Equal(UrlScheme))
+	g.Expect(ingressCfg.IngressDomain).To(gomega.Equal(IngressDomain))
+	g.Expect(*ingressCfg.AdditionalIngressDomains).To(gomega.Equal([]string{AdditionalDomain, AdditionalDomainExtra}))
 }
 
 func TestNewDeployConfig(t *testing.T) {

diff --git a/pkg/apis/serving/v1beta1/openapi_generated.go b/pkg/apis/serving/v1beta1/openapi_generated.go
diff --git a/pkg/apis/serving/v1beta1/swagger.json b/pkg/apis/serving/v1beta1/swagger.json
@@ -2699,6 +2699,13 @@
     "v1beta1.IngressConfig": {
       "type": "object",
       "properties": {
+        "additionalIngressDomains": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "default": ""
+          }
+        },
         "disableIngressCreation": {
           "type": "boolean"
         },

diff --git a/pkg/constants/constants.go b/pkg/constants/constants.go
@@ -360,6 +360,10 @@ const (
 	ModelMeshDeployment DeploymentModeType = "ModelMesh"
 )
 
+const (
+	DefaultNSKnativeServing = "knative-serving"
+)
+
 // built-in runtime servers
 const (
 	SKLearnServer = "kserve-sklearnserver"

diff --git a/pkg/controller/v1beta1/inferenceservice/controller.go b/pkg/controller/v1beta1/inferenceservice/controller.go
@@ -230,7 +230,7 @@ func (r *InferenceServiceReconciler) Reconcile(ctx context.Context, req ctrl.Req
 			return reconcile.Result{}, errors.Wrapf(err, "fails to reconcile ingress")
 		}
 	} else {
-		reconciler := ingress.NewIngressReconciler(r.Client, r.Scheme, ingressConfig)
+		reconciler := ingress.NewIngressReconciler(r.Client, r.Clientset, r.Scheme, ingressConfig)
 		r.Log.Info("Reconciling ingress for inference service", "isvc", isvc.Name)
 		if err := reconciler.Reconcile(isvc); err != nil {
 			return reconcile.Result{}, errors.Wrapf(err, "fails to reconcile ingress")