Skip to content

implement GEP-718: rework RouteForwardTo #750

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 6, 2021
Merged

implement GEP-718: rework RouteForwardTo #750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
125 changes: 24 additions & 101 deletions apis/v1alpha2/httproute_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,14 +240,19 @@ type HTTPRouteRule struct {
// +kubebuilder:validation:MaxItems=16
Filters []HTTPRouteFilter `json:"filters,omitempty"`

// ForwardTo defines the backend(s) where matching requests should be sent.
// If unspecified, the rule performs no forwarding. If unspecified and no
// filters are specified that would result in a response being sent, a 503
// error code is returned.
// BackendRefs defines the backend(s) where matching requests should be
// sent. If unspecified, the rule performs no forwarding. If unspecified and
// no filters are specified that would result in a response being sent,
// a HTTP 503 status code is returned.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
//
// Support for weight: Core
//
// +optional
// +kubebuilder:validation:MaxItems=16
ForwardTo []HTTPRouteForwardTo `json:"forwardTo,omitempty"`
BackendRefs []HTTPBackendRef `json:"backendRefs,omitempty"`
}

// PathMatchType specifies the semantics of how HTTP paths should be compared.
Expand Down Expand Up @@ -563,7 +568,7 @@ const (
//
// Support in HTTPRouteRule: Core
//
// Support in HTTPRouteForwardTo: Extended
// Support in HTTPBackendRef: Extended
HTTPRouteFilterRequestHeaderModifier HTTPRouteFilterType = "RequestHeaderModifier"

// HTTPRouteFilterRequestRedirect can be used to redirect a request to
Expand All @@ -572,7 +577,7 @@ const (
//
// Support in HTTPRouteRule: Core
//
// Support in HTTPRouteForwardTo: Extended
// Support in HTTPBackendRef: Extended
HTTPRouteFilterRequestRedirect HTTPRouteFilterType = "RequestRedirect"

// HTTPRouteFilterRequestMirror can be used to mirror HTTP requests to a
Expand All @@ -581,15 +586,15 @@ const (
//
// Support in HTTPRouteRule: Extended
//
// Support in HTTPRouteForwardTo: Extended
// Support in HTTPBackendRef: Extended
HTTPRouteFilterRequestMirror HTTPRouteFilterType = "RequestMirror"

// HTTPRouteFilterExtensionRef should be used for configuring custom
// HTTP filters.
//
// Support in HTTPRouteRule: Custom
//
// Support in HTTPRouteForwardTo: Custom
// Support in HTTPBackendRef: Custom
HTTPRouteFilterExtensionRef HTTPRouteFilterType = "ExtensionRef"
)

Expand Down Expand Up @@ -716,112 +721,30 @@ type HTTPRequestRedirect struct {

// HTTPRequestMirrorFilter defines configuration for the RequestMirror filter.
type HTTPRequestMirrorFilter struct {
// ServiceName refers to the name of the Service to mirror matched requests
// to. When specified, this takes the place of BackendRef. If both
// BackendRef and ServiceName are specified, ServiceName will be given
// precedence.
// BackendRef references a resource where mirrored requests are sent.
//
// If the referent cannot be found, the rule is not included in the route.
// The controller should raise the "ResolvedRefs" condition on the Gateway
// with the "DegradedRoutes" reason. The gateway status for this route should
// be updated with a condition that describes the error more specifically.
//
// Support: Core
// Support: Extended for Kubernetes Service
// Support: Custom for any other resource
//
// +optional
// +kubebuilder:validation:MaxLength=253
ServiceName *string `json:"serviceName,omitempty"`
BackendRef *BackendObjectReference `json:"backendRef,omitempty"`
}

// BackendRef is a local object reference to mirror matched requests to. If
// both BackendRef and ServiceName are specified, ServiceName will be given
// precedence.
// HTTPBackendRef defines how a HTTPRoute should forward an HTTP request.
type HTTPBackendRef struct {
// BackendRef defines how a Route should forward a request to a Kubernetes
// resource.
//
// If the referent cannot be found, the rule is not included in the route.
// The controller should raise the "ResolvedRefs" condition on the Gateway
// with the "DegradedRoutes" reason. The gateway status for this route should
// be updated with a condition that describes the error more specifically.
//
// Support: Custom
//
// +optional
BackendRef *LocalObjectReference `json:"backendRef,omitempty"`

// Port specifies the destination port number to use for the
// backend referenced by the ServiceName or BackendRef field.
//
// If unspecified, the destination port in the request is used
// when forwarding to a backendRef or serviceName.
//
// +optional
Port *PortNumber `json:"port,omitempty"`
}

// HTTPRouteForwardTo defines how a HTTPRoute should forward a request.
type HTTPRouteForwardTo struct {
// ServiceName refers to the name of the Service to forward matched requests
// to. When specified, this takes the place of BackendRef. If both
// BackendRef and ServiceName are specified, ServiceName will be given
// precedence.
//
// If the referent cannot be found, the route must be dropped
// from the Gateway. The controller should raise the "ResolvedRefs"
// condition on the Gateway with the "DegradedRoutes" reason.
// The gateway status for this route should be updated with a
// condition that describes the error more specifically.
//
// The protocol to use should be specified with the AppProtocol field on
// Service resources.
//
// Support: Core
//
// +optional
// +kubebuilder:validation:MaxLength=253
ServiceName *string `json:"serviceName,omitempty"`

// BackendRef is a reference to a backend to forward matched requests to. If
// both BackendRef and ServiceName are specified, ServiceName will be given
// precedence.
//
// If the referent cannot be found, the route must be dropped
// from the Gateway. The controller should raise the "ResolvedRefs"
// condition on the Gateway with the "DegradedRoutes" reason.
// The gateway status for this route should be updated with a
// condition that describes the error more specifically.
//
// Support: Custom
//
// +optional
BackendRef *LocalObjectReference `json:"backendRef,omitempty"`

// Port specifies the destination port number to use for the
// backend referenced by the ServiceName or BackendRef field.
// If unspecified, the destination port in the request is used
// when forwarding to a backendRef or serviceName.
//
// Support: Core
//
// +optional
Port *PortNumber `json:"port,omitempty"`

// Weight specifies the proportion of HTTP requests forwarded to the backend
// referenced by the ServiceName or BackendRef field. This is computed as
// weight/(sum of all weights in this ForwardTo list). For non-zero values,
// there may be some epsilon from the exact proportion defined here
// depending on the precision an implementation supports. Weight is not a
// percentage and the sum of weights does not need to equal 100.
//
// If only one backend is specified and it has a weight greater than 0, 100%
// of the traffic is forwarded to that backend. If weight is set to 0,
// traffic must not be forwarded for this entry. If unspecified, weight
// defaults to 1.
//
// Support: Core
//
// +optional
// +kubebuilder:default=1
// +kubebuilder:validation:Minimum=0
// +kubebuilder:validation:Maximum=1000000
Weight *int32 `json:"weight,omitempty"`
BackendRef `json:",inline"`

// Filters defined at this-level should be executed if and only if the
// request is being forwarded to the backend defined here.
Expand Down
68 changes: 32 additions & 36 deletions apis/v1alpha2/shared_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,53 +77,49 @@ type GatewayReference struct {
Namespace string `json:"namespace"`
}

// RouteForwardTo defines how a Route should forward a request.
type RouteForwardTo struct {
// ServiceName refers to the name of the Service to forward matched requests
// to. When specified, this takes the place of BackendRef. If both
// BackendRef and ServiceName are specified, ServiceName will be given
// precedence.
//
// If the referent cannot be found, the rule is not included in the route.
// The controller should raise the "ResolvedRefs" condition on the Gateway
// with the "DegradedRoutes" reason. The gateway status for this route should
// be updated with a condition that describes the error more specifically.
//
// The protocol to use should be specified with the AppProtocol field on
// Service resources.
//
// Support: Core
// BackendObjectReference defines how an ObjectReference that is
// specific to BackendRef. It includes a few additional fields and features
// than a regular ObjectReference.
type BackendObjectReference struct {
// Group is the group of the referent.
// When unspecified (empty string), core API group is inferred.
//
// +optional
// +kubebuilder:default=""
// +kubebuilder:validation:MaxLength=253
ServiceName *string `json:"serviceName,omitempty"`
Group *string `json:"group"`

// BackendRef is a reference to a backend to forward matched requests to. If
// both BackendRef and ServiceName are specified, ServiceName will be given
// precedence.
//
// If the referent cannot be found, the rule is not included in the route.
// The controller should raise the "ResolvedRefs" condition on the Gateway
// with the "DegradedRoutes" reason. The gateway status for this route should
// be updated with a condition that describes the error more specifically.
//
// Support: Custom
// Kind is kind of the referent.
//
// +optional
BackendRef *LocalObjectReference `json:"backendRef,omitempty"`
// +kubebuilder:default=Service
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=253
Kind *string `json:"kind"`

// Port specifies the destination port number to use for the
// backend referenced by the ServiceName or BackendRef field.
// If unspecified, the destination port in the request is used
// when forwarding to a backendRef or serviceName.
// Name is the name of the referent.
//
// Support: Core
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=253
Name string `json:"name"`

// Port specifies the destination port number to use for this resource.
// Port is required when the referent is a Kubernetes Service.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created #753 to track webhook validation for this.

// For other resources, destination port can be derived from the referent
// resource or this field.
//
// +optional
Port *PortNumber `json:"port,omitempty"`
}

// BackendRef defines how a Route should forward a request to a Kubernetes
// resource.
type BackendRef struct {
// BackendObjectReference references a Kubernetes object.
BackendObjectReference `json:",inline"`

// Weight specifies the proportion of HTTP requests forwarded to the backend
// referenced by the ServiceName or BackendRef field. This is computed as
// Weight specifies the proportion of HTTP requests forwarded to the
// referenced backend. This is computed as
// weight/(sum of all weights in this ForwardTo list). For non-zero values,
// there may be some epsilon from the exact proportion defined here
// depending on the precision an implementation supports. Weight is not a
Expand All @@ -134,7 +130,7 @@ type RouteForwardTo struct {
// traffic should be forwarded for this entry. If unspecified, weight
// defaults to 1.
//
// Support: Extended
// Support for this field varies based on the context where used.
//
// +optional
// +kubebuilder:default=1
Expand Down
11 changes: 8 additions & 3 deletions apis/v1alpha2/tcproute_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,17 @@ type TCPRouteRule struct {
// +kubebuilder:validation:MaxItems=8
Matches []TCPRouteMatch `json:"matches,omitempty"`

// ForwardTo defines the backend(s) where matching requests should
// be sent.
// BackendRefs defines the backend(s) where matching requests should be
// sent.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
//
// Support for weight: Extended
//
// +kubebuilder:validation:MinItems=1
// +kubebuilder:validation:MaxItems=16
ForwardTo []RouteForwardTo `json:"forwardTo"`
BackendRefs []BackendRef `json:"backendRefs,omitempty"`
}

// TCPRouteMatch defines the predicate used to match connections to a
Expand Down
9 changes: 7 additions & 2 deletions apis/v1alpha2/tlsroute_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,17 @@ type TLSRouteRule struct {
// +kubebuilder:validation:MaxItems=8
Matches []TLSRouteMatch `json:"matches,omitempty"`

// ForwardTo defines the backend(s) where matching requests should be
// BackendRefs defines the backend(s) where matching requests should be
// sent.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
//
// Support for weight: Extended
//
// +kubebuilder:validation:MinItems=1
// +kubebuilder:validation:MaxItems=16
ForwardTo []RouteForwardTo `json:"forwardTo"`
BackendRefs []BackendRef `json:"backendRefs,omitempty"`
}

// TLSRouteMatch defines the predicate used to match connections to a
Expand Down
11 changes: 8 additions & 3 deletions apis/v1alpha2/udproute_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,17 @@ type UDPRouteRule struct {
// +kubebuilder:validation:MaxItems=8
Matches []UDPRouteMatch `json:"matches,omitempty"`

// ForwardTo defines the backend(s) where matching requests should
// be sent.
// BackendRefs defines the backend(s) where matching requests should be
// sent.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
//
// Support for weight: Extended
//
// +kubebuilder:validation:MinItems=1
// +kubebuilder:validation:MaxItems=16
ForwardTo []RouteForwardTo `json:"forwardTo"`
BackendRefs []BackendRef `json:"backendRefs,omitempty"`
}

// UDPRouteMatch defines the predicate used to match packets to a
Expand Down
Loading