Integrate GRPCRoute into NIMService

Signed-off-by: Sheng Lin <[email protected]>

Author: shengnuo

api/apps/v1alpha1/common_types.go

@@ -85,6 +85,10 @@ type Gateway struct {
 	// +kubebuilder:default:=true
 	// HTTPRoutesEnabled is a flag to enable HTTPRoutes for the created gateway.
 	HTTPRoutesEnabled bool `json:"httpRoutesEnabled,omitempty"`
+
+	// +kubebuilder:default:=false
+	// GRPCRoutesEnabled is a flag to enable GRPCRoutes for the created gateway.
+	GRPCRoutesEnabled bool `json:"grpcRoutesEnabled,omitempty"`
 }
 
 // DEPRECATED ExposeV1 defines attributes to expose the service.
@@ -270,6 +274,38 @@ func (r *Router) GenerateGatewayHTTPRouteSpec(namespace, name string, port int32
 	}
 }
 
+func (r *Router) GenerateGatewayGRPCRouteSpec(namespace, name string, port int32) gatewayv1.GRPCRouteSpec {
+	if r.Gateway == nil || !r.Gateway.GRPCRoutesEnabled {
+		return gatewayv1.GRPCRouteSpec{}
+	}
+
+	return gatewayv1.GRPCRouteSpec{
+		CommonRouteSpec: gatewayv1.CommonRouteSpec{
+			ParentRefs: []gatewayv1.ParentReference{
+				{
+					Name:      gatewayv1.ObjectName(r.Gateway.Name),
+					Namespace: ptr.To(gatewayv1.Namespace(r.Gateway.Namespace)),
+				},
+			},
+		},
+		Hostnames: []gatewayv1.Hostname{gatewayv1.Hostname(r.getHostname(namespace, name))},
+		Rules: []gatewayv1.GRPCRouteRule{
+			{
+				BackendRefs: []gatewayv1.GRPCBackendRef{
+					{
+						BackendRef: gatewayv1.BackendRef{
+							BackendObjectReference: gatewayv1.BackendObjectReference{
+								Name: gatewayv1.ObjectName(name),
+								Port: ptr.To(gatewayv1.PortNumber(port)),
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
 func (r *Router) getHostname(namespace, name string) string {
 	return fmt.Sprintf("%s.%s.%s", name, namespace, r.HostDomainName)
 }

api/apps/v1alpha1/nimservice_types.go

@@ -963,6 +963,14 @@ func (n *NIMService) GetHTTPRouteSpec() gatewayv1.HTTPRouteSpec {
 	return n.Spec.Router.GenerateGatewayHTTPRouteSpec(n.GetNamespace(), n.GetName(), n.GetServicePort())
 }
 
+func (n *NIMService) IsGRPCRouteEnabled() bool {
+	return n.Spec.Router.Gateway != nil && n.Spec.Router.Gateway.GRPCRoutesEnabled
+}
+
+func (n *NIMService) GetGRPCRouteSpec() gatewayv1.GRPCRouteSpec {
+	return n.Spec.Router.GenerateGatewayGRPCRouteSpec(n.GetNamespace(), n.GetName(), n.GetServicePort())
+}
+
 // IsServiceMonitorEnabled returns true if servicemonitor is enabled for NIMService deployment.
 func (n *NIMService) IsServiceMonitorEnabled() bool {
 	return n.Spec.Metrics.Enabled != nil && *n.Spec.Metrics.Enabled
@@ -1350,6 +1358,16 @@ func (n *NIMService) GetHTTPRouteParams() *rendertypes.HTTPRouteParams {
 	return params
 }
 
+func (n *NIMService) GetGRPCRouteParams() *rendertypes.GRPCRouteParams {
+	params := &rendertypes.GRPCRouteParams{}
+	params.Enabled = n.IsGRPCRouteEnabled()
+	params.Name = n.GetName()
+	params.Namespace = n.GetNamespace()
+	params.Labels = n.GetServiceLabels()
+	params.Spec = n.GetGRPCRouteSpec()
+	return params
+}
+
 // GetRoleParams returns params to render Role from templates.
 func (n *NIMService) GetRoleParams() *rendertypes.RoleParams {
 	params := &rendertypes.RoleParams{}

bundle/manifests/apps.nvidia.com_nemocustomizers.yaml

@@ -1213,6 +1213,11 @@ spec:
                   gateway:
                     description: Gateway is the gateway to use for the created HTTPRoute.
                     properties:
+                      grpcRoutesEnabled:
+                        default: false
+                        description: GRPCRoutesEnabled is a flag to enable GRPCRoutes
+                          for the created gateway.
+                        type: boolean
                       httpRoutesEnabled:
                         default: true
                         description: HTTPRoutesEnabled is a flag to enable HTTPRoutes

bundle/manifests/apps.nvidia.com_nemodatastores.yaml

@@ -892,6 +892,11 @@ spec:
                   gateway:
                     description: Gateway is the gateway to use for the created HTTPRoute.
                     properties:
+                      grpcRoutesEnabled:
+                        default: false
+                        description: GRPCRoutesEnabled is a flag to enable GRPCRoutes
+                          for the created gateway.
+                        type: boolean
                       httpRoutesEnabled:
                         default: true
                         description: HTTPRoutesEnabled is a flag to enable HTTPRoutes

bundle/manifests/apps.nvidia.com_nemoentitystores.yaml

@@ -822,6 +822,11 @@ spec:
                   gateway:
                     description: Gateway is the gateway to use for the created HTTPRoute.
                     properties:
+                      grpcRoutesEnabled:
+                        default: false
+                        description: GRPCRoutesEnabled is a flag to enable GRPCRoutes
+                          for the created gateway.
+                        type: boolean
                       httpRoutesEnabled:
                         default: true
                         description: HTTPRoutesEnabled is a flag to enable HTTPRoutes

bundle/manifests/apps.nvidia.com_nemoevaluators.yaml

@@ -958,6 +958,11 @@ spec:
                   gateway:
                     description: Gateway is the gateway to use for the created HTTPRoute.
                     properties:
+                      grpcRoutesEnabled:
+                        default: false
+                        description: GRPCRoutesEnabled is a flag to enable GRPCRoutes
+                          for the created gateway.
+                        type: boolean
                       httpRoutesEnabled:
                         default: true
                         description: HTTPRoutesEnabled is a flag to enable HTTPRoutes

bundle/manifests/apps.nvidia.com_nemoguardrails.yaml

@@ -885,6 +885,11 @@ spec:
                   gateway:
                     description: Gateway is the gateway to use for the created HTTPRoute.
                     properties:
+                      grpcRoutesEnabled:
+                        default: false
+                        description: GRPCRoutesEnabled is a flag to enable GRPCRoutes
+                          for the created gateway.
+                        type: boolean
                       httpRoutesEnabled:
                         default: true
                         description: HTTPRoutesEnabled is a flag to enable HTTPRoutes

bundle/manifests/apps.nvidia.com_nimpipelines.yaml

@@ -1678,6 +1678,11 @@ spec:
                               description: Gateway is the gateway to use for the created
                                 HTTPRoute.
                               properties:
+                                grpcRoutesEnabled:
+                                  default: false
+                                  description: GRPCRoutesEnabled is a flag to enable
+                                    GRPCRoutes for the created gateway.
+                                  type: boolean
                                 httpRoutesEnabled:
                                   default: true
                                   description: HTTPRoutesEnabled is a flag to enable

bundle/manifests/apps.nvidia.com_nimservices.yaml

@@ -1601,6 +1601,11 @@ spec:
                   gateway:
                     description: Gateway is the gateway to use for the created HTTPRoute.
                     properties:
+                      grpcRoutesEnabled:
+                        default: false
+                        description: GRPCRoutesEnabled is a flag to enable GRPCRoutes
+                          for the created gateway.
+                        type: boolean
                       httpRoutesEnabled:
                         default: true
                         description: HTTPRoutesEnabled is a flag to enable HTTPRoutes

bundle/manifests/k8s-nim-operator.clusterserviceversion.yaml

@@ -1349,6 +1349,7 @@ spec:
               - gateway.networking.k8s.io
               resources:
               - httproutes
+              - grpcroutes
               verbs:
               - create
               - delete