1285 lines
80 KiB
YAML
1285 lines
80 KiB
YAML
|
|
||
|
|
---
|
||
|
|
apiVersion: apiextensions.k8s.io/v1
|
||
|
|
kind: CustomResourceDefinition
|
||
|
|
metadata:
|
||
|
|
annotations:
|
||
|
|
api-approved.kubernetes.io: https://github.com/kubernetes-sigs/gateway-api/pull/891
|
||
|
|
creationTimestamp: null
|
||
|
|
name: httproutes.gateway.networking.k8s.io
|
||
|
|
spec:
|
||
|
|
group: gateway.networking.k8s.io
|
||
|
|
names:
|
||
|
|
categories:
|
||
|
|
- gateway-api
|
||
|
|
kind: HTTPRoute
|
||
|
|
listKind: HTTPRouteList
|
||
|
|
plural: httproutes
|
||
|
|
singular: httproute
|
||
|
|
scope: Namespaced
|
||
|
|
versions:
|
||
|
|
- additionalPrinterColumns:
|
||
|
|
- jsonPath: .spec.hostnames
|
||
|
|
name: Hostnames
|
||
|
|
type: string
|
||
|
|
- jsonPath: .metadata.creationTimestamp
|
||
|
|
name: Age
|
||
|
|
type: date
|
||
|
|
name: v1alpha2
|
||
|
|
schema:
|
||
|
|
openAPIV3Schema:
|
||
|
|
description: 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.
|
||
|
|
properties:
|
||
|
|
apiVersion:
|
||
|
|
description: 'APIVersion defines the versioned schema of this representation
|
||
|
|
of an object. Servers should convert recognized schemas to the latest
|
||
|
|
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
description: 'Kind is a string value representing the REST resource this
|
||
|
|
object represents. Servers may infer this from the endpoint the client
|
||
|
|
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
|
||
|
|
type: string
|
||
|
|
metadata:
|
||
|
|
type: object
|
||
|
|
spec:
|
||
|
|
description: Spec defines the desired state of HTTPRoute.
|
||
|
|
properties:
|
||
|
|
hostnames:
|
||
|
|
description: "Hostnames defines a set of hostname that should match
|
||
|
|
against the HTTP Host header to select a HTTPRoute to process the
|
||
|
|
request. This matches the RFC 1123 definition of a hostname with
|
||
|
|
2 notable exceptions: \n 1. IPs are not allowed. 2. A hostname may
|
||
|
|
be prefixed with a wildcard label (`*.`). The wildcard label
|
||
|
|
must appear by itself as the first label. \n 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:
|
||
|
|
\n * A Listener with `test.example.com` as the hostname matches
|
||
|
|
HTTPRoutes that have either not specified any hostnames, or have
|
||
|
|
specified at least one of `test.example.com` or `*.example.com`.
|
||
|
|
* A Listener with `*.example.com` as 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, `test.example.com` and `*.example.com` would both match.
|
||
|
|
On the other hand, `example.com` and `test.example.net` would
|
||
|
|
not match. \n 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. \n 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. \n Support: Core"
|
||
|
|
items:
|
||
|
|
description: "Hostname is the fully qualified domain name of a network
|
||
|
|
host. This matches the RFC 1123 definition of a hostname with
|
||
|
|
2 notable exceptions: \n 1. IPs are not allowed. 2. A hostname
|
||
|
|
may be prefixed with a wildcard label (`*.`). The wildcard label
|
||
|
|
must appear by itself as the first label. \n Hostname can be \"precise\"
|
||
|
|
which is a domain name without the terminating dot of a network
|
||
|
|
host (e.g. \"foo.example.com\") or \"wildcard\", which is a domain
|
||
|
|
name prefixed with a single wildcard label (e.g. `*.example.com`).
|
||
|
|
\n Note that as per RFC1035 and RFC1123, a *label* must consist
|
||
|
|
of lower case alphanumeric characters or '-', and must start and
|
||
|
|
end with an alphanumeric character. No other punctuation is allowed."
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
parentRefs:
|
||
|
|
description: "ParentRefs references the resources (usually Gateways)
|
||
|
|
that a Route wants to be attached to. Note that the referenced parent
|
||
|
|
resource needs to allow this for the attachment to be complete.
|
||
|
|
For Gateways, that means the Gateway needs to allow attachment from
|
||
|
|
Routes of this kind and namespace. \n The only kind of parent resource
|
||
|
|
with \"Core\" support is Gateway. This API may be extended in the
|
||
|
|
future to support additional kinds of parent resources such as one
|
||
|
|
of the route kinds. \n It is invalid to reference an identical parent
|
||
|
|
more than once. It is valid to reference multiple distinct sections
|
||
|
|
within the same parent resource, such as 2 Listeners within a Gateway.
|
||
|
|
\n It is possible to separately reference multiple distinct objects
|
||
|
|
that may be collapsed by an implementation. For example, some implementations
|
||
|
|
may choose to merge compatible Gateway Listeners together. If that
|
||
|
|
is the case, the list of routes attached to those resources should
|
||
|
|
also be merged."
|
||
|
|
items:
|
||
|
|
description: "ParentRef identifies an API object (usually a Gateway)
|
||
|
|
that can be considered a parent of this resource (usually a route).
|
||
|
|
The only kind of parent resource with \"Core\" support is Gateway.
|
||
|
|
This API may be extended in the future to support additional kinds
|
||
|
|
of parent resources, such as HTTPRoute. \n 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. \n References to
|
||
|
|
objects with invalid Group and Kind are not valid, and must be
|
||
|
|
rejected by the implementation, with appropriate Conditions set
|
||
|
|
on the containing object."
|
||
|
|
properties:
|
||
|
|
group:
|
||
|
|
default: gateway.networking.k8s.io
|
||
|
|
description: "Group is the group of the referent. \n Support:
|
||
|
|
Core"
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
default: Gateway
|
||
|
|
description: "Kind is kind of the referent. \n Support: Core
|
||
|
|
(Gateway) Support: Custom (Other Resources)"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: "Name is the name of the referent. \n Support:
|
||
|
|
Core"
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
namespace:
|
||
|
|
description: "Namespace is the namespace of the referent. When
|
||
|
|
unspecified (or empty string), this refers to the local namespace
|
||
|
|
of the Route. \n Support: Core"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
|
||
|
|
type: string
|
||
|
|
sectionName:
|
||
|
|
description: "SectionName is the name of a section within the
|
||
|
|
target resource. In the following resources, SectionName is
|
||
|
|
interpreted as the following: \n * Gateway: Listener Name
|
||
|
|
\n Implementations MAY choose to support attaching Routes
|
||
|
|
to other resources. If that is the case, they MUST clearly
|
||
|
|
document how SectionName is interpreted. \n 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. \n
|
||
|
|
Support: Core"
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
maxItems: 32
|
||
|
|
type: array
|
||
|
|
rules:
|
||
|
|
default:
|
||
|
|
- matches:
|
||
|
|
- path:
|
||
|
|
type: PathPrefix
|
||
|
|
value: /
|
||
|
|
description: Rules are a list of HTTP matchers, filters and actions.
|
||
|
|
items:
|
||
|
|
description: HTTPRouteRule defines semantics for matching an HTTP
|
||
|
|
request based on conditions (matches), processing it (filters),
|
||
|
|
and forwarding the request to an API object (backendRefs).
|
||
|
|
properties:
|
||
|
|
backendRefs:
|
||
|
|
description: "If unspecified or invalid (refers to a non-existent
|
||
|
|
resource or a Service with no endpoints), the rule performs
|
||
|
|
no forwarding. If there are also no filters specified that
|
||
|
|
would result in a response being sent, a HTTP 503 status code
|
||
|
|
is returned. 503 responses must be sent so that the overall
|
||
|
|
weight is respected; if an invalid backend is requested to
|
||
|
|
have 80% of requests, then 80% of requests must get a 503
|
||
|
|
instead. \n Support: Core for Kubernetes Service Support:
|
||
|
|
Custom for any other resource \n Support for weight: Core"
|
||
|
|
items:
|
||
|
|
description: HTTPBackendRef defines how a HTTPRoute should
|
||
|
|
forward an HTTP request.
|
||
|
|
properties:
|
||
|
|
filters:
|
||
|
|
description: "Filters defined at this level should be
|
||
|
|
executed if and only if the request is being forwarded
|
||
|
|
to the backend defined here. \n Support: Custom (For
|
||
|
|
broader support of filters, use the Filters field in
|
||
|
|
HTTPRouteRule.)"
|
||
|
|
items:
|
||
|
|
description: 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.
|
||
|
|
properties:
|
||
|
|
extensionRef:
|
||
|
|
description: "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. \n Support: Implementation-specific"
|
||
|
|
properties:
|
||
|
|
group:
|
||
|
|
description: Group is the group of the referent.
|
||
|
|
For example, "networking.k8s.io". When unspecified
|
||
|
|
(empty string), core API group is inferred.
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
description: Kind is kind of the referent. For
|
||
|
|
example "HTTPRoute" or "Service".
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: Name is the name of the referent.
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- group
|
||
|
|
- kind
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
requestHeaderModifier:
|
||
|
|
description: "RequestHeaderModifier defines a schema
|
||
|
|
for a filter that modifies request headers. \n
|
||
|
|
Support: Core"
|
||
|
|
properties:
|
||
|
|
add:
|
||
|
|
description: "Add adds the given header(s) (name,
|
||
|
|
value) to the request before the action. It
|
||
|
|
appends to any existing values associated
|
||
|
|
with the header name. \n Input: GET /foo
|
||
|
|
HTTP/1.1 my-header: foo \n Config: add:
|
||
|
|
\ - name: \"my-header\" value: \"bar\"
|
||
|
|
\n Output: GET /foo HTTP/1.1 my-header:
|
||
|
|
foo my-header: bar"
|
||
|
|
items:
|
||
|
|
description: HTTPHeader represents an HTTP
|
||
|
|
Header name and value as defined by RFC
|
||
|
|
7230.
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
description: "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).
|
||
|
|
\n 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."
|
||
|
|
maxLength: 256
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
description: Value is the value of HTTP
|
||
|
|
Header to be matched.
|
||
|
|
maxLength: 4096
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
- value
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- name
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
remove:
|
||
|
|
description: "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).
|
||
|
|
\n Input: GET /foo HTTP/1.1 my-header1:
|
||
|
|
foo my-header2: bar my-header3: baz \n
|
||
|
|
Config: remove: [\"my-header1\", \"my-header3\"]
|
||
|
|
\n Output: GET /foo HTTP/1.1 my-header2:
|
||
|
|
bar"
|
||
|
|
items:
|
||
|
|
type: string
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
set:
|
||
|
|
description: "Set overwrites the request with
|
||
|
|
the given header (name, value) before the
|
||
|
|
action. \n Input: GET /foo HTTP/1.1 my-header:
|
||
|
|
foo \n Config: set: - name: \"my-header\"
|
||
|
|
\ value: \"bar\" \n Output: GET /foo
|
||
|
|
HTTP/1.1 my-header: bar"
|
||
|
|
items:
|
||
|
|
description: HTTPHeader represents an HTTP
|
||
|
|
Header name and value as defined by RFC
|
||
|
|
7230.
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
description: "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).
|
||
|
|
\n 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."
|
||
|
|
maxLength: 256
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
description: Value is the value of HTTP
|
||
|
|
Header to be matched.
|
||
|
|
maxLength: 4096
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
- value
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- name
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
type: object
|
||
|
|
requestMirror:
|
||
|
|
description: "RequestMirror defines a schema for
|
||
|
|
a filter that mirrors requests. Requests are sent
|
||
|
|
to the specified destination, but responses from
|
||
|
|
that destination are ignored. \n Support: Extended"
|
||
|
|
properties:
|
||
|
|
backendRef:
|
||
|
|
description: "BackendRef references a resource
|
||
|
|
where mirrored requests are sent. \n 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. \n If there is
|
||
|
|
a cross-namespace reference to an *existing*
|
||
|
|
object that is not allowed by a ReferencePolicy,
|
||
|
|
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. \n In either error case, the
|
||
|
|
Message of the `ResolvedRefs` Condition should
|
||
|
|
be used to provide more detail about the problem.
|
||
|
|
\n Support: Extended for Kubernetes Service
|
||
|
|
Support: Custom for any other resource"
|
||
|
|
properties:
|
||
|
|
group:
|
||
|
|
default: ""
|
||
|
|
description: Group is the group of the referent.
|
||
|
|
For example, "networking.k8s.io". When
|
||
|
|
unspecified (empty string), core API group
|
||
|
|
is inferred.
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
default: Service
|
||
|
|
description: Kind is kind of the referent.
|
||
|
|
For example "HTTPRoute" or "Service".
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: Name is the name of the referent.
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
namespace:
|
||
|
|
description: "Namespace is the namespace
|
||
|
|
of the backend. When unspecified, the
|
||
|
|
local namespace is inferred. \n Note that
|
||
|
|
when a namespace is specified, a ReferencePolicy
|
||
|
|
object is required in the referent namespace
|
||
|
|
to allow that namespace's owner to accept
|
||
|
|
the reference. See the ReferencePolicy
|
||
|
|
documentation for details. \n Support:
|
||
|
|
Core"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
|
||
|
|
type: string
|
||
|
|
port:
|
||
|
|
description: Port specifies the destination
|
||
|
|
port number to use for this resource.
|
||
|
|
Port is required when the referent is
|
||
|
|
a Kubernetes Service. For other resources,
|
||
|
|
destination port might be derived from
|
||
|
|
the referent resource or this field.
|
||
|
|
format: int32
|
||
|
|
maximum: 65535
|
||
|
|
minimum: 1
|
||
|
|
type: integer
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- backendRef
|
||
|
|
type: object
|
||
|
|
requestRedirect:
|
||
|
|
description: "RequestRedirect defines a schema for
|
||
|
|
a filter that responds to the request with an
|
||
|
|
HTTP redirection. \n Support: Core"
|
||
|
|
properties:
|
||
|
|
hostname:
|
||
|
|
description: "Hostname is the hostname to be
|
||
|
|
used in the value of the `Location` header
|
||
|
|
in the response. When empty, the hostname
|
||
|
|
of the request is used. \n Support: Core"
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
port:
|
||
|
|
description: "Port is the port to be used in
|
||
|
|
the value of the `Location` header in the
|
||
|
|
response. When empty, port (if specified)
|
||
|
|
of the request is used. \n Support: Extended"
|
||
|
|
format: int32
|
||
|
|
maximum: 65535
|
||
|
|
minimum: 1
|
||
|
|
type: integer
|
||
|
|
scheme:
|
||
|
|
description: "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. \n Support: Extended"
|
||
|
|
enum:
|
||
|
|
- http
|
||
|
|
- https
|
||
|
|
type: string
|
||
|
|
statusCode:
|
||
|
|
default: 302
|
||
|
|
description: "StatusCode is the HTTP status
|
||
|
|
code to be used in response. \n Support: Core"
|
||
|
|
enum:
|
||
|
|
- 301
|
||
|
|
- 302
|
||
|
|
type: integer
|
||
|
|
type: object
|
||
|
|
type:
|
||
|
|
description: "Type identifies the type of filter
|
||
|
|
to apply. As with other API fields, types are
|
||
|
|
classified into three conformance levels: \n -
|
||
|
|
Core: Filter types and their corresponding configuration
|
||
|
|
defined by \"Support: Core\" in this package,
|
||
|
|
e.g. \"RequestHeaderModifier\". All implementations
|
||
|
|
must support core filters. \n - Extended: Filter
|
||
|
|
types and their corresponding configuration defined
|
||
|
|
by \"Support: Extended\" in this package, e.g.
|
||
|
|
\"RequestMirror\". Implementers are encouraged
|
||
|
|
to support extended filters. \n - Custom: 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. `Type` should be set to \"ExtensionRef\"
|
||
|
|
for custom filters. \n Implementers are encouraged
|
||
|
|
to define custom implementation types to extend
|
||
|
|
the core API with implementation-specific behavior.
|
||
|
|
\n 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."
|
||
|
|
enum:
|
||
|
|
- RequestHeaderModifier
|
||
|
|
- RequestMirror
|
||
|
|
- RequestRedirect
|
||
|
|
- ExtensionRef
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- type
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
group:
|
||
|
|
default: ""
|
||
|
|
description: Group is the group of the referent. For example,
|
||
|
|
"networking.k8s.io". When unspecified (empty string),
|
||
|
|
core API group is inferred.
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
default: Service
|
||
|
|
description: Kind is kind of the referent. For example
|
||
|
|
"HTTPRoute" or "Service".
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: Name is the name of the referent.
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
namespace:
|
||
|
|
description: "Namespace is the namespace of the backend.
|
||
|
|
When unspecified, the local namespace is inferred. \n
|
||
|
|
Note that when a namespace is specified, a ReferencePolicy
|
||
|
|
object is required in the referent namespace to allow
|
||
|
|
that namespace's owner to accept the reference. See
|
||
|
|
the ReferencePolicy documentation for details. \n Support:
|
||
|
|
Core"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
|
||
|
|
type: string
|
||
|
|
port:
|
||
|
|
description: Port specifies the destination port number
|
||
|
|
to use for this resource. Port is required when the
|
||
|
|
referent is a Kubernetes Service. For other resources,
|
||
|
|
destination port might be derived from the referent
|
||
|
|
resource or this field.
|
||
|
|
format: int32
|
||
|
|
maximum: 65535
|
||
|
|
minimum: 1
|
||
|
|
type: integer
|
||
|
|
weight:
|
||
|
|
default: 1
|
||
|
|
description: "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. \n
|
||
|
|
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. \n Support for this field varies based
|
||
|
|
on the context where used."
|
||
|
|
format: int32
|
||
|
|
maximum: 1000000
|
||
|
|
minimum: 0
|
||
|
|
type: integer
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
filters:
|
||
|
|
description: "Filters define the filters that are applied to
|
||
|
|
requests that match this rule. \n The effects of ordering
|
||
|
|
of multiple behaviors are currently unspecified. This can
|
||
|
|
change in the future based on feedback during the alpha stage.
|
||
|
|
\n Conformance-levels at this level are defined based on the
|
||
|
|
type of filter: \n - ALL core filters MUST be supported by
|
||
|
|
all implementations. - Implementers are encouraged to support
|
||
|
|
extended filters. - Implementation-specific custom filters
|
||
|
|
have no API guarantees across implementations. \n Specifying
|
||
|
|
a core filter multiple times has unspecified or custom conformance.
|
||
|
|
\n Support: Core"
|
||
|
|
items:
|
||
|
|
description: 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.
|
||
|
|
properties:
|
||
|
|
extensionRef:
|
||
|
|
description: "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. \n Support: Implementation-specific"
|
||
|
|
properties:
|
||
|
|
group:
|
||
|
|
description: Group is the group of the referent. For
|
||
|
|
example, "networking.k8s.io". When unspecified (empty
|
||
|
|
string), core API group is inferred.
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
description: Kind is kind of the referent. For example
|
||
|
|
"HTTPRoute" or "Service".
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: Name is the name of the referent.
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- group
|
||
|
|
- kind
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
requestHeaderModifier:
|
||
|
|
description: "RequestHeaderModifier defines a schema for
|
||
|
|
a filter that modifies request headers. \n Support:
|
||
|
|
Core"
|
||
|
|
properties:
|
||
|
|
add:
|
||
|
|
description: "Add adds the given header(s) (name,
|
||
|
|
value) to the request before the action. It appends
|
||
|
|
to any existing values associated with the header
|
||
|
|
name. \n Input: GET /foo HTTP/1.1 my-header:
|
||
|
|
foo \n Config: add: - name: \"my-header\" value:
|
||
|
|
\"bar\" \n Output: GET /foo HTTP/1.1 my-header:
|
||
|
|
foo my-header: bar"
|
||
|
|
items:
|
||
|
|
description: HTTPHeader represents an HTTP Header
|
||
|
|
name and value as defined by RFC 7230.
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
description: "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).
|
||
|
|
\n 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."
|
||
|
|
maxLength: 256
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
description: Value is the value of HTTP Header
|
||
|
|
to be matched.
|
||
|
|
maxLength: 4096
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
- value
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- name
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
remove:
|
||
|
|
description: "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).
|
||
|
|
\n Input: GET /foo HTTP/1.1 my-header1: foo
|
||
|
|
\ my-header2: bar my-header3: baz \n Config:
|
||
|
|
\ remove: [\"my-header1\", \"my-header3\"] \n Output:
|
||
|
|
\ GET /foo HTTP/1.1 my-header2: bar"
|
||
|
|
items:
|
||
|
|
type: string
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
set:
|
||
|
|
description: "Set overwrites the request with the
|
||
|
|
given header (name, value) before the action. \n
|
||
|
|
Input: GET /foo HTTP/1.1 my-header: foo \n Config:
|
||
|
|
\ set: - name: \"my-header\" value: \"bar\"
|
||
|
|
\n Output: GET /foo HTTP/1.1 my-header: bar"
|
||
|
|
items:
|
||
|
|
description: HTTPHeader represents an HTTP Header
|
||
|
|
name and value as defined by RFC 7230.
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
description: "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).
|
||
|
|
\n 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."
|
||
|
|
maxLength: 256
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
description: Value is the value of HTTP Header
|
||
|
|
to be matched.
|
||
|
|
maxLength: 4096
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
- value
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- name
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
type: object
|
||
|
|
requestMirror:
|
||
|
|
description: "RequestMirror defines a schema for a filter
|
||
|
|
that mirrors requests. Requests are sent to the specified
|
||
|
|
destination, but responses from that destination are
|
||
|
|
ignored. \n Support: Extended"
|
||
|
|
properties:
|
||
|
|
backendRef:
|
||
|
|
description: "BackendRef references a resource where
|
||
|
|
mirrored requests are sent. \n 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. \n If
|
||
|
|
there is a cross-namespace reference to an *existing*
|
||
|
|
object that is not allowed by a ReferencePolicy,
|
||
|
|
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. \n
|
||
|
|
In either error case, the Message of the `ResolvedRefs`
|
||
|
|
Condition should be used to provide more detail
|
||
|
|
about the problem. \n Support: Extended for Kubernetes
|
||
|
|
Service Support: Custom for any other resource"
|
||
|
|
properties:
|
||
|
|
group:
|
||
|
|
default: ""
|
||
|
|
description: Group is the group of the referent.
|
||
|
|
For example, "networking.k8s.io". When unspecified
|
||
|
|
(empty string), core API group is inferred.
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
default: Service
|
||
|
|
description: Kind is kind of the referent. For
|
||
|
|
example "HTTPRoute" or "Service".
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: Name is the name of the referent.
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
namespace:
|
||
|
|
description: "Namespace is the namespace of the
|
||
|
|
backend. When unspecified, the local namespace
|
||
|
|
is inferred. \n Note that when a namespace is
|
||
|
|
specified, a ReferencePolicy object is required
|
||
|
|
in the referent namespace to allow that namespace's
|
||
|
|
owner to accept the reference. See the ReferencePolicy
|
||
|
|
documentation for details. \n Support: Core"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
|
||
|
|
type: string
|
||
|
|
port:
|
||
|
|
description: Port specifies the destination port
|
||
|
|
number to use for this resource. Port is required
|
||
|
|
when the referent is a Kubernetes Service. For
|
||
|
|
other resources, destination port might be derived
|
||
|
|
from the referent resource or this field.
|
||
|
|
format: int32
|
||
|
|
maximum: 65535
|
||
|
|
minimum: 1
|
||
|
|
type: integer
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- backendRef
|
||
|
|
type: object
|
||
|
|
requestRedirect:
|
||
|
|
description: "RequestRedirect defines a schema for a filter
|
||
|
|
that responds to the request with an HTTP redirection.
|
||
|
|
\n Support: Core"
|
||
|
|
properties:
|
||
|
|
hostname:
|
||
|
|
description: "Hostname is the hostname to be used
|
||
|
|
in the value of the `Location` header in the response.
|
||
|
|
When empty, the hostname of the request is used.
|
||
|
|
\n Support: Core"
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
port:
|
||
|
|
description: "Port is the port to be used in the value
|
||
|
|
of the `Location` header in the response. When empty,
|
||
|
|
port (if specified) of the request is used. \n Support:
|
||
|
|
Extended"
|
||
|
|
format: int32
|
||
|
|
maximum: 65535
|
||
|
|
minimum: 1
|
||
|
|
type: integer
|
||
|
|
scheme:
|
||
|
|
description: "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. \n
|
||
|
|
Support: Extended"
|
||
|
|
enum:
|
||
|
|
- http
|
||
|
|
- https
|
||
|
|
type: string
|
||
|
|
statusCode:
|
||
|
|
default: 302
|
||
|
|
description: "StatusCode is the HTTP status code to
|
||
|
|
be used in response. \n Support: Core"
|
||
|
|
enum:
|
||
|
|
- 301
|
||
|
|
- 302
|
||
|
|
type: integer
|
||
|
|
type: object
|
||
|
|
type:
|
||
|
|
description: "Type identifies the type of filter to apply.
|
||
|
|
As with other API fields, types are classified into
|
||
|
|
three conformance levels: \n - Core: Filter types and
|
||
|
|
their corresponding configuration defined by \"Support:
|
||
|
|
Core\" in this package, e.g. \"RequestHeaderModifier\".
|
||
|
|
All implementations must support core filters. \n
|
||
|
|
- Extended: Filter types and their corresponding configuration
|
||
|
|
defined by \"Support: Extended\" in this package,
|
||
|
|
e.g. \"RequestMirror\". Implementers are encouraged
|
||
|
|
to support extended filters. \n - Custom: 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. `Type` should
|
||
|
|
be set to \"ExtensionRef\" for custom filters. \n
|
||
|
|
Implementers are encouraged to define custom implementation
|
||
|
|
types to extend the core API with implementation-specific
|
||
|
|
behavior. \n 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."
|
||
|
|
enum:
|
||
|
|
- RequestHeaderModifier
|
||
|
|
- RequestMirror
|
||
|
|
- RequestRedirect
|
||
|
|
- ExtensionRef
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- type
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
matches:
|
||
|
|
default:
|
||
|
|
- path:
|
||
|
|
type: PathPrefix
|
||
|
|
value: /
|
||
|
|
description: "Matches define conditions used for matching the
|
||
|
|
rule against incoming HTTP requests. Each match is independent,
|
||
|
|
i.e. this rule will be matched if **any** one of the matches
|
||
|
|
is satisfied. \n For example, take the following matches configuration:
|
||
|
|
\n ``` matches: - path: value: \"/foo\" headers: -
|
||
|
|
name: \"version\" value: \"v2\" - path: value: \"/v2/foo\"
|
||
|
|
``` \n For a request to match against this rule, a request
|
||
|
|
must satisfy EITHER of the two conditions: \n - path prefixed
|
||
|
|
with `/foo` AND contains the header `version: v2` - path prefix
|
||
|
|
of `/v2/foo` \n See the documentation for HTTPRouteMatch on
|
||
|
|
how to specify multiple match conditions that should be ANDed
|
||
|
|
together. \n If no matches are specified, the default is a
|
||
|
|
prefix path match on \"/\", which has the effect of matching
|
||
|
|
every HTTP request. \n Proxy or Load Balancer routing configuration
|
||
|
|
generated from HTTPRoutes MUST prioritize rules based on the
|
||
|
|
following criteria, continuing on ties. Precedence must be
|
||
|
|
given to the the Rule with the largest number of: \n * Characters
|
||
|
|
in a matching non-wildcard hostname. * Characters in a matching
|
||
|
|
hostname. * Characters in a matching path. * Header matches.
|
||
|
|
* Query param matches. \n If ties still exist across multiple
|
||
|
|
Routes, matching precedence MUST be determined in order of
|
||
|
|
the following criteria, continuing on ties: \n * The oldest
|
||
|
|
Route based on creation timestamp. * The Route appearing first
|
||
|
|
in alphabetical order by \"<namespace>/<name>\". \n If ties
|
||
|
|
still exist within the Route that has been given precedence,
|
||
|
|
matching precedence MUST be granted to the first matching
|
||
|
|
rule meeting the above criteria."
|
||
|
|
items:
|
||
|
|
description: "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. \n For example, the match
|
||
|
|
below will match a HTTP request only if its path starts
|
||
|
|
with `/foo` AND it contains the `version: v1` header: \n
|
||
|
|
``` match: path: value: \"/foo\" headers: - name:
|
||
|
|
\"version\" value \"v1\" ```"
|
||
|
|
properties:
|
||
|
|
headers:
|
||
|
|
description: Headers specifies HTTP request header matchers.
|
||
|
|
Multiple match values are ANDed together, meaning, a
|
||
|
|
request must match all the specified headers to select
|
||
|
|
the route.
|
||
|
|
items:
|
||
|
|
description: HTTPHeaderMatch describes how to select
|
||
|
|
a HTTP route by matching HTTP request headers.
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
description: "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).
|
||
|
|
\n 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.
|
||
|
|
\n 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\"."
|
||
|
|
maxLength: 256
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
|
||
|
|
type: string
|
||
|
|
type:
|
||
|
|
default: Exact
|
||
|
|
description: "Type specifies how to match against
|
||
|
|
the value of the header. \n Support: Core (Exact)
|
||
|
|
\n Support: Custom (RegularExpression) \n Since
|
||
|
|
RegularExpression HeaderMatchType has custom conformance,
|
||
|
|
implementations can support POSIX, PCRE or any
|
||
|
|
other dialects of regular expressions. Please
|
||
|
|
read the implementation's documentation to determine
|
||
|
|
the supported dialect."
|
||
|
|
enum:
|
||
|
|
- Exact
|
||
|
|
- RegularExpression
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
description: Value is the value of HTTP Header to
|
||
|
|
be matched.
|
||
|
|
maxLength: 4096
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
- value
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- name
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
method:
|
||
|
|
description: "Method specifies HTTP method matcher. When
|
||
|
|
specified, this route will be matched only if the request
|
||
|
|
has the specified method. \n Support: Extended"
|
||
|
|
enum:
|
||
|
|
- GET
|
||
|
|
- HEAD
|
||
|
|
- POST
|
||
|
|
- PUT
|
||
|
|
- DELETE
|
||
|
|
- CONNECT
|
||
|
|
- OPTIONS
|
||
|
|
- TRACE
|
||
|
|
- PATCH
|
||
|
|
type: string
|
||
|
|
path:
|
||
|
|
default:
|
||
|
|
type: PathPrefix
|
||
|
|
value: /
|
||
|
|
description: Path specifies a HTTP request path matcher.
|
||
|
|
If this field is not specified, a default prefix match
|
||
|
|
on the "/" path is provided.
|
||
|
|
properties:
|
||
|
|
type:
|
||
|
|
default: PathPrefix
|
||
|
|
description: "Type specifies how to match against
|
||
|
|
the path Value. \n Support: Core (Exact, PathPrefix)
|
||
|
|
\n Support: Custom (RegularExpression)"
|
||
|
|
enum:
|
||
|
|
- Exact
|
||
|
|
- PathPrefix
|
||
|
|
- RegularExpression
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
default: /
|
||
|
|
description: Value of the HTTP path to match against.
|
||
|
|
maxLength: 1024
|
||
|
|
type: string
|
||
|
|
type: object
|
||
|
|
queryParams:
|
||
|
|
description: QueryParams specifies HTTP query parameter
|
||
|
|
matchers. Multiple match values are ANDed together,
|
||
|
|
meaning, a request must match all the specified query
|
||
|
|
parameters to select the route.
|
||
|
|
items:
|
||
|
|
description: HTTPQueryParamMatch describes how to select
|
||
|
|
a HTTP route by matching HTTP query parameters.
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
description: 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).
|
||
|
|
maxLength: 256
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
type:
|
||
|
|
default: Exact
|
||
|
|
description: "Type specifies how to match against
|
||
|
|
the value of the query parameter. \n Support:
|
||
|
|
Extended (Exact) \n Support: Custom (RegularExpression)
|
||
|
|
\n Since RegularExpression QueryParamMatchType
|
||
|
|
has custom conformance, implementations can support
|
||
|
|
POSIX, PCRE or any other dialects of regular expressions.
|
||
|
|
Please read the implementation's documentation
|
||
|
|
to determine the supported dialect."
|
||
|
|
enum:
|
||
|
|
- Exact
|
||
|
|
- RegularExpression
|
||
|
|
type: string
|
||
|
|
value:
|
||
|
|
description: Value is the value of HTTP query param
|
||
|
|
to be matched.
|
||
|
|
maxLength: 1024
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
- value
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- name
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
type: object
|
||
|
|
maxItems: 8
|
||
|
|
type: array
|
||
|
|
type: object
|
||
|
|
maxItems: 16
|
||
|
|
type: array
|
||
|
|
type: object
|
||
|
|
status:
|
||
|
|
description: Status defines the current state of HTTPRoute.
|
||
|
|
properties:
|
||
|
|
parents:
|
||
|
|
description: "Parents is a list of parent resources (usually Gateways)
|
||
|
|
that are associated with the route, and the status of the route
|
||
|
|
with respect to each parent. When this route attaches to a parent,
|
||
|
|
the controller that manages the parent must add an entry to this
|
||
|
|
list when the controller first sees the route and should update
|
||
|
|
the entry as appropriate when the route or gateway is modified.
|
||
|
|
\n Note that parent references that cannot be resolved by an implementation
|
||
|
|
of this API will not be added to this list. Implementations of this
|
||
|
|
API can only populate Route status for the Gateways/parent resources
|
||
|
|
they are responsible for. \n A maximum of 32 Gateways will be represented
|
||
|
|
in this list. An empty list means the route has not been attached
|
||
|
|
to any Gateway."
|
||
|
|
items:
|
||
|
|
description: RouteParentStatus describes the status of a route with
|
||
|
|
respect to an associated Parent.
|
||
|
|
properties:
|
||
|
|
conditions:
|
||
|
|
description: "Conditions describes the status of the route with
|
||
|
|
respect to the Gateway. Note that the route's availability
|
||
|
|
is also subject to the Gateway's own status conditions and
|
||
|
|
listener status. \n If the Route's ParentRef specifies an
|
||
|
|
existing Gateway that supports Routes of this kind AND that
|
||
|
|
Gateway's controller has sufficient access, then that Gateway's
|
||
|
|
controller MUST set the \"Accepted\" condition on the Route,
|
||
|
|
to indicate whether the route has been accepted or rejected
|
||
|
|
by the Gateway, and why. \n A Route MUST be considered \"Accepted\"
|
||
|
|
if at least one of the Route's rules is implemented by the
|
||
|
|
Gateway. \n There are a number of cases where the \"Accepted\"
|
||
|
|
condition may not be set due to lack of controller visibility,
|
||
|
|
that includes when: \n * The Route refers to a non-existent
|
||
|
|
parent. * The Route is of a type that the controller does
|
||
|
|
not support. * The Route is in a namespace the the controller
|
||
|
|
does not have access to."
|
||
|
|
items:
|
||
|
|
description: "Condition contains details for one aspect of
|
||
|
|
the current state of this API Resource. --- This struct
|
||
|
|
is intended for direct use as an array at the field path
|
||
|
|
.status.conditions. For example, type FooStatus struct{
|
||
|
|
\ // Represents the observations of a foo's current state.
|
||
|
|
\ // Known .status.conditions.type are: \"Available\",
|
||
|
|
\"Progressing\", and \"Degraded\" // +patchMergeKey=type
|
||
|
|
\ // +patchStrategy=merge // +listType=map //
|
||
|
|
+listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\"
|
||
|
|
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
|
||
|
|
\n // other fields }"
|
||
|
|
properties:
|
||
|
|
lastTransitionTime:
|
||
|
|
description: 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.
|
||
|
|
format: date-time
|
||
|
|
type: string
|
||
|
|
message:
|
||
|
|
description: message is a human readable message indicating
|
||
|
|
details about the transition. This may be an empty string.
|
||
|
|
maxLength: 32768
|
||
|
|
type: string
|
||
|
|
observedGeneration:
|
||
|
|
description: 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.
|
||
|
|
format: int64
|
||
|
|
minimum: 0
|
||
|
|
type: integer
|
||
|
|
reason:
|
||
|
|
description: 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.
|
||
|
|
maxLength: 1024
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
|
||
|
|
type: string
|
||
|
|
status:
|
||
|
|
description: status of the condition, one of True, False,
|
||
|
|
Unknown.
|
||
|
|
enum:
|
||
|
|
- "True"
|
||
|
|
- "False"
|
||
|
|
- Unknown
|
||
|
|
type: string
|
||
|
|
type:
|
||
|
|
description: type of condition in CamelCase or in foo.example.com/CamelCase.
|
||
|
|
--- Many .condition.type values are consistent across
|
||
|
|
resources like Available, but because arbitrary conditions
|
||
|
|
can be useful (see .node.status.conditions), the ability
|
||
|
|
to deconflict is important. The regex it matches is
|
||
|
|
(dns1123SubdomainFmt/)?(qualifiedNameFmt)
|
||
|
|
maxLength: 316
|
||
|
|
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- lastTransitionTime
|
||
|
|
- message
|
||
|
|
- reason
|
||
|
|
- status
|
||
|
|
- type
|
||
|
|
type: object
|
||
|
|
maxItems: 8
|
||
|
|
minItems: 1
|
||
|
|
type: array
|
||
|
|
x-kubernetes-list-map-keys:
|
||
|
|
- type
|
||
|
|
x-kubernetes-list-type: map
|
||
|
|
controllerName:
|
||
|
|
description: "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. \n Example:
|
||
|
|
\"example.net/gateway-controller\". \n 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)."
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
|
||
|
|
type: string
|
||
|
|
parentRef:
|
||
|
|
description: ParentRef corresponds with a ParentRef in the spec
|
||
|
|
that this RouteParentStatus struct describes the status of.
|
||
|
|
properties:
|
||
|
|
group:
|
||
|
|
default: gateway.networking.k8s.io
|
||
|
|
description: "Group is the group of the referent. \n Support:
|
||
|
|
Core"
|
||
|
|
maxLength: 253
|
||
|
|
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
kind:
|
||
|
|
default: Gateway
|
||
|
|
description: "Kind is kind of the referent. \n Support:
|
||
|
|
Core (Gateway) Support: Custom (Other Resources)"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
|
||
|
|
type: string
|
||
|
|
name:
|
||
|
|
description: "Name is the name of the referent. \n Support:
|
||
|
|
Core"
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
type: string
|
||
|
|
namespace:
|
||
|
|
description: "Namespace is the namespace of the referent.
|
||
|
|
When unspecified (or empty string), this refers to the
|
||
|
|
local namespace of the Route. \n Support: Core"
|
||
|
|
maxLength: 63
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
|
||
|
|
type: string
|
||
|
|
sectionName:
|
||
|
|
description: "SectionName is the name of a section within
|
||
|
|
the target resource. In the following resources, SectionName
|
||
|
|
is interpreted as the following: \n * Gateway: Listener
|
||
|
|
Name \n Implementations MAY choose to support attaching
|
||
|
|
Routes to other resources. If that is the case, they MUST
|
||
|
|
clearly document how SectionName is interpreted. \n 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. \n Support: Core"
|
||
|
|
maxLength: 253
|
||
|
|
minLength: 1
|
||
|
|
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- name
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- controllerName
|
||
|
|
- parentRef
|
||
|
|
type: object
|
||
|
|
maxItems: 32
|
||
|
|
type: array
|
||
|
|
required:
|
||
|
|
- parents
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- spec
|
||
|
|
type: object
|
||
|
|
served: true
|
||
|
|
storage: true
|
||
|
|
subresources:
|
||
|
|
status: {}
|
||
|
|
status:
|
||
|
|
acceptedNames:
|
||
|
|
kind: ""
|
||
|
|
plural: ""
|
||
|
|
conditions: []
|
||
|
|
storedVersions: []
|