HTTPRoute [httproutes.gateway.networking.k8s.io/v1]
gateway.networking.k8s.io group
HTTPRoute provides a way to route HTTP requests. This includes the capability to match requests by hostname, path, header, or query param. Filters can be used to specify additional processing steps. Backends specify where matching requests should be routed.
v1 versionspec object required
Spec defines the desired state of HTTPRoute.
hostnames []string
Hostnames defines a set of hostnames that should match against the HTTP Host header to select a HTTPRoute used to process the request. Implementations MUST ignore any port value specified in the HTTP Host header while performing a match and (absent of any applicable header modification configuration) MUST forward this header unmodified to the backend.
Valid values for Hostnames are determined by RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
*.). The wildcard label must appear by itself as the first label.
If a hostname is specified by both the Listener and HTTPRoute, there must be at least one intersecting hostname for the HTTPRoute to be attached to the Listener. For example:
- A Listener with
test.example.comas the hostname matches HTTPRoutes that have either not specified any hostnames, or have specified at least one oftest.example.comor*.example.com. - A Listener with
*.example.comas the hostname matches HTTPRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example,*.example.com,test.example.com, andfoo.test.example.comwould all match. On the other hand,example.comandtest.example.netwould not match.
Hostnames that are prefixed with a wildcard label (*.) are interpreted
as a suffix match. That means that a match for *.example.com would match
both test.example.com, and foo.test.example.com, but not example.com.
If both the Listener and HTTPRoute have specified hostnames, any
HTTPRoute hostnames that do not match the Listener hostname MUST be
ignored. For example, if a Listener specified *.example.com, and the
HTTPRoute specified test.example.com and test.example.net,
test.example.net must not be considered for a match.
If both the Listener and HTTPRoute have specified hostnames, and none
match with the criteria above, then the HTTPRoute is not accepted. The
implementation must raise an 'Accepted' Condition with a status of
False in the corresponding RouteParentStatus.
In the event that multiple HTTPRoutes specify intersecting hostnames (e.g. overlapping wildcard matching and exact matching hostnames), precedence must be given to rules from the HTTPRoute with the largest number of:
- Characters in a matching non-wildcard hostname.
- Characters in a matching hostname.
If ties exist across multiple Routes, the matching precedence rules for HTTPRouteMatches takes over.
Support: Core
parentRefs []object
ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with "Core" support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
This API may be extended in the future to support additional kinds of parent resources.
The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.
group string
Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string).
Support: Core
kind string
Kind is kind of the referent.
There are two kinds of parent resources with "Core" support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
name string required
Name is the name of the referent.
Support: Core
namespace string
Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route.
Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference.
Support: Core
port integer
Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource.
When the parent resource is a Gateway, this targets all listeners
listening on the specified port that also support this kind of Route(and
select this Route). It's not recommended to set Port unless the
networking behaviors specified in a Route must apply to a specific port
as opposed to a listener(s) whose port(s) may be changed. When both Port
and SectionName are specified, the name and port of the selected listener
must match both specified values.
Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted.
For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Extended
sectionName string
SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following:
- Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
- Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted.
When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Core
rules []object
HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).
backendRefs []object
HTTPBackendRef defines how a HTTPRoute forwards a HTTP request.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
filters []object
HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.
extensionRef object
ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters.
This filter can be used multiple times within the same rule.
Support: Implementation-specific
group string required
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string required
Kind is kind of the referent. For example "HTTPRoute" or "Service".
name string required
Name is the name of the referent.
requestHeaderModifier object
RequestHeaderModifier defines a schema for a filter that modifies request headers.
Support: Core
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
requestMirror object
RequestMirror defines a schema for a filter that mirrors requests. Requests are sent to the specified destination, but responses from that destination are ignored.
This filter can be used multiple times within the same rule. Note that not all implementations will be able to support mirroring to multiple backends.
Support: Extended
backendRef object required
BackendRef references a resource where mirrored requests are sent.
Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef.
If the referent cannot be found, this BackendRef is invalid and must be
dropped from the Gateway. The controller must ensure the "ResolvedRefs"
condition on the Route status is set to status: False and not configure
this backend in the underlying implementation.
If there is a cross-namespace reference to an existing object
that is not allowed by a ReferenceGrant, the controller must ensure the
"ResolvedRefs" condition on the Route is set to status: False,
with the "RefNotPermitted" reason and not configure this backend in the
underlying implementation.
In either error case, the Message of the ResolvedRefs Condition
should be used to provide more detail about the problem.
Support: Extended for Kubernetes Service
Support: Implementation-specific for any other resource
group string
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string
Kind is the Kubernetes resource kind of the referent. For example "Service".
Defaults to "Service" when not specified.
ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.
Support: Core (Services with a type other than ExternalName)
Support: Implementation-specific (Services with type ExternalName)
name string required
Name is the name of the referent.
namespace string
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
Support: Core
port integer
Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
fraction object
Fraction represents the fraction of requests that should be mirrored to BackendRef.
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
denominator integer
numerator integer required
percent integer
Percent represents the percentage of requests that should be mirrored to BackendRef. Its minimum value is 0 (indicating 0% of requests) and its maximum value is 100 (indicating 100% of requests).
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
requestRedirect object
RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection.
Support: Core
hostname string
Hostname is the hostname to be used in the value of the Location
header in the response.
When empty, the hostname in the Host header of the request is used.
Support: Core
path object
Path defines parameters used to modify the path of the incoming request.
The modified path is then used to construct the Location header. When
empty, the request path is used as-is.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
port integer
Port is the port to be used in the value of the Location
header in the response.
If no port is specified, the redirect port MUST be derived using the following rules:
- If redirect scheme is not-empty, the redirect port MUST be the well-known port associated with the redirect scheme. Specifically "http" to port 80 and "https" to port 443. If the redirect scheme does not have a well-known port, the listener port of the Gateway SHOULD be used.
- If redirect scheme is empty, the redirect port MUST be the Gateway Listener port.
Implementations SHOULD NOT add the port number in the 'Location' header in the following cases:
- A Location header that will use HTTP (whether that is determined via the Listener protocol or the Scheme field) and use port 80.
- A Location header that will use HTTPS (whether that is determined via the Listener protocol or the Scheme field) and use port 443.
Support: Extended
scheme string
Scheme is the scheme to be used in the value of the Location header in
the response. When empty, the scheme of the request is used.
Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Extended
statusCode integer
StatusCode is the HTTP status code to be used in response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Core
responseHeaderModifier object
ResponseHeaderModifier defines a schema for a filter that modifies response headers.
Support: Extended
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
type string required
Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:
-
Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations must support core filters.
-
Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters.
-
Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field.
Typeshould be set to "ExtensionRef" for custom filters.
Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.
If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
urlRewrite object
URLRewrite defines a schema for a filter that modifies a request during forwarding.
Support: Extended
hostname string
Hostname is the value to be used to replace the Host header value during forwarding.
Support: Extended
path object
Path defines a path rewrite.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
group string
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string
Kind is the Kubernetes resource kind of the referent. For example "Service".
Defaults to "Service" when not specified.
ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.
Support: Core (Services with a type other than ExternalName)
Support: Implementation-specific (Services with type ExternalName)
name string required
Name is the name of the referent.
namespace string
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
Support: Core
port integer
Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
weight integer
Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs 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, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1.
Support for this field varies based on the context where used.
filters []object
HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.
extensionRef object
ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters.
This filter can be used multiple times within the same rule.
Support: Implementation-specific
group string required
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string required
Kind is kind of the referent. For example "HTTPRoute" or "Service".
name string required
Name is the name of the referent.
requestHeaderModifier object
RequestHeaderModifier defines a schema for a filter that modifies request headers.
Support: Core
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
requestMirror object
RequestMirror defines a schema for a filter that mirrors requests. Requests are sent to the specified destination, but responses from that destination are ignored.
This filter can be used multiple times within the same rule. Note that not all implementations will be able to support mirroring to multiple backends.
Support: Extended
backendRef object required
BackendRef references a resource where mirrored requests are sent.
Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef.
If the referent cannot be found, this BackendRef is invalid and must be
dropped from the Gateway. The controller must ensure the "ResolvedRefs"
condition on the Route status is set to status: False and not configure
this backend in the underlying implementation.
If there is a cross-namespace reference to an existing object
that is not allowed by a ReferenceGrant, the controller must ensure the
"ResolvedRefs" condition on the Route is set to status: False,
with the "RefNotPermitted" reason and not configure this backend in the
underlying implementation.
In either error case, the Message of the ResolvedRefs Condition
should be used to provide more detail about the problem.
Support: Extended for Kubernetes Service
Support: Implementation-specific for any other resource
group string
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string
Kind is the Kubernetes resource kind of the referent. For example "Service".
Defaults to "Service" when not specified.
ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.
Support: Core (Services with a type other than ExternalName)
Support: Implementation-specific (Services with type ExternalName)
name string required
Name is the name of the referent.
namespace string
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
Support: Core
port integer
Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
fraction object
Fraction represents the fraction of requests that should be mirrored to BackendRef.
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
denominator integer
numerator integer required
percent integer
Percent represents the percentage of requests that should be mirrored to BackendRef. Its minimum value is 0 (indicating 0% of requests) and its maximum value is 100 (indicating 100% of requests).
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
requestRedirect object
RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection.
Support: Core
hostname string
Hostname is the hostname to be used in the value of the Location
header in the response.
When empty, the hostname in the Host header of the request is used.
Support: Core
path object
Path defines parameters used to modify the path of the incoming request.
The modified path is then used to construct the Location header. When
empty, the request path is used as-is.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
port integer
Port is the port to be used in the value of the Location
header in the response.
If no port is specified, the redirect port MUST be derived using the following rules:
- If redirect scheme is not-empty, the redirect port MUST be the well-known port associated with the redirect scheme. Specifically "http" to port 80 and "https" to port 443. If the redirect scheme does not have a well-known port, the listener port of the Gateway SHOULD be used.
- If redirect scheme is empty, the redirect port MUST be the Gateway Listener port.
Implementations SHOULD NOT add the port number in the 'Location' header in the following cases:
- A Location header that will use HTTP (whether that is determined via the Listener protocol or the Scheme field) and use port 80.
- A Location header that will use HTTPS (whether that is determined via the Listener protocol or the Scheme field) and use port 443.
Support: Extended
scheme string
Scheme is the scheme to be used in the value of the Location header in
the response. When empty, the scheme of the request is used.
Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Extended
statusCode integer
StatusCode is the HTTP status code to be used in response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Core
responseHeaderModifier object
ResponseHeaderModifier defines a schema for a filter that modifies response headers.
Support: Extended
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
type string required
Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:
-
Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations must support core filters.
-
Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters.
-
Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field.
Typeshould be set to "ExtensionRef" for custom filters.
Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.
If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
urlRewrite object
URLRewrite defines a schema for a filter that modifies a request during forwarding.
Support: Extended
hostname string
Hostname is the value to be used to replace the Host header value during forwarding.
Support: Extended
path object
Path defines a path rewrite.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
matches []object
HTTPRouteMatch defines the predicate used to match requests to a given action. Multiple match types are ANDed together, i.e. the match will evaluate to true only if all conditions are satisfied.
For example, the match below will match a HTTP request only if its path
starts with /foo AND it contains the version: v1 header:
headers []object
HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
When a header is repeated in an HTTP request, it is implementation-specific behavior as to how this is represented. Generally, proxies should follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding processing a repeated header, with special handling for "Set-Cookie".
type string
Type specifies how to match against the value of the header.
Support: Core (Exact)
Support: Implementation-specific (RegularExpression)
Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.
value string required
Value is the value of HTTP Header to be matched.
method string
Method specifies HTTP method matcher. When specified, this route will be matched only if the request has the specified method.
Support: Extended
path object
Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided.
type string
Type specifies how to match against the path Value.
Support: Core (Exact, PathPrefix)
Support: Implementation-specific (RegularExpression)
value string
Value of the HTTP path to match against.
queryParams []object
HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters.
name string required
Name is the name of the HTTP query param to be matched. This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).
If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored.
If a query param is repeated in an HTTP request, the behavior is purposely left undefined, since different data planes have different capabilities. However, it is recommended that implementations should match against the first value of the param if the data plane supports it, as this behavior is expected in other load balancing contexts outside of the Gateway API.
Users SHOULD NOT route traffic based on repeated query params to guard themselves against potential differences in the implementations.
type string
Type specifies how to match against the value of the query parameter.
Support: Extended (Exact)
Support: Implementation-specific (RegularExpression)
Since RegularExpression QueryParamMatchType has Implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.
value string required
Value is the value of HTTP query param to be matched.
name string
Name is the name of the route rule. This name MUST be unique within a Route if it is set.
Support: Extended
timeouts object
Timeouts defines the timeouts that can be configured for an HTTP request.
Support: Extended
backendRequest string
BackendRequest specifies a timeout for an individual request from the gateway to a backend. This covers the time from when the request first starts being sent from the gateway to when the full response has been received from the backend.
Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout completely. Implementations that cannot completely disable the timeout MUST instead interpret the zero duration as the longest possible value to which the timeout can be set.
An entire client HTTP transaction with a gateway, covered by the Request timeout, may result in more than one call from the gateway to the destination backend, for example, if automatic retries are supported.
The value of BackendRequest must be a Gateway API Duration string as defined by GEP-2257. When this field is unspecified, its behavior is implementation-specific; when specified, the value of BackendRequest must be no more than the value of the Request timeout (since the Request timeout encompasses the BackendRequest timeout).
Support: Extended
request string
Request specifies the maximum duration for a gateway to respond to an HTTP request. If the gateway has not been able to respond before this deadline is met, the gateway MUST return a timeout error.
For example, setting the rules.timeouts.request field to the value 10s in an
HTTPRoute will cause a timeout if a client request is taking longer than 10 seconds
to complete.
Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout completely. Implementations that cannot completely disable the timeout MUST instead interpret the zero duration as the longest possible value to which the timeout can be set.
This timeout is intended to cover as close to the whole request-response transaction as possible although an implementation MAY choose to start the timeout after the entire request stream has been received instead of immediately after the transaction is initiated by the client.
The value of Request is a Gateway API Duration string as defined by GEP-2257. When this field is unspecified, request timeout behavior is implementation-specific.
Support: Extended
status object
Status defines the current state of HTTPRoute.
parents []object required
RouteParentStatus describes the status of a route with respect to an associated Parent.
conditions []object required
Condition contains details for one aspect of the current state of this API Resource.
lastTransitionTime string required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message string required
message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration integer
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason string required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status string required
status of the condition, one of True, False, Unknown.
type string required
type of condition in CamelCase or in foo.example.com/CamelCase.
controllerName string required
ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass.
Example: "example.net/gateway-controller".
The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary.
parentRef object required
ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of.
group string
Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string).
Support: Core
kind string
Kind is kind of the referent.
There are two kinds of parent resources with "Core" support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
name string required
Name is the name of the referent.
Support: Core
namespace string
Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route.
Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference.
Support: Core
port integer
Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource.
When the parent resource is a Gateway, this targets all listeners
listening on the specified port that also support this kind of Route(and
select this Route). It's not recommended to set Port unless the
networking behaviors specified in a Route must apply to a specific port
as opposed to a listener(s) whose port(s) may be changed. When both Port
and SectionName are specified, the name and port of the selected listener
must match both specified values.
Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted.
For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Extended
sectionName string
SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following:
- Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
- Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted.
When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Core
HTTPRoute provides a way to route HTTP requests. This includes the capability to match requests by hostname, path, header, or query param. Filters can be used to specify additional processing steps. Backends specify where matching requests should be routed.
v1beta1 versionspec object required
Spec defines the desired state of HTTPRoute.
hostnames []string
Hostnames defines a set of hostnames that should match against the HTTP Host header to select a HTTPRoute used to process the request. Implementations MUST ignore any port value specified in the HTTP Host header while performing a match and (absent of any applicable header modification configuration) MUST forward this header unmodified to the backend.
Valid values for Hostnames are determined by RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
*.). The wildcard label must appear by itself as the first label.
If a hostname is specified by both the Listener and HTTPRoute, there must be at least one intersecting hostname for the HTTPRoute to be attached to the Listener. For example:
- A Listener with
test.example.comas the hostname matches HTTPRoutes that have either not specified any hostnames, or have specified at least one oftest.example.comor*.example.com. - A Listener with
*.example.comas the hostname matches HTTPRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example,*.example.com,test.example.com, andfoo.test.example.comwould all match. On the other hand,example.comandtest.example.netwould not match.
Hostnames that are prefixed with a wildcard label (*.) are interpreted
as a suffix match. That means that a match for *.example.com would match
both test.example.com, and foo.test.example.com, but not example.com.
If both the Listener and HTTPRoute have specified hostnames, any
HTTPRoute hostnames that do not match the Listener hostname MUST be
ignored. For example, if a Listener specified *.example.com, and the
HTTPRoute specified test.example.com and test.example.net,
test.example.net must not be considered for a match.
If both the Listener and HTTPRoute have specified hostnames, and none
match with the criteria above, then the HTTPRoute is not accepted. The
implementation must raise an 'Accepted' Condition with a status of
False in the corresponding RouteParentStatus.
In the event that multiple HTTPRoutes specify intersecting hostnames (e.g. overlapping wildcard matching and exact matching hostnames), precedence must be given to rules from the HTTPRoute with the largest number of:
- Characters in a matching non-wildcard hostname.
- Characters in a matching hostname.
If ties exist across multiple Routes, the matching precedence rules for HTTPRouteMatches takes over.
Support: Core
parentRefs []object
ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with "Core" support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
This API may be extended in the future to support additional kinds of parent resources.
The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.
group string
Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string).
Support: Core
kind string
Kind is kind of the referent.
There are two kinds of parent resources with "Core" support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
name string required
Name is the name of the referent.
Support: Core
namespace string
Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route.
Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference.
Support: Core
port integer
Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource.
When the parent resource is a Gateway, this targets all listeners
listening on the specified port that also support this kind of Route(and
select this Route). It's not recommended to set Port unless the
networking behaviors specified in a Route must apply to a specific port
as opposed to a listener(s) whose port(s) may be changed. When both Port
and SectionName are specified, the name and port of the selected listener
must match both specified values.
Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted.
For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Extended
sectionName string
SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following:
- Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
- Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted.
When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Core
rules []object
HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).
backendRefs []object
HTTPBackendRef defines how a HTTPRoute forwards a HTTP request.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
filters []object
HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.
extensionRef object
ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters.
This filter can be used multiple times within the same rule.
Support: Implementation-specific
group string required
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string required
Kind is kind of the referent. For example "HTTPRoute" or "Service".
name string required
Name is the name of the referent.
requestHeaderModifier object
RequestHeaderModifier defines a schema for a filter that modifies request headers.
Support: Core
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
requestMirror object
RequestMirror defines a schema for a filter that mirrors requests. Requests are sent to the specified destination, but responses from that destination are ignored.
This filter can be used multiple times within the same rule. Note that not all implementations will be able to support mirroring to multiple backends.
Support: Extended
backendRef object required
BackendRef references a resource where mirrored requests are sent.
Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef.
If the referent cannot be found, this BackendRef is invalid and must be
dropped from the Gateway. The controller must ensure the "ResolvedRefs"
condition on the Route status is set to status: False and not configure
this backend in the underlying implementation.
If there is a cross-namespace reference to an existing object
that is not allowed by a ReferenceGrant, the controller must ensure the
"ResolvedRefs" condition on the Route is set to status: False,
with the "RefNotPermitted" reason and not configure this backend in the
underlying implementation.
In either error case, the Message of the ResolvedRefs Condition
should be used to provide more detail about the problem.
Support: Extended for Kubernetes Service
Support: Implementation-specific for any other resource
group string
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string
Kind is the Kubernetes resource kind of the referent. For example "Service".
Defaults to "Service" when not specified.
ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.
Support: Core (Services with a type other than ExternalName)
Support: Implementation-specific (Services with type ExternalName)
name string required
Name is the name of the referent.
namespace string
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
Support: Core
port integer
Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
fraction object
Fraction represents the fraction of requests that should be mirrored to BackendRef.
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
denominator integer
numerator integer required
percent integer
Percent represents the percentage of requests that should be mirrored to BackendRef. Its minimum value is 0 (indicating 0% of requests) and its maximum value is 100 (indicating 100% of requests).
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
requestRedirect object
RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection.
Support: Core
hostname string
Hostname is the hostname to be used in the value of the Location
header in the response.
When empty, the hostname in the Host header of the request is used.
Support: Core
path object
Path defines parameters used to modify the path of the incoming request.
The modified path is then used to construct the Location header. When
empty, the request path is used as-is.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
port integer
Port is the port to be used in the value of the Location
header in the response.
If no port is specified, the redirect port MUST be derived using the following rules:
- If redirect scheme is not-empty, the redirect port MUST be the well-known port associated with the redirect scheme. Specifically "http" to port 80 and "https" to port 443. If the redirect scheme does not have a well-known port, the listener port of the Gateway SHOULD be used.
- If redirect scheme is empty, the redirect port MUST be the Gateway Listener port.
Implementations SHOULD NOT add the port number in the 'Location' header in the following cases:
- A Location header that will use HTTP (whether that is determined via the Listener protocol or the Scheme field) and use port 80.
- A Location header that will use HTTPS (whether that is determined via the Listener protocol or the Scheme field) and use port 443.
Support: Extended
scheme string
Scheme is the scheme to be used in the value of the Location header in
the response. When empty, the scheme of the request is used.
Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Extended
statusCode integer
StatusCode is the HTTP status code to be used in response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Core
responseHeaderModifier object
ResponseHeaderModifier defines a schema for a filter that modifies response headers.
Support: Extended
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
type string required
Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:
-
Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations must support core filters.
-
Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters.
-
Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field.
Typeshould be set to "ExtensionRef" for custom filters.
Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.
If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
urlRewrite object
URLRewrite defines a schema for a filter that modifies a request during forwarding.
Support: Extended
hostname string
Hostname is the value to be used to replace the Host header value during forwarding.
Support: Extended
path object
Path defines a path rewrite.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
group string
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string
Kind is the Kubernetes resource kind of the referent. For example "Service".
Defaults to "Service" when not specified.
ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.
Support: Core (Services with a type other than ExternalName)
Support: Implementation-specific (Services with type ExternalName)
name string required
Name is the name of the referent.
namespace string
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
Support: Core
port integer
Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
weight integer
Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs 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, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1.
Support for this field varies based on the context where used.
filters []object
HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter.
extensionRef object
ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters.
This filter can be used multiple times within the same rule.
Support: Implementation-specific
group string required
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string required
Kind is kind of the referent. For example "HTTPRoute" or "Service".
name string required
Name is the name of the referent.
requestHeaderModifier object
RequestHeaderModifier defines a schema for a filter that modifies request headers.
Support: Core
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
requestMirror object
RequestMirror defines a schema for a filter that mirrors requests. Requests are sent to the specified destination, but responses from that destination are ignored.
This filter can be used multiple times within the same rule. Note that not all implementations will be able to support mirroring to multiple backends.
Support: Extended
backendRef object required
BackendRef references a resource where mirrored requests are sent.
Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef.
If the referent cannot be found, this BackendRef is invalid and must be
dropped from the Gateway. The controller must ensure the "ResolvedRefs"
condition on the Route status is set to status: False and not configure
this backend in the underlying implementation.
If there is a cross-namespace reference to an existing object
that is not allowed by a ReferenceGrant, the controller must ensure the
"ResolvedRefs" condition on the Route is set to status: False,
with the "RefNotPermitted" reason and not configure this backend in the
underlying implementation.
In either error case, the Message of the ResolvedRefs Condition
should be used to provide more detail about the problem.
Support: Extended for Kubernetes Service
Support: Implementation-specific for any other resource
group string
Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.
kind string
Kind is the Kubernetes resource kind of the referent. For example "Service".
Defaults to "Service" when not specified.
ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.
Support: Core (Services with a type other than ExternalName)
Support: Implementation-specific (Services with type ExternalName)
name string required
Name is the name of the referent.
namespace string
Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.
Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
Support: Core
port integer
Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.
fraction object
Fraction represents the fraction of requests that should be mirrored to BackendRef.
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
denominator integer
numerator integer required
percent integer
Percent represents the percentage of requests that should be mirrored to BackendRef. Its minimum value is 0 (indicating 0% of requests) and its maximum value is 100 (indicating 100% of requests).
Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored.
requestRedirect object
RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection.
Support: Core
hostname string
Hostname is the hostname to be used in the value of the Location
header in the response.
When empty, the hostname in the Host header of the request is used.
Support: Core
path object
Path defines parameters used to modify the path of the incoming request.
The modified path is then used to construct the Location header. When
empty, the request path is used as-is.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
port integer
Port is the port to be used in the value of the Location
header in the response.
If no port is specified, the redirect port MUST be derived using the following rules:
- If redirect scheme is not-empty, the redirect port MUST be the well-known port associated with the redirect scheme. Specifically "http" to port 80 and "https" to port 443. If the redirect scheme does not have a well-known port, the listener port of the Gateway SHOULD be used.
- If redirect scheme is empty, the redirect port MUST be the Gateway Listener port.
Implementations SHOULD NOT add the port number in the 'Location' header in the following cases:
- A Location header that will use HTTP (whether that is determined via the Listener protocol or the Scheme field) and use port 80.
- A Location header that will use HTTPS (whether that is determined via the Listener protocol or the Scheme field) and use port 443.
Support: Extended
scheme string
Scheme is the scheme to be used in the value of the Location header in
the response. When empty, the scheme of the request is used.
Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Extended
statusCode integer
StatusCode is the HTTP status code to be used in response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
Support: Core
responseHeaderModifier object
ResponseHeaderModifier defines a schema for a filter that modifies response headers.
Support: Extended
add []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
remove []string
Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz
Config: remove: ["my-header1", "my-header3"]
Output: GET /foo HTTP/1.1 my-header2: bar
set []object
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
value string required
Value is the value of HTTP Header to be matched.
type string required
Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels:
-
Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations must support core filters.
-
Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters.
-
Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field.
Typeshould be set to "ExtensionRef" for custom filters.
Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior.
If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
urlRewrite object
URLRewrite defines a schema for a filter that modifies a request during forwarding.
Support: Extended
hostname string
Hostname is the value to be used to replace the Host header value during forwarding.
Support: Extended
path object
Path defines a path rewrite.
Support: Extended
replaceFullPath string
ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect.
replacePrefixMatch string
ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the / separator. When specified, a trailing / is
ignored. For example, the paths /abc, /abc/, and /abc/def would all
match the prefix /abc, but the path /abcd would not.
ReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to status: False.
Request Path | Prefix Match | Replace Prefix | Modified Path
type string required
Type defines the type of path modifier. Additional types may be added in a future release of the API.
Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to status: False, with a
Reason of UnsupportedValue.
matches []object
HTTPRouteMatch defines the predicate used to match requests to a given action. Multiple match types are ANDed together, i.e. the match will evaluate to true only if all conditions are satisfied.
For example, the match below will match a HTTP request only if its path
starts with /foo AND it contains the version: v1 header:
headers []object
HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers.
name string required
Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent.
When a header is repeated in an HTTP request, it is implementation-specific behavior as to how this is represented. Generally, proxies should follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding processing a repeated header, with special handling for "Set-Cookie".
type string
Type specifies how to match against the value of the header.
Support: Core (Exact)
Support: Implementation-specific (RegularExpression)
Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.
value string required
Value is the value of HTTP Header to be matched.
method string
Method specifies HTTP method matcher. When specified, this route will be matched only if the request has the specified method.
Support: Extended
path object
Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided.
type string
Type specifies how to match against the path Value.
Support: Core (Exact, PathPrefix)
Support: Implementation-specific (RegularExpression)
value string
Value of the HTTP path to match against.
queryParams []object
HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters.
name string required
Name is the name of the HTTP query param to be matched. This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).
If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored.
If a query param is repeated in an HTTP request, the behavior is purposely left undefined, since different data planes have different capabilities. However, it is recommended that implementations should match against the first value of the param if the data plane supports it, as this behavior is expected in other load balancing contexts outside of the Gateway API.
Users SHOULD NOT route traffic based on repeated query params to guard themselves against potential differences in the implementations.
type string
Type specifies how to match against the value of the query parameter.
Support: Extended (Exact)
Support: Implementation-specific (RegularExpression)
Since RegularExpression QueryParamMatchType has Implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.
value string required
Value is the value of HTTP query param to be matched.
name string
Name is the name of the route rule. This name MUST be unique within a Route if it is set.
Support: Extended
timeouts object
Timeouts defines the timeouts that can be configured for an HTTP request.
Support: Extended
backendRequest string
BackendRequest specifies a timeout for an individual request from the gateway to a backend. This covers the time from when the request first starts being sent from the gateway to when the full response has been received from the backend.
Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout completely. Implementations that cannot completely disable the timeout MUST instead interpret the zero duration as the longest possible value to which the timeout can be set.
An entire client HTTP transaction with a gateway, covered by the Request timeout, may result in more than one call from the gateway to the destination backend, for example, if automatic retries are supported.
The value of BackendRequest must be a Gateway API Duration string as defined by GEP-2257. When this field is unspecified, its behavior is implementation-specific; when specified, the value of BackendRequest must be no more than the value of the Request timeout (since the Request timeout encompasses the BackendRequest timeout).
Support: Extended
request string
Request specifies the maximum duration for a gateway to respond to an HTTP request. If the gateway has not been able to respond before this deadline is met, the gateway MUST return a timeout error.
For example, setting the rules.timeouts.request field to the value 10s in an
HTTPRoute will cause a timeout if a client request is taking longer than 10 seconds
to complete.
Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout completely. Implementations that cannot completely disable the timeout MUST instead interpret the zero duration as the longest possible value to which the timeout can be set.
This timeout is intended to cover as close to the whole request-response transaction as possible although an implementation MAY choose to start the timeout after the entire request stream has been received instead of immediately after the transaction is initiated by the client.
The value of Request is a Gateway API Duration string as defined by GEP-2257. When this field is unspecified, request timeout behavior is implementation-specific.
Support: Extended
status object
Status defines the current state of HTTPRoute.
parents []object required
RouteParentStatus describes the status of a route with respect to an associated Parent.
conditions []object required
Condition contains details for one aspect of the current state of this API Resource.
lastTransitionTime string required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message string required
message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration integer
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason string required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status string required
status of the condition, one of True, False, Unknown.
type string required
type of condition in CamelCase or in foo.example.com/CamelCase.
controllerName string required
ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass.
Example: "example.net/gateway-controller".
The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary.
parentRef object required
ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of.
group string
Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string).
Support: Core
kind string
Kind is kind of the referent.
There are two kinds of parent resources with "Core" support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
name string required
Name is the name of the referent.
Support: Core
namespace string
Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route.
Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference.
Support: Core
port integer
Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource.
When the parent resource is a Gateway, this targets all listeners
listening on the specified port that also support this kind of Route(and
select this Route). It's not recommended to set Port unless the
networking behaviors specified in a Route must apply to a specific port
as opposed to a listener(s) whose port(s) may be changed. When both Port
and SectionName are specified, the name and port of the selected listener
must match both specified values.
Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted.
For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Extended
sectionName string
SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following:
- Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
- Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.
Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted.
When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.
Support: Core