diff --git a/gateway-api/kcl.mod b/gateway-api/kcl.mod index e393e94d..b37bbbb0 100644 --- a/gateway-api/kcl.mod +++ b/gateway-api/kcl.mod @@ -1,7 +1,7 @@ [package] name = "gateway-api" edition = "0.0.1" -version = "0.1.0" +version = "0.2.0" [dependencies] k8s = "1.28" diff --git a/gateway-api/update.sh b/gateway-api/update.sh new file mode 100755 index 00000000..d64940f6 --- /dev/null +++ b/gateway-api/update.sh @@ -0,0 +1,43 @@ +#!/bin/bash + +set -o errexit +set -o nounset +set -eoux pipefail + +VERSION="v1.1.0" + +rm -rf gateway-api +git clone https://github.com/kubernetes-sigs/gateway-api.git -b ${VERSION} --depth=1 + +for API in gateway-api/config/crd/standard/* +do + if [ "$(basename "${API}")" = "kustomization.yaml" ];then + continue + fi + kcl-openapi generate model --crd -f $API --skip-validation -t standard +done + +for API in gateway-api/config/crd/experimental/* +do + if [ "$(basename "${API}")" = "kustomization.yaml" ];then + continue + fi + kcl-openapi generate model --crd -f $API --skip-validation -t experimental +done + +rm -rf standard/models/k8s +rm -rf experimental/models/k8s + +mkdir -p v1 v1alpha2 v1beta1 + +mv standard/models/*_v1_*.k v1/ || true +mv standard/models/*_v1alpha2_*.k v1alpha2/ || true +mv standard/models/*_v1beta1_*.k v1beta1/ || true + +mv experimental/models/*_v1_*.k v1/ || true +mv experimental/models/*_v1alpha2_*.k v1alpha2/ || true +mv experimental/models/*_v1beta1_*.k v1beta1/ || true + +rm -rf standard +rm -rf experimental +rm -rf gateway-api diff --git a/gateway-api/v1/gateway_networking_k8s_io_v1_g_rpc_route.k b/gateway-api/v1/gateway_networking_k8s_io_v1_g_rpc_route.k new file mode 100644 index 00000000..a11ec6e3 --- /dev/null +++ b/gateway-api/v1/gateway_networking_k8s_io_v1_g_rpc_route.k @@ -0,0 +1,2351 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema GRPCRoute: + r""" + GRPCRoute provides a way to route gRPC requests. This includes the capability + to match requests by hostname, gRPC service, gRPC method, or HTTP/2 header. + Filters can be used to specify additional processing steps. Backends specify + where matching requests will be routed. + + + GRPCRoute falls under extended support within the Gateway API. Within the + following specification, the word "MUST" indicates that an implementation + supporting GRPCRoute must conform to the indicated requirement, but an + implementation not supporting this route type need not follow the requirement + unless explicitly indicated. + + + Implementations supporting `GRPCRoute` with the `HTTPS` `ProtocolType` MUST + accept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. via + ALPN. If the implementation does not support this, then it MUST set the + "Accepted" condition to "False" for the affected listener with a reason of + "UnsupportedProtocol". Implementations MAY also accept HTTP/2 connections + with an upgrade from HTTP/1. + + + Implementations supporting `GRPCRoute` with the `HTTP` `ProtocolType` MUST + support HTTP/2 over cleartext TCP (h2c, + https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initial + upgrade from HTTP/1.1, i.e. with prior knowledge + (https://www.rfc-editor.org/rfc/rfc7540#section-3.4). If the implementation + does not support this, then it MUST set the "Accepted" condition to "False" + for the affected listener with a reason of "UnsupportedProtocol". + Implementations MAY also accept HTTP/2 connections with an upgrade from + HTTP/1, i.e. without prior knowledge. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1", required + 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 + kind : str, default is "GRPCRoute", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1GRPCRouteSpec, default is Undefined, optional + spec + status : GatewayNetworkingK8sIoV1GRPCRouteStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1" = "gateway.networking.k8s.io/v1" + + kind: "GRPCRoute" = "GRPCRoute" + + metadata?: v1.ObjectMeta + + spec?: GatewayNetworkingK8sIoV1GRPCRouteSpec + + status?: GatewayNetworkingK8sIoV1GRPCRouteStatus + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpec: + r""" + Spec defines the desired state of GRPCRoute. + + Attributes + ---------- + hostnames : [str], default is Undefined, optional + Hostnames defines a set of hostnames to match against the GRPC + Host header to select a GRPCRoute to process the request. This matches + the RFC 1123 definition of a hostname with 2 notable exceptions: + + + 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. + + + If a hostname is specified by both the Listener and GRPCRoute, there + MUST be at least one intersecting hostname for the GRPCRoute to be + attached to the Listener. For example: + + + * A Listener with `test.example.com` as the hostname matches GRPCRoutes + 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 GRPCRoutes + 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. + + + 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 GRPCRoute have specified hostnames, any + GRPCRoute hostnames that do not match the Listener hostname MUST be + ignored. For example, if a Listener specified `*.example.com`, and the + GRPCRoute specified `test.example.com` and `test.example.net`, + `test.example.net` MUST NOT be considered for a match. + + + If both the Listener and GRPCRoute have specified hostnames, and none + match with the criteria above, then the GRPCRoute MUST NOT be accepted by + the implementation. The implementation MUST raise an 'Accepted' Condition + with a status of `False` in the corresponding RouteParentStatus. + + + If a Route (A) of type HTTPRoute or GRPCRoute is attached to a + Listener and that listener already has another Route (B) of the other + type attached and the intersection of the hostnames of A and B is + non-empty, then the implementation MUST accept exactly one of these two + routes, determined by the following criteria, in order: + + + * The oldest Route based on creation timestamp. + * The Route appearing first in alphabetical order by + "{namespace}/{name}". + + + The rejected Route MUST raise an 'Accepted' condition with a status of + 'False' in the corresponding RouteParentStatus. + + + Support: Core + parentRefs : [GatewayNetworkingK8sIoV1GRPCRouteSpecParentRefsItems0], default is Undefined, optional + 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. For Services, that means the Service must either be in the same + namespace for a "producer" route, or the mesh implementation must support + and allow "consumer" routes for the referenced Service. ReferenceGrant is + not applicable for governing ParentRefs to Services - it is not possible to + create a "producer" route for a Service in a different namespace from the + 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. + + + ParentRefs must be _distinct_. This means either that: + + + * They select different objects. If this is the case, then parentRef + entries are distinct. In terms of fields, this means that the + multi-part key defined by `group`, `kind`, `namespace`, and `name` must + be unique across all parentRef entries in the Route. + * They do not select different objects, but for each optional field used, + each ParentRef that selects the same object must set the same set of + optional fields to different values. If one ParentRef sets a + combination of optional fields, all must set the same combination. + + + Some examples: + + + * If one ParentRef sets `sectionName`, all ParentRefs referencing the + same object must also set `sectionName`. + * If one ParentRef sets `port`, all ParentRefs referencing the same + object must also set `port`. + * If one ParentRef sets `sectionName` and `port`, all ParentRefs + referencing the same object must also set `sectionName` and `port`. + + + 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. + + + Note that for ParentRefs that cross namespace boundaries, there are specific + rules. 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 other kinds of cross-namespace reference. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + + + + + rules : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0], default is Undefined, optional + Rules are a list of GRPC matchers, filters and actions. + """ + + + hostnames?: [str] + + parentRefs?: [GatewayNetworkingK8sIoV1GRPCRouteSpecParentRefsItems0] + + rules?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0] + + + check: + len(hostnames) <= 16 if hostnames + all hostnames in hostnames { len(hostnames) <= 253 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { len(hostnames) >= 1 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { _regex_match(str(hostnames), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostnames } if hostnames + len(parentRefs) <= 32 if parentRefs + len(rules) <= 16 if rules + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecParentRefsItems0: + r""" + 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. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0: + r""" + GRPCRouteRule defines the semantics for matching a gRPC request based on + conditions (matches), processing it (filters), and forwarding the request to + an API object (backendRefs). + + Attributes + ---------- + backendRefs : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional + BackendRefs defines the backend(s) where matching requests should be + sent. + + + Failure behavior here depends on how many BackendRefs are specified and + how many are invalid. + + + If *all* entries in BackendRefs are invalid, and there are also no filters + specified in this route rule, *all* traffic which matches this rule MUST + receive an `UNAVAILABLE` status. + + + See the GRPCBackendRef definition for the rules about what makes a single + GRPCBackendRef invalid. + + + When a GRPCBackendRef is invalid, `UNAVAILABLE` statuses MUST be returned for + requests that would have otherwise been routed to an invalid backend. If + multiple backends are specified, and some are invalid, the proportion of + requests that would otherwise have been routed to an invalid backend + MUST receive an `UNAVAILABLE` status. + + + For example, if two backends are specified with equal weights, and one is + invalid, 50 percent of traffic MUST receive an `UNAVAILABLE` status. + Implementations may choose how that 50 percent is determined. + + + Support: Core for Kubernetes Service + + + Support: Implementation-specific for any other resource + + + Support for weight: Core + filters : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0], default is Undefined, optional + Filters define the filters that are applied to requests that match + this rule. + + + The effects of ordering of multiple behaviors are currently unspecified. + This can change in the future based on feedback during the alpha stage. + + + Conformance-levels at this level are defined based on the type of filter: + + + - ALL core filters MUST be supported by all implementations that support + GRPCRoute. + - Implementers are encouraged to support extended filters. + - Implementation-specific custom filters have no API guarantees across + implementations. + + + Specifying the same filter multiple times is not supported unless explicitly + indicated in the filter. + + + If an implementation can not support a combination of filters, it must clearly + document that limitation. In cases where incompatible or unsupported + filters are specified and cause the `Accepted` condition to be set to status + `False`, implementations may use the `IncompatibleFilters` reason to specify + this configuration error. + + + Support: Core + matches : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0], default is Undefined, optional + Matches define conditions used for matching the rule against incoming + gRPC requests. Each match is independent, i.e. this rule will be matched + if **any** one of the matches is satisfied. + + + For example, take the following matches configuration: + + + ``` + matches: + - method: + service: foo.bar + headers: + values: + version: 2 + - method: + service: foo.bar.v2 + ``` + + + For a request to match against this rule, it MUST satisfy + EITHER of the two conditions: + + + - service of foo.bar AND contains the header `version: 2` + - service of foo.bar.v2 + + + See the documentation for GRPCRouteMatch on how to specify multiple + match conditions to be ANDed together. + + + If no matches are specified, the implementation MUST match every gRPC request. + + + Proxy or Load Balancer routing configuration generated from GRPCRoutes + MUST prioritize rules based on the following criteria, continuing on + ties. Merging MUST not be done between GRPCRoutes and HTTPRoutes. + Precedence MUST be given to the rule with the largest number of: + + + * Characters in a matching non-wildcard hostname. + * Characters in a matching hostname. + * Characters in a matching service. + * Characters in a matching method. + * Header matches. + + + If ties still exist across multiple Routes, matching precedence MUST be + determined in order of the following criteria, continuing on ties: + + + * The oldest Route based on creation timestamp. + * The Route appearing first in alphabetical order by + "{namespace}/{name}". + + + 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. + sessionPersistence : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0SessionPersistence, default is Undefined, optional + session persistence + """ + + + backendRefs?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0] + + filters?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0] + + matches?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0] + + sessionPersistence?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0SessionPersistence + + + check: + len(backendRefs) <= 16 if backendRefs + len(filters) <= 16 if filters + len(matches) <= 8 if matches + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0: + r""" + GRPCBackendRef defines how a GRPCRoute forwards a gRPC 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. + + + + + + When the BackendRef points to a Kubernetes Service, implementations SHOULD + honor the appProtocol field if it is set for the target Service Port. + + + Implementations supporting appProtocol SHOULD recognize the Kubernetes + Standard Application Protocols defined in KEP-3726. + + + If a Service appProtocol isn't specified, an implementation MAY infer the + backend protocol through its own means. Implementations MAY infer the + protocol from the Route type referring to the backend Service. + + + If a Route is not able to send traffic to the backend using the specified + protocol then the backend is considered invalid. Implementations MUST set the + "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. + + + + + Attributes + ---------- + filters : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0], default is Undefined, optional + Filters defined at this level MUST be executed if and only if the + request is being forwarded to the backend defined here. + + + Support: Implementation-specific (For broader support of filters, use the + Filters field in GRPCRouteRule.) + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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 : int, default is 1, optional + 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?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0] + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + weight?: int = 1 + + + check: + len(filters) <= 16 if filters + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + weight <= 1e+06 if weight not in [None, Undefined] + weight >= 0 if weight not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0: + r""" + GRPCRouteFilter defines processing steps that must be completed during the + request or response lifecycle. GRPCRouteFilters 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. + + Attributes + ---------- + extensionRef : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef, default is Undefined, optional + extension ref + requestHeaderModifier : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional + request header modifier + requestMirror : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror, default is Undefined, optional + request mirror + responseHeaderModifier : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional + response header modifier + $type : str, default is Undefined, 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 supporting GRPCRoute 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. `Type` MUST 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. + + + + """ + + + extensionRef?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef + + requestHeaderModifier?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier + + requestMirror?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror + + responseHeaderModifier?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier + + $type: "ResponseHeaderModifier" | "RequestHeaderModifier" | "RequestMirror" | "ExtensionRef" + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef: + r""" + 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. + + + Support: Implementation-specific + + + This filter can be used multiple times within the same rule. + + Attributes + ---------- + group : str, default is Undefined, 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 : str, default is Undefined, required + Kind is kind of the referent. For example "HTTPRoute" or "Service". + name : str, default is Undefined, required + Name is the name of the referent. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier: + r""" + RequestHeaderModifier defines a schema for a filter that modifies request + headers. + + + Support: Core + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror: + r""" + 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 + + Attributes + ---------- + backendRef : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required + backend ref + """ + + + backendRef: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef: + r""" + 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 + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier: + r""" + ResponseHeaderModifier defines a schema for a filter that modifies response + headers. + + + Support: Extended + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0: + r""" + GRPCRouteFilter defines processing steps that must be completed during the + request or response lifecycle. GRPCRouteFilters 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. + + Attributes + ---------- + extensionRef : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ExtensionRef, default is Undefined, optional + extension ref + requestHeaderModifier : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional + request header modifier + requestMirror : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestMirror, default is Undefined, optional + request mirror + responseHeaderModifier : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional + response header modifier + $type : str, default is Undefined, 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 supporting GRPCRoute 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. `Type` MUST 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. + + + + """ + + + extensionRef?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ExtensionRef + + requestHeaderModifier?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifier + + requestMirror?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestMirror + + responseHeaderModifier?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier + + $type: "ResponseHeaderModifier" | "RequestHeaderModifier" | "RequestMirror" | "ExtensionRef" + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ExtensionRef: + r""" + 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. + + + Support: Implementation-specific + + + This filter can be used multiple times within the same rule. + + Attributes + ---------- + group : str, default is Undefined, 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 : str, default is Undefined, required + Kind is kind of the referent. For example "HTTPRoute" or "Service". + name : str, default is Undefined, required + Name is the name of the referent. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifier: + r""" + RequestHeaderModifier defines a schema for a filter that modifies request + headers. + + + Support: Core + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestMirror: + r""" + 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 + + Attributes + ---------- + backendRef : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required + backend ref + """ + + + backendRef: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef: + r""" + 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 + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier: + r""" + ResponseHeaderModifier defines a schema for a filter that modifies response + headers. + + + Support: Extended + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0: + r""" + GRPCRouteMatch 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 gRPC request only if its service + is `foo` AND it contains the `version: v1` header: + + + ``` + matches: + - method: + type: Exact + service: "foo" + headers: + - name: "version" + value "v1" + + + ``` + + Attributes + ---------- + headers : [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0HeadersItems0], default is Undefined, optional + Headers specifies gRPC request header matchers. Multiple match values are + ANDed together, meaning, a request MUST match all the specified headers + to select the route. + method : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0Method, default is Undefined, optional + method + """ + + + headers?: [GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0HeadersItems0] + + method?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0Method + + + check: + len(headers) <= 16 if headers + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0HeadersItems0: + r""" + GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request + headers. + + Attributes + ---------- + name : str, default is Undefined, required + Name is the name of the gRPC Header to be matched. + + + 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. + $type : str, default is "Exact", optional + Type specifies how to match against the value of the header. + value : str, default is Undefined, required + Value is the value of the gRPC Header to be matched. + """ + + + name: str + + $type?: "Exact" | "RegularExpression" = "Exact" + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0MatchesItems0Method: + r""" + Method specifies a gRPC request service/method matcher. If this field is + not specified, all services and methods will match. + + Attributes + ---------- + method : str, default is Undefined, optional + Value of the method to match against. If left empty or omitted, will + match all services. + + + At least one of Service and Method MUST be a non-empty string. + service : str, default is Undefined, optional + Value of the service to match against. If left empty or omitted, will + match any service. + + + At least one of Service and Method MUST be a non-empty string. + $type : str, default is "Exact", optional + Type specifies how to match against the service and/or method. + Support: Core (Exact with service and method specified) + + + Support: Implementation-specific (Exact with method specified but no service specified) + + + Support: Implementation-specific (RegularExpression) + """ + + + method?: str + + service?: str + + $type?: "Exact" | "RegularExpression" = "Exact" + + + check: + len(method) <= 1024 if method + len(service) <= 1024 if service + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0SessionPersistence: + r""" + SessionPersistence defines and configures session persistence + for the route rule. + + + Support: Extended + + + + + Attributes + ---------- + absoluteTimeout : str, default is Undefined, optional + AbsoluteTimeout defines the absolute timeout of the persistent + session. Once the AbsoluteTimeout duration has elapsed, the + session becomes invalid. + + + Support: Extended + cookieConfig : GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0SessionPersistenceCookieConfig, default is Undefined, optional + cookie config + idleTimeout : str, default is Undefined, optional + IdleTimeout defines the idle timeout of the persistent session. + Once the session has been idle for more than the specified + IdleTimeout duration, the session becomes invalid. + + + Support: Extended + sessionName : str, default is Undefined, optional + SessionName defines the name of the persistent session token + which may be reflected in the cookie or the header. Users + should avoid reusing session names to prevent unintended + consequences, such as rejection or unpredictable behavior. + + + Support: Implementation-specific + $type : str, default is "Cookie", optional + Type defines the type of session persistence such as through + the use a header or cookie. Defaults to cookie based session + persistence. + + + Support: Core for "Cookie" type + + + Support: Extended for "Header" type + """ + + + absoluteTimeout?: str + + cookieConfig?: GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0SessionPersistenceCookieConfig + + idleTimeout?: str + + sessionName?: str + + $type?: "Cookie" | "Header" = "Cookie" + + + check: + _regex_match(str(absoluteTimeout), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if absoluteTimeout + _regex_match(str(idleTimeout), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if idleTimeout + len(sessionName) <= 128 if sessionName + + +schema GatewayNetworkingK8sIoV1GRPCRouteSpecRulesItems0SessionPersistenceCookieConfig: + r""" + CookieConfig provides configuration settings that are specific + to cookie-based session persistence. + + + Support: Core + + Attributes + ---------- + lifetimeType : str, default is "Session", optional + LifetimeType specifies whether the cookie has a permanent or + session-based lifetime. A permanent cookie persists until its + specified expiry time, defined by the Expires or Max-Age cookie + attributes, while a session cookie is deleted when the current + session ends. + + + When set to "Permanent", AbsoluteTimeout indicates the + cookie's lifetime via the Expires or Max-Age cookie attributes + and is required. + + + When set to "Session", AbsoluteTimeout indicates the + absolute lifetime of the cookie tracked by the gateway and + is optional. + + + Support: Core for "Session" type + + + Support: Extended for "Permanent" type + """ + + + lifetimeType?: "Permanent" | "Session" = "Session" + + +schema GatewayNetworkingK8sIoV1GRPCRouteStatus: + r""" + Status defines the current state of GRPCRoute. + + Attributes + ---------- + parents : [GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0], default is Undefined, required + 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. + + + 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. + + + A maximum of 32 Gateways will be represented in this list. An empty list + means the route has not been attached to any Gateway. + """ + + + parents: [GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0] + + + check: + len(parents) <= 32 + + +schema GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0: + r""" + RouteParentStatus describes the status of a route with respect to an + associated Parent. + + Attributes + ---------- + conditions : [GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional + 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. + + + 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. + + + A Route MUST be considered "Accepted" if at least one of the Route's + rules is implemented by the Gateway. + + + There are a number of cases where the "Accepted" condition may not be set + due to lack of controller visibility, that includes when: + + + * 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 controller does not have access to. + controllerName : str, default is Undefined, 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 : GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0ParentRef, default is Undefined, required + parent ref + """ + + + conditions?: [GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0ConditionsItems0] + + controllerName: str + + parentRef: GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0ParentRef + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1GRPCRouteStatusParentsItems0ParentRef: + r""" + ParentRef corresponds with a ParentRef in the spec that this + RouteParentStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + diff --git a/gateway-api/v1/gateway_networking_k8s_io_v1_gateway.k b/gateway-api/v1/gateway_networking_k8s_io_v1_gateway.k new file mode 100644 index 00000000..e6e8f674 --- /dev/null +++ b/gateway-api/v1/gateway_networking_k8s_io_v1_gateway.k @@ -0,0 +1,1222 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema Gateway: + r""" + Gateway represents an instance of a service-traffic handling infrastructure + by binding Listeners to a set of IP addresses. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1", required + 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 + kind : str, default is "Gateway", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1GatewaySpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1GatewayStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1" = "gateway.networking.k8s.io/v1" + + kind: "Gateway" = "Gateway" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1GatewaySpec + + status?: GatewayNetworkingK8sIoV1GatewayStatus + + +schema GatewayNetworkingK8sIoV1GatewaySpec: + r""" + Spec defines the desired state of Gateway. + + Attributes + ---------- + addresses : [GatewayNetworkingK8sIoV1GatewaySpecAddressesItems0], default is Undefined, optional + Addresses requested for this Gateway. This is optional and behavior can + depend on the implementation. If a value is set in the spec and the + requested address is invalid or unavailable, the implementation MUST + indicate this in the associated entry in GatewayStatus.Addresses. + + + The Addresses field represents a request for the address(es) on the + "outside of the Gateway", that traffic bound for this Gateway will use. + This could be the IP address or hostname of an external load balancer or + other networking infrastructure, or some other address that traffic will + be sent to. + + + If no Addresses are specified, the implementation MAY schedule the + Gateway in an implementation-specific manner, assigning an appropriate + set of Addresses. + + + The implementation MUST bind all Listeners to every GatewayAddress that + it assigns to the Gateway and add a corresponding entry in + GatewayStatus.Addresses. + + + Support: Extended + + + + gatewayClassName : str, default is Undefined, required + GatewayClassName used for this Gateway. This is the name of a + GatewayClass resource. + listeners : [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0], default is Undefined, required + Listeners associated with this Gateway. Listeners define + logical endpoints that are bound on this Gateway's addresses. + At least one Listener MUST be specified. + + + Each Listener in a set of Listeners (for example, in a single Gateway) + MUST be _distinct_, in that a traffic flow MUST be able to be assigned to + exactly one listener. (This section uses "set of Listeners" rather than + "Listeners in a single Gateway" because implementations MAY merge configuration + from multiple Gateways onto a single data plane, and these rules _also_ + apply in that case). + + + Practically, this means that each listener in a set MUST have a unique + combination of Port, Protocol, and, if supported by the protocol, Hostname. + + + Some combinations of port, protocol, and TLS settings are considered + Core support and MUST be supported by implementations based on their + targeted conformance profile: + + + HTTP Profile + + + 1. HTTPRoute, Port: 80, Protocol: HTTP + 2. HTTPRoute, Port: 443, Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided + + + TLS Profile + + + 1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode: Passthrough + + + "Distinct" Listeners have the following property: + + + The implementation can match inbound requests to a single distinct + Listener. When multiple Listeners share values for fields (for + example, two Listeners with the same Port value), the implementation + can match requests to only one of the Listeners using other + Listener fields. + + + For example, the following Listener scenarios are distinct: + + + 1. Multiple Listeners with the same Port that all use the "HTTP" + Protocol that all have unique Hostname values. + 2. Multiple Listeners with the same Port that use either the "HTTPS" or + "TLS" Protocol that all have unique Hostname values. + 3. A mixture of "TCP" and "UDP" Protocol Listeners, where no Listener + with the same Protocol has the same Port value. + + + Some fields in the Listener struct have possible values that affect + whether the Listener is distinct. Hostname is particularly relevant + for HTTP or HTTPS protocols. + + + When using the Hostname value to select between same-Port, same-Protocol + Listeners, the Hostname value must be different on each Listener for the + Listener to be distinct. + + + When the Listeners are distinct based on Hostname, inbound request + hostnames MUST match from the most specific to least specific Hostname + values to choose the correct Listener and its associated set of Routes. + + + Exact matches must be processed before wildcard matches, and wildcard + matches must be processed before fallback (empty Hostname value) + matches. For example, `"foo.example.com"` takes precedence over + `"*.example.com"`, and `"*.example.com"` takes precedence over `""`. + + + Additionally, if there are multiple wildcard entries, more specific + wildcard entries must be processed before less specific wildcard entries. + For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. + The precise definition here is that the higher the number of dots in the + hostname to the right of the wildcard character, the higher the precedence. + + + The wildcard character will match any number of characters _and dots_ to + the left, however, so `"*.example.com"` will match both + `"foo.bar.example.com"` _and_ `"bar.example.com"`. + + + If a set of Listeners contains Listeners that are not distinct, then those + Listeners are Conflicted, and the implementation MUST set the "Conflicted" + condition in the Listener Status to "True". + + + Implementations MAY choose to accept a Gateway with some Conflicted + Listeners only if they only accept the partial Listener set that contains + no Conflicted Listeners. To put this another way, implementations may + accept a partial Listener set only if they throw out *all* the conflicting + Listeners. No picking one of the conflicting listeners as the winner. + This also means that the Gateway must have at least one non-conflicting + Listener in this case, otherwise it violates the requirement that at + least one Listener must be present. + + + The implementation MUST set a "ListenersNotValid" condition on the + Gateway Status when the Gateway contains Conflicted Listeners whether or + not they accept the Gateway. That Condition SHOULD clearly + indicate in the Message which Listeners are conflicted, and which are + Accepted. Additionally, the Listener status for those listeners SHOULD + indicate which Listeners are conflicted and not Accepted. + + + A Gateway's Listeners are considered "compatible" if: + + + 1. They are distinct. + 2. The implementation can serve them in compliance with the Addresses + requirement that all Listeners are available on all assigned + addresses. + + + Compatible combinations in Extended support are expected to vary across + implementations. A combination that is compatible for one implementation + may not be compatible for another. + + + For example, an implementation that cannot serve both TCP and UDP listeners + on the same address, or cannot mix HTTPS and generic TLS listens on the same port + would not consider those cases compatible, even though they are distinct. + + + Note that requests SHOULD match at most one Listener. For example, if + Listeners are defined for "foo.example.com" and "*.example.com", a + request to "foo.example.com" SHOULD only be routed using routes attached + to the "foo.example.com" Listener (and not the "*.example.com" Listener). + This concept is known as "Listener Isolation". Implementations that do + not support Listener Isolation MUST clearly document this. + + + Implementations MAY merge separate Gateways onto a single set of + Addresses if all Listeners across all Gateways are compatible. + + + Support: Core + infrastructure : GatewayNetworkingK8sIoV1GatewaySpecInfrastructure, default is Undefined, optional + infrastructure + """ + + + addresses?: [GatewayNetworkingK8sIoV1GatewaySpecAddressesItems0] + + gatewayClassName: str + + listeners: [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0] + + infrastructure?: GatewayNetworkingK8sIoV1GatewaySpecInfrastructure + + + check: + len(addresses) <= 16 if addresses + len(gatewayClassName) <= 253 + len(gatewayClassName) >= 1 + len(listeners) >= 1 + len(listeners) <= 64 + + +schema GatewayNetworkingK8sIoV1GatewaySpecAddressesItems0: + r""" + GatewayAddress describes an address that can be bound to a Gateway. + + Attributes + ---------- + $type : str, default is "IPAddress", optional + Type of the address. + value : str, default is Undefined, required + Value of the address. The validity of the values will depend + on the type and support by the controller. + + + Examples: `1.2.3.4`, `128::1`, `my-ip-address`. + """ + + + $type?: str = "IPAddress" + + value: str + + + check: + len($type) <= 253 if $type + len($type) >= 1 if $type + _regex_match(str($type), r"^Hostname|IPAddress|NamedAddress|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") if $type + len(value) <= 253 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GatewaySpecInfrastructure: + r""" + Infrastructure defines infrastructure level attributes about this Gateway instance. + + + Support: Core + + + + + Attributes + ---------- + annotations : {str:str}, default is Undefined, optional + Annotations that SHOULD be applied to any resources created in response to this Gateway. + + + For implementations creating other Kubernetes objects, this should be the `metadata.annotations` field on resources. + For other implementations, this refers to any relevant (implementation specific) "annotations" concepts. + + + An implementation may chose to add additional implementation-specific annotations as they see fit. + + + Support: Extended + labels : {str:str}, default is Undefined, optional + Labels that SHOULD be applied to any resources created in response to this Gateway. + + + For implementations creating other Kubernetes objects, this should be the `metadata.labels` field on resources. + For other implementations, this refers to any relevant (implementation specific) "labels" concepts. + + + An implementation may chose to add additional implementation-specific labels as they see fit. + + + Support: Extended + parametersRef : GatewayNetworkingK8sIoV1GatewaySpecInfrastructureParametersRef, default is Undefined, optional + parameters ref + """ + + + annotations?: {str:str} + + labels?: {str:str} + + parametersRef?: GatewayNetworkingK8sIoV1GatewaySpecInfrastructureParametersRef + + + check: + all _, annotations in annotations { len(annotations) <= 4096 if annotations not in [None, Undefined] } if annotations + all _, annotations in annotations { len(annotations) >= 0 if annotations not in [None, Undefined] } if annotations + all _, labels in labels { len(labels) <= 4096 if labels not in [None, Undefined] } if labels + all _, labels in labels { len(labels) >= 0 if labels not in [None, Undefined] } if labels + + +schema GatewayNetworkingK8sIoV1GatewaySpecInfrastructureParametersRef: + r""" + ParametersRef is a reference to a resource that contains the configuration + parameters corresponding to the Gateway. This is optional if the + controller does not require any additional configuration. + + + This follows the same semantics as GatewayClass's `parametersRef`, but on a per-Gateway basis + + + The Gateway's GatewayClass may provide its own `parametersRef`. When both are specified, + the merging behavior is implementation specific. + It is generally recommended that GatewayClass provides defaults that can be overridden by a Gateway. + + + Support: Implementation-specific + + Attributes + ---------- + group : str, default is Undefined, required + Group is the group of the referent. + kind : str, default is Undefined, required + Kind is kind of the referent. + name : str, default is Undefined, required + Name is the name of the referent. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0: + r""" + Listener embodies the concept of a logical endpoint where a Gateway accepts + network connections. + + Attributes + ---------- + allowedRoutes : GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutes, default is Undefined, optional + allowed routes + hostname : str, default is Undefined, optional + Hostname specifies the virtual hostname to match for protocol types that + define this concept. When unspecified, all hostnames are matched. This + field is ignored for protocols that don't require hostname based + matching. + + + Implementations MUST apply Hostname matching appropriately for each of + the following protocols: + + + * TLS: The Listener Hostname MUST match the SNI. + * HTTP: The Listener Hostname MUST match the Host header of the request. + * HTTPS: The Listener Hostname SHOULD match at both the TLS and HTTP + protocol layers as described above. If an implementation does not + ensure that both the SNI and Host header match the Listener hostname, + it MUST clearly document that. + + + For HTTPRoute and TLSRoute resources, there is an interaction with the + `spec.hostnames` array. When both listener and route specify hostnames, + there MUST be an intersection between the values for a Route to be + accepted. For more information, refer to the Route specific Hostnames + documentation. + + + 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`. + + + Support: Core + name : str, default is Undefined, required + Name is the name of the Listener. This name MUST be unique within a + Gateway. + + + Support: Core + port : int, default is Undefined, required + Port is the network port. Multiple listeners may use the + same port, subject to the Listener compatibility rules. + + + Support: Core + $protocol : str, default is Undefined, required + Protocol specifies the network protocol this listener expects to receive. + + + Support: Core + tls : GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLS, default is Undefined, optional + tls + """ + + + allowedRoutes?: GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutes + + hostname?: str + + name: str + + port: int + + $protocol: str + + tls?: GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLS + + + check: + len(hostname) <= 253 if hostname + len(hostname) >= 1 if hostname + _regex_match(str(hostname), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname + len(name) <= 253 + len(name) >= 1 + _regex_match(str(name), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + port <= 65535 + port >= 1 + len($protocol) <= 255 + len($protocol) >= 1 + _regex_match(str($protocol), r"^[a-zA-Z0-9]([-a-zSA-Z0-9]*[a-zA-Z0-9])?$|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9]+$") + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutes: + r""" + AllowedRoutes defines the types of routes that MAY be attached to a + Listener and the trusted namespaces where those Route resources MAY be + present. + + + Although a client request may match multiple route rules, only one rule + may ultimately receive the request. Matching precedence MUST be + determined in order of the following criteria: + + + * The most specific match as defined by the Route type. + * The oldest Route based on creation timestamp. For example, a Route with + a creation timestamp of "2020-09-08 01:02:03" is given precedence over + a Route with a creation timestamp of "2020-09-08 01:02:04". + * If everything else is equivalent, the Route appearing first in + alphabetical order (namespace/name) should be given precedence. For + example, foo/bar is given precedence over foo/baz. + + + All valid rules within a Route attached to this Listener should be + implemented. Invalid Route rules can be ignored (sometimes that will mean + the full Route). If a Route rule transitions from valid to invalid, + support for that Route rule should be dropped to ensure consistency. For + example, even if a filter specified by a Route rule is invalid, the rest + of the rules within that Route should still be supported. + + + Support: Core + + Attributes + ---------- + kinds : [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesKindsItems0], default is Undefined, optional + Kinds specifies the groups and kinds of Routes that are allowed to bind + to this Gateway Listener. When unspecified or empty, the kinds of Routes + selected are determined using the Listener protocol. + + + A RouteGroupKind MUST correspond to kinds of Routes that are compatible + with the application protocol specified in the Listener's Protocol field. + If an implementation does not support or recognize this resource type, it + MUST set the "ResolvedRefs" condition to False for this Listener with the + "InvalidRouteKinds" reason. + + + Support: Core + namespaces : GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespaces, default is Undefined, optional + namespaces + """ + + + kinds?: [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesKindsItems0] + + namespaces?: GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespaces + + + check: + len(kinds) <= 8 if kinds + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesKindsItems0: + r""" + RouteGroupKind indicates the group and kind of a Route resource. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + Group is the group of the Route. + kind : str, default is Undefined, required + Kind is the kind of the Route. + """ + + + group?: str = "gateway.networking.k8s.io" + + kind: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespaces: + r""" + Namespaces indicates namespaces from which Routes may be attached to this + Listener. This is restricted to the namespace of this Gateway by default. + + + Support: Core + + Attributes + ---------- + from : str, default is "Same", optional + From indicates where Routes will be selected for this Gateway. Possible + values are: + + + * All: Routes in all namespaces may be used by this Gateway. + * Selector: Routes in namespaces selected by the selector may be used by + this Gateway. + * Same: Only Routes in the same namespace may be used by this Gateway. + + + Support: Core + selector : GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespacesSelector, default is Undefined, optional + selector + """ + + + from?: "All" | "Selector" | "Same" = "Same" + + selector?: GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespacesSelector + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespacesSelector: + r""" + Selector must be specified when From is set to "Selector". In that case, + only Routes in Namespaces matching this Selector will be selected by this + Gateway. This field is ignored for other values of "From". + + + Support: Core + + Attributes + ---------- + matchExpressions : [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespacesSelectorMatchExpressionsItems0], default is Undefined, optional + matchExpressions is a list of label selector requirements. The requirements are ANDed. + matchLabels : {str:str}, default is Undefined, optional + matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels + map is equivalent to an element of matchExpressions, whose key field is "key", the + operator is "In", and the values array contains only "value". The requirements are ANDed. + """ + + + matchExpressions?: [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespacesSelectorMatchExpressionsItems0] + + matchLabels?: {str:str} + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0AllowedRoutesNamespacesSelectorMatchExpressionsItems0: + r""" + A label selector requirement is a selector that contains values, a key, and an operator that + relates the key and values. + + Attributes + ---------- + key : str, default is Undefined, required + key is the label key that the selector applies to. + operator : str, default is Undefined, required + operator represents a key's relationship to a set of values. + Valid operators are In, NotIn, Exists and DoesNotExist. + values : [str], default is Undefined, optional + values is an array of string values. If the operator is In or NotIn, + the values array must be non-empty. If the operator is Exists or DoesNotExist, + the values array must be empty. This array is replaced during a strategic + merge patch. + """ + + + key: str + + operator: str + + values?: [str] + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLS: + r""" + TLS is the TLS configuration for the Listener. This field is required if + the Protocol field is "HTTPS" or "TLS". It is invalid to set this field + if the Protocol field is "HTTP", "TCP", or "UDP". + + + The association of SNIs to Certificate defined in GatewayTLSConfig is + defined based on the Hostname field for this listener. + + + The GatewayClass MUST use the longest matching SNI out of all + available certificates for any TLS handshake. + + + Support: Core + + Attributes + ---------- + certificateRefs : [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSCertificateRefsItems0], default is Undefined, optional + CertificateRefs contains a series of references to Kubernetes objects that + contains TLS certificates and private keys. These certificates are used to + establish a TLS handshake for requests that match the hostname of the + associated listener. + + + A single CertificateRef to a Kubernetes Secret has "Core" support. + Implementations MAY choose to support attaching multiple certificates to + a Listener, but this behavior is implementation-specific. + + + References to a resource in different namespace are invalid UNLESS there + is a ReferenceGrant in the target namespace that allows the certificate + to be attached. If a ReferenceGrant does not allow this reference, the + "ResolvedRefs" condition MUST be set to False for this listener with the + "RefNotPermitted" reason. + + + This field is required to have at least one element when the mode is set + to "Terminate" (default) and is optional otherwise. + + + CertificateRefs can reference to standard Kubernetes resources, i.e. + Secret, or implementation-specific custom resources. + + + Support: Core - A single reference to a Kubernetes Secret of type kubernetes.io/tls + + + Support: Implementation-specific (More than one reference or other resource types) + frontendValidation : GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSFrontendValidation, default is Undefined, optional + frontend validation + mode : str, default is "Terminate", optional + Mode defines the TLS behavior for the TLS session initiated by the client. + There are two possible modes: + + + - Terminate: The TLS session between the downstream client and the + Gateway is terminated at the Gateway. This mode requires certificates + to be specified in some way, such as populating the certificateRefs + field. + - Passthrough: The TLS session is NOT terminated by the Gateway. This + implies that the Gateway can't decipher the TLS stream except for + the ClientHello message of the TLS protocol. The certificateRefs field + is ignored in this mode. + + + Support: Core + options : {str:str}, default is Undefined, optional + Options are a list of key/value pairs to enable extended TLS + configuration for each implementation. For example, configuring the + minimum TLS version or supported cipher suites. + + + A set of common keys MAY be defined by the API in the future. To avoid + any ambiguity, implementation-specific definitions MUST use + domain-prefixed names, such as `example.com/my-custom-option`. + Un-prefixed names are reserved for key names defined by Gateway API. + + + Support: Implementation-specific + """ + + + certificateRefs?: [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSCertificateRefsItems0] + + frontendValidation?: GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSFrontendValidation + + mode?: "Terminate" | "Passthrough" = "Terminate" + + options?: {str:str} + + + check: + len(certificateRefs) <= 64 if certificateRefs + all _, options in options { len(options) <= 4096 if options not in [None, Undefined] } if options + all _, options in options { len(options) >= 0 if options not in [None, Undefined] } if options + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSCertificateRefsItems0: + r""" + SecretObjectReference identifies an API object including its namespace, + defaulting to Secret. + + + 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. + + + 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. + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Secret", optional + Kind is kind of the referent. For example "Secret". + name : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + Namespace is the namespace of the referenced object. 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 + """ + + + group?: str = "" + + kind?: str = "Secret" + + name: str + + namespace?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSFrontendValidation: + r""" + FrontendValidation holds configuration information for validating the frontend (client). + Setting this field will require clients to send a client certificate + required for validation during the TLS handshake. In browsers this may result in a dialog appearing + that requests a user to specify the client certificate. + The maximum depth of a certificate chain accepted in verification is Implementation specific. + + + Support: Extended + + + + + Attributes + ---------- + caCertificateRefs : [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSFrontendValidationCaCertificateRefsItems0], default is Undefined, optional + CACertificateRefs contains one or more references to + Kubernetes objects that contain TLS certificates of + the Certificate Authorities that can be used + as a trust anchor to validate the certificates presented by the client. + + + A single CA certificate reference to a Kubernetes ConfigMap + has "Core" support. + Implementations MAY choose to support attaching multiple CA certificates to + a Listener, but this behavior is implementation-specific. + + + Support: Core - A single reference to a Kubernetes ConfigMap + with the CA certificate in a key named `ca.crt`. + + + Support: Implementation-specific (More than one reference, or other kinds + of resources). + + + References to a resource in a different namespace are invalid UNLESS there + is a ReferenceGrant in the target namespace that allows the certificate + to be attached. If a ReferenceGrant does not allow this reference, the + "ResolvedRefs" condition MUST be set to False for this listener with the + "RefNotPermitted" reason. + """ + + + caCertificateRefs?: [GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSFrontendValidationCaCertificateRefsItems0] + + + check: + len(caCertificateRefs) >= 1 if caCertificateRefs + len(caCertificateRefs) <= 8 if caCertificateRefs + + +schema GatewayNetworkingK8sIoV1GatewaySpecListenersItems0TLSFrontendValidationCaCertificateRefsItems0: + r""" + ObjectReference identifies an API object including its namespace. + + + 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. + + + 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. + + Attributes + ---------- + group : str, default is Undefined, 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 : str, default is Undefined, required + Kind is kind of the referent. For example "ConfigMap" or "Service". + name : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + Namespace is the namespace of the referenced object. 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 + """ + + + group: str + + kind: str + + name: str + + namespace?: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + + +schema GatewayNetworkingK8sIoV1GatewayStatus: + r""" + Status defines the current state of Gateway. + + Attributes + ---------- + addresses : [GatewayNetworkingK8sIoV1GatewayStatusAddressesItems0], default is Undefined, optional + Addresses lists the network addresses that have been bound to the + Gateway. + + + This list may differ from the addresses provided in the spec under some + conditions: + + + * no addresses are specified, all addresses are dynamically assigned + * a combination of specified and dynamic addresses are assigned + * a specified address was unusable (e.g. already in use) + + + + conditions : [GatewayNetworkingK8sIoV1GatewayStatusConditionsItems0], default is [{"lastTransitionTime": {"value": "1970-01-01T00:00:00Z", "x-order": 0}, "message": {"x-order": 1, "value": "Waiting for controller"}, "reason": {"value": "Pending", "x-order": 2}, "status": {"value": "Unknown", "x-order": 3}, "type": {"value": "Accepted", "x-order": 4}}, {"lastTransitionTime": {"value": "1970-01-01T00:00:00Z", "x-order": 0}, "message": {"value": "Waiting for controller", "x-order": 1}, "reason": {"value": "Pending", "x-order": 2}, "status": {"value": "Unknown", "x-order": 3}, "type": {"x-order": 4, "value": "Programmed"}}], optional + Conditions describe the current conditions of the Gateway. + + + Implementations should prefer to express Gateway conditions + using the `GatewayConditionType` and `GatewayConditionReason` + constants so that operators and tools can converge on a common + vocabulary to describe Gateway state. + + + Known condition types are: + + + * "Accepted" + * "Programmed" + * "Ready" + listeners : [GatewayNetworkingK8sIoV1GatewayStatusListenersItems0], default is Undefined, optional + Listeners provide status for each unique listener port defined in the Spec. + """ + + + addresses?: [GatewayNetworkingK8sIoV1GatewayStatusAddressesItems0] + + conditions?: [GatewayNetworkingK8sIoV1GatewayStatusConditionsItems0] = [{"lastTransitionTime": {"value": "1970-01-01T00:00:00Z", "x-order": 0}, "message": {"value": "Waiting for controller", "x-order": 1}, "reason": {"value": "Pending", "x-order": 2}, "status": {"value": "Unknown", "x-order": 3}, "type": {"x-order": 4, "value": "Accepted"}}, {"lastTransitionTime": {"value": "1970-01-01T00:00:00Z", "x-order": 0}, "message": {"value": "Waiting for controller", "x-order": 1}, "reason": {"value": "Pending", "x-order": 2}, "status": {"value": "Unknown", "x-order": 3}, "type": {"x-order": 4, "value": "Programmed"}}] + + listeners?: [GatewayNetworkingK8sIoV1GatewayStatusListenersItems0] + + + check: + len(addresses) <= 16 if addresses + len(conditions) <= 8 if conditions + len(listeners) <= 64 if listeners + + +schema GatewayNetworkingK8sIoV1GatewayStatusAddressesItems0: + r""" + GatewayStatusAddress describes a network address that is bound to a Gateway. + + Attributes + ---------- + $type : str, default is "IPAddress", optional + Type of the address. + value : str, default is Undefined, required + Value of the address. The validity of the values will depend + on the type and support by the controller. + + + Examples: `1.2.3.4`, `128::1`, `my-ip-address`. + """ + + + $type?: str = "IPAddress" + + value: str + + + check: + len($type) <= 253 if $type + len($type) >= 1 if $type + _regex_match(str($type), r"^Hostname|IPAddress|NamedAddress|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") if $type + len(value) <= 253 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1GatewayStatusConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1GatewayStatusListenersItems0: + r""" + ListenerStatus is the status associated with a Listener. + + Attributes + ---------- + attachedRoutes : int, default is Undefined, required + AttachedRoutes represents the total number of Routes that have been + successfully attached to this Listener. + + + Successful attachment of a Route to a Listener is based solely on the + combination of the AllowedRoutes field on the corresponding Listener + and the Route's ParentRefs field. A Route is successfully attached to + a Listener when it is selected by the Listener's AllowedRoutes field + AND the Route has a valid ParentRef selecting the whole Gateway + resource or a specific Listener as a parent resource (more detail on + attachment semantics can be found in the documentation on the various + Route kinds ParentRefs fields). Listener or Route status does not impact + successful attachment, i.e. the AttachedRoutes field count MUST be set + for Listeners with condition Accepted: false and MUST count successfully + attached Routes that may themselves have Accepted: false conditions. + + + Uses for this field include troubleshooting Route attachment and + measuring blast radius/impact of changes to a Listener. + conditions : [GatewayNetworkingK8sIoV1GatewayStatusListenersItems0ConditionsItems0], default is Undefined, required + Conditions describe the current condition of this listener. + name : str, default is Undefined, required + Name is the name of the Listener that this status corresponds to. + supportedKinds : [GatewayNetworkingK8sIoV1GatewayStatusListenersItems0SupportedKindsItems0], default is Undefined, required + SupportedKinds is the list indicating the Kinds supported by this + listener. This MUST represent the kinds an implementation supports for + that Listener configuration. + + + If kinds are specified in Spec that are not supported, they MUST NOT + appear in this list and an implementation MUST set the "ResolvedRefs" + condition to "False" with the "InvalidRouteKinds" reason. If both valid + and invalid Route kinds are specified, the implementation MUST + reference the valid Route kinds that have been specified. + """ + + + attachedRoutes: int + + conditions: [GatewayNetworkingK8sIoV1GatewayStatusListenersItems0ConditionsItems0] + + name: str + + supportedKinds: [GatewayNetworkingK8sIoV1GatewayStatusListenersItems0SupportedKindsItems0] + + + check: + len(conditions) <= 8 + len(name) <= 253 + len(name) >= 1 + _regex_match(str(name), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(supportedKinds) <= 8 + + +schema GatewayNetworkingK8sIoV1GatewayStatusListenersItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1GatewayStatusListenersItems0SupportedKindsItems0: + r""" + RouteGroupKind indicates the group and kind of a Route resource. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + Group is the group of the Route. + kind : str, default is Undefined, required + Kind is the kind of the Route. + """ + + + group?: str = "gateway.networking.k8s.io" + + kind: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + + diff --git a/gateway-api/v1/gateway_networking_k8s_io_v1_gateway_class.k b/gateway-api/v1/gateway_networking_k8s_io_v1_gateway_class.k new file mode 100644 index 00000000..a8b23cad --- /dev/null +++ b/gateway-api/v1/gateway_networking_k8s_io_v1_gateway_class.k @@ -0,0 +1,263 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema GatewayClass: + r""" + GatewayClass describes a class of Gateways available to the user for creating + Gateway resources. + + + It is recommended that this resource be used as a template for Gateways. This + means that a Gateway is based on the state of the GatewayClass at the time it + was created and changes to the GatewayClass or associated parameters are not + propagated down to existing Gateways. This recommendation is intended to + limit the blast radius of changes to GatewayClass or associated parameters. + If implementations choose to propagate GatewayClass changes to existing + Gateways, that MUST be clearly documented by the implementation. + + + Whenever one or more Gateways are using a GatewayClass, implementations SHOULD + add the `gateway-exists-finalizer.gateway.networking.k8s.io` finalizer on the + associated GatewayClass. This ensures that a GatewayClass associated with a + Gateway is not deleted while in use. + + + GatewayClass is a Cluster level resource. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1", required + 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 + kind : str, default is "GatewayClass", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1GatewayClassSpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1GatewayClassStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1" = "gateway.networking.k8s.io/v1" + + kind: "GatewayClass" = "GatewayClass" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1GatewayClassSpec + + status?: GatewayNetworkingK8sIoV1GatewayClassStatus + + +schema GatewayNetworkingK8sIoV1GatewayClassSpec: + r""" + Spec defines the desired state of GatewayClass. + + Attributes + ---------- + controllerName : str, default is Undefined, required + ControllerName is the name of the controller that is managing Gateways of + this class. The value of this field MUST be a domain prefixed path. + + + Example: "example.net/gateway-controller". + + + This field is not mutable and cannot be empty. + + + Support: Core + description : str, default is Undefined, optional + Description helps describe a GatewayClass with more details. + parametersRef : GatewayNetworkingK8sIoV1GatewayClassSpecParametersRef, default is Undefined, optional + parameters ref + """ + + + controllerName: str + + description?: str + + parametersRef?: GatewayNetworkingK8sIoV1GatewayClassSpecParametersRef + + + check: + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + len(description) <= 64 if description + + +schema GatewayNetworkingK8sIoV1GatewayClassSpecParametersRef: + r""" + ParametersRef is a reference to a resource that contains the configuration + parameters corresponding to the GatewayClass. This is optional if the + controller does not require any additional configuration. + + + ParametersRef can reference a standard Kubernetes resource, i.e. ConfigMap, + or an implementation-specific custom resource. The resource can be + cluster-scoped or namespace-scoped. + + + If the referent cannot be found, the GatewayClass's "InvalidParameters" + status condition will be true. + + + A Gateway for this GatewayClass may provide its own `parametersRef`. When both are specified, + the merging behavior is implementation specific. + It is generally recommended that GatewayClass provides defaults that can be overridden by a Gateway. + + + Support: Implementation-specific + + Attributes + ---------- + group : str, default is Undefined, required + Group is the group of the referent. + kind : str, default is Undefined, required + Kind is kind of the referent. + name : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + Namespace is the namespace of the referent. + This field is required when referring to a Namespace-scoped resource and + MUST be unset when referring to a Cluster-scoped resource. + """ + + + group: str + + kind: str + + name: str + + namespace?: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + + +schema GatewayNetworkingK8sIoV1GatewayClassStatus: + r""" + Status defines the current state of GatewayClass. + + + Implementations MUST populate status on all GatewayClass resources which + specify their controller name. + + Attributes + ---------- + conditions : [GatewayNetworkingK8sIoV1GatewayClassStatusConditionsItems0], default is [{"lastTransitionTime": {"value": "1970-01-01T00:00:00Z", "x-order": 0}, "message": {"value": "Waiting for controller", "x-order": 1}, "reason": {"value": "Pending", "x-order": 2}, "status": {"value": "Unknown", "x-order": 3}, "type": {"value": "Accepted", "x-order": 4}}], optional + Conditions is the current status from the controller for + this GatewayClass. + + + Controllers should prefer to publish conditions using values + of GatewayClassConditionType for the type of each Condition. + supportedFeatures : [str], default is Undefined, optional + SupportedFeatures is the set of features the GatewayClass support. + It MUST be sorted in ascending alphabetical order. + + """ + + + conditions?: [GatewayNetworkingK8sIoV1GatewayClassStatusConditionsItems0] = [{"message": {"value": "Waiting for controller", "x-order": 1}, "reason": {"value": "Pending", "x-order": 2}, "status": {"value": "Unknown", "x-order": 3}, "type": {"value": "Accepted", "x-order": 4}, "lastTransitionTime": {"value": "1970-01-01T00:00:00Z", "x-order": 0}}] + + supportedFeatures?: [str] + + + check: + len(conditions) <= 8 if conditions + len(supportedFeatures) <= 64 if supportedFeatures + + +schema GatewayNetworkingK8sIoV1GatewayClassStatusConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + diff --git a/gateway-api/v1/gateway_networking_k8s_io_v1_http_route.k b/gateway-api/v1/gateway_networking_k8s_io_v1_http_route.k new file mode 100644 index 00000000..afc0ad33 --- /dev/null +++ b/gateway-api/v1/gateway_networking_k8s_io_v1_http_route.k @@ -0,0 +1,3105 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema HTTPRoute: + r""" + 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. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1", required + 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 + kind : str, default is "HTTPRoute", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1HTTPRouteSpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1HTTPRouteStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1" = "gateway.networking.k8s.io/v1" + + kind: "HTTPRoute" = "HTTPRoute" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1HTTPRouteSpec + + status?: GatewayNetworkingK8sIoV1HTTPRouteStatus + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpec: + r""" + Spec defines the desired state of HTTPRoute. + + Attributes + ---------- + hostnames : [str], default is Undefined, optional + 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: + + + 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. + + + 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.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, + `*.example.com`, `test.example.com`, and `foo.test.example.com` would + all match. On the other hand, `example.com` and `test.example.net` would + 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 : [GatewayNetworkingK8sIoV1HTTPRouteSpecParentRefsItems0], default is Undefined, optional + 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. For Services, that means the Service must either be in the same + namespace for a "producer" route, or the mesh implementation must support + and allow "consumer" routes for the referenced Service. ReferenceGrant is + not applicable for governing ParentRefs to Services - it is not possible to + create a "producer" route for a Service in a different namespace from the + 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. + + + ParentRefs must be _distinct_. This means either that: + + + * They select different objects. If this is the case, then parentRef + entries are distinct. In terms of fields, this means that the + multi-part key defined by `group`, `kind`, `namespace`, and `name` must + be unique across all parentRef entries in the Route. + * They do not select different objects, but for each optional field used, + each ParentRef that selects the same object must set the same set of + optional fields to different values. If one ParentRef sets a + combination of optional fields, all must set the same combination. + + + Some examples: + + + * If one ParentRef sets `sectionName`, all ParentRefs referencing the + same object must also set `sectionName`. + * If one ParentRef sets `port`, all ParentRefs referencing the same + object must also set `port`. + * If one ParentRef sets `sectionName` and `port`, all ParentRefs + referencing the same object must also set `sectionName` and `port`. + + + 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. + + + Note that for ParentRefs that cross namespace boundaries, there are specific + rules. 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 other kinds of cross-namespace reference. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + + + + + rules : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0], default is [{"matches": {"value": [{"path": {"value": {"type": {"value": "PathPrefix", "x-order": 0}, "value": {"value": "/", "x-order": 1}}, "x-order": 0}}], "x-order": 0}}], optional + Rules are a list of HTTP matchers, filters and actions. + """ + + + hostnames?: [str] + + parentRefs?: [GatewayNetworkingK8sIoV1HTTPRouteSpecParentRefsItems0] + + rules?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0] = [{"matches": {"value": [{"path": {"x-order": 0, "value": {"type": {"value": "PathPrefix", "x-order": 0}, "value": {"value": "/", "x-order": 1}}}}], "x-order": 0}}] + + + check: + len(hostnames) <= 16 if hostnames + all hostnames in hostnames { len(hostnames) <= 253 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { len(hostnames) >= 1 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { _regex_match(str(hostnames), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostnames } if hostnames + len(parentRefs) <= 32 if parentRefs + len(rules) <= 16 if rules + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecParentRefsItems0: + r""" + 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. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0: + r""" + HTTPRouteRule defines semantics for matching an HTTP request based on + conditions (matches), processing it (filters), and forwarding the request to + an API object (backendRefs). + + Attributes + ---------- + backendRefs : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional + BackendRefs defines the backend(s) where matching requests should be + sent. + + + Failure behavior here depends on how many BackendRefs are specified and + how many are invalid. + + + If *all* entries in BackendRefs are invalid, and there are also no filters + specified in this route rule, *all* traffic which matches this rule MUST + receive a 500 status code. + + + See the HTTPBackendRef definition for the rules about what makes a single + HTTPBackendRef invalid. + + + When a HTTPBackendRef is invalid, 500 status codes MUST be returned for + requests that would have otherwise been routed to an invalid backend. If + multiple backends are specified, and some are invalid, the proportion of + requests that would otherwise have been routed to an invalid backend + MUST receive a 500 status code. + + + For example, if two backends are specified with equal weights, and one is + invalid, 50 percent of traffic must receive a 500. Implementations may + choose how that 50 percent is determined. + + + Support: Core for Kubernetes Service + + + Support: Extended for Kubernetes ServiceImport + + + Support: Implementation-specific for any other resource + + + Support for weight: Core + filters : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0], default is Undefined, optional + Filters define the filters that are applied to requests that match + this rule. + + + Wherever possible, implementations SHOULD implement filters in the order + they are specified. + + + Implementations MAY choose to implement this ordering strictly, rejecting + any combination or order of filters that can not be supported. If implementations + choose a strict interpretation of filter ordering, they MUST clearly document + that behavior. + + + To reject an invalid combination or order of filters, implementations SHOULD + consider the Route Rules with this configuration invalid. If all Route Rules + in a Route are invalid, the entire Route would be considered invalid. If only + a portion of Route Rules are invalid, implementations MUST set the + "PartiallyInvalid" condition for the Route. + + + Conformance-levels at this level are defined based on the type of filter: + + + - 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. + + + Specifying the same filter multiple times is not supported unless explicitly + indicated in the filter. + + + All filters are expected to be compatible with each other except for the + URLRewrite and RequestRedirect filters, which may not be combined. If an + implementation can not support other combinations of filters, they must clearly + document that limitation. In cases where incompatible or unsupported + filters are specified and cause the `Accepted` condition to be set to status + `False`, implementations may use the `IncompatibleFilters` reason to specify + this configuration error. + + + Support: Core + matches : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0], default is [{"path": {"value": "/", "type": "PathPrefix"}}], optional + 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. + + + For example, take the following matches configuration: + + + ``` + matches: + - path: + value: "/foo" + headers: + - name: "version" + value: "v2" + - path: + value: "/v2/foo" + ``` + + + For a request to match against this rule, a request must satisfy + EITHER of the two conditions: + + + - path prefixed with `/foo` AND contains the header `version: v2` + - path prefix of `/v2/foo` + + + See the documentation for HTTPRouteMatch on how to specify multiple + match conditions that should be ANDed together. + + + If no matches are specified, the default is a prefix + path match on "/", which has the effect of matching every + HTTP request. + + + Proxy or Load Balancer routing configuration generated from HTTPRoutes + MUST prioritize matches based on the following criteria, continuing on + ties. Across all rules specified on applicable Routes, precedence must be + given to the match having: + + + * "Exact" path match. + * "Prefix" path match with largest number of characters. + * Method match. + * Largest number of header matches. + * Largest number of query param matches. + + + Note: The precedence of RegularExpression path matches are implementation-specific. + + + If ties still exist across multiple Routes, matching precedence MUST be + determined in order of the following criteria, continuing on ties: + + + * The oldest Route based on creation timestamp. + * The Route appearing first in alphabetical order by + "{namespace}/{name}". + + + If ties still exist within an HTTPRoute, matching precedence MUST be granted + to the FIRST matching rule (in list order) with a match meeting the above + criteria. + + + When no rules matching a request have been successfully attached to the + parent a request is coming from, a HTTP 404 status code MUST be returned. + sessionPersistence : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0SessionPersistence, default is Undefined, optional + session persistence + timeouts : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0Timeouts, default is Undefined, optional + timeouts + """ + + + backendRefs?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0] + + filters?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0] + + matches?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0] = [{"path": {"type": "PathPrefix", "value": "/"}}] + + sessionPersistence?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0SessionPersistence + + timeouts?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0Timeouts + + + check: + len(backendRefs) <= 16 if backendRefs + len(filters) <= 16 if filters + len(matches) <= 8 if matches + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0: + r""" + 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. + + + + + + When the BackendRef points to a Kubernetes Service, implementations SHOULD + honor the appProtocol field if it is set for the target Service Port. + + + Implementations supporting appProtocol SHOULD recognize the Kubernetes + Standard Application Protocols defined in KEP-3726. + + + If a Service appProtocol isn't specified, an implementation MAY infer the + backend protocol through its own means. Implementations MAY infer the + protocol from the Route type referring to the backend Service. + + + If a Route is not able to send traffic to the backend using the specified + protocol then the backend is considered invalid. Implementations MUST set the + "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. + + + + + Attributes + ---------- + filters : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0], default is Undefined, optional + Filters defined at this level should be executed if and only if the + request is being forwarded to the backend defined here. + + + Support: Implementation-specific (For broader support of filters, use the + Filters field in HTTPRouteRule.) + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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 : int, default is 1, optional + 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?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0] + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + weight?: int = 1 + + + check: + len(filters) <= 16 if filters + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + weight <= 1e+06 if weight not in [None, Undefined] + weight >= 0 if weight not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0: + r""" + 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. + + Attributes + ---------- + extensionRef : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef, default is Undefined, optional + extension ref + requestHeaderModifier : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional + request header modifier + requestMirror : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror, default is Undefined, optional + request mirror + requestRedirect : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirect, default is Undefined, optional + request redirect + responseHeaderModifier : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional + response header modifier + $type : str, default is Undefined, 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. `Type` should 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 : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewrite, default is Undefined, optional + url rewrite + """ + + + extensionRef?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef + + requestHeaderModifier?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier + + requestMirror?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror + + requestRedirect?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirect + + responseHeaderModifier?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier + + $type: "RequestHeaderModifier" | "ResponseHeaderModifier" | "RequestMirror" | "RequestRedirect" | "URLRewrite" | "ExtensionRef" + + urlRewrite?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewrite + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef: + r""" + 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 + + Attributes + ---------- + group : str, default is Undefined, 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 : str, default is Undefined, required + Kind is kind of the referent. For example "HTTPRoute" or "Service". + name : str, default is Undefined, required + Name is the name of the referent. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier: + r""" + RequestHeaderModifier defines a schema for a filter that modifies request + headers. + + + Support: Core + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror: + r""" + 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 + + Attributes + ---------- + backendRef : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required + backend ref + """ + + + backendRef: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef: + r""" + 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 + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirect: + r""" + RequestRedirect defines a schema for a filter that responds to the + request with an HTTP redirection. + + + Support: Core + + Attributes + ---------- + hostname : str, default is Undefined, optional + 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 : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirectPath, default is Undefined, optional + path + port : int, default is Undefined, optional + 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 : str, default is Undefined, optional + 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 : int, default is 302, optional + 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 + """ + + + hostname?: str + + path?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirectPath + + port?: int + + scheme?: "http" | "https" + + statusCode?: 301 | 302 = 302 + + + check: + len(hostname) <= 253 if hostname + len(hostname) >= 1 if hostname + _regex_match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirectPath: + r""" + 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 + + Attributes + ---------- + replaceFullPath : str, default is Undefined, optional + ReplaceFullPath specifies the value with which to replace the full path + of a request during a rewrite or redirect. + replacePrefixMatch : str, default is Undefined, optional + 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 + -------------|--------------|----------------|---------- + /foo/bar | /foo | /xyz | /xyz/bar + /foo/bar | /foo | /xyz/ | /xyz/bar + /foo/bar | /foo/ | /xyz | /xyz/bar + /foo/bar | /foo/ | /xyz/ | /xyz/bar + /foo | /foo | /xyz | /xyz + /foo/ | /foo | /xyz | /xyz/ + /foo/bar | /foo | | /bar + /foo/ | /foo | | / + /foo | /foo | | / + /foo/ | /foo | / | / + /foo | /foo | / | / + $type : str, default is Undefined, 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`. + """ + + + replaceFullPath?: str + + replacePrefixMatch?: str + + $type: "ReplaceFullPath" | "ReplacePrefixMatch" + + + check: + len(replaceFullPath) <= 1024 if replaceFullPath + len(replacePrefixMatch) <= 1024 if replacePrefixMatch + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier: + r""" + ResponseHeaderModifier defines a schema for a filter that modifies response + headers. + + + Support: Extended + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewrite: + r""" + URLRewrite defines a schema for a filter that modifies a request during forwarding. + + + Support: Extended + + Attributes + ---------- + hostname : str, default is Undefined, optional + Hostname is the value to be used to replace the Host header value during + forwarding. + + + Support: Extended + path : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewritePath, default is Undefined, optional + path + """ + + + hostname?: str + + path?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewritePath + + + check: + len(hostname) <= 253 if hostname + len(hostname) >= 1 if hostname + _regex_match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewritePath: + r""" + Path defines a path rewrite. + + + Support: Extended + + Attributes + ---------- + replaceFullPath : str, default is Undefined, optional + ReplaceFullPath specifies the value with which to replace the full path + of a request during a rewrite or redirect. + replacePrefixMatch : str, default is Undefined, optional + 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 + -------------|--------------|----------------|---------- + /foo/bar | /foo | /xyz | /xyz/bar + /foo/bar | /foo | /xyz/ | /xyz/bar + /foo/bar | /foo/ | /xyz | /xyz/bar + /foo/bar | /foo/ | /xyz/ | /xyz/bar + /foo | /foo | /xyz | /xyz + /foo/ | /foo | /xyz | /xyz/ + /foo/bar | /foo | | /bar + /foo/ | /foo | | / + /foo | /foo | | / + /foo/ | /foo | / | / + /foo | /foo | / | / + $type : str, default is Undefined, 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`. + """ + + + replaceFullPath?: str + + replacePrefixMatch?: str + + $type: "ReplaceFullPath" | "ReplacePrefixMatch" + + + check: + len(replaceFullPath) <= 1024 if replaceFullPath + len(replacePrefixMatch) <= 1024 if replacePrefixMatch + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0: + r""" + 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. + + Attributes + ---------- + extensionRef : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ExtensionRef, default is Undefined, optional + extension ref + requestHeaderModifier : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional + request header modifier + requestMirror : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestMirror, default is Undefined, optional + request mirror + requestRedirect : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestRedirect, default is Undefined, optional + request redirect + responseHeaderModifier : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional + response header modifier + $type : str, default is Undefined, 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. `Type` should 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 : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0URLRewrite, default is Undefined, optional + url rewrite + """ + + + extensionRef?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ExtensionRef + + requestHeaderModifier?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifier + + requestMirror?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestMirror + + requestRedirect?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestRedirect + + responseHeaderModifier?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier + + $type: "RequestHeaderModifier" | "ResponseHeaderModifier" | "RequestMirror" | "RequestRedirect" | "URLRewrite" | "ExtensionRef" + + urlRewrite?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0URLRewrite + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ExtensionRef: + r""" + 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 + + Attributes + ---------- + group : str, default is Undefined, 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 : str, default is Undefined, required + Kind is kind of the referent. For example "HTTPRoute" or "Service". + name : str, default is Undefined, required + Name is the name of the referent. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifier: + r""" + RequestHeaderModifier defines a schema for a filter that modifies request + headers. + + + Support: Core + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestMirror: + r""" + 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 + + Attributes + ---------- + backendRef : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required + backend ref + """ + + + backendRef: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef: + r""" + 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 + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestRedirect: + r""" + RequestRedirect defines a schema for a filter that responds to the + request with an HTTP redirection. + + + Support: Core + + Attributes + ---------- + hostname : str, default is Undefined, optional + 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 : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestRedirectPath, default is Undefined, optional + path + port : int, default is Undefined, optional + 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 : str, default is Undefined, optional + 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 : int, default is 302, optional + 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 + """ + + + hostname?: str + + path?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestRedirectPath + + port?: int + + scheme?: "http" | "https" + + statusCode?: 301 | 302 = 302 + + + check: + len(hostname) <= 253 if hostname + len(hostname) >= 1 if hostname + _regex_match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0RequestRedirectPath: + r""" + 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 + + Attributes + ---------- + replaceFullPath : str, default is Undefined, optional + ReplaceFullPath specifies the value with which to replace the full path + of a request during a rewrite or redirect. + replacePrefixMatch : str, default is Undefined, optional + 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 + -------------|--------------|----------------|---------- + /foo/bar | /foo | /xyz | /xyz/bar + /foo/bar | /foo | /xyz/ | /xyz/bar + /foo/bar | /foo/ | /xyz | /xyz/bar + /foo/bar | /foo/ | /xyz/ | /xyz/bar + /foo | /foo | /xyz | /xyz + /foo/ | /foo | /xyz | /xyz/ + /foo/bar | /foo | | /bar + /foo/ | /foo | | / + /foo | /foo | | / + /foo/ | /foo | / | / + /foo | /foo | / | / + $type : str, default is Undefined, 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`. + """ + + + replaceFullPath?: str + + replacePrefixMatch?: str + + $type: "ReplaceFullPath" | "ReplacePrefixMatch" + + + check: + len(replaceFullPath) <= 1024 if replaceFullPath + len(replacePrefixMatch) <= 1024 if replacePrefixMatch + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier: + r""" + ResponseHeaderModifier defines a schema for a filter that modifies response + headers. + + + Support: Extended + + Attributes + ---------- + add : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional + 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. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + add: + - name: "my-header" + value: "bar,baz" + + + Output: + GET /foo HTTP/1.1 + my-header: foo,bar,baz + remove : [str], default is Undefined, optional + 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 : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional + Set overwrites the request with the given header (name, value) + before the action. + + + Input: + GET /foo HTTP/1.1 + my-header: foo + + + Config: + set: + - name: "my-header" + value: "bar" + + + Output: + GET /foo HTTP/1.1 + my-header: bar + """ + + + add?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0] + + remove?: [str] + + set?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0] + + + check: + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0: + r""" + HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0URLRewrite: + r""" + URLRewrite defines a schema for a filter that modifies a request during forwarding. + + + Support: Extended + + Attributes + ---------- + hostname : str, default is Undefined, optional + Hostname is the value to be used to replace the Host header value during + forwarding. + + + Support: Extended + path : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0URLRewritePath, default is Undefined, optional + path + """ + + + hostname?: str + + path?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0URLRewritePath + + + check: + len(hostname) <= 253 if hostname + len(hostname) >= 1 if hostname + _regex_match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0FiltersItems0URLRewritePath: + r""" + Path defines a path rewrite. + + + Support: Extended + + Attributes + ---------- + replaceFullPath : str, default is Undefined, optional + ReplaceFullPath specifies the value with which to replace the full path + of a request during a rewrite or redirect. + replacePrefixMatch : str, default is Undefined, optional + 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 + -------------|--------------|----------------|---------- + /foo/bar | /foo | /xyz | /xyz/bar + /foo/bar | /foo | /xyz/ | /xyz/bar + /foo/bar | /foo/ | /xyz | /xyz/bar + /foo/bar | /foo/ | /xyz/ | /xyz/bar + /foo | /foo | /xyz | /xyz + /foo/ | /foo | /xyz | /xyz/ + /foo/bar | /foo | | /bar + /foo/ | /foo | | / + /foo | /foo | | / + /foo/ | /foo | / | / + /foo | /foo | / | / + $type : str, default is Undefined, 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`. + """ + + + replaceFullPath?: str + + replacePrefixMatch?: str + + $type: "ReplaceFullPath" | "ReplacePrefixMatch" + + + check: + len(replaceFullPath) <= 1024 if replaceFullPath + len(replacePrefixMatch) <= 1024 if replacePrefixMatch + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0: + r""" + 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: + + + ``` + match: + + + path: + value: "/foo" + headers: + - name: "version" + value "v1" + + + ``` + + Attributes + ---------- + headers : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0HeadersItems0], default is Undefined, optional + 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. + method : str, default is Undefined, optional + Method specifies HTTP method matcher. + When specified, this route will be matched only if the request has the + specified method. + + + Support: Extended + path : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0Path, default is Undefined, optional + path + queryParams : [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0QueryParamsItems0], default is Undefined, optional + 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. + + + Support: Extended + """ + + + headers?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0HeadersItems0] + + method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH" + + path?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0Path + + queryParams?: [GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0QueryParamsItems0] + + + check: + len(headers) <= 16 if headers + len(queryParams) <= 16 if queryParams + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0HeadersItems0: + r""" + HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request + headers. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is "Exact", optional + 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 : str, default is Undefined, required + Value is the value of HTTP Header to be matched. + """ + + + name: str + + $type?: "Exact" | "RegularExpression" = "Exact" + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 4096 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0Path: + r""" + Path specifies a HTTP request path matcher. If this field is not + specified, a default prefix match on the "/" path is provided. + + Attributes + ---------- + $type : str, default is "PathPrefix", optional + Type specifies how to match against the path Value. + + + Support: Core (Exact, PathPrefix) + + + Support: Implementation-specific (RegularExpression) + value : str, default is "/", optional + Value of the HTTP path to match against. + """ + + + $type?: "Exact" | "PathPrefix" | "RegularExpression" = "PathPrefix" + + value?: str = "/" + + + check: + len(value) <= 1024 if value + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0MatchesItems0QueryParamsItems0: + r""" + HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP + query parameters. + + Attributes + ---------- + name : str, default is Undefined, 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 : str, default is "Exact", optional + 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 : str, default is Undefined, required + Value is the value of HTTP query param to be matched. + """ + + + name: str + + $type?: "Exact" | "RegularExpression" = "Exact" + + value: str + + + check: + len(name) <= 256 + len(name) >= 1 + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + len(value) <= 1024 + len(value) >= 1 + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0SessionPersistence: + r""" + SessionPersistence defines and configures session persistence + for the route rule. + + + Support: Extended + + + + + Attributes + ---------- + absoluteTimeout : str, default is Undefined, optional + AbsoluteTimeout defines the absolute timeout of the persistent + session. Once the AbsoluteTimeout duration has elapsed, the + session becomes invalid. + + + Support: Extended + cookieConfig : GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0SessionPersistenceCookieConfig, default is Undefined, optional + cookie config + idleTimeout : str, default is Undefined, optional + IdleTimeout defines the idle timeout of the persistent session. + Once the session has been idle for more than the specified + IdleTimeout duration, the session becomes invalid. + + + Support: Extended + sessionName : str, default is Undefined, optional + SessionName defines the name of the persistent session token + which may be reflected in the cookie or the header. Users + should avoid reusing session names to prevent unintended + consequences, such as rejection or unpredictable behavior. + + + Support: Implementation-specific + $type : str, default is "Cookie", optional + Type defines the type of session persistence such as through + the use a header or cookie. Defaults to cookie based session + persistence. + + + Support: Core for "Cookie" type + + + Support: Extended for "Header" type + """ + + + absoluteTimeout?: str + + cookieConfig?: GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0SessionPersistenceCookieConfig + + idleTimeout?: str + + sessionName?: str + + $type?: "Cookie" | "Header" = "Cookie" + + + check: + _regex_match(str(absoluteTimeout), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if absoluteTimeout + _regex_match(str(idleTimeout), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if idleTimeout + len(sessionName) <= 128 if sessionName + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0SessionPersistenceCookieConfig: + r""" + CookieConfig provides configuration settings that are specific + to cookie-based session persistence. + + + Support: Core + + Attributes + ---------- + lifetimeType : str, default is "Session", optional + LifetimeType specifies whether the cookie has a permanent or + session-based lifetime. A permanent cookie persists until its + specified expiry time, defined by the Expires or Max-Age cookie + attributes, while a session cookie is deleted when the current + session ends. + + + When set to "Permanent", AbsoluteTimeout indicates the + cookie's lifetime via the Expires or Max-Age cookie attributes + and is required. + + + When set to "Session", AbsoluteTimeout indicates the + absolute lifetime of the cookie tracked by the gateway and + is optional. + + + Support: Core for "Session" type + + + Support: Extended for "Permanent" type + """ + + + lifetimeType?: "Permanent" | "Session" = "Session" + + +schema GatewayNetworkingK8sIoV1HTTPRouteSpecRulesItems0Timeouts: + r""" + Timeouts defines the timeouts that can be configured for an HTTP request. + + + Support: Extended + + + + + Attributes + ---------- + backendRequest : str, default is Undefined, optional + 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. + + + Because the Request timeout encompasses the BackendRequest timeout, the value of + BackendRequest must be <= the value of Request timeout. + + + Support: Extended + request : str, default is Undefined, optional + 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. + + + When this field is unspecified, request timeout behavior is implementation-specific. + + + Support: Extended + """ + + + backendRequest?: str + + request?: str + + + check: + _regex_match(str(backendRequest), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if backendRequest + _regex_match(str(request), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if request + + +schema GatewayNetworkingK8sIoV1HTTPRouteStatus: + r""" + Status defines the current state of HTTPRoute. + + Attributes + ---------- + parents : [GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0], default is Undefined, required + 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. + + + 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. + + + A maximum of 32 Gateways will be represented in this list. An empty list + means the route has not been attached to any Gateway. + """ + + + parents: [GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0] + + + check: + len(parents) <= 32 + + +schema GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0: + r""" + RouteParentStatus describes the status of a route with respect to an + associated Parent. + + Attributes + ---------- + conditions : [GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional + 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. + + + 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. + + + A Route MUST be considered "Accepted" if at least one of the Route's + rules is implemented by the Gateway. + + + There are a number of cases where the "Accepted" condition may not be set + due to lack of controller visibility, that includes when: + + + * 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 controller does not have access to. + controllerName : str, default is Undefined, 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 : GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0ParentRef, default is Undefined, required + parent ref + """ + + + conditions?: [GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0ConditionsItems0] + + controllerName: str + + parentRef: GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0ParentRef + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1HTTPRouteStatusParentsItems0ParentRef: + r""" + ParentRef corresponds with a ParentRef in the spec that this + RouteParentStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_backend_l_b_policy.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_backend_l_b_policy.k new file mode 100644 index 00000000..371e5725 --- /dev/null +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_backend_l_b_policy.k @@ -0,0 +1,565 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema BackendLBPolicy: + r""" + BackendLBPolicy provides a way to define load balancing rules + for a backend. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required + 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 + kind : str, default is "BackendLBPolicy", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" + + kind: "BackendLBPolicy" = "BackendLBPolicy" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpec + + status?: GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatus + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpec: + r""" + Spec defines the desired state of BackendLBPolicy. + + Attributes + ---------- + targetRefs : [GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecTargetRefsItems0], default is Undefined, required + TargetRef identifies an API object to apply policy to. + Currently, Backends (i.e. Service, ServiceImport, or any + implementation-specific backendRef) are the only valid API + target references. + sessionPersistence : GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecSessionPersistence, default is Undefined, optional + session persistence + """ + + + targetRefs: [GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecTargetRefsItems0] + + sessionPersistence?: GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecSessionPersistence + + + check: + len(targetRefs) >= 1 + len(targetRefs) <= 16 + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecSessionPersistence: + r""" + SessionPersistence defines and configures session persistence + for the backend. + + + Support: Extended + + Attributes + ---------- + absoluteTimeout : str, default is Undefined, optional + AbsoluteTimeout defines the absolute timeout of the persistent + session. Once the AbsoluteTimeout duration has elapsed, the + session becomes invalid. + + + Support: Extended + idleTimeout : str, default is Undefined, optional + IdleTimeout defines the idle timeout of the persistent session. + Once the session has been idle for more than the specified + IdleTimeout duration, the session becomes invalid. + + + Support: Extended + sessionName : str, default is Undefined, optional + SessionName defines the name of the persistent session token + which may be reflected in the cookie or the header. Users + should avoid reusing session names to prevent unintended + consequences, such as rejection or unpredictable behavior. + + + Support: Implementation-specific + $type : str, default is "Cookie", optional + Type defines the type of session persistence such as through + the use a header or cookie. Defaults to cookie based session + persistence. + + + Support: Core for "Cookie" type + + + Support: Extended for "Header" type + cookieConfig : GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecSessionPersistenceCookieConfig, default is Undefined, optional + cookie config + """ + + + absoluteTimeout?: str + + idleTimeout?: str + + sessionName?: str + + $type?: "Cookie" | "Header" = "Cookie" + + cookieConfig?: GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecSessionPersistenceCookieConfig + + + check: + _regex_match(str(absoluteTimeout), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if absoluteTimeout + _regex_match(str(idleTimeout), r"^([0-9]{1,5}(h|m|s|ms)){1,4}$") if idleTimeout + len(sessionName) <= 128 if sessionName + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecSessionPersistenceCookieConfig: + r""" + CookieConfig provides configuration settings that are specific + to cookie-based session persistence. + + + Support: Core + + Attributes + ---------- + lifetimeType : str, default is "Session", optional + LifetimeType specifies whether the cookie has a permanent or + session-based lifetime. A permanent cookie persists until its + specified expiry time, defined by the Expires or Max-Age cookie + attributes, while a session cookie is deleted when the current + session ends. + + + When set to "Permanent", AbsoluteTimeout indicates the + cookie's lifetime via the Expires or Max-Age cookie attributes + and is required. + + + When set to "Session", AbsoluteTimeout indicates the + absolute lifetime of the cookie tracked by the gateway and + is optional. + + + Support: Core for "Session" type + + + Support: Extended for "Permanent" type + """ + + + lifetimeType?: "Permanent" | "Session" = "Session" + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicySpecTargetRefsItems0: + r""" + LocalPolicyTargetReference identifies an API object to apply a direct or + inherited policy to. This should be used as part of Policy resources + that can target Gateway API resources. For more information on how this + policy attachment model works, and a sample Policy resource, refer to + the policy attachment documentation for Gateway API. + + Attributes + ---------- + group : str, default is Undefined, required + Group is the group of the target resource. + kind : str, default is Undefined, required + Kind is kind of the target resource. + name : str, default is Undefined, required + Name is the name of the target resource. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatus: + r""" + Status defines the current state of BackendLBPolicy. + + Attributes + ---------- + ancestors : [GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0], default is Undefined, required + Ancestors is a list of ancestor resources (usually Gateways) that are + associated with the policy, and the status of the policy with respect to + each ancestor. When this policy attaches to a parent, the controller that + manages the parent and the ancestors MUST add an entry to this list when + the controller first sees the policy and SHOULD update the entry as + appropriate when the relevant ancestor is modified. + + + Note that choosing the relevant ancestor is left to the Policy designers; + an important part of Policy design is designing the right object level at + which to namespace this status. + + + Note also that implementations MUST ONLY populate ancestor status for + the Ancestor resources they are responsible for. Implementations MUST + use the ControllerName field to uniquely identify the entries in this list + that they are responsible for. + + + Note that to achieve this, the list of PolicyAncestorStatus structs + MUST be treated as a map with a composite key, made up of the AncestorRef + and ControllerName fields combined. + + + A maximum of 16 ancestors will be represented in this list. An empty list + means the Policy is not relevant for any ancestors. + + + If this slice is full, implementations MUST NOT add further entries. + Instead they MUST consider the policy unimplementable and signal that + on any related resources such as the ancestor that would be referenced + here. For example, if this list was full on BackendTLSPolicy, no + additional Gateways would be able to reference the Service targeted by + the BackendTLSPolicy. + """ + + + ancestors: [GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0] + + + check: + len(ancestors) <= 16 + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0: + r""" + PolicyAncestorStatus describes the status of a route with respect to an + associated Ancestor. + + + Ancestors refer to objects that are either the Target of a policy or above it + in terms of object hierarchy. For example, if a policy targets a Service, the + Policy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and + the GatewayClass. Almost always, in this hierarchy, the Gateway will be the most + useful object to place Policy status on, so we recommend that implementations + SHOULD use Gateway as the PolicyAncestorStatus object unless the designers + have a _very_ good reason otherwise. + + + In the context of policy attachment, the Ancestor is used to distinguish which + resource results in a distinct application of this policy. For example, if a policy + targets a Service, it may have a distinct result per attached Gateway. + + + Policies targeting the same resource may have different effects depending on the + ancestors of those resources. For example, different Gateways targeting the same + Service may have different capabilities, especially if they have different underlying + implementations. + + + For example, in BackendTLSPolicy, the Policy attaches to a Service that is + used as a backend in a HTTPRoute that is itself attached to a Gateway. + In this case, the relevant object for status is the Gateway, and that is the + ancestor object referred to in this status. + + + Note that a parent is also an ancestor, so for objects where the parent is the + relevant object for status, this struct SHOULD still be used. + + + This struct is intended to be used in a slice that's effectively a map, + with a composite key made up of the AncestorRef and the ControllerName. + + Attributes + ---------- + ancestorRef : GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0AncestorRef, default is Undefined, required + ancestor ref + conditions : [GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0ConditionsItems0], default is Undefined, optional + Conditions describes the status of the Policy with respect to the given Ancestor. + controllerName : str, default is Undefined, 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. + """ + + + ancestorRef: GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0AncestorRef + + conditions?: [GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0ConditionsItems0] + + controllerName: str + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0AncestorRef: + r""" + AncestorRef corresponds with a ParentRef in the spec that this + PolicyAncestorStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1alpha2BackendLBPolicyStatusAncestorsItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_backend_tls_policy.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_backend_tls_policy.k new file mode 100644 index 00000000..30386c7f --- /dev/null +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_backend_tls_policy.k @@ -0,0 +1,357 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema BackendTLSPolicy: + r""" + BackendTLSPolicy provides a way to configure how a Gateway connects to a Backend via TLS. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required + 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 + kind : str, default is "BackendTLSPolicy", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" + + kind: "BackendTLSPolicy" = "BackendTLSPolicy" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpec + + status?: GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatus + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpec: + r""" + Spec defines the desired state of BackendTLSPolicy. + + Attributes + ---------- + targetRef : GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTargetRef, default is Undefined, required + target ref + tls : GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTLS, default is Undefined, required + tls + """ + + + targetRef: GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTargetRef + + tls: GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTLS + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTLS: + r""" + TLS contains backend TLS policy configuration. + + Attributes + ---------- + caCertRefs : [GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTLSCaCertRefsItems0], default is Undefined, optional + CACertRefs contains one or more references to Kubernetes objects that contain a PEM-encoded TLS CA certificate bundle, which is used to validate a TLS handshake between the Gateway and backend Pod. + If CACertRefs is empty or unspecified, then WellKnownCACerts must be specified. Only one of CACertRefs or WellKnownCACerts may be specified, not both. If CACertRefs is empty or unspecified, the configuration for WellKnownCACerts MUST be honored instead. + References to a resource in a different namespace are invalid for the moment, although we will revisit this in the future. + A single CACertRef to a Kubernetes ConfigMap kind has "Core" support. Implementations MAY choose to support attaching multiple certificates to a backend, but this behavior is implementation-specific. + Support: Core - An optional single reference to a Kubernetes ConfigMap, with the CA certificate in a key named `ca.crt`. + Support: Implementation-specific (More than one reference, or other kinds of resources). + hostname : str, default is Undefined, required + Hostname is used for two purposes in the connection between Gateways and backends: + 1. Hostname MUST be used as the SNI to connect to the backend (RFC 6066). 2. Hostname MUST be used for authentication and MUST match the certificate served by the matching backend. + Support: Core + wellKnownCACerts : str, default is Undefined, optional + WellKnownCACerts specifies whether system CA certificates may be used in the TLS handshake between the gateway and backend pod. + If WellKnownCACerts is unspecified or empty (""), then CACertRefs must be specified with at least one entry for a valid configuration. Only one of CACertRefs or WellKnownCACerts may be specified, not both. + Support: Core for "System" + """ + + + caCertRefs?: [GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTLSCaCertRefsItems0] + + hostname: str + + wellKnownCACerts?: "System" + + + check: + len(caCertRefs) <= 8 if caCertRefs + len(hostname) <= 253 + len(hostname) >= 1 + _regex_match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTLSCaCertRefsItems0: + r""" + LocalObjectReference identifies an API object within the namespace of the referrer. 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. + 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. + + Attributes + ---------- + group : str, default is Undefined, 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 : str, default is Undefined, required + Kind is kind of the referent. For example "HTTPRoute" or "Service". + name : str, default is Undefined, required + Name is the name of the referent. + """ + + + group: str + + kind: str + + name: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicySpecTargetRef: + r""" + TargetRef identifies an API object to apply the policy to. Only Services have Extended support. Implementations MAY support additional objects, with Implementation Specific support. Note that this config applies to the entire referenced resource by default, but this default may change in the future to provide a more granular application of the policy. + Support: Extended for Kubernetes Service + Support: Implementation-specific for any other resource + + Attributes + ---------- + group : str, default is Undefined, required + Group is the group of the target resource. + kind : str, default is Undefined, required + Kind is kind of the target resource. + name : str, default is Undefined, required + Name is the name of the target resource. + namespace : str, default is Undefined, optional + Namespace is the namespace of the referent. When unspecified, the local namespace is inferred. Even when policy targets a resource in a different namespace, it MUST only apply to traffic originating from the same namespace as the policy. + sectionName : str, default is Undefined, optional + SectionName is the name of a section within the target resource. When unspecified, this targetRef targets the entire resource. In the following resources, SectionName is interpreted as the following: + * Gateway: Listener Name * Service: Port Name + If a SectionName is specified, but does not exist on the targeted object, the Policy must fail to attach, and the policy implementation should record a `ResolvedRefs` or similar Condition in the Policy's status. + """ + + + group: str + + kind: str + + name: str + + namespace?: str + + sectionName?: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatus: + r""" + Status defines the current state of BackendTLSPolicy. + + Attributes + ---------- + ancestors : [GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0], default is Undefined, required + Ancestors is a list of ancestor resources (usually Gateways) that are associated with the policy, and the status of the policy with respect to each ancestor. When this policy attaches to a parent, the controller that manages the parent and the ancestors MUST add an entry to this list when the controller first sees the policy and SHOULD update the entry as appropriate when the relevant ancestor is modified. + Note that choosing the relevant ancestor is left to the Policy designers; an important part of Policy design is designing the right object level at which to namespace this status. + Note also that implementations MUST ONLY populate ancestor status for the Ancestor resources they are responsible for. Implementations MUST use the ControllerName field to uniquely identify the entries in this list that they are responsible for. + Note that to achieve this, the list of PolicyAncestorStatus structs MUST be treated as a map with a composite key, made up of the AncestorRef and ControllerName fields combined. + A maximum of 16 ancestors will be represented in this list. An empty list means the Policy is not relevant for any ancestors. + If this slice is full, implementations MUST NOT add further entries. Instead they MUST consider the policy unimplementable and signal that on any related resources such as the ancestor that would be referenced here. For example, if this list was full on BackendTLSPolicy, no additional Gateways would be able to reference the Service targeted by the BackendTLSPolicy. + """ + + + ancestors: [GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0] + + + check: + len(ancestors) <= 16 + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0: + r""" + PolicyAncestorStatus describes the status of a route with respect to an associated Ancestor. + Ancestors refer to objects that are either the Target of a policy or above it in terms of object hierarchy. For example, if a policy targets a Service, the Policy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and the GatewayClass. Almost always, in this hierarchy, the Gateway will be the most useful object to place Policy status on, so we recommend that implementations SHOULD use Gateway as the PolicyAncestorStatus object unless the designers have a _very_ good reason otherwise. + In the context of policy attachment, the Ancestor is used to distinguish which resource results in a distinct application of this policy. For example, if a policy targets a Service, it may have a distinct result per attached Gateway. + Policies targeting the same resource may have different effects depending on the ancestors of those resources. For example, different Gateways targeting the same Service may have different capabilities, especially if they have different underlying implementations. + For example, in BackendTLSPolicy, the Policy attaches to a Service that is used as a backend in a HTTPRoute that is itself attached to a Gateway. In this case, the relevant object for status is the Gateway, and that is the ancestor object referred to in this status. + Note that a parent is also an ancestor, so for objects where the parent is the relevant object for status, this struct SHOULD still be used. + This struct is intended to be used in a slice that's effectively a map, with a composite key made up of the AncestorRef and the ControllerName. + + Attributes + ---------- + ancestorRef : GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0AncestorRef, default is Undefined, required + ancestor ref + conditions : [GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0ConditionsItems0], default is Undefined, optional + Conditions describes the status of the Policy with respect to the given Ancestor. + controllerName : str, default is Undefined, 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. + """ + + + ancestorRef: GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0AncestorRef + + conditions?: [GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0ConditionsItems0] + + controllerName: str + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0AncestorRef: + r""" + AncestorRef corresponds with a ParentRef in the spec that this PolicyAncestorStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + Kind is kind of the referent. + There are two kinds of parent resources with "Core" support: + * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) + Support for other resources is Implementation-Specific. + name : str, default is Undefined, required + Name is the name of the referent. + Support: Core + namespace : str, default is Undefined, optional + 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. + ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. + ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. + Support: Core + port : int, default is Undefined, optional + 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. + When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port 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 : str, default is Undefined, optional + 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. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1alpha2BackendTLSPolicyStatusAncestorsItems0ConditionsItems0: + r""" + 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"` + // other fields } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_http_route.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_g_rpc_route.k similarity index 53% rename from gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_http_route.k rename to gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_g_rpc_route.k index 9523acf2..57627ada 100644 --- a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_http_route.k +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_g_rpc_route.k @@ -4,85 +4,99 @@ Editing this file might prove futile when you re-run the KCL auto-gen generate c """ import regex import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match -schema HTTPRoute: - """ - 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. +schema GRPCRoute: + r""" + GRPCRoute provides a way to route gRPC requests. This includes the capability to match requests by hostname, gRPC service, gRPC method, or HTTP/2 header. Filters can be used to specify additional processing steps. Backends specify where matching requests will be routed. + GRPCRoute falls under extended support within the Gateway API. Within the following specification, the word "MUST" indicates that an implementation supporting GRPCRoute must conform to the indicated requirement, but an implementation not supporting this route type need not follow the requirement unless explicitly indicated. + Implementations supporting `GRPCRoute` with the `HTTPS` `ProtocolType` MUST accept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. via ALPN. If the implementation does not support this, then it MUST set the "Accepted" condition to "False" for the affected listener with a reason of "UnsupportedProtocol". Implementations MAY also accept HTTP/2 connections with an upgrade from HTTP/1. + Implementations supporting `GRPCRoute` with the `HTTP` `ProtocolType` MUST support HTTP/2 over cleartext TCP (h2c, https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initial upgrade from HTTP/1.1, i.e. with prior knowledge (https://www.rfc-editor.org/rfc/rfc7540#section-3.4). If the implementation does not support this, then it MUST set the "Accepted" condition to "False" for the affected listener with a reason of "UnsupportedProtocol". Implementations MAY also accept HTTP/2 connections with an upgrade from HTTP/1, i.e. without prior knowledge. Attributes ---------- apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required 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 - kind : str, default is "HTTPRoute", required + kind : str, default is "GRPCRoute", required 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 metadata : v1.ObjectMeta, default is Undefined, optional metadata - spec : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpec, default is Undefined, required + spec : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpec, default is Undefined, optional spec - status : GatewayNetworkingK8sIoV1alpha2HTTPRouteStatus, default is Undefined, optional + status : GatewayNetworkingK8sIoV1alpha2GRPCRouteStatus, default is Undefined, optional status """ apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" - kind: "HTTPRoute" = "HTTPRoute" + kind: "GRPCRoute" = "GRPCRoute" metadata?: v1.ObjectMeta - spec: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpec + spec?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpec - status?: GatewayNetworkingK8sIoV1alpha2HTTPRouteStatus + status?: GatewayNetworkingK8sIoV1alpha2GRPCRouteStatus -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpec: - """ - Spec defines the desired state of HTTPRoute. +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpec: + r""" + Spec defines the desired state of GRPCRoute. Attributes ---------- hostnames : [str], default is Undefined, optional - Hostnames defines a set of hostname 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. - Valid values for Hostnames are determined by RFC 1123 definition of a hostname with 2 notable exceptions: - 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. - 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.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, `*.example.com`, `test.example.com`, and `foo.test.example.com` would all match. On the other hand, `example.com` and `test.example.net` would not match. + Hostnames defines a set of hostnames to match against the GRPC Host header to select a GRPCRoute to process the request. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: + 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. + If a hostname is specified by both the Listener and GRPCRoute, there MUST be at least one intersecting hostname for the GRPCRoute to be attached to the Listener. For example: + * A Listener with `test.example.com` as the hostname matches GRPCRoutes 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 GRPCRoutes 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. 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. + If both the Listener and GRPCRoute have specified hostnames, any GRPCRoute hostnames that do not match the Listener hostname MUST be ignored. For example, if a Listener specified `*.example.com`, and the GRPCRoute specified `test.example.com` and `test.example.net`, `test.example.net` MUST NOT be considered for a match. + If both the Listener and GRPCRoute have specified hostnames, and none match with the criteria above, then the GRPCRoute MUST NOT be accepted by the implementation. The implementation MUST raise an 'Accepted' Condition with a status of `False` in the corresponding RouteParentStatus. + If a Route (A) of type HTTPRoute or GRPCRoute is attached to a Listener and that listener already has another Route (B) of the other type attached and the intersection of the hostnames of A and B is non-empty, then the implementation MUST accept exactly one of these two routes, determined by the following criteria, in order: + * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by "{namespace}/{name}". + The rejected Route MUST raise an 'Accepted' condition with a status of 'False' in the corresponding RouteParentStatus. Support: Core - parentRefs : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecParentRefsItems0], default is Undefined, optional - 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. - 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. - 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. + parentRefs : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecParentRefsItems0], default is Undefined, optional + 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. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. + There are two kinds of parent resources with "Core" support: + * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. + ParentRefs must be _distinct_. This means either that: + * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + Some examples: + * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. 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. - Note that for ParentRefs that cross namespace boundaries, there are specific rules. 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. - rules : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0], default is [{matches: [map[path:map[type:PathPrefix value:/]]]}], optional - Rules are a list of HTTP matchers, filters and actions. + Note that for ParentRefs that cross namespace boundaries, there are specific rules. 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 other kinds of cross-namespace reference. + ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. + ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. + + rules : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0], default is Undefined, optional + Rules are a list of GRPC matchers, filters and actions. """ hostnames?: [str] - parentRefs?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecParentRefsItems0] + parentRefs?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecParentRefsItems0] - rules?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0] = [{matches: [map[path:map[type:PathPrefix value:/]]]}] + rules?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0] check: - len(hostnames) <= 16 - all n in hostnames { regex.match(str(n), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") } if hostnames - len(parentRefs) <= 32 - len(rules) <= 16 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecParentRefsItems0: - """ - ParentReference 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. + len(hostnames) <= 16 if hostnames + all hostnames in hostnames { len(hostnames) <= 253 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { len(hostnames) >= 1 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { _regex_match(str(hostnames), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostnames } if hostnames + len(parentRefs) <= 32 if parentRefs + len(rules) <= 16 if rules + + +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecParentRefsItems0: + r""" + 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, experimental, 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. Attributes @@ -92,18 +106,29 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecParentRefsItems0: Support: Core kind : str, default is "Gateway", optional Kind is kind of the referent. - Support: Core (Gateway) - Support: Implementation-specific (Other Resources) + There are two kinds of parent resources with "Core" support: + * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) + Support for other resources is Implementation-Specific. name : str, default is Undefined, required Name is the name of the referent. Support: Core namespace : str, default is Undefined, optional 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. + ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. + ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. Support: Core + port : int, default is Undefined, optional + 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. + When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port 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 : str, default is Undefined, optional 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. + * 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. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. 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 @@ -118,90 +143,98 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecParentRefsItems0: namespace?: str + port?: int + sectionName?: str check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind len(name) <= 253 len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - len(sectionName) <= 253 - len(sectionName) >= 1 - regex.match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0: - """ - HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs). +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0: + r""" + GRPCRouteRule defines the semantics for matching a gRPC request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs). Attributes ---------- - backendRefs : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional + backendRefs : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional BackendRefs defines the backend(s) where matching requests should be sent. Failure behavior here depends on how many BackendRefs are specified and how many are invalid. - If *all* entries in BackendRefs are invalid, and there are also no filters specified in this route rule, *all* traffic which matches this rule MUST receive a 500 status code. - See the HTTPBackendRef definition for the rules about what makes a single HTTPBackendRef invalid. - When a HTTPBackendRef is invalid, 500 status codes MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive a 500 status code. - For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic must receive a 500. Implementations may choose how that 50 percent is determined. + If *all* entries in BackendRefs are invalid, and there are also no filters specified in this route rule, *all* traffic which matches this rule MUST receive an `UNAVAILABLE` status. + See the GRPCBackendRef definition for the rules about what makes a single GRPCBackendRef invalid. + When a GRPCBackendRef is invalid, `UNAVAILABLE` statuses MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive an `UNAVAILABLE` status. + For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic MUST receive an `UNAVAILABLE` status. Implementations may choose how that 50 percent is determined. Support: Core for Kubernetes Service - Support: Extended for Kubernetes ServiceImport Support: Implementation-specific for any other resource Support for weight: Core - filters : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0], default is Undefined, optional + filters : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0], default is Undefined, optional Filters define the filters that are applied to requests that match this rule. The effects of ordering of multiple behaviors are currently unspecified. This can change in the future based on feedback during the alpha stage. Conformance-levels at this level are defined based on the type of filter: - - 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. - Specifying a core filter multiple times has unspecified or implementation-specific conformance. - All filters are expected to be compatible with each other except for the URLRewrite and RequestRedirect filters, which may not be combined. If an implementation can not support other combinations of filters, they must clearly document that limitation. In all cases where incompatible or unsupported filters are specified, implementations MUST add a warning condition to status. + - ALL core filters MUST be supported by all implementations that support GRPCRoute. - Implementers are encouraged to support extended filters. - Implementation-specific custom filters have no API guarantees across implementations. + Specifying the same filter multiple times is not supported unless explicitly indicated in the filter. + If an implementation can not support a combination of filters, it must clearly document that limitation. In cases where incompatible or unsupported filters are specified and cause the `Accepted` condition to be set to status `False`, implementations may use the `IncompatibleFilters` reason to specify this configuration error. Support: Core - matches : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0], default is [{path: map[type:PathPrefix value:/]}], optional - 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. + matches : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0], default is Undefined, optional + Matches define conditions used for matching the rule against incoming gRPC requests. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. For example, take the following matches configuration: - ``` matches: - path: value: "/foo" headers: - name: "version" value: "v2" - path: value: "/v2/foo" ``` - For a request to match against this rule, a request must satisfy EITHER of the two conditions: - - path prefixed with `/foo` AND contains the header `version: v2` - path prefix of `/v2/foo` - See the documentation for HTTPRouteMatch on how to specify multiple match conditions that should be ANDed together. - If no matches are specified, the default is a prefix path match on "/", which has the effect of matching every HTTP request. - Proxy or Load Balancer routing configuration generated from HTTPRoutes MUST prioritize matches based on the following criteria, continuing on ties. Across all rules specified on applicable Routes, precedence must be given to the match having: - * "Exact" path match. * "Prefix" path match with largest number of characters. * Method match. * Largest number of header matches. * Largest number of query param matches. - Note: The precedence of RegularExpression path matches are implementation-specific. + ``` matches: - method: service: foo.bar headers: values: version: 2 - method: service: foo.bar.v2 ``` + For a request to match against this rule, it MUST satisfy EITHER of the two conditions: + - service of foo.bar AND contains the header `version: 2` - service of foo.bar.v2 + See the documentation for GRPCRouteMatch on how to specify multiple match conditions to be ANDed together. + If no matches are specified, the implementation MUST match every gRPC request. + Proxy or Load Balancer routing configuration generated from GRPCRoutes MUST prioritize rules based on the following criteria, continuing on ties. Merging MUST not be done between GRPCRoutes and HTTPRoutes. Precedence MUST be given to the rule with the largest number of: + * Characters in a matching non-wildcard hostname. * Characters in a matching hostname. * Characters in a matching service. * Characters in a matching method. * Header matches. If ties still exist across multiple Routes, matching precedence MUST be determined in order of the following criteria, continuing on ties: * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by "{namespace}/{name}". - If ties still exist within an HTTPRoute, matching precedence MUST be granted to the FIRST matching rule (in list order) with a match meeting the above criteria. - When no rules matching a request have been successfully attached to the parent a request is coming from, a HTTP 404 status code MUST be returned. + 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. """ - backendRefs?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0] + backendRefs?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0] - filters?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0] + filters?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0] - matches?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0] = [{path: map[type:PathPrefix value:/]}] + matches?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0] check: - len(backendRefs) <= 16 - len(filters) <= 16 - len(matches) <= 8 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0: - """ - HTTPBackendRef defines how a HTTPRoute should forward an HTTP request. + len(backendRefs) <= 16 if backendRefs + len(filters) <= 16 if filters + len(matches) <= 8 if matches + + +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0: + r""" + GRPCBackendRef defines how a GRPCRoute forwards a gRPC 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. + + When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. + Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. + If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. + If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. + Attributes ---------- - filters : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0], default is Undefined, optional - Filters defined at this level should be executed if and only if the request is being forwarded to the backend defined here. - Support: Implementation-specific (For broader support of filters, use the Filters field in HTTPRouteRule.) + filters : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0], default is Undefined, optional + Filters defined at this level MUST be executed if and only if the request is being forwarded to the backend defined here. + Support: Implementation-specific (For broader support of filters, use the Filters field in GRPCRouteRule.) group : str, default is Undefined, optional Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. kind : str, default is "Service", optional @@ -225,7 +258,7 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0: """ - filters?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0] + filters?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0] group?: str = "" @@ -241,72 +274,64 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0: check: - len(filters) <= 16 - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(filters) <= 16 if filters + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind len(name) <= 253 len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - port <= 65535 - port >= 1 - weight <= 1e+06 - weight >= 0 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + weight <= 1e+06 if weight not in [None, Undefined] + weight >= 0 if weight not in [None, Undefined] -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0: - """ - 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. +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0: + r""" + GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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. Attributes ---------- - extensionRef : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef, default is Undefined, optional + extensionRef : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef, default is Undefined, optional extension ref - requestHeaderModifier : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional + requestHeaderModifier : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional request header modifier - requestMirror : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror, default is Undefined, optional + requestMirror : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror, default is Undefined, optional request mirror - requestRedirect : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirect, default is Undefined, optional - request redirect - responseHeaderModifier : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional + responseHeaderModifier : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional response header modifier $type : str, default is Undefined, 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. + - Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations supporting GRPCRoute 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. `Type` should be set to "ExtensionRef" for custom 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. `Type` MUST 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 : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewrite, default is Undefined, optional - url rewrite + """ - extensionRef?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef - - requestHeaderModifier?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier + extensionRef?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef - requestMirror?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror + requestHeaderModifier?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier - requestRedirect?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirect + requestMirror?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror - responseHeaderModifier?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier + responseHeaderModifier?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier - $type: "RequestHeaderModifier" | "ResponseHeaderModifier" | "RequestMirror" | "RequestRedirect" | "URLRewrite" | "ExtensionRef" + $type: "ResponseHeaderModifier" | "RequestHeaderModifier" | "RequestMirror" | "ExtensionRef" - urlRewrite?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewrite - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ExtensionRef: + r""" 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. - Support: Implementation-specific + Support: Implementation-specific + This filter can be used multiple times within the same rule. Attributes ---------- @@ -328,22 +353,22 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi check: len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") len(kind) <= 63 len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") len(name) <= 253 len(name) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifier: + r""" RequestHeaderModifier defines a schema for a filter that modifies request headers. Support: Core Attributes ---------- - add : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional + add : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional 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. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" @@ -353,7 +378,7 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi 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 : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional + set : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" @@ -361,21 +386,21 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi """ - add?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0] + add?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0] remove?: [str] - set?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0] + set?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0] check: - len(add) <= 16 - len(remove) <= 16 - len(set) <= 16 + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierAddItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -396,13 +421,13 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestHeaderModifierSetItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -423,29 +448,31 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirror: + r""" 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 Attributes ---------- - backendRef : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required + backendRef : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required backend ref """ - backendRef: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef + backendRef: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestMirrorBackendRef: + r""" 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. @@ -485,111 +512,28 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind len(name) <= 253 len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - port <= 65535 - port >= 1 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirect: - """ - RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. - Support: Core - - Attributes - ---------- - hostname : str, default is Undefined, optional - 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 : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirectPath, default is Undefined, optional - path - port : int, default is Undefined, optional - 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 : str, default is Undefined, optional - 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 : int, default is 302, optional - 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 - """ - - - hostname?: str - - path?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirectPath - - port?: int - - scheme?: "http" | "https" - - statusCode?: 301 | 302 = 302 - - - check: - len(hostname) <= 253 - len(hostname) >= 1 - regex.match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname - port <= 65535 - port >= 1 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0RequestRedirectPath: - """ - 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 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] - Attributes - ---------- - replaceFullPath : str, default is Undefined, optional - ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. - replacePrefixMatch : str, default is Undefined, optional - 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" would be modified to "/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. - $type : str, default is Undefined, 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`. - """ - - - replaceFullPath?: str - - replacePrefixMatch?: str - $type: "ReplaceFullPath" | "ReplacePrefixMatch" - - - check: - len(replaceFullPath) <= 1024 - len(replacePrefixMatch) <= 1024 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifier: + r""" ResponseHeaderModifier defines a schema for a filter that modifies response headers. Support: Extended Attributes ---------- - add : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional + add : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional 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. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" @@ -599,7 +543,7 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi 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 : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional + set : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" @@ -607,21 +551,21 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi """ - add?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0] + add?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0] remove?: [str] - set?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0] + set?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0] check: - len(add) <= 16 - len(remove) <= 16 - len(set) <= 16 + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierAddItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -642,13 +586,13 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0BackendRefsItems0FiltersItems0ResponseHeaderModifierSetItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -669,117 +613,52 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0Fi check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewrite: - """ - URLRewrite defines a schema for a filter that modifies a request during forwarding. - Support: Extended - - Attributes - ---------- - hostname : str, default is Undefined, optional - Hostname is the value to be used to replace the Host header value during forwarding. - Support: Extended - path : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewritePath, default is Undefined, optional - path - """ - - - hostname?: str - - path?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewritePath - - - check: - len(hostname) <= 253 - len(hostname) >= 1 - regex.match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0BackendRefsItems0FiltersItems0URLRewritePath: - """ - Path defines a path rewrite. - Support: Extended - - Attributes - ---------- - replaceFullPath : str, default is Undefined, optional - ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. - replacePrefixMatch : str, default is Undefined, optional - 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" would be modified to "/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. - $type : str, default is Undefined, 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`. - """ - - - replaceFullPath?: str - - replacePrefixMatch?: str - - $type: "ReplaceFullPath" | "ReplacePrefixMatch" - - - check: - len(replaceFullPath) <= 1024 - len(replacePrefixMatch) <= 1024 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0: - """ - 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. +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0: + r""" + GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters 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. Attributes ---------- - extensionRef : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ExtensionRef, default is Undefined, optional + extensionRef : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ExtensionRef, default is Undefined, optional extension ref - requestHeaderModifier : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional + requestHeaderModifier : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifier, default is Undefined, optional request header modifier - requestMirror : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestMirror, default is Undefined, optional + requestMirror : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestMirror, default is Undefined, optional request mirror - requestRedirect : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestRedirect, default is Undefined, optional - request redirect - responseHeaderModifier : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional + responseHeaderModifier : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier, default is Undefined, optional response header modifier $type : str, default is Undefined, 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. + - Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations supporting GRPCRoute 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. `Type` should be set to "ExtensionRef" for custom 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. `Type` MUST 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 : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0URLRewrite, default is Undefined, optional - url rewrite + """ - extensionRef?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ExtensionRef + extensionRef?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ExtensionRef - requestHeaderModifier?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifier + requestHeaderModifier?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifier - requestMirror?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestMirror + requestMirror?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestMirror - requestRedirect?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestRedirect + responseHeaderModifier?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier - responseHeaderModifier?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier + $type: "ResponseHeaderModifier" | "RequestHeaderModifier" | "RequestMirror" | "ExtensionRef" - $type: "RequestHeaderModifier" | "ResponseHeaderModifier" | "RequestMirror" | "RequestRedirect" | "URLRewrite" | "ExtensionRef" - urlRewrite?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0URLRewrite - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ExtensionRef: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ExtensionRef: + r""" 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. - Support: Implementation-specific + Support: Implementation-specific + This filter can be used multiple times within the same rule. Attributes ---------- @@ -801,22 +680,22 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Extens check: len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") len(kind) <= 63 len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") len(name) <= 253 len(name) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifier: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifier: + r""" RequestHeaderModifier defines a schema for a filter that modifies request headers. Support: Core Attributes ---------- - add : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional + add : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0], default is Undefined, optional 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. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" @@ -826,7 +705,7 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Reques 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 : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional + set : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0], default is Undefined, optional Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" @@ -834,21 +713,21 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Reques """ - add?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0] + add?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0] remove?: [str] - set?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0] + set?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0] check: - len(add) <= 16 - len(remove) <= 16 - len(set) <= 16 + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierAddItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -869,13 +748,13 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Reques check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestHeaderModifierSetItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -896,29 +775,31 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Reques check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestMirror: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestMirror: + r""" 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 Attributes ---------- - backendRef : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required + backendRef : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef, default is Undefined, required backend ref """ - backendRef: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef + backendRef: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0RequestMirrorBackendRef: + r""" 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. @@ -958,111 +839,28 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Reques check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind len(name) <= 253 len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - port <= 65535 - port >= 1 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestRedirect: - """ - RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. - Support: Core - - Attributes - ---------- - hostname : str, default is Undefined, optional - 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 : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestRedirectPath, default is Undefined, optional - path - port : int, default is Undefined, optional - 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 : str, default is Undefined, optional - 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 : int, default is 302, optional - 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 - """ - - - hostname?: str - - path?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestRedirectPath - - port?: int - - scheme?: "http" | "https" - - statusCode?: 301 | 302 = 302 - - - check: - len(hostname) <= 253 - len(hostname) >= 1 - regex.match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname - port <= 65535 - port >= 1 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0RequestRedirectPath: - """ - 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 - - Attributes - ---------- - replaceFullPath : str, default is Undefined, optional - ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. - replacePrefixMatch : str, default is Undefined, optional - 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" would be modified to "/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. - $type : str, default is Undefined, 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`. - """ - - - replaceFullPath?: str - - replacePrefixMatch?: str - - $type: "ReplaceFullPath" | "ReplacePrefixMatch" + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] - check: - len(replaceFullPath) <= 1024 - len(replacePrefixMatch) <= 1024 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifier: + r""" ResponseHeaderModifier defines a schema for a filter that modifies response headers. Support: Extended Attributes ---------- - add : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional + add : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0], default is Undefined, optional 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. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" @@ -1072,7 +870,7 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Respon 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 : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional + set : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0], default is Undefined, optional Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" @@ -1080,21 +878,21 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Respon """ - add?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0] + add?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0] remove?: [str] - set?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0] + set?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0] check: - len(add) <= 16 - len(remove) <= 16 - len(set) <= 16 + len(add) <= 16 if add + len(remove) <= 16 if remove + len(set) <= 16 if set -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierAddItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -1115,13 +913,13 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Respon check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0FiltersItems0ResponseHeaderModifierSetItems0: + r""" HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. Attributes @@ -1142,122 +940,49 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0Respon check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0URLRewrite: - """ - URLRewrite defines a schema for a filter that modifies a request during forwarding. - Support: Extended - - Attributes - ---------- - hostname : str, default is Undefined, optional - Hostname is the value to be used to replace the Host header value during forwarding. - Support: Extended - path : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0URLRewritePath, default is Undefined, optional - path - """ - - - hostname?: str - - path?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0URLRewritePath - - - check: - len(hostname) <= 253 - len(hostname) >= 1 - regex.match(str(hostname), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0FiltersItems0URLRewritePath: - """ - Path defines a path rewrite. - Support: Extended - - Attributes - ---------- - replaceFullPath : str, default is Undefined, optional - ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. - replacePrefixMatch : str, default is Undefined, optional - 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" would be modified to "/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. - $type : str, default is Undefined, 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`. - """ - - - replaceFullPath?: str - - replacePrefixMatch?: str - - $type: "ReplaceFullPath" | "ReplacePrefixMatch" - - - check: - len(replaceFullPath) <= 1024 - len(replacePrefixMatch) <= 1024 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0: - """ - 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: - ``` match: - path: value: "/foo" headers: - name: "version" value "v1" +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0: + r""" + GRPCRouteMatch 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 gRPC request only if its service is `foo` AND it contains the `version: v1` header: + ``` matches: - method: type: Exact service: "foo" headers: - name: "version" value "v1" ``` Attributes ---------- - headers : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0HeadersItems0], default is Undefined, optional - 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. - method : str, default is Undefined, optional - Method specifies HTTP method matcher. When specified, this route will be matched only if the request has the specified method. - Support: Extended - path : GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0Path, default is Undefined, optional - path - queryParams : [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0QueryParamsItems0], default is Undefined, optional - 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. - Support: Extended + headers : [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0HeadersItems0], default is Undefined, optional + Headers specifies gRPC request header matchers. Multiple match values are ANDed together, meaning, a request MUST match all the specified headers to select the route. + method : GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0Method, default is Undefined, optional + method """ - headers?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0HeadersItems0] - - method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH" + headers?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0HeadersItems0] - path?: GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0Path - - queryParams?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0QueryParamsItems0] + method?: GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0Method check: - len(headers) <= 16 - len(queryParams) <= 16 + len(headers) <= 16 if headers -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0HeadersItems0: - """ - HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers. +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0HeadersItems0: + r""" + GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request headers. Attributes ---------- name : str, default is Undefined, 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". + Name is the name of the gRPC Header to be matched. + 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. $type : str, default is "Exact", optional - 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. + Type specifies how to match against the value of the header. value : str, default is Undefined, required - Value is the value of HTTP Header to be matched. + Value is the value of the gRPC Header to be matched. """ @@ -1271,98 +996,69 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0Header check: len(name) <= 256 len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") + _regex_match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") len(value) <= 4096 len(value) >= 1 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0Path: - """ - Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteSpecRulesItems0MatchesItems0Method: + r""" + Method specifies a gRPC request service/method matcher. If this field is not specified, all services and methods will match. Attributes ---------- - $type : str, default is "PathPrefix", optional - Type specifies how to match against the path Value. - Support: Core (Exact, PathPrefix) + method : str, default is Undefined, optional + Value of the method to match against. If left empty or omitted, will match all services. + At least one of Service and Method MUST be a non-empty string. + service : str, default is Undefined, optional + Value of the service to match against. If left empty or omitted, will match any service. + At least one of Service and Method MUST be a non-empty string. + $type : str, default is "Exact", optional + Type specifies how to match against the service and/or method. Support: Core (Exact with service and method specified) + Support: Implementation-specific (Exact with method specified but no service specified) Support: Implementation-specific (RegularExpression) - value : str, default is "/", optional - Value of the HTTP path to match against. - """ - - - $type?: "Exact" | "PathPrefix" | "RegularExpression" = "PathPrefix" - - value?: str = "/" - - - check: - len(value) <= 1024 - - -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteSpecRulesItems0MatchesItems0QueryParamsItems0: """ - HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters. - Attributes - ---------- - name : str, default is Undefined, 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 : str, default is "Exact", optional - 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 : str, default is Undefined, required - Value is the value of HTTP query param to be matched. - """ + method?: str - name: str + service?: str $type?: "Exact" | "RegularExpression" = "Exact" - value: str - check: - len(name) <= 256 - len(name) >= 1 - regex.match(str(name), r"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$") - len(value) <= 1024 - len(value) >= 1 + len(method) <= 1024 if method + len(service) <= 1024 if service -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatus: - """ - Status defines the current state of HTTPRoute. +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteStatus: + r""" + Status defines the current state of GRPCRoute. Attributes ---------- - parents : [GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0], default is Undefined, required + parents : [GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0], default is Undefined, required 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. 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. A maximum of 32 Gateways will be represented in this list. An empty list means the route has not been attached to any Gateway. """ - parents: [GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0] + parents: [GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0] check: len(parents) <= 32 -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0: + r""" RouteParentStatus describes the status of a route with respect to an associated Parent. Attributes ---------- - conditions : [GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional + conditions : [GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional 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. 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. A Route MUST be considered "Accepted" if at least one of the Route's rules is implemented by the Gateway. @@ -1373,28 +1069,28 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0: 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 : GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ParentRef, default is Undefined, required + parentRef : GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0ParentRef, default is Undefined, required parent ref """ - conditions?: [GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ConditionsItems0] + conditions?: [GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0ConditionsItems0] controllerName: str - parentRef: GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ParentRef + parentRef: GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0ParentRef check: - len(conditions) >= 1 - len(conditions) <= 8 + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions len(controllerName) <= 253 len(controllerName) >= 1 - regex.match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ConditionsItems0: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0ConditionsItems0: + r""" 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"` // other fields } @@ -1431,16 +1127,16 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ConditionsItems check: len(message) <= 32768 - observedGeneration >= 0 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] len(reason) <= 1024 len(reason) >= 1 - regex.match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") len($type) <= 316 - regex.match(str($type), r"^([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])$") + _regex_match(str($type), r"^([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])$") -schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ParentRef: - """ +schema GatewayNetworkingK8sIoV1alpha2GRPCRouteStatusParentsItems0ParentRef: + r""" ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. Attributes @@ -1450,18 +1146,29 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ParentRef: Support: Core kind : str, default is "Gateway", optional Kind is kind of the referent. - Support: Core (Gateway) - Support: Implementation-specific (Other Resources) + There are two kinds of parent resources with "Core" support: + * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) + Support for other resources is Implementation-Specific. name : str, default is Undefined, required Name is the name of the referent. Support: Core namespace : str, default is Undefined, optional 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. + ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. + ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. Support: Core + port : int, default is Undefined, optional + 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. + When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port 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 : str, default is Undefined, optional 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. + * 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. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. 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 @@ -1476,22 +1183,26 @@ schema GatewayNetworkingK8sIoV1alpha2HTTPRouteStatusParentsItems0ParentRef: namespace?: str + port?: int + sectionName?: str check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind len(name) <= 253 len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - len(sectionName) <= 253 - len(sectionName) >= 1 - regex.match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_gateway.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_gateway.k deleted file mode 100644 index b25afca7..00000000 --- a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_gateway.k +++ /dev/null @@ -1,573 +0,0 @@ -""" -This file was generated by the KCL auto-gen tool. DO NOT EDIT. -Editing this file might prove futile when you re-run the KCL auto-gen generate command. -""" -import regex -import k8s.apimachinery.pkg.apis.meta.v1 - - -schema Gateway: - """ - Gateway represents an instance of a service-traffic handling infrastructure by binding Listeners to a set of IP addresses. - - Attributes - ---------- - apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required - 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 - kind : str, default is "Gateway", required - 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 - metadata : v1.ObjectMeta, default is Undefined, optional - metadata - spec : GatewayNetworkingK8sIoV1alpha2GatewaySpec, default is Undefined, required - spec - status : GatewayNetworkingK8sIoV1alpha2GatewayStatus, default is Undefined, optional - status - """ - - - apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" - - kind: "Gateway" = "Gateway" - - metadata?: v1.ObjectMeta - - spec: GatewayNetworkingK8sIoV1alpha2GatewaySpec - - status?: GatewayNetworkingK8sIoV1alpha2GatewayStatus - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpec: - """ - Spec defines the desired state of Gateway. - - Attributes - ---------- - addresses : [GatewayNetworkingK8sIoV1alpha2GatewaySpecAddressesItems0], default is Undefined, optional - Addresses requested for this Gateway. This is optional and behavior can depend on the implementation. If a value is set in the spec and the requested address is invalid or unavailable, the implementation MUST indicate this in the associated entry in GatewayStatus.Addresses. - The Addresses field represents a request for the address(es) on the "outside of the Gateway", that traffic bound for this Gateway will use. This could be the IP address or hostname of an external load balancer or other networking infrastructure, or some other address that traffic will be sent to. - The .listener.hostname field is used to route traffic that has already arrived at the Gateway to the correct in-cluster destination. - If no Addresses are specified, the implementation MAY schedule the Gateway in an implementation-specific manner, assigning an appropriate set of Addresses. - The implementation MUST bind all Listeners to every GatewayAddress that it assigns to the Gateway and add a corresponding entry in GatewayStatus.Addresses. - Support: Extended - gatewayClassName : str, default is Undefined, required - GatewayClassName used for this Gateway. This is the name of a GatewayClass resource. - listeners : [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0], default is Undefined, required - Listeners associated with this Gateway. Listeners define logical endpoints that are bound on this Gateway's addresses. At least one Listener MUST be specified. - Each listener in a Gateway must have a unique combination of Hostname, Port, and Protocol. - An implementation MAY group Listeners by Port and then collapse each group of Listeners into a single Listener if the implementation determines that the Listeners in the group are "compatible". An implementation MAY also group together and collapse compatible Listeners belonging to different Gateways. - For example, an implementation might consider Listeners to be compatible with each other if all of the following conditions are met: - 1. Either each Listener within the group specifies the "HTTP" Protocol or each Listener within the group specifies either the "HTTPS" or "TLS" Protocol. - 2. Each Listener within the group specifies a Hostname that is unique within the group. - 3. As a special case, one Listener within a group may omit Hostname, in which case this Listener matches when no other Listener matches. - If the implementation does collapse compatible Listeners, the hostname provided in the incoming client request MUST be matched to a Listener to find the correct set of Routes. The incoming hostname MUST be matched using the Hostname field for each Listener in order of most to least specific. That is, exact matches must be processed before wildcard matches. - If this field specifies multiple Listeners that have the same Port value but are not compatible, the implementation must raise a "Conflicted" condition in the Listener status. - Support: Core - """ - - - addresses?: [GatewayNetworkingK8sIoV1alpha2GatewaySpecAddressesItems0] - - gatewayClassName: str - - listeners: [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0] - - - check: - len(addresses) <= 16 - len(gatewayClassName) <= 253 - len(gatewayClassName) >= 1 - len(listeners) >= 1 - len(listeners) <= 64 - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecAddressesItems0: - """ - GatewayAddress describes an address that can be bound to a Gateway. - - Attributes - ---------- - $type : str, default is "IPAddress", optional - Type of the address. - value : str, default is Undefined, required - Value of the address. The validity of the values will depend on the type and support by the controller. - Examples: `1.2.3.4`, `128::1`, `my-ip-address`. - """ - - - $type?: str = "IPAddress" - - value: str - - - check: - len($type) <= 253 - len($type) >= 1 - regex.match(str($type), r"^Hostname|IPAddress|NamedAddress|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") if $type - len(value) <= 253 - len(value) >= 1 - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0: - """ - Listener embodies the concept of a logical endpoint where a Gateway accepts network connections. - - Attributes - ---------- - allowedRoutes : GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutes, default is Undefined, optional - allowed routes - hostname : str, default is Undefined, optional - Hostname specifies the virtual hostname to match for protocol types that define this concept. When unspecified, all hostnames are matched. This field is ignored for protocols that don't require hostname based matching. - Implementations MUST apply Hostname matching appropriately for each of the following protocols: - * TLS: The Listener Hostname MUST match the SNI. * HTTP: The Listener Hostname MUST match the Host header of the request. * HTTPS: The Listener Hostname SHOULD match at both the TLS and HTTP protocol layers as described above. If an implementation does not ensure that both the SNI and Host header match the Listener hostname, it MUST clearly document that. - For HTTPRoute and TLSRoute resources, there is an interaction with the `spec.hostnames` array. When both listener and route specify hostnames, there MUST be an intersection between the values for a Route to be accepted. For more information, refer to the Route specific Hostnames documentation. - 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`. - Support: Core - name : str, default is Undefined, required - Name is the name of the Listener. This name MUST be unique within a Gateway. - Support: Core - port : int, default is Undefined, required - Port is the network port. Multiple listeners may use the same port, subject to the Listener compatibility rules. - Support: Core - $protocol : str, default is Undefined, required - Protocol specifies the network protocol this listener expects to receive. - Support: Core - tls : GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0TLS, default is Undefined, optional - tls - """ - - - allowedRoutes?: GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutes - - hostname?: str - - name: str - - port: int - - $protocol: str - - tls?: GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0TLS - - - check: - len(hostname) <= 253 - len(hostname) >= 1 - regex.match(str(hostname), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostname - len(name) <= 253 - len(name) >= 1 - regex.match(str(name), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") - port <= 65535 - port >= 1 - len($protocol) <= 255 - len($protocol) >= 1 - regex.match(str($protocol), r"^[a-zA-Z0-9]([-a-zSA-Z0-9]*[a-zA-Z0-9])?$|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9]+$") - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutes: - """ - AllowedRoutes defines the types of routes that MAY be attached to a Listener and the trusted namespaces where those Route resources MAY be present. - Although a client request may match multiple route rules, only one rule may ultimately receive the request. Matching precedence MUST be determined in order of the following criteria: - * The most specific match as defined by the Route type. * The oldest Route based on creation timestamp. For example, a Route with a creation timestamp of "2020-09-08 01:02:03" is given precedence over a Route with a creation timestamp of "2020-09-08 01:02:04". * If everything else is equivalent, the Route appearing first in alphabetical order (namespace/name) should be given precedence. For example, foo/bar is given precedence over foo/baz. - All valid rules within a Route attached to this Listener should be implemented. Invalid Route rules can be ignored (sometimes that will mean the full Route). If a Route rule transitions from valid to invalid, support for that Route rule should be dropped to ensure consistency. For example, even if a filter specified by a Route rule is invalid, the rest of the rules within that Route should still be supported. - Support: Core - - Attributes - ---------- - kinds : [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesKindsItems0], default is Undefined, optional - Kinds specifies the groups and kinds of Routes that are allowed to bind to this Gateway Listener. When unspecified or empty, the kinds of Routes selected are determined using the Listener protocol. - A RouteGroupKind MUST correspond to kinds of Routes that are compatible with the application protocol specified in the Listener's Protocol field. If an implementation does not support or recognize this resource type, it MUST set the "ResolvedRefs" condition to False for this Listener with the "InvalidRouteKinds" reason. - Support: Core - namespaces : GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespaces, default is Undefined, optional - namespaces - """ - - - kinds?: [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesKindsItems0] - - namespaces?: GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespaces - - - check: - len(kinds) <= 8 - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesKindsItems0: - """ - RouteGroupKind indicates the group and kind of a Route resource. - - Attributes - ---------- - group : str, default is "gateway.networking.k8s.io", optional - Group is the group of the Route. - kind : str, default is Undefined, required - Kind is the kind of the Route. - """ - - - group?: str = "gateway.networking.k8s.io" - - kind: str - - - check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespaces: - """ - Namespaces indicates namespaces from which Routes may be attached to this Listener. This is restricted to the namespace of this Gateway by default. - Support: Core - - Attributes - ---------- - from : str, default is "Same", optional - From indicates where Routes will be selected for this Gateway. Possible values are: * All: Routes in all namespaces may be used by this Gateway. * Selector: Routes in namespaces selected by the selector may be used by this Gateway. * Same: Only Routes in the same namespace may be used by this Gateway. - Support: Core - selector : GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespacesSelector, default is Undefined, optional - selector - """ - - - from?: "All" | "Selector" | "Same" = "Same" - - selector?: GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespacesSelector - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespacesSelector: - """ - Selector must be specified when From is set to "Selector". In that case, only Routes in Namespaces matching this Selector will be selected by this Gateway. This field is ignored for other values of "From". - Support: Core - - Attributes - ---------- - matchExpressions : [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespacesSelectorMatchExpressionsItems0], default is Undefined, optional - matchExpressions is a list of label selector requirements. The requirements are ANDed. - matchLabels : {str:str}, default is Undefined, optional - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. - """ - - - matchExpressions?: [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespacesSelectorMatchExpressionsItems0] - - matchLabels?: {str:str} - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0AllowedRoutesNamespacesSelectorMatchExpressionsItems0: - """ - A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. - - Attributes - ---------- - key : str, default is Undefined, required - key is the label key that the selector applies to. - operator : str, default is Undefined, required - operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. - values : [str], default is Undefined, optional - values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. - """ - - - key: str - - operator: str - - values?: [str] - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0TLS: - """ - TLS is the TLS configuration for the Listener. This field is required if the Protocol field is "HTTPS" or "TLS". It is invalid to set this field if the Protocol field is "HTTP", "TCP", or "UDP". - The association of SNIs to Certificate defined in GatewayTLSConfig is defined based on the Hostname field for this listener. - The GatewayClass MUST use the longest matching SNI out of all available certificates for any TLS handshake. - Support: Core - - Attributes - ---------- - certificateRefs : [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0TLSCertificateRefsItems0], default is Undefined, optional - CertificateRefs contains a series of references to Kubernetes objects that contains TLS certificates and private keys. These certificates are used to establish a TLS handshake for requests that match the hostname of the associated listener. - A single CertificateRef to a Kubernetes Secret has "Core" support. Implementations MAY choose to support attaching multiple certificates to a Listener, but this behavior is implementation-specific. - References to a resource in different namespace are invalid UNLESS there is a ReferenceGrant in the target namespace that allows the certificate to be attached. If a ReferenceGrant does not allow this reference, the "ResolvedRefs" condition MUST be set to False for this listener with the "RefNotPermitted" reason. - This field is required to have at least one element when the mode is set to "Terminate" (default) and is optional otherwise. - CertificateRefs can reference to standard Kubernetes resources, i.e. Secret, or implementation-specific custom resources. - Support: Core - A single reference to a Kubernetes Secret of type kubernetes.io/tls - Support: Implementation-specific (More than one reference or other resource types) - mode : str, default is "Terminate", optional - Mode defines the TLS behavior for the TLS session initiated by the client. There are two possible modes: - - Terminate: The TLS session between the downstream client and the Gateway is terminated at the Gateway. This mode requires certificateRefs to be set and contain at least one element. - Passthrough: The TLS session is NOT terminated by the Gateway. This implies that the Gateway can't decipher the TLS stream except for the ClientHello message of the TLS protocol. CertificateRefs field is ignored in this mode. - Support: Core - options : {str:str}, default is Undefined, optional - Options are a list of key/value pairs to enable extended TLS configuration for each implementation. For example, configuring the minimum TLS version or supported cipher suites. - A set of common keys MAY be defined by the API in the future. To avoid any ambiguity, implementation-specific definitions MUST use domain-prefixed names, such as `example.com/my-custom-option`. Un-prefixed names are reserved for key names defined by Gateway API. - Support: Implementation-specific - """ - - - certificateRefs?: [GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0TLSCertificateRefsItems0] - - mode?: "Terminate" | "Passthrough" = "Terminate" - - options?: {str:str} - - - check: - len(certificateRefs) <= 64 - - -schema GatewayNetworkingK8sIoV1alpha2GatewaySpecListenersItems0TLSCertificateRefsItems0: - """ - SecretObjectReference identifies an API object including its namespace, defaulting to Secret. - 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. - 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. - - Attributes - ---------- - group : str, default is Undefined, optional - Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. - kind : str, default is "Secret", optional - Kind is kind of the referent. For example "Secret". - name : str, default is Undefined, required - Name is the name of the referent. - namespace : str, default is Undefined, optional - 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 - """ - - - group?: str = "" - - kind?: str = "Secret" - - name: str - - namespace?: str - - - check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind - len(name) <= 253 - len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - - -schema GatewayNetworkingK8sIoV1alpha2GatewayStatus: - """ - Status defines the current state of Gateway. - - Attributes - ---------- - addresses : [GatewayNetworkingK8sIoV1alpha2GatewayStatusAddressesItems0], default is Undefined, optional - Addresses lists the IP addresses that have actually been bound to the Gateway. These addresses may differ from the addresses in the Spec, e.g. if the Gateway automatically assigns an address from a reserved pool. - conditions : [GatewayNetworkingK8sIoV1alpha2GatewayStatusConditionsItems0], default is [{lastTransitionTime: 1970-01-01T00:00:00Z, message: Waiting for controller, reason: Pending, status: Unknown, type: Accepted}, {message: Waiting for controller, reason: Pending, status: Unknown, type: Programmed, lastTransitionTime: 1970-01-01T00:00:00Z}], optional - Conditions describe the current conditions of the Gateway. - Implementations should prefer to express Gateway conditions using the `GatewayConditionType` and `GatewayConditionReason` constants so that operators and tools can converge on a common vocabulary to describe Gateway state. - Known condition types are: - * "Accepted" * "Programmed" * "Ready" - listeners : [GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0], default is Undefined, optional - Listeners provide status for each unique listener port defined in the Spec. - """ - - - addresses?: [GatewayNetworkingK8sIoV1alpha2GatewayStatusAddressesItems0] - - conditions?: [GatewayNetworkingK8sIoV1alpha2GatewayStatusConditionsItems0] = [{status: Unknown, type: Accepted, lastTransitionTime: 1970-01-01T00:00:00Z, message: Waiting for controller, reason: Pending}, {lastTransitionTime: 1970-01-01T00:00:00Z, message: Waiting for controller, reason: Pending, status: Unknown, type: Programmed}] - - listeners?: [GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0] - - - check: - len(addresses) <= 16 - len(conditions) <= 8 - len(listeners) <= 64 - - -schema GatewayNetworkingK8sIoV1alpha2GatewayStatusAddressesItems0: - """ - GatewayAddress describes an address that can be bound to a Gateway. - - Attributes - ---------- - $type : str, default is "IPAddress", optional - Type of the address. - value : str, default is Undefined, required - Value of the address. The validity of the values will depend on the type and support by the controller. - Examples: `1.2.3.4`, `128::1`, `my-ip-address`. - """ - - - $type?: str = "IPAddress" - - value: str - - - check: - len($type) <= 253 - len($type) >= 1 - regex.match(str($type), r"^Hostname|IPAddress|NamedAddress|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") if $type - len(value) <= 253 - len(value) >= 1 - - -schema GatewayNetworkingK8sIoV1alpha2GatewayStatusConditionsItems0: - """ - 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"` - // other fields } - - Attributes - ---------- - lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required - message is a human readable message indicating details about the transition. This may be an empty string. - observedGeneration : int, default is Undefined, optional - 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 : str, default is Undefined, 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 : str, default is Undefined, required - status of the condition, one of True, False, Unknown. - $type : str, default is Undefined, required - 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) - """ - - - lastTransitionTime: str - - message: str - - observedGeneration?: int - - reason: str - - status: "True" | "False" | "Unknown" - - $type: str - - - check: - len(message) <= 32768 - observedGeneration >= 0 - len(reason) <= 1024 - len(reason) >= 1 - regex.match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") - len($type) <= 316 - regex.match(str($type), r"^([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])$") - - -schema GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0: - """ - ListenerStatus is the status associated with a Listener. - - Attributes - ---------- - attachedRoutes : int, default is Undefined, required - AttachedRoutes represents the total number of accepted Routes that have been successfully attached to this Listener. - conditions : [GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0ConditionsItems0], default is Undefined, required - Conditions describe the current condition of this listener. - name : str, default is Undefined, required - Name is the name of the Listener that this status corresponds to. - supportedKinds : [GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0SupportedKindsItems0], default is Undefined, required - SupportedKinds is the list indicating the Kinds supported by this listener. This MUST represent the kinds an implementation supports for that Listener configuration. - If kinds are specified in Spec that are not supported, they MUST NOT appear in this list and an implementation MUST set the "ResolvedRefs" condition to "False" with the "InvalidRouteKinds" reason. If both valid and invalid Route kinds are specified, the implementation MUST reference the valid Route kinds that have been specified. - """ - - - attachedRoutes: int - - conditions: [GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0ConditionsItems0] - - name: str - - supportedKinds: [GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0SupportedKindsItems0] - - - check: - len(conditions) <= 8 - len(name) <= 253 - len(name) >= 1 - regex.match(str(name), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") - len(supportedKinds) <= 8 - - -schema GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0ConditionsItems0: - """ - 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"` - // other fields } - - Attributes - ---------- - lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required - message is a human readable message indicating details about the transition. This may be an empty string. - observedGeneration : int, default is Undefined, optional - 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 : str, default is Undefined, 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 : str, default is Undefined, required - status of the condition, one of True, False, Unknown. - $type : str, default is Undefined, required - 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) - """ - - - lastTransitionTime: str - - message: str - - observedGeneration?: int - - reason: str - - status: "True" | "False" | "Unknown" - - $type: str - - - check: - len(message) <= 32768 - observedGeneration >= 0 - len(reason) <= 1024 - len(reason) >= 1 - regex.match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") - len($type) <= 316 - regex.match(str($type), r"^([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])$") - - -schema GatewayNetworkingK8sIoV1alpha2GatewayStatusListenersItems0SupportedKindsItems0: - """ - RouteGroupKind indicates the group and kind of a Route resource. - - Attributes - ---------- - group : str, default is "gateway.networking.k8s.io", optional - Group is the group of the Route. - kind : str, default is Undefined, required - Kind is the kind of the Route. - """ - - - group?: str = "gateway.networking.k8s.io" - - kind: str - - - check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") - - diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_gateway_class.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_gateway_class.k deleted file mode 100644 index cb3f7da4..00000000 --- a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_gateway_class.k +++ /dev/null @@ -1,180 +0,0 @@ -""" -This file was generated by the KCL auto-gen tool. DO NOT EDIT. -Editing this file might prove futile when you re-run the KCL auto-gen generate command. -""" -import regex -import k8s.apimachinery.pkg.apis.meta.v1 - - -schema GatewayClass: - """ - GatewayClass describes a class of Gateways available to the user for creating Gateway resources. - It is recommended that this resource be used as a template for Gateways. This means that a Gateway is based on the state of the GatewayClass at the time it was created and changes to the GatewayClass or associated parameters are not propagated down to existing Gateways. This recommendation is intended to limit the blast radius of changes to GatewayClass or associated parameters. If implementations choose to propagate GatewayClass changes to existing Gateways, that MUST be clearly documented by the implementation. - Whenever one or more Gateways are using a GatewayClass, implementations SHOULD add the `gateway-exists-finalizer.gateway.networking.k8s.io` finalizer on the associated GatewayClass. This ensures that a GatewayClass associated with a Gateway is not deleted while in use. - GatewayClass is a Cluster level resource. - - Attributes - ---------- - apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required - 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 - kind : str, default is "GatewayClass", required - 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 - metadata : v1.ObjectMeta, default is Undefined, optional - metadata - spec : GatewayNetworkingK8sIoV1alpha2GatewayClassSpec, default is Undefined, required - spec - status : GatewayNetworkingK8sIoV1alpha2GatewayClassStatus, default is Undefined, optional - status - """ - - - apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" - - kind: "GatewayClass" = "GatewayClass" - - metadata?: v1.ObjectMeta - - spec: GatewayNetworkingK8sIoV1alpha2GatewayClassSpec - - status?: GatewayNetworkingK8sIoV1alpha2GatewayClassStatus - - -schema GatewayNetworkingK8sIoV1alpha2GatewayClassSpec: - """ - Spec defines the desired state of GatewayClass. - - Attributes - ---------- - controllerName : str, default is Undefined, required - ControllerName is the name of the controller that is managing Gateways of this class. The value of this field MUST be a domain prefixed path. - Example: "example.net/gateway-controller". - This field is not mutable and cannot be empty. - Support: Core - description : str, default is Undefined, optional - Description helps describe a GatewayClass with more details. - parametersRef : GatewayNetworkingK8sIoV1alpha2GatewayClassSpecParametersRef, default is Undefined, optional - parameters ref - """ - - - controllerName: str - - description?: str - - parametersRef?: GatewayNetworkingK8sIoV1alpha2GatewayClassSpecParametersRef - - - check: - len(controllerName) <= 253 - len(controllerName) >= 1 - regex.match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") - len(description) <= 64 - - -schema GatewayNetworkingK8sIoV1alpha2GatewayClassSpecParametersRef: - """ - ParametersRef is a reference to a resource that contains the configuration parameters corresponding to the GatewayClass. This is optional if the controller does not require any additional configuration. - ParametersRef can reference a standard Kubernetes resource, i.e. ConfigMap, or an implementation-specific custom resource. The resource can be cluster-scoped or namespace-scoped. - If the referent cannot be found, the GatewayClass's "InvalidParameters" status condition will be true. - Support: Implementation-specific - - Attributes - ---------- - group : str, default is Undefined, required - Group is the group of the referent. - kind : str, default is Undefined, required - Kind is kind of the referent. - name : str, default is Undefined, required - Name is the name of the referent. - namespace : str, default is Undefined, optional - Namespace is the namespace of the referent. This field is required when referring to a Namespace-scoped resource and MUST be unset when referring to a Cluster-scoped resource. - """ - - - group: str - - kind: str - - name: str - - namespace?: str - - - check: - len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") - len(kind) <= 63 - len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") - len(name) <= 253 - len(name) >= 1 - len(namespace) <= 63 - len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace - - -schema GatewayNetworkingK8sIoV1alpha2GatewayClassStatus: - """ - Status defines the current state of GatewayClass. - - Attributes - ---------- - conditions : [GatewayNetworkingK8sIoV1alpha2GatewayClassStatusConditionsItems0], default is [{lastTransitionTime: 1970-01-01T00:00:00Z, message: Waiting for controller, reason: Pending, status: Unknown, type: Accepted}], optional - Conditions is the current status from the controller for this GatewayClass. - Controllers should prefer to publish conditions using values of GatewayClassConditionType for the type of each Condition. - """ - - - conditions?: [GatewayNetworkingK8sIoV1alpha2GatewayClassStatusConditionsItems0] = [{lastTransitionTime: 1970-01-01T00:00:00Z, message: Waiting for controller, reason: Pending, status: Unknown, type: Accepted}] - - - check: - len(conditions) <= 8 - - -schema GatewayNetworkingK8sIoV1alpha2GatewayClassStatusConditionsItems0: - """ - 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"` - // other fields } - - Attributes - ---------- - lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required - message is a human readable message indicating details about the transition. This may be an empty string. - observedGeneration : int, default is Undefined, optional - 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 : str, default is Undefined, 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 : str, default is Undefined, required - status of the condition, one of True, False, Unknown. - $type : str, default is Undefined, required - 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) - """ - - - lastTransitionTime: str - - message: str - - observedGeneration?: int - - reason: str - - status: "True" | "False" | "Unknown" - - $type: str - - - check: - len(message) <= 32768 - observedGeneration >= 0 - len(reason) <= 1024 - len(reason) >= 1 - regex.match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") - len($type) <= 316 - regex.match(str($type), r"^([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])$") - - diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_reference_grant.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_reference_grant.k index af4be883..f0a95547 100644 --- a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_reference_grant.k +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_reference_grant.k @@ -4,15 +4,34 @@ Editing this file might prove futile when you re-run the KCL auto-gen generate c """ import regex import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match schema ReferenceGrant: - """ - ReferenceGrant identifies kinds of resources in other namespaces that are trusted to reference the specified kinds of resources in the same namespace as the policy. - Each ReferenceGrant can be used to represent a unique trust relationship. Additional Reference Grants can be used to add to the set of trusted sources of inbound references for the namespace they are defined within. - All cross-namespace references in Gateway API (with the exception of cross-namespace Gateway-route attachment) require a ReferenceGrant. - ReferenceGrant is a form of runtime verification allowing users to assert which cross-namespace object references are permitted. Implementations that support ReferenceGrant MUST NOT permit cross-namespace references which have no grant, and MUST respond to the removal of a grant by revoking the access that the grant allowed. - Support: Core + r""" + ReferenceGrant identifies kinds of resources in other namespaces that are + trusted to reference the specified kinds of resources in the same namespace + as the policy. + + + Each ReferenceGrant can be used to represent a unique trust relationship. + Additional Reference Grants can be used to add to the set of trusted + sources of inbound references for the namespace they are defined within. + + + A ReferenceGrant is required for all cross-namespace references in Gateway API + (with the exception of cross-namespace Route-Gateway attachment, which is + governed by the AllowedRoutes configuration on the Gateway, and cross-namespace + Service ParentRefs on a "consumer" mesh Route, which defines routing rules + applicable only to workloads in the Route namespace). ReferenceGrants allowing + a reference from a Route to a Service are only applicable to BackendRefs. + + + ReferenceGrant is a form of runtime verification allowing users to assert + which cross-namespace object references are permitted. Implementations that + support ReferenceGrant MUST NOT permit cross-namespace references which have + no grant, and MUST respond to the removal of a grant by revoking the access + that the grant allowed. Attributes ---------- @@ -37,17 +56,27 @@ schema ReferenceGrant: schema GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpec: - """ + r""" Spec defines the desired state of ReferenceGrant. Attributes ---------- from : [GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpecFromItems0], default is Undefined, required - From describes the trusted namespaces and kinds that can reference the resources described in "To". Each entry in this list MUST be considered to be an additional place that references can be valid from, or to put this another way, entries MUST be combined using OR. - Support: Core + From describes the trusted namespaces and kinds that can reference the + resources described in "To". Each entry in this list MUST be considered + to be an additional place that references can be valid from, or to put + this another way, entries MUST be combined using OR. + + + Support: Core to : [GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpecToItems0], default is Undefined, required - To describes the resources that may be referenced by the resources described in "From". Each entry in this list MUST be considered to be an additional place that references can be valid to, or to put this another way, entries MUST be combined using OR. - Support: Core + To describes the resources that may be referenced by the resources + described in "From". Each entry in this list MUST be considered to be an + additional place that references can be valid to, or to put this another + way, entries MUST be combined using OR. + + + Support: Core """ @@ -64,23 +93,42 @@ schema GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpec: schema GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpecFromItems0: - """ + r""" ReferenceGrantFrom describes trusted namespaces and kinds. Attributes ---------- group : str, default is Undefined, required - Group is the group of the referent. When empty, the Kubernetes core API group is inferred. - Support: Core + Group is the group of the referent. + When empty, the Kubernetes core API group is inferred. + + + Support: Core kind : str, default is Undefined, required - Kind is the kind of the referent. Although implementations may support additional resources, the following types are part of the "Core" support level for this field. - When used to permit a SecretObjectReference: - * Gateway - When used to permit a BackendObjectReference: - * GRPCRoute * HTTPRoute * TCPRoute * TLSRoute * UDPRoute + Kind is the kind of the referent. Although implementations may support + additional resources, the following types are part of the "Core" + support level for this field. + + + When used to permit a SecretObjectReference: + + + * Gateway + + + When used to permit a BackendObjectReference: + + + * GRPCRoute + * HTTPRoute + * TCPRoute + * TLSRoute + * UDPRoute namespace : str, default is Undefined, required - Namespace is the namespace of the referent. - Support: Core + Namespace is the namespace of the referent. + + + Support: Core """ @@ -93,29 +141,40 @@ schema GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpecFromItems0: check: len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") len(kind) <= 63 len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") len(namespace) <= 63 len(namespace) >= 1 - regex.match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") schema GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpecToItems0: - """ - ReferenceGrantTo describes what Kinds are allowed as targets of the references. + r""" + ReferenceGrantTo describes what Kinds are allowed as targets of the + references. Attributes ---------- group : str, default is Undefined, required - Group is the group of the referent. When empty, the Kubernetes core API group is inferred. - Support: Core + Group is the group of the referent. + When empty, the Kubernetes core API group is inferred. + + + Support: Core kind : str, default is Undefined, required - Kind is the kind of the referent. Although implementations may support additional resources, the following types are part of the "Core" support level for this field: - * Secret when used to permit a SecretObjectReference * Service when used to permit a BackendObjectReference + Kind is the kind of the referent. Although implementations may support + additional resources, the following types are part of the "Core" + support level for this field: + + + * Secret when used to permit a SecretObjectReference + * Service when used to permit a BackendObjectReference name : str, default is Undefined, optional - Name is the name of the referent. When unspecified, this policy refers to all resources of the specified Group and Kind in the local namespace. + Name is the name of the referent. When unspecified, this policy + refers to all resources of the specified Group and Kind in the local + namespace. """ @@ -128,11 +187,11 @@ schema GatewayNetworkingK8sIoV1alpha2ReferenceGrantSpecToItems0: check: len(group) <= 253 - regex.match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") len(kind) <= 63 len(kind) >= 1 - regex.match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") - len(name) <= 253 - len(name) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 if name + len(name) >= 1 if name diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_tcp_route.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_tcp_route.k new file mode 100644 index 00000000..02e45c60 --- /dev/null +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_tcp_route.k @@ -0,0 +1,814 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema TCPRoute: + r""" + TCPRoute provides a way to route TCP requests. When combined with a Gateway + listener, it can be used to forward connections on the port specified by the + listener to a set of backends specified by the TCPRoute. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required + 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 + kind : str, default is "TCPRoute", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1alpha2TCPRouteSpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1alpha2TCPRouteStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" + + kind: "TCPRoute" = "TCPRoute" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1alpha2TCPRouteSpec + + status?: GatewayNetworkingK8sIoV1alpha2TCPRouteStatus + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteSpec: + r""" + Spec defines the desired state of TCPRoute. + + Attributes + ---------- + parentRefs : [GatewayNetworkingK8sIoV1alpha2TCPRouteSpecParentRefsItems0], default is Undefined, optional + 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. For Services, that means the Service must either be in the same + namespace for a "producer" route, or the mesh implementation must support + and allow "consumer" routes for the referenced Service. ReferenceGrant is + not applicable for governing ParentRefs to Services - it is not possible to + create a "producer" route for a Service in a different namespace from the + 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. + + + ParentRefs must be _distinct_. This means either that: + + + * They select different objects. If this is the case, then parentRef + entries are distinct. In terms of fields, this means that the + multi-part key defined by `group`, `kind`, `namespace`, and `name` must + be unique across all parentRef entries in the Route. + * They do not select different objects, but for each optional field used, + each ParentRef that selects the same object must set the same set of + optional fields to different values. If one ParentRef sets a + combination of optional fields, all must set the same combination. + + + Some examples: + + + * If one ParentRef sets `sectionName`, all ParentRefs referencing the + same object must also set `sectionName`. + * If one ParentRef sets `port`, all ParentRefs referencing the same + object must also set `port`. + * If one ParentRef sets `sectionName` and `port`, all ParentRefs + referencing the same object must also set `sectionName` and `port`. + + + 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. + + + Note that for ParentRefs that cross namespace boundaries, there are specific + rules. 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 other kinds of cross-namespace reference. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + + + + + rules : [GatewayNetworkingK8sIoV1alpha2TCPRouteSpecRulesItems0], default is Undefined, required + Rules are a list of TCP matchers and actions. + """ + + + parentRefs?: [GatewayNetworkingK8sIoV1alpha2TCPRouteSpecParentRefsItems0] + + rules: [GatewayNetworkingK8sIoV1alpha2TCPRouteSpecRulesItems0] + + + check: + len(parentRefs) <= 32 if parentRefs + len(rules) >= 1 + len(rules) <= 16 + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteSpecParentRefsItems0: + r""" + 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. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteSpecRulesItems0: + r""" + TCPRouteRule is the configuration for a given rule. + + Attributes + ---------- + backendRefs : [GatewayNetworkingK8sIoV1alpha2TCPRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional + BackendRefs defines the backend(s) where matching requests should be + sent. If unspecified or invalid (refers to a non-existent resource or a + Service with no endpoints), the underlying implementation MUST actively + reject connection attempts to this backend. Connection rejections must + respect weight; if an invalid backend is requested to have 80% of + connections, then 80% of connections must be rejected instead. + + + Support: Core for Kubernetes Service + + + Support: Extended for Kubernetes ServiceImport + + + Support: Implementation-specific for any other resource + + + Support for weight: Extended + """ + + + backendRefs?: [GatewayNetworkingK8sIoV1alpha2TCPRouteSpecRulesItems0BackendRefsItems0] + + + check: + len(backendRefs) >= 1 if backendRefs + len(backendRefs) <= 16 if backendRefs + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteSpecRulesItems0BackendRefsItems0: + r""" + BackendRef defines how a Route should forward a request to a Kubernetes + resource. + + + 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. + + + + + + When the BackendRef points to a Kubernetes Service, implementations SHOULD + honor the appProtocol field if it is set for the target Service Port. + + + Implementations supporting appProtocol SHOULD recognize the Kubernetes + Standard Application Protocols defined in KEP-3726. + + + If a Service appProtocol isn't specified, an implementation MAY infer the + backend protocol through its own means. Implementations MAY infer the + protocol from the Route type referring to the backend Service. + + + If a Route is not able to send traffic to the backend using the specified + protocol then the backend is considered invalid. Implementations MUST set the + "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. + + + + + + Note that when the BackendTLSPolicy object is enabled by the implementation, + there are some extra rules about validity to consider here. See the fields + where this struct is used for more information about the exact behavior. + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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 : int, default is 1, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + weight?: int = 1 + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + weight <= 1e+06 if weight not in [None, Undefined] + weight >= 0 if weight not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteStatus: + r""" + Status defines the current state of TCPRoute. + + Attributes + ---------- + parents : [GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0], default is Undefined, required + 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. + + + 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. + + + A maximum of 32 Gateways will be represented in this list. An empty list + means the route has not been attached to any Gateway. + """ + + + parents: [GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0] + + + check: + len(parents) <= 32 + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0: + r""" + RouteParentStatus describes the status of a route with respect to an + associated Parent. + + Attributes + ---------- + conditions : [GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional + 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. + + + 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. + + + A Route MUST be considered "Accepted" if at least one of the Route's + rules is implemented by the Gateway. + + + There are a number of cases where the "Accepted" condition may not be set + due to lack of controller visibility, that includes when: + + + * 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 controller does not have access to. + controllerName : str, default is Undefined, 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 : GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0ParentRef, default is Undefined, required + parent ref + """ + + + conditions?: [GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0ConditionsItems0] + + controllerName: str + + parentRef: GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0ParentRef + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1alpha2TCPRouteStatusParentsItems0ParentRef: + r""" + ParentRef corresponds with a ParentRef in the spec that this + RouteParentStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_tls_route.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_tls_route.k new file mode 100644 index 00000000..8ccc6b21 --- /dev/null +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_tls_route.k @@ -0,0 +1,867 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema TLSRoute: + r""" + The TLSRoute resource is similar to TCPRoute, but can be configured + to match against TLS-specific metadata. This allows more flexibility + in matching streams for a given TLS listener. + + + If you need to forward traffic to a single target for a TLS listener, you + could choose to use a TCPRoute with a TLS listener. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required + 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 + kind : str, default is "TLSRoute", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1alpha2TLSRouteSpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1alpha2TLSRouteStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" + + kind: "TLSRoute" = "TLSRoute" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1alpha2TLSRouteSpec + + status?: GatewayNetworkingK8sIoV1alpha2TLSRouteStatus + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteSpec: + r""" + Spec defines the desired state of TLSRoute. + + Attributes + ---------- + hostnames : [str], default is Undefined, optional + Hostnames defines a set of SNI names that should match against the + SNI attribute of TLS ClientHello message in TLS handshake. This matches + the RFC 1123 definition of a hostname with 2 notable exceptions: + + + 1. IPs are not allowed in SNI names per RFC 6066. + 2. 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 TLSRoute, there + must be at least one intersecting hostname for the TLSRoute to be + attached to the Listener. For example: + + + * A Listener with `test.example.com` as the hostname matches TLSRoutes + 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 TLSRoutes + 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. + + + If both the Listener and TLSRoute have specified hostnames, any + TLSRoute hostnames that do not match the Listener hostname MUST be + ignored. For example, if a Listener specified `*.example.com`, and the + TLSRoute specified `test.example.com` and `test.example.net`, + `test.example.net` must not be considered for a match. + + + If both the Listener and TLSRoute have specified hostnames, and none + match with the criteria above, then the TLSRoute is not accepted. The + implementation must raise an 'Accepted' Condition with a status of + `False` in the corresponding RouteParentStatus. + + + Support: Core + parentRefs : [GatewayNetworkingK8sIoV1alpha2TLSRouteSpecParentRefsItems0], default is Undefined, optional + 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. For Services, that means the Service must either be in the same + namespace for a "producer" route, or the mesh implementation must support + and allow "consumer" routes for the referenced Service. ReferenceGrant is + not applicable for governing ParentRefs to Services - it is not possible to + create a "producer" route for a Service in a different namespace from the + 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. + + + ParentRefs must be _distinct_. This means either that: + + + * They select different objects. If this is the case, then parentRef + entries are distinct. In terms of fields, this means that the + multi-part key defined by `group`, `kind`, `namespace`, and `name` must + be unique across all parentRef entries in the Route. + * They do not select different objects, but for each optional field used, + each ParentRef that selects the same object must set the same set of + optional fields to different values. If one ParentRef sets a + combination of optional fields, all must set the same combination. + + + Some examples: + + + * If one ParentRef sets `sectionName`, all ParentRefs referencing the + same object must also set `sectionName`. + * If one ParentRef sets `port`, all ParentRefs referencing the same + object must also set `port`. + * If one ParentRef sets `sectionName` and `port`, all ParentRefs + referencing the same object must also set `sectionName` and `port`. + + + 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. + + + Note that for ParentRefs that cross namespace boundaries, there are specific + rules. 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 other kinds of cross-namespace reference. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + + + + + rules : [GatewayNetworkingK8sIoV1alpha2TLSRouteSpecRulesItems0], default is Undefined, required + Rules are a list of TLS matchers and actions. + """ + + + hostnames?: [str] + + parentRefs?: [GatewayNetworkingK8sIoV1alpha2TLSRouteSpecParentRefsItems0] + + rules: [GatewayNetworkingK8sIoV1alpha2TLSRouteSpecRulesItems0] + + + check: + len(hostnames) <= 16 if hostnames + all hostnames in hostnames { len(hostnames) <= 253 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { len(hostnames) >= 1 if hostnames not in [None, Undefined] } if hostnames + all hostnames in hostnames { _regex_match(str(hostnames), r"^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if hostnames } if hostnames + len(parentRefs) <= 32 if parentRefs + len(rules) >= 1 + len(rules) <= 16 + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteSpecParentRefsItems0: + r""" + 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. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteSpecRulesItems0: + r""" + TLSRouteRule is the configuration for a given rule. + + Attributes + ---------- + backendRefs : [GatewayNetworkingK8sIoV1alpha2TLSRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional + BackendRefs defines the backend(s) where matching requests should be + sent. If unspecified or invalid (refers to a non-existent resource or + a Service with no endpoints), the rule performs no forwarding; if no + filters are specified that would result in a response being sent, the + underlying implementation must actively reject request attempts to this + backend, by rejecting the connection or returning a 500 status code. + Request rejections must respect weight; if an invalid backend is + requested to have 80% of requests, then 80% of requests must be rejected + instead. + + + Support: Core for Kubernetes Service + + + Support: Extended for Kubernetes ServiceImport + + + Support: Implementation-specific for any other resource + + + Support for weight: Extended + """ + + + backendRefs?: [GatewayNetworkingK8sIoV1alpha2TLSRouteSpecRulesItems0BackendRefsItems0] + + + check: + len(backendRefs) >= 1 if backendRefs + len(backendRefs) <= 16 if backendRefs + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteSpecRulesItems0BackendRefsItems0: + r""" + BackendRef defines how a Route should forward a request to a Kubernetes + resource. + + + 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. + + + + + + When the BackendRef points to a Kubernetes Service, implementations SHOULD + honor the appProtocol field if it is set for the target Service Port. + + + Implementations supporting appProtocol SHOULD recognize the Kubernetes + Standard Application Protocols defined in KEP-3726. + + + If a Service appProtocol isn't specified, an implementation MAY infer the + backend protocol through its own means. Implementations MAY infer the + protocol from the Route type referring to the backend Service. + + + If a Route is not able to send traffic to the backend using the specified + protocol then the backend is considered invalid. Implementations MUST set the + "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. + + + + + + Note that when the BackendTLSPolicy object is enabled by the implementation, + there are some extra rules about validity to consider here. See the fields + where this struct is used for more information about the exact behavior. + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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 : int, default is 1, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + weight?: int = 1 + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + weight <= 1e+06 if weight not in [None, Undefined] + weight >= 0 if weight not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteStatus: + r""" + Status defines the current state of TLSRoute. + + Attributes + ---------- + parents : [GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0], default is Undefined, required + 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. + + + 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. + + + A maximum of 32 Gateways will be represented in this list. An empty list + means the route has not been attached to any Gateway. + """ + + + parents: [GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0] + + + check: + len(parents) <= 32 + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0: + r""" + RouteParentStatus describes the status of a route with respect to an + associated Parent. + + Attributes + ---------- + conditions : [GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional + 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. + + + 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. + + + A Route MUST be considered "Accepted" if at least one of the Route's + rules is implemented by the Gateway. + + + There are a number of cases where the "Accepted" condition may not be set + due to lack of controller visibility, that includes when: + + + * 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 controller does not have access to. + controllerName : str, default is Undefined, 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 : GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0ParentRef, default is Undefined, required + parent ref + """ + + + conditions?: [GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0ConditionsItems0] + + controllerName: str + + parentRef: GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0ParentRef + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1alpha2TLSRouteStatusParentsItems0ParentRef: + r""" + ParentRef corresponds with a ParentRef in the spec that this + RouteParentStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + diff --git a/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_udp_route.k b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_udp_route.k new file mode 100644 index 00000000..c37463ba --- /dev/null +++ b/gateway-api/v1alpha2/gateway_networking_k8s_io_v1alpha2_udp_route.k @@ -0,0 +1,814 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema UDPRoute: + r""" + UDPRoute provides a way to route UDP traffic. When combined with a Gateway + listener, it can be used to forward traffic on the port specified by the + listener to a set of backends specified by the UDPRoute. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1alpha2", required + 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 + kind : str, default is "UDPRoute", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1alpha2UDPRouteSpec, default is Undefined, required + spec + status : GatewayNetworkingK8sIoV1alpha2UDPRouteStatus, default is Undefined, optional + status + """ + + + apiVersion: "gateway.networking.k8s.io/v1alpha2" = "gateway.networking.k8s.io/v1alpha2" + + kind: "UDPRoute" = "UDPRoute" + + metadata?: v1.ObjectMeta + + spec: GatewayNetworkingK8sIoV1alpha2UDPRouteSpec + + status?: GatewayNetworkingK8sIoV1alpha2UDPRouteStatus + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteSpec: + r""" + Spec defines the desired state of UDPRoute. + + Attributes + ---------- + parentRefs : [GatewayNetworkingK8sIoV1alpha2UDPRouteSpecParentRefsItems0], default is Undefined, optional + 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. For Services, that means the Service must either be in the same + namespace for a "producer" route, or the mesh implementation must support + and allow "consumer" routes for the referenced Service. ReferenceGrant is + not applicable for governing ParentRefs to Services - it is not possible to + create a "producer" route for a Service in a different namespace from the + 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. + + + ParentRefs must be _distinct_. This means either that: + + + * They select different objects. If this is the case, then parentRef + entries are distinct. In terms of fields, this means that the + multi-part key defined by `group`, `kind`, `namespace`, and `name` must + be unique across all parentRef entries in the Route. + * They do not select different objects, but for each optional field used, + each ParentRef that selects the same object must set the same set of + optional fields to different values. If one ParentRef sets a + combination of optional fields, all must set the same combination. + + + Some examples: + + + * If one ParentRef sets `sectionName`, all ParentRefs referencing the + same object must also set `sectionName`. + * If one ParentRef sets `port`, all ParentRefs referencing the same + object must also set `port`. + * If one ParentRef sets `sectionName` and `port`, all ParentRefs + referencing the same object must also set `sectionName` and `port`. + + + 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. + + + Note that for ParentRefs that cross namespace boundaries, there are specific + rules. 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 other kinds of cross-namespace reference. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + + + + + rules : [GatewayNetworkingK8sIoV1alpha2UDPRouteSpecRulesItems0], default is Undefined, required + Rules are a list of UDP matchers and actions. + """ + + + parentRefs?: [GatewayNetworkingK8sIoV1alpha2UDPRouteSpecParentRefsItems0] + + rules: [GatewayNetworkingK8sIoV1alpha2UDPRouteSpecRulesItems0] + + + check: + len(parentRefs) <= 32 if parentRefs + len(rules) >= 1 + len(rules) <= 16 + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteSpecParentRefsItems0: + r""" + 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. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteSpecRulesItems0: + r""" + UDPRouteRule is the configuration for a given rule. + + Attributes + ---------- + backendRefs : [GatewayNetworkingK8sIoV1alpha2UDPRouteSpecRulesItems0BackendRefsItems0], default is Undefined, optional + BackendRefs defines the backend(s) where matching requests should be + sent. If unspecified or invalid (refers to a non-existent resource or a + Service with no endpoints), the underlying implementation MUST actively + reject connection attempts to this backend. Packet drops must + respect weight; if an invalid backend is requested to have 80% of + the packets, then 80% of packets must be dropped instead. + + + Support: Core for Kubernetes Service + + + Support: Extended for Kubernetes ServiceImport + + + Support: Implementation-specific for any other resource + + + Support for weight: Extended + """ + + + backendRefs?: [GatewayNetworkingK8sIoV1alpha2UDPRouteSpecRulesItems0BackendRefsItems0] + + + check: + len(backendRefs) >= 1 if backendRefs + len(backendRefs) <= 16 if backendRefs + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteSpecRulesItems0BackendRefsItems0: + r""" + BackendRef defines how a Route should forward a request to a Kubernetes + resource. + + + 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. + + + + + + When the BackendRef points to a Kubernetes Service, implementations SHOULD + honor the appProtocol field if it is set for the target Service Port. + + + Implementations supporting appProtocol SHOULD recognize the Kubernetes + Standard Application Protocols defined in KEP-3726. + + + If a Service appProtocol isn't specified, an implementation MAY infer the + backend protocol through its own means. Implementations MAY infer the + protocol from the Route type referring to the backend Service. + + + If a Route is not able to send traffic to the backend using the specified + protocol then the backend is considered invalid. Implementations MUST set the + "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. + + + + + + Note that when the BackendTLSPolicy object is enabled by the implementation, + there are some extra rules about validity to consider here. See the fields + where this struct is used for more information about the exact behavior. + + Attributes + ---------- + group : str, default is Undefined, optional + Group is the group of the referent. For example, "gateway.networking.k8s.io". + When unspecified or empty string, core API group is inferred. + kind : str, default is "Service", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + namespace : str, default is Undefined, optional + 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 : int, default is Undefined, optional + 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 : int, default is 1, optional + 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. + """ + + + group?: str = "" + + kind?: str = "Service" + + name: str + + namespace?: str + + port?: int + + weight?: int = 1 + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + weight <= 1e+06 if weight not in [None, Undefined] + weight >= 0 if weight not in [None, Undefined] + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteStatus: + r""" + Status defines the current state of UDPRoute. + + Attributes + ---------- + parents : [GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0], default is Undefined, required + 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. + + + 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. + + + A maximum of 32 Gateways will be represented in this list. An empty list + means the route has not been attached to any Gateway. + """ + + + parents: [GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0] + + + check: + len(parents) <= 32 + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0: + r""" + RouteParentStatus describes the status of a route with respect to an + associated Parent. + + Attributes + ---------- + conditions : [GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0ConditionsItems0], default is Undefined, optional + 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. + + + 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. + + + A Route MUST be considered "Accepted" if at least one of the Route's + rules is implemented by the Gateway. + + + There are a number of cases where the "Accepted" condition may not be set + due to lack of controller visibility, that includes when: + + + * 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 controller does not have access to. + controllerName : str, default is Undefined, 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 : GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0ParentRef, default is Undefined, required + parent ref + """ + + + conditions?: [GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0ConditionsItems0] + + controllerName: str + + parentRef: GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0ParentRef + + + check: + len(conditions) >= 1 if conditions + len(conditions) <= 8 if conditions + len(controllerName) <= 253 + len(controllerName) >= 1 + _regex_match(str(controllerName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$") + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0ConditionsItems0: + r""" + 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"` + + + // other fields + } + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, 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 : str, default is Undefined, required + message is a human readable message indicating details about the transition. + This may be an empty string. + observedGeneration : int, default is Undefined, optional + 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 : str, default is Undefined, 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 : str, default is Undefined, required + status of the condition, one of True, False, Unknown. + $type : str, default is Undefined, required + 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) + """ + + + lastTransitionTime: str + + message: str + + observedGeneration?: int + + reason: str + + status: "True" | "False" | "Unknown" + + $type: str + + + check: + len(message) <= 32768 + observedGeneration >= 0 if observedGeneration not in [None, Undefined] + len(reason) <= 1024 + len(reason) >= 1 + _regex_match(str(reason), r"^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$") + len($type) <= 316 + _regex_match(str($type), r"^([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])$") + + +schema GatewayNetworkingK8sIoV1alpha2UDPRouteStatusParentsItems0ParentRef: + r""" + ParentRef corresponds with a ParentRef in the spec that this + RouteParentStatus struct describes the status of. + + Attributes + ---------- + group : str, default is "gateway.networking.k8s.io", optional + 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 : str, default is "Gateway", optional + 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 : str, default is Undefined, required + Name is the name of the referent. + + + Support: Core + namespace : str, default is Undefined, optional + 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. + + + + ParentRefs from a Route to a Service in the same namespace are "producer" + routes, which apply default routing rules to inbound connections from + any namespace to the Service. + + + ParentRefs from a Route to a Service in a different namespace are + "consumer" routes, and these routing rules are only applied to outbound + connections originating from the same namespace as the Route, for which + the intended destination of the connections are a Service targeted as a + ParentRef of the Route. + + + + Support: Core + port : int, default is Undefined, optional + 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. + + + + When the parent resource is a Service, this targets a specific port in the + Service spec. When both Port (experimental) and SectionName are specified, + the name and port of the selected port 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 : str, default is Undefined, optional + 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 + """ + + + group?: str = "gateway.networking.k8s.io" + + kind?: str = "Gateway" + + name: str + + namespace?: str + + port?: int + + sectionName?: str + + + check: + len(group) <= 253 if group + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if group + len(kind) <= 63 if kind + len(kind) >= 1 if kind + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") if kind + len(name) <= 253 + len(name) >= 1 + len(namespace) <= 63 if namespace + len(namespace) >= 1 if namespace + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") if namespace + port <= 65535 if port not in [None, Undefined] + port >= 1 if port not in [None, Undefined] + len(sectionName) <= 253 if sectionName + len(sectionName) >= 1 if sectionName + _regex_match(str(sectionName), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") if sectionName + + diff --git a/gateway-api/v1beta1/gateway_networking_k8s_io_v1beta1_reference_grant.k b/gateway-api/v1beta1/gateway_networking_k8s_io_v1beta1_reference_grant.k new file mode 100644 index 00000000..d5a7c87a --- /dev/null +++ b/gateway-api/v1beta1/gateway_networking_k8s_io_v1beta1_reference_grant.k @@ -0,0 +1,193 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import regex +import k8s.apimachinery.pkg.apis.meta.v1 +_regex_match = regex.match + + +schema ReferenceGrant: + r""" + ReferenceGrant identifies kinds of resources in other namespaces that are + trusted to reference the specified kinds of resources in the same namespace + as the policy. + + + Each ReferenceGrant can be used to represent a unique trust relationship. + Additional Reference Grants can be used to add to the set of trusted + sources of inbound references for the namespace they are defined within. + + + All cross-namespace references in Gateway API (with the exception of cross-namespace + Gateway-route attachment) require a ReferenceGrant. + + + ReferenceGrant is a form of runtime verification allowing users to assert + which cross-namespace object references are permitted. Implementations that + support ReferenceGrant MUST NOT permit cross-namespace references which have + no grant, and MUST respond to the removal of a grant by revoking the access + that the grant allowed. + + Attributes + ---------- + apiVersion : str, default is "gateway.networking.k8s.io/v1beta1", required + 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 + kind : str, default is "ReferenceGrant", required + 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 + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : GatewayNetworkingK8sIoV1beta1ReferenceGrantSpec, default is Undefined, optional + spec + """ + + + apiVersion: "gateway.networking.k8s.io/v1beta1" = "gateway.networking.k8s.io/v1beta1" + + kind: "ReferenceGrant" = "ReferenceGrant" + + metadata?: v1.ObjectMeta + + spec?: GatewayNetworkingK8sIoV1beta1ReferenceGrantSpec + + +schema GatewayNetworkingK8sIoV1beta1ReferenceGrantSpec: + r""" + Spec defines the desired state of ReferenceGrant. + + Attributes + ---------- + from : [GatewayNetworkingK8sIoV1beta1ReferenceGrantSpecFromItems0], default is Undefined, required + From describes the trusted namespaces and kinds that can reference the + resources described in "To". Each entry in this list MUST be considered + to be an additional place that references can be valid from, or to put + this another way, entries MUST be combined using OR. + + + Support: Core + to : [GatewayNetworkingK8sIoV1beta1ReferenceGrantSpecToItems0], default is Undefined, required + To describes the resources that may be referenced by the resources + described in "From". Each entry in this list MUST be considered to be an + additional place that references can be valid to, or to put this another + way, entries MUST be combined using OR. + + + Support: Core + """ + + + from: [GatewayNetworkingK8sIoV1beta1ReferenceGrantSpecFromItems0] + + to: [GatewayNetworkingK8sIoV1beta1ReferenceGrantSpecToItems0] + + + check: + len(from) >= 1 + len(from) <= 16 + len(to) >= 1 + len(to) <= 16 + + +schema GatewayNetworkingK8sIoV1beta1ReferenceGrantSpecFromItems0: + r""" + ReferenceGrantFrom describes trusted namespaces and kinds. + + Attributes + ---------- + group : str, default is Undefined, required + Group is the group of the referent. + When empty, the Kubernetes core API group is inferred. + + + Support: Core + kind : str, default is Undefined, required + Kind is the kind of the referent. Although implementations may support + additional resources, the following types are part of the "Core" + support level for this field. + + + When used to permit a SecretObjectReference: + + + * Gateway + + + When used to permit a BackendObjectReference: + + + * GRPCRoute + * HTTPRoute + * TCPRoute + * TLSRoute + * UDPRoute + namespace : str, default is Undefined, required + Namespace is the namespace of the referent. + + + Support: Core + """ + + + group: str + + kind: str + + namespace: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(namespace) <= 63 + len(namespace) >= 1 + _regex_match(str(namespace), r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") + + +schema GatewayNetworkingK8sIoV1beta1ReferenceGrantSpecToItems0: + r""" + ReferenceGrantTo describes what Kinds are allowed as targets of the + references. + + Attributes + ---------- + group : str, default is Undefined, required + Group is the group of the referent. + When empty, the Kubernetes core API group is inferred. + + + Support: Core + kind : str, default is Undefined, required + Kind is the kind of the referent. Although implementations may support + additional resources, the following types are part of the "Core" + support level for this field: + + + * Secret when used to permit a SecretObjectReference + * Service when used to permit a BackendObjectReference + name : str, default is Undefined, optional + Name is the name of the referent. When unspecified, this policy + refers to all resources of the specified Group and Kind in the local + namespace. + """ + + + group: str + + kind: str + + name?: str + + + check: + len(group) <= 253 + _regex_match(str(group), r"^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") + len(kind) <= 63 + len(kind) >= 1 + _regex_match(str(kind), r"^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$") + len(name) <= 253 if name + len(name) >= 1 if name + +