# Packages
No description provided by the author
# Functions
Resource takes an unqualified resource and returns a Group qualified GroupResource.
# Constants
CookieBasedSessionPersistence specifies cookie-based session persistence.
This type of modifier indicates that the full path will be replaced by the specified value.
This condition indicates whether the GatewayClass has been accepted by the controller requested in the `spec.controller` field.
This condition indicates whether the GatewayClass supports the version(s) of Gateway API CRDs present in the cluster.
GatewayClassFinalizerGatewaysExist should be added as a finalizer to the GatewayClass whenever there are provisioned Gateways using a GatewayClass.
This reason is used with the "Accepted" condition when the condition is true.
This reason is used with the "Accepted" condition when the GatewayClass was not accepted because the parametersRef field was invalid, with more detail in the message.
This reason is used with the "Accepted" condition when the requested controller has not yet made a decision about whether to admit the GatewayClass.
This reason is used with the "SupportedVersion" condition when the condition is true.
This reason is used with the "SupportedVersion" or "Accepted" condition when the condition is false.
Deprecated: Use "Pending" instead.
This condition is true when the controller managing the Gateway is syntactically and semantically valid enough to produce some configuration in the underlying data plane.
This condition indicates whether a Gateway has generated some configuration that is assumed to be ready soon in the underlying data plane.
"Ready" is a condition type reserved for future use.
Deprecated: use "Accepted" instead.
This reason is used with the "Accepted" condition when the condition is True.
This reason is used with the "Programmed" condition when the underlying implementation and network have yet to dynamically assign addresses for a Gateway.
This reason is used with the "Programmed" condition when the underlying implementation (and possibly, network) are unable to use an address that was provided in the Gateway specification.
This reason is used with the "Programmed" and "Accepted" conditions when the Gateway is syntactically or semantically invalid.
This reason is used with the "Accepted" condition when the Gateway was not accepted because the parametersRef field was invalid, with more detail in the message.
Deprecated: Ready is reserved for future use.
This reason is used with the "Accepted" condition when one or more Listeners have an invalid or unsupported configuration and cannot be configured on the Gateway.
This reason is used with the "Programmed" condition when the Gateway is not scheduled because insufficient infrastructure resources are available.
Deprecated: Use "Pending" instead.
This reason is used with the "Accepted" and "Programmed" conditions when the status is "Unknown" and no controller has reconciled the Gateway.
This reason is used with the "Programmed" condition when the condition is true.
Deprecated: Ready is reserved for future use.
This reason is used with the "Scheduled" condition when the condition is True.
This reason is used with the "Accepted" condition to indicate that the Gateway could not be accepted because an address that was provided is a type which is not supported by the implementation.
GroupName specifies the group name used to register the objects.
GRPCHeaderMatchType constants.
GRPCHeaderMatchType constants.
Matches the method or service exactly and with case sensitivity.
Matches if the method or service matches the given regular expression with case sensitivity.
GRPCRouteFilterExtensionRef should be used for configuring custom gRPC filters.
GRPCRouteFilterRequestHeaderModifier can be used to add or remove a gRPC header from a gRPC request before it is sent to the upstream target.
GRPCRouteFilterRequestMirror can be used to mirror gRPC requests to a different backend.
GRPCRouteFilterRequestHeaderModifier can be used to add or remove a gRPC header from a gRPC response before it is sent to the client.
HeaderBasedSessionPersistence specifies header-based session persistence.
HeaderMatchType constants.
HeaderMatchType constants.
A Hostname represents a DNS based ingress point.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Accepts cleartext HTTP/1.1 sessions over TCP.
HTTPRouteFilterExtensionRef should be used for configuring custom HTTP filters.
HTTPRouteFilterRequestHeaderModifier can be used to add or remove an HTTP header from an HTTP request before it is sent to the upstream target.
HTTPRouteFilterRequestMirror can be used to mirror HTTP requests to a different backend.
HTTPRouteFilterRequestRedirect can be used to redirect a request to another location.
HTTPRouteFilterResponseHeaderModifier can be used to add or remove an HTTP header from an HTTP response before it is sent to the client.
HTTPRouteFilterURLRewrite can be used to modify a request during forwarding.
Accepts HTTP/1.1 or HTTP/2 sessions over TLS.
A textual representation of a numeric IP address.
This condition indicates that the listener is syntactically and semantically valid, and that all features used in the listener's spec are supported.
This condition indicates that the controller was unable to resolve conflicting specification requirements for this Listener.
Deprecated: use "Accepted" instead.
This condition indicates whether a Listener has generated some configuration that will soon be ready in the underlying data plane.
"Ready" is a condition type reserved for future use.
This condition indicates whether the controller was able to resolve all the object references for the Listener.
This reason is used with the "Accepted" condition when the condition is True.
This reason is used with the "Detached" condition when the condition is False.
This reason is used with the "Conflicted" condition when the Listener conflicts with hostnames in other Listeners.
This reason is used with the "Ready" and "Programmed" conditions when the Listener is syntactically or semantically invalid.
This reason is used with the "ResolvedRefs" condition when the Listener has a TLS configuration with at least one TLS CertificateRef that is invalid or does not exist.
This reason is used with the "ResolvedRefs" condition when an invalid or unsupported Route kind is specified by the Listener.
This reason is used with the "Conflicted" condition when the condition is False.
This reason is used with the "Accepted", "Ready" and "Programmed" conditions when the Listener is either not yet reconciled or not yet not online and ready to accept client traffic.
This reason is used with the "Accepted" condition when the Listener requests a port that cannot be used on the Gateway.
This reason is used with the "Programmed" condition when the condition is true.
This reason is used with the "Conflicted" condition when multiple Listeners are specified with the same Listener port number, but have conflicting protocol specifications.
Deprecated: Ready is reserved for future use.
This reason is used with the "ResolvedRefs" condition when the Listener has a TLS configuration that references an object in another namespace, where the object in the other namespace does not have a ReferenceGrant explicitly allowing the reference.
This reason is used with the "ResolvedRefs" condition when the condition is true.
This reason is used with the "Accepted" condition when the Listener could not be attached to be Gateway because its protocol type is not supported.
A NamedAddress provides a way to reference a specific IP address by name.
Routes in all namespaces may be attached to this Gateway.
Only Routes in the same namespace as the Gateway may be attached to this Gateway.
Only Routes in namespaces selected by the selector may be attached to this Gateway.
Matches the URL path exactly and with case sensitivity.
Matches based on a URL path prefix split by `/`.
Matches if the URL path matches the given regular expression with case sensitivity.
PermanentCookieLifetimeType specifies the type for a permanent cookie.
This type of modifier indicates that any prefix path matches will be replaced by the substitution value.
QueryParamMatchType constants.
QueryParamMatchType constants.
This condition indicates whether the route has been accepted or rejected by a Gateway, and why.
This condition indicates that the Route contains a combination of both valid and invalid rules.
This condition indicates whether the controller was able to resolve all the object references for the Route.
This reason is used with the "Accepted" condition when the Route has been accepted by the Gateway.
This reason is used with the "ResolvedRefs" condition when one of the Route's rules has a reference to a resource that does not exist.
This reason is used with the "Accepted" condition when there are incompatible filters present on a route rule (for example if the URLRewrite and RequestRedirect are both present on an HTTPRoute).
This reason is used with the "ResolvedRefs" condition when one of the Route's rules has a reference to an unknown or unsupported Group and/or Kind.
This reason is used with the "Accepted" condition when the Gateway has no compatible Listeners whose Hostname matches the route.
This reason is used with the "Accepted" condition when there are no matching Parents.
This reason is used with the "Accepted" condition when the route has not been accepted by a Gateway because the Gateway has no Listener whose allowedRoutes criteria permit the route.
This reason is used with the "Accepted" when a controller has not yet reconciled the route.
This reason is used with the "ResolvedRefs" condition when one of the Listener's Routes has a BackendRef to an object in another namespace, where the object in the other namespace does not have a ReferenceGrant explicitly allowing the reference.
This reason is used with the "ResolvedRefs" condition when the condition is true.
This reason is used with the "ResolvedRefs" condition when one of the Route's rules has a reference to a resource with an app protocol that is not supported by this implementation.
This reason is used with the "Accepted" condition when a value for an Enum is not recognized.
SessionCookieLifetimeType specifies the type for a session cookie.
Accepts TCP sessions.
In this mode, the TLS session is NOT terminated by the Gateway.
In this mode, TLS session between the downstream client and the Gateway is terminated at the Gateway.
Accepts TLS sessions over TCP.
Accepts UDP packets.
# Variables
Deprecated: use Install instead.
GroupVersion specifies the group and the version used to register the objects.
No description provided by the author
localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.
# Structs
AllowedRoutes defines which Routes may be attached to this Listener.
BackendObjectReference defines how an ObjectReference that is specific to BackendRef.
BackendRef defines how a Route should forward a request to a Kubernetes resource.
CommonRouteSpec defines the common attributes that all Routes MUST include within their spec.
CookieConfig defines the configuration for cookie-based session persistence.
FrontendTLSValidation holds configuration information that can be used to validate the frontend initiating the TLS connection.
Gateway represents an instance of a service-traffic handling infrastructure by binding Listeners to a set of IP addresses.
GatewayAddress describes an address that can be bound to a Gateway.
GatewayClass describes a class of Gateways available to the user for creating Gateway resources.
GatewayClassList contains a list of GatewayClass.
GatewayClassSpec reflects the configuration of a class of Gateways.
GatewayClassStatus is the current status for the GatewayClass.
GatewayInfrastructure defines infrastructure level attributes about a Gateway instance.
GatewayList contains a list of Gateways.
GatewaySpec defines the desired state of Gateway.
GatewayStatus defines the observed state of Gateway.
GatewayStatusAddress describes a network address that is bound to a Gateway.
GatewayTLSConfig describes a TLS configuration.
GRPCBackendRef defines how a GRPCRoute forwards a gRPC request.
GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request headers.
GRPCMethodMatch describes how to select a gRPC route by matching the gRPC request service and/or method.
GRPCRoute provides a way to route gRPC requests.
GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle.
GRPCRouteList contains a list of GRPCRoute.
GRPCRouteMatch defines the predicate used to match requests to a given action.
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).
GRPCRouteSpec defines the desired state of GRPCRoute.
GRPCRouteStatus defines the observed state of GRPCRoute.
HTTPBackendRef defines how a HTTPRoute forwards a HTTP request.
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
HTTPHeaderFilter defines a filter that modifies the headers of an HTTP request or response.
HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers.
HTTPPathMatch describes how to select a HTTP route by matching the HTTP request path.
HTTPPathModifier defines configuration for path modifiers.
HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters.
HTTPRequestMirrorFilter defines configuration for the RequestMirror filter.
HTTPRequestRedirect defines a filter that redirects a request.
HTTPRoute provides a way to route HTTP requests.
HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle.
HTTPRouteList contains a list of HTTPRoute.
HTTPRouteMatch defines the predicate used to match requests to a given action.
HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).
HTTPRouteSpec defines the desired state of HTTPRoute.
HTTPRouteStatus defines the observed state of HTTPRoute.
HTTPRouteTimeouts defines timeouts that can be configured for an HTTPRoute.
HTTPURLRewriteFilter defines a filter that modifies a request during forwarding.
Listener embodies the concept of a logical endpoint where a Gateway accepts network connections.
ListenerStatus is the status associated with a Listener.
LocalObjectReference identifies an API object within the namespace of the referrer.
LocalParametersReference identifies an API object containing controller-specific configuration resource within the namespace.
ObjectReference identifies an API object including its namespace.
ParametersReference identifies an API object containing controller-specific configuration resource within the cluster.
ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route).
RouteGroupKind indicates the group and kind of a Route resource.
RouteNamespaces indicate which namespaces Routes should be selected from.
RouteParentStatus describes the status of a route with respect to an associated Parent.
RouteStatus defines the common attributes that all Routes MUST include within their status.
SecretObjectReference identifies an API object including its namespace, defaulting to Secret.
SessionPersistence defines the desired state of SessionPersistence.
# Type aliases
AddressType defines how a network address is represented as a text string.
AnnotationKey is the key of an annotation in Gateway API.
AnnotationValue is the value of an annotation in Gateway API.
+kubebuilder:validation:Enum=Permanent;Session.
Duration is a string value representing a duration in time.
FromNamespaces specifies namespace from which Routes may be attached to a Gateway.
GatewayClassConditionReason defines the set of reasons that explain why a particular GatewayClass condition type has been raised.
GatewayClassConditionType is the type for status conditions on Gateway resources.
GatewayConditionReason defines the set of reasons that explain why a particular Gateway condition type has been raised.
GatewayConditionType is a type of condition associated with a Gateway.
GatewayController is the name of a Gateway API controller.
Group refers to a Kubernetes Group.
GRPCHeaderMatchType specifies the semantics of how GRPC header values should be compared.
No description provided by the author
MethodMatchType specifies the semantics of how gRPC methods and services are compared.
GRPCRouteFilterType identifies a type of GRPCRoute filter.
HeaderMatchType specifies the semantics of how HTTP header values should be compared.
HeaderName is the name of a header or query parameter.
Hostname is the fully qualified domain name of a network host.
HTTPHeaderName is the name of an HTTP header.
HTTPMethod describes how to select a HTTP route by matching the HTTP method as defined by [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-4) and [RFC 5789](https://datatracker.ietf.org/doc/html/rfc5789#section-2).
HTTPPathModifierType defines the type of path redirect or rewrite.
HTTPRouteFilterType identifies a type of HTTPRoute filter.
Kind refers to a Kubernetes Kind.
ListenerConditionReason defines the set of reasons that explain why a particular Listener condition type has been raised.
ListenerConditionType is a type of condition associated with the listener.
Namespace refers to a Kubernetes namespace.
ObjectName refers to the name of a Kubernetes object.
PathMatchType specifies the semantics of how HTTP paths should be compared.
PortNumber defines a network port.
PreciseHostname is the fully qualified domain name of a network host.
ProtocolType defines the application protocol accepted by a Listener.
QueryParamMatchType specifies the semantics of how HTTP query parameter values should be compared.
RouteConditionReason is a reason for a route condition.
RouteConditionType is a type of condition for a route.
SectionName is the name of a section in a Kubernetes resource.
+kubebuilder:validation:Enum=Cookie;Header.
SupportedFeature is used to describe distinct features that are covered by conformance tests.
TLSModeType type defines how a Gateway handles TLS sessions.