Documentation ¶
Overview ¶
Package v1beta1 contains API Schema definitions for the gateway.networking.k8s.io API group.
+kubebuilder:object:generate=true +groupName=gateway.networking.k8s.io
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type AddressType
- type AllowedRoutes
- type AnnotationKey
- type AnnotationValue
- type BackendObjectReference
- type BackendRef
- type CommonRouteSpec
- type FromNamespaces
- type Gateway
- type GatewayAddress
- type GatewayClass
- type GatewayClassConditionReason
- type GatewayClassConditionType
- type GatewayClassList
- type GatewayClassSpec
- type GatewayClassStatus
- type GatewayConditionReason
- type GatewayConditionType
- type GatewayController
- type GatewayList
- type GatewaySpec
- type GatewayStatus
- type GatewayStatusAddress
- type GatewayTLSConfig
- type Group
- type HTTPBackendRef
- type HTTPHeader
- type HTTPHeaderFilter
- type HTTPHeaderMatch
- type HTTPHeaderName
- type HTTPMethod
- type HTTPPathMatch
- type HTTPPathModifier
- type HTTPPathModifierType
- type HTTPQueryParamMatch
- type HTTPRequestMirrorFilter
- type HTTPRequestRedirectFilter
- type HTTPRoute
- type HTTPRouteFilter
- type HTTPRouteFilterType
- type HTTPRouteList
- type HTTPRouteMatch
- type HTTPRouteRule
- type HTTPRouteSpec
- type HTTPRouteStatus
- type HTTPURLRewriteFilter
- type HeaderMatchType
- type HeaderName
- type Hostname
- type Kind
- type Listener
- type ListenerConditionReason
- type ListenerConditionType
- type ListenerStatus
- type LocalObjectReference
- type Namespace
- type ObjectName
- type ParametersReference
- type ParentReference
- type PathMatchType
- type PortNumber
- type PreciseHostname
- type ProtocolType
- type QueryParamMatchType
- type ReferenceGrant
- type ReferenceGrantFrom
- type ReferenceGrantList
- type ReferenceGrantSpec
- type ReferenceGrantTo
- type RouteConditionReason
- type RouteConditionType
- type RouteGroupKind
- type RouteNamespaces
- type RouteParentStatus
- type RouteStatus
- type SecretObjectReference
- type SectionName
- type TLSModeType
Constants ¶
const ( // This condition indicates whether a Gateway has generated some // configuration that is assumed to be ready soon in the underlying data // plane. // // It is a positive-polarity summary condition, and so should always be // present on the resource with ObservedGeneration set. // // It should be set to Unknown if the controller performs updates to the // status before it has all the information it needs to be able to determine // if the condition is true. // // Possible reasons for this condition to be True are: // // * "Programmed" // // Possible reasons for this condition to be False are: // // * "Invalid" // * "Pending" // * "NoResources" // * "AddressNotAssigned" // // Possible reasons for this condition to be Unknown are: // // * "Pending" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. GatewayConditionProgrammed GatewayConditionType = "Programmed" // This reason is used with the "Programmed" condition when the condition is // true. GatewayReasonProgrammed GatewayConditionReason = "Programmed" // This reason is used with the "Programmed" and "Accepted" conditions when the Gateway is // syntactically or semantically invalid. GatewayReasonInvalid GatewayConditionReason = "Invalid" // This reason is used with the "Programmed" condition when the // Gateway is not scheduled because insufficient infrastructure // resources are available. GatewayReasonNoResources GatewayConditionReason = "NoResources" // This reason is used with the "Programmed" condition when none of the requested // addresses have been assigned to the Gateway. This reason can be used to // express a range of circumstances, including (but not limited to) IPAM // address exhaustion, address not yet allocated, or a named address not being found. GatewayReasonAddressNotAssigned GatewayConditionReason = "AddressNotAssigned" )
const ( // 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 does not indicate whether or not the // configuration has been propagated to the data plane. // // Possible reasons for this condition to be True are: // // * "Accepted" // * "ListenersNotValid" // // Possible reasons for this condition to be False are: // // * "Invalid" // * "NotReconciled" // * "UnsupportedAddress" // * "ListenersNotValid" // // Possible reasons for this condition to be Unknown are: // // * "Pending" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. GatewayConditionAccepted GatewayConditionType = "Accepted" // This reason is used with the "Accepted" condition when the condition is // True. GatewayReasonAccepted GatewayConditionReason = "Accepted" // 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 can be the reason when "Accepted" is "True" or "False", depending on whether // the listener being invalid causes the entire Gateway to not be accepted. GatewayReasonListenersNotValid GatewayConditionReason = "ListenersNotValid" // This reason is used with the "Accepted" and "Programmed" // conditions when the status is "Unknown" and no controller has reconciled // the Gateway. GatewayReasonPending GatewayConditionReason = "Pending" // This reason is used with the "Accepted" condition when the Gateway could not be configured // because the requested address is not supported. This reason could be used in a number of // instances, including: // // * The address is already in use. // * The type of address is not supported by the implementation. GatewayReasonUnsupportedAddress GatewayConditionReason = "UnsupportedAddress" )
const ( // Deprecated: use "Accepted" instead. GatewayConditionScheduled GatewayConditionType = "Scheduled" // This reason is used with the "Scheduled" condition when the condition is // True. // // Deprecated: use the "Accepted" condition with reason "Accepted" instead. GatewayReasonScheduled GatewayConditionReason = "Scheduled" // Deprecated: Use "Pending" instead. GatewayReasonNotReconciled GatewayConditionReason = "NotReconciled" )
const ( // "Ready" is a condition type reserved for future use. It should not be used by implementations. // // If used in the future, "Ready" will represent the final state where all configuration is confirmed good // _and has completely propagated to the data plane_. That is, it is a _guarantee_ that, as soon as something // sees the Condition as `true`, then connections will be correctly routed _immediately_. // // This is a very strong guarantee, and to date no implementation has satisfied it enough to implement it. // This reservation can be discussed in the future if necessary. // // Note: This condition is not really "deprecated", but rather "reserved"; however, deprecated triggers Go linters // to alert about usage. // Deprecated: Ready is reserved for future use GatewayConditionReady GatewayConditionType = "Ready" // Deprecated: Ready is reserved for future use GatewayReasonReady GatewayConditionReason = "Ready" // Deprecated: Ready is reserved for future use GatewayReasonListenersNotReady GatewayConditionReason = "ListenersNotReady" )
const ( // This condition indicates that the controller was unable to resolve // conflicting specification requirements for this Listener. If a // Listener is conflicted, its network port should not be configured // on any network elements. // // Possible reasons for this condition to be true are: // // * "HostnameConflict" // * "ProtocolConflict" // // Possible reasons for this condition to be False are: // // * "NoConflicts" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. ListenerConditionConflicted ListenerConditionType = "Conflicted" // This reason is used with the "Conflicted" condition when // the Listener conflicts with hostnames in other Listeners. For // example, this reason would be used when multiple Listeners on // the same port use `example.com` in the hostname field. ListenerReasonHostnameConflict ListenerConditionReason = "HostnameConflict" // This reason is used with the "Conflicted" condition when // multiple Listeners are specified with the same Listener port // number, but have conflicting protocol specifications. ListenerReasonProtocolConflict ListenerConditionReason = "ProtocolConflict" // This reason is used with the "Conflicted" condition when the condition // is False. ListenerReasonNoConflicts ListenerConditionReason = "NoConflicts" )
const ( // This condition indicates that the listener is syntactically and // semantically valid, and that all features used in the listener's spec are // supported. // // In general, a Listener will be marked as Accepted when the supplied // configuration will generate at least some data plane configuration. // // For example, a Listener with an unsupported protocol will never generate // any data plane config, and so will have Accepted set to `false.` // Conversely, a Listener that does not have any Routes will be able to // generate data plane config, and so will have Accepted set to `true`. // // Possible reasons for this condition to be True are: // // * "Accepted" // // Possible reasons for this condition to be False are: // // * "PortUnavailable" // * "UnsupportedProtocol" // // Possible reasons for this condition to be Unknown are: // // * "Pending" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. ListenerConditionAccepted ListenerConditionType = "Accepted" // Deprecated: use "Accepted" instead. ListenerConditionDetached ListenerConditionType = "Detached" // This reason is used with the "Accepted" condition when the condition is // True. ListenerReasonAccepted ListenerConditionReason = "Accepted" // This reason is used with the "Detached" condition when the condition is // False. // // Deprecated: use the "Accepted" condition with reason "Accepted" instead. ListenerReasonAttached ListenerConditionReason = "Attached" // requests a port that cannot be used on the Gateway. This reason could be // used in a number of instances, including: // // * The port is already in use. // * The port is not supported by the implementation. ListenerReasonPortUnavailable ListenerConditionReason = "PortUnavailable" // 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. ListenerReasonUnsupportedProtocol ListenerConditionReason = "UnsupportedProtocol" )
const ( // This condition indicates whether the controller was able to // resolve all the object references for the Listener. // // Possible reasons for this condition to be true are: // // * "ResolvedRefs" // // Possible reasons for this condition to be False are: // // * "InvalidCertificateRef" // * "InvalidRouteKinds" // * "RefNotPermitted" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. ListenerConditionResolvedRefs ListenerConditionType = "ResolvedRefs" // This reason is used with the "ResolvedRefs" condition when the condition // is true. ListenerReasonResolvedRefs ListenerConditionReason = "ResolvedRefs" // 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. // A CertificateRef is considered invalid when it refers to a nonexistent // or unsupported resource or kind, or when the data within that resource // is malformed. // This reason must be used only when the reference is allowed, either by // referencing an object in the same namespace as the Gateway, or when // a cross-namespace reference has been explicitly allowed by a ReferenceGrant. // If the reference is not allowed, the reason RefNotPermitted must be used // instead. ListenerReasonInvalidCertificateRef ListenerConditionReason = "InvalidCertificateRef" // This reason is used with the "ResolvedRefs" condition when an invalid or // unsupported Route kind is specified by the Listener. ListenerReasonInvalidRouteKinds ListenerConditionReason = "InvalidRouteKinds" // 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. ListenerReasonRefNotPermitted ListenerConditionReason = "RefNotPermitted" )
const ( // This condition indicates whether a Listener has generated some // configuration that will soon be ready in the underlying data plane. // // It is a positive-polarity summary condition, and so should always be // present on the resource with ObservedGeneration set. // // It should be set to Unknown if the controller performs updates to the // status before it has all the information it needs to be able to determine // if the condition is true. // // Possible reasons for this condition to be True are: // // * "Programmed" // // Possible reasons for this condition to be False are: // // * "Invalid" // * "Pending" // // Possible reasons for this condition to be Unknown are: // // * "Pending" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. ListenerConditionProgrammed ListenerConditionType = "Programmed" // This reason is used with the "Programmed" condition when the condition is // true. ListenerReasonProgrammed ListenerConditionReason = "Programmed" // This reason is used with the "Ready" and "Programmed" conditions when the // Listener is syntactically or semantically invalid. ListenerReasonInvalid ListenerConditionReason = "Invalid" // 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. ListenerReasonPending ListenerConditionReason = "Pending" )
const ( // "Ready" is a condition type reserved for future use. It should not be used by implementations. // Note: This condition is not really "deprecated", but rather "reserved"; however, deprecated triggers Go linters // to alert about usage. // // If used in the future, "Ready" will represent the final state where all configuration is confirmed good // _and has completely propagated to the data plane_. That is, it is a _guarantee_ that, as soon as something // sees the Condition as `true`, then connections will be correctly routed _immediately_. // // This is a very strong guarantee, and to date no implementation has satisfied it enough to implement it. // This reservation can be discussed in the future if necessary. // // Deprecated: Ready is reserved for future use ListenerConditionReady ListenerConditionType = "Ready" // Deprecated: Ready is reserved for future use ListenerReasonReady ListenerConditionReason = "Ready" )
const ( // This condition indicates whether the GatewayClass has been accepted by // the controller requested in the `spec.controller` field. // // This condition defaults to Unknown, and MUST be set by a controller when // it sees a GatewayClass using its controller string. The status of this // condition MUST be set to True if the controller will support provisioning // Gateways using this class. Otherwise, this status MUST be set to False. // If the status is set to False, the controller SHOULD set a Message and // Reason as an explanation. // // Possible reasons for this condition to be true are: // // * "Accepted" // // Possible reasons for this condition to be False are: // // * "InvalidParameters" // // Possible reasons for this condition to be Unknown are: // // * "Pending" // // Controllers should prefer to use the values of GatewayClassConditionReason // for the corresponding Reason, where appropriate. GatewayClassConditionStatusAccepted GatewayClassConditionType = "Accepted" // This reason is used with the "Accepted" condition when the condition is // true. GatewayClassReasonAccepted GatewayClassConditionReason = "Accepted" // 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. GatewayClassReasonInvalidParameters GatewayClassConditionReason = "InvalidParameters" // This reason is used with the "Accepted" condition when the // requested controller has not yet made a decision about whether // to admit the GatewayClass. It is the default Reason on a new // GatewayClass. GatewayClassReasonPending GatewayClassConditionReason = "Pending" // Deprecated: Use "Pending" instead. GatewayClassReasonWaiting GatewayClassConditionReason = "Waiting" )
const ( // This condition indicates whether the route has been accepted or rejected // by a Gateway, and why. // // Possible reasons for this condition to be true are: // // * "Accepted" // // Possible reasons for this condition to be False are: // // * "NotAllowedByListeners" // * "NoMatchingListenerHostname" // * "NoMatchingParent" // * "UnsupportedValue" // // Possible reasons for this condition to be Unknown are: // // * "Pending" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. RouteConditionAccepted RouteConditionType = "Accepted" // This reason is used with the "Accepted" condition when the Route has been // accepted by the Gateway. RouteReasonAccepted RouteConditionReason = "Accepted" // 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 RouteReasonNotAllowedByListeners RouteConditionReason = "NotAllowedByListeners" // This reason is used with the "Accepted" condition when the Gateway has no // compatible Listeners whose Hostname matches the route RouteReasonNoMatchingListenerHostname RouteConditionReason = "NoMatchingListenerHostname" // This reason is used with the "Accepted" condition when there are // no matching Parents. In the case of Gateways, this can occur when // a Route ParentRef specifies a Port and/or SectionName that does not // match any Listeners in the Gateway. RouteReasonNoMatchingParent RouteConditionReason = "NoMatchingParent" // This reason is used with the "Accepted" condition when a value for an Enum // is not recognized. RouteReasonUnsupportedValue RouteConditionReason = "UnsupportedValue" // This reason is used with the "Accepted" when a controller has not yet // reconciled the route. RouteReasonPending RouteConditionReason = "Pending" // 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). RouteReasonIncompatibleFilters RouteConditionReason = "IncompatibleFilters" // This condition indicates whether the controller was able to resolve all // the object references for the Route. // // Possible reasons for this condition to be true are: // // * "ResolvedRefs" // // Possible reasons for this condition to be false are: // // * "RefNotPermitted" // * "InvalidKind" // * "BackendNotFound" // // Controllers may raise this condition with other reasons, // but should prefer to use the reasons listed above to improve // interoperability. RouteConditionResolvedRefs RouteConditionType = "ResolvedRefs" // This reason is used with the "ResolvedRefs" condition when the condition // is true. RouteReasonResolvedRefs RouteConditionReason = "ResolvedRefs" // 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. RouteReasonRefNotPermitted RouteConditionReason = "RefNotPermitted" // 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. RouteReasonInvalidKind RouteConditionReason = "InvalidKind" // 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. RouteReasonBackendNotFound RouteConditionReason = "BackendNotFound" )
const ( // GatewayClassFinalizerGatewaysExist should be added as a finalizer to the // GatewayClass whenever there are provisioned Gateways using a // GatewayClass. GatewayClassFinalizerGatewaysExist = "gateway-exists-finalizer.gateway.networking.k8s.io" )
const GroupName = "gateway.networking.k8s.io"
GroupName specifies the group name used to register the objects.
Variables ¶
var ( // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder // Depreciated: use Install instead AddToScheme = localSchemeBuilder.AddToScheme Install = localSchemeBuilder.AddToScheme )
var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1beta1"}
GroupVersion specifies the group and the version used to register the objects.
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}
SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AddressType ¶
type AddressType string
AddressType defines how a network address is represented as a text string. This may take two possible forms:
* A predefined CamelCase string identifier (currently limited to `IPAddress` or `Hostname`) * A domain-prefixed string identifier (like `acme.io/CustomAddressType`)
Values `IPAddress` and `Hostname` have Extended support.
The `NamedAddress` value has been deprecated in favor of implementation specific domain-prefixed strings.
All other values, including domain-prefixed values have Implementation-specific support, which are used in implementation-specific behaviors. Support for additional predefined CamelCase identifiers may be added in future releases.
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^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\/\-._~%!$&'()*+,;=:]+$`
const ( // A textual representation of a numeric IP address. IPv4 // addresses must be in dotted-decimal form. IPv6 addresses // must be in a standard IPv6 text representation // (see [RFC 5952](https://tools.ietf.org/html/rfc5952)). // // This type is intended for specific addresses. Address ranges are not // supported (e.g. you can not use a CIDR range like 127.0.0.0/24 as an // IPAddress). // // Support: Extended IPAddressType AddressType = "IPAddress" // A Hostname represents a DNS based ingress point. This is similar to the // corresponding hostname field in Kubernetes load balancer status. For // example, this concept may be used for cloud load balancers where a DNS // name is used to expose a load balancer. // // Support: Extended HostnameAddressType AddressType = "Hostname" // A NamedAddress provides a way to reference a specific IP address by name. // For example, this may be a name or other unique identifier that refers // to a resource on a cloud provider such as a static IP. // // The `NamedAddress` type has been deprecated in favor of implementation // specific domain-prefixed strings. // // Support: Implementation-specific NamedAddressType AddressType = "NamedAddress" )
type AllowedRoutes ¶
type AllowedRoutes struct { // 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 // // +optional // +kubebuilder:default={from: Same} Namespaces *RouteNamespaces `json:"namespaces,omitempty"` // 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 // // +optional // +kubebuilder:validation:MaxItems=8 Kinds []RouteGroupKind `json:"kinds,omitempty"` }
AllowedRoutes defines which Routes may be attached to this Listener.
func (*AllowedRoutes) DeepCopy ¶
func (in *AllowedRoutes) DeepCopy() *AllowedRoutes
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AllowedRoutes.
func (*AllowedRoutes) DeepCopyInto ¶
func (in *AllowedRoutes) DeepCopyInto(out *AllowedRoutes)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AnnotationKey ¶
type AnnotationKey string
AnnotationKey is the key of an annotation in Gateway API. This is used for validation of maps such as TLS options. This matches the Kubernetes "qualified name" validation that is used for annotations and other common values.
Valid values include:
* example * example.com * example.com/path * example.com/path.html
Invalid values include:
* example~ - "~" is an invalid character * example.com. - can not start or end with "."
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]/?)*$`
type AnnotationValue ¶
type AnnotationValue string
AnnotationValue is the value of an annotation in Gateway API. This is used for validation of maps such as TLS options. This roughly matches Kubernetes annotation validation, although the length validation in that case is based on the entire size of the annotations struct.
+kubebuilder:validation:MinLength=0 +kubebuilder:validation:MaxLength=4096
type BackendObjectReference ¶
type BackendObjectReference struct { // Group is the group of the referent. For example, "gateway.networking.k8s.io". // When unspecified or empty string, core API group is inferred. // // +optional // +kubebuilder:default="" Group *Group `json:"group,omitempty"` // 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) // // +optional // +kubebuilder:default=Service Kind *Kind `json:"kind,omitempty"` // Name is the name of the referent. Name ObjectName `json:"name"` // 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 // // +optional Namespace *Namespace `json:"namespace,omitempty"` // 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. // // +optional Port *PortNumber `json:"port,omitempty"` }
BackendObjectReference defines how an ObjectReference that is specific to BackendRef. It includes a few additional fields and features than a regular ObjectReference.
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.
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.
+kubebuilder:validation:XValidation:message="Must have port for Service reference",rule="(size(self.group) == 0 && self.kind == 'Service') ? has(self.port) : true"
func (*BackendObjectReference) DeepCopy ¶
func (in *BackendObjectReference) DeepCopy() *BackendObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendObjectReference.
func (*BackendObjectReference) DeepCopyInto ¶
func (in *BackendObjectReference) DeepCopyInto(out *BackendObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackendRef ¶
type BackendRef struct { // BackendObjectReference references a Kubernetes object. BackendObjectReference `json:",inline"` // 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. // // +optional // +kubebuilder:default=1 // +kubebuilder:validation:Minimum=0 // +kubebuilder:validation:Maximum=1000000 Weight *int32 `json:"weight,omitempty"` }
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.
func (*BackendRef) DeepCopy ¶
func (in *BackendRef) DeepCopy() *BackendRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendRef.
func (*BackendRef) DeepCopyInto ¶
func (in *BackendRef) DeepCopyInto(out *BackendRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CommonRouteSpec ¶
type CommonRouteSpec struct { // 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. // // 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 two separate Listeners on the same Gateway or two separate // ports on the same Service. // // 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. // // +optional // +kubebuilder:validation:MaxItems=32 // <gateway:standard:validation:XValidation:message="sectionName must be unique when parentRefs includes 2 or more references to the same parent",rule="self.all(p1, self.exists_one(p2, p1.group == p2.group && p1.kind == p2.kind && ((!has(p1.__namespace__) && !has(p2.__namespace__)) || (!has(p1.__namespace__) && p2.__namespace__ == ”) || (p1.__namespace__ == ” && !has(p2.__namespace__)) || (p1.__namespace__ == p2.__namespace__)) && p1.name == p2.name && ((!has(p1.sectionName) && !has(p2.sectionName)) || (!has(p1.sectionName) && p2.sectionName == ”) || (p1.sectionName == ” && !has(p2.sectionName)) || (p1.sectionName == p2.sectionName))))"> // <gateway:experimental:validation:XValidation:message="sectionName or port must be unique when parentRefs includes 2 or more references to the same parent",rule="self.all(p1, self.exists_one(p2, p1.group == p2.group && p1.kind == p2.kind && ((!has(p1.__namespace__) && !has(p2.__namespace__)) || (!has(p1.__namespace__) && p2.__namespace__ == ”) || (p1.__namespace__ == ” && !has(p2.__namespace__)) || (p1.__namespace__ == p2.__namespace__)) && p1.name == p2.name && ((!has(p1.sectionName) && !has(p2.sectionName)) || (!has(p1.sectionName) && p2.sectionName == ”) || (p1.sectionName == ” && !has(p2.sectionName)) || (p1.sectionName == p2.sectionName)) && ((!has(p1.port) && !has(p2.port)) || (!has(p1.port) && p2.port == 0) || (p1.port == 0 && !has(p2.port)) || (p1.port == p2.port))))"> ParentRefs []ParentReference `json:"parentRefs,omitempty"` }
CommonRouteSpec defines the common attributes that all Routes MUST include within their spec.
func (*CommonRouteSpec) DeepCopy ¶
func (in *CommonRouteSpec) DeepCopy() *CommonRouteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonRouteSpec.
func (*CommonRouteSpec) DeepCopyInto ¶
func (in *CommonRouteSpec) DeepCopyInto(out *CommonRouteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FromNamespaces ¶
type FromNamespaces string
FromNamespaces specifies namespace from which Routes may be attached to a Gateway.
+kubebuilder:validation:Enum=All;Selector;Same
const ( // Routes in all namespaces may be attached to this Gateway. NamespacesFromAll FromNamespaces = "All" // Only Routes in namespaces selected by the selector may be attached to // this Gateway. NamespacesFromSelector FromNamespaces = "Selector" // Only Routes in the same namespace as the Gateway may be attached to this // Gateway. NamespacesFromSame FromNamespaces = "Same" )
type Gateway ¶
type Gateway struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of Gateway. Spec GatewaySpec `json:"spec"` // Status defines the current state of Gateway. // // +kubebuilder:default={conditions: {{type: "Accepted", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"},{type: "Programmed", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}}} Status GatewayStatus `json:"status,omitempty"` }
Gateway represents an instance of a service-traffic handling infrastructure by binding Listeners to a set of IP addresses.
func (*Gateway) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Gateway.
func (*Gateway) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Gateway) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GatewayAddress ¶
type GatewayAddress struct { // Type of the address. // // +optional // +kubebuilder:default=IPAddress Type *AddressType `json:"type,omitempty"` // 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`. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 Value string `json:"value"` }
GatewayAddress describes an address that can be bound to a Gateway.
+kubebuilder:validation:XValidation:message="Hostname value must only contain valid characters (matching ^(\\*\\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$)",rule="self.type == 'Hostname' ? self.value.matches('^(\\\\*\\\\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$'): true"
func (*GatewayAddress) DeepCopy ¶
func (in *GatewayAddress) DeepCopy() *GatewayAddress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayAddress.
func (*GatewayAddress) DeepCopyInto ¶
func (in *GatewayAddress) DeepCopyInto(out *GatewayAddress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayClass ¶
type GatewayClass struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of GatewayClass. Spec GatewayClassSpec `json:"spec"` // Status defines the current state of GatewayClass. // // Implementations MUST populate status on all GatewayClass resources which // specify their controller name. // // +kubebuilder:default={conditions: {{type: "Accepted", status: "Unknown", message: "Waiting for controller", reason: "Waiting", lastTransitionTime: "1970-01-01T00:00:00Z"}}} Status GatewayClassStatus `json:"status,omitempty"` }
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.
func (*GatewayClass) DeepCopy ¶
func (in *GatewayClass) DeepCopy() *GatewayClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayClass.
func (*GatewayClass) DeepCopyInto ¶
func (in *GatewayClass) DeepCopyInto(out *GatewayClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GatewayClass) DeepCopyObject ¶
func (in *GatewayClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GatewayClassConditionReason ¶
type GatewayClassConditionReason string
GatewayClassConditionReason defines the set of reasons that explain why a particular GatewayClass condition type has been raised.
type GatewayClassConditionType ¶
type GatewayClassConditionType string
GatewayClassConditionType is the type for status conditions on Gateway resources. This type should be used with the GatewayClassStatus.Conditions field.
type GatewayClassList ¶
type GatewayClassList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []GatewayClass `json:"items"` }
GatewayClassList contains a list of GatewayClass
func (*GatewayClassList) DeepCopy ¶
func (in *GatewayClassList) DeepCopy() *GatewayClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayClassList.
func (*GatewayClassList) DeepCopyInto ¶
func (in *GatewayClassList) DeepCopyInto(out *GatewayClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GatewayClassList) DeepCopyObject ¶
func (in *GatewayClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GatewayClassSpec ¶
type GatewayClassSpec struct { // 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 // // +kubebuilder:validation:XValidation:message="Value is immutable",rule="self == oldSelf" ControllerName GatewayController `json:"controllerName"` // 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 // // +optional ParametersRef *ParametersReference `json:"parametersRef,omitempty"` // Description helps describe a GatewayClass with more details. // // +kubebuilder:validation:MaxLength=64 // +optional Description *string `json:"description,omitempty"` }
GatewayClassSpec reflects the configuration of a class of Gateways.
func (*GatewayClassSpec) DeepCopy ¶
func (in *GatewayClassSpec) DeepCopy() *GatewayClassSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayClassSpec.
func (*GatewayClassSpec) DeepCopyInto ¶
func (in *GatewayClassSpec) DeepCopyInto(out *GatewayClassSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayClassStatus ¶
type GatewayClassStatus struct { // 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. // // +optional // +listType=map // +listMapKey=type // +kubebuilder:validation:MaxItems=8 // +kubebuilder:default={{type: "Accepted", status: "Unknown", message: "Waiting for controller", reason: "Pending", lastTransitionTime: "1970-01-01T00:00:00Z"}} Conditions []metav1.Condition `json:"conditions,omitempty"` }
GatewayClassStatus is the current status for the GatewayClass.
func (*GatewayClassStatus) DeepCopy ¶
func (in *GatewayClassStatus) DeepCopy() *GatewayClassStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayClassStatus.
func (*GatewayClassStatus) DeepCopyInto ¶
func (in *GatewayClassStatus) DeepCopyInto(out *GatewayClassStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayConditionReason ¶
type GatewayConditionReason string
GatewayConditionReason defines the set of reasons that explain why a particular Gateway condition type has been raised.
type GatewayConditionType ¶
type GatewayConditionType string
GatewayConditionType is a type of condition associated with a Gateway. This type should be used with the GatewayStatus.Conditions field.
type GatewayController ¶
type GatewayController string
GatewayController is the name of a Gateway API controller. It must be a domain prefixed path.
Valid values include:
* "example.com/bar"
Invalid values include:
* "example.com" - must include path * "foo.example.com" - must include path
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$`
type GatewayList ¶
type GatewayList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Gateway `json:"items"` }
GatewayList contains a list of Gateways.
func (*GatewayList) DeepCopy ¶
func (in *GatewayList) DeepCopy() *GatewayList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayList.
func (*GatewayList) DeepCopyInto ¶
func (in *GatewayList) DeepCopyInto(out *GatewayList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GatewayList) DeepCopyObject ¶
func (in *GatewayList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GatewaySpec ¶
type GatewaySpec struct { // GatewayClassName used for this Gateway. This is the name of a // GatewayClass resource. GatewayClassName ObjectName `json:"gatewayClassName"` // 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. // // Within the HTTP Conformance Profile, the below combinations of port and // protocol are considered Core and MUST be supported: // // 1. Port: 80, Protocol: HTTP // 2. Port: 443, Protocol: HTTPS // // Within the TLS Conformance Profile, the below combinations of port and // protocol are considered Core and MUST be supported: // // 1. Port: 443, Protocol: TLS // // Port and protocol combinations not listed above are considered Extended. // // 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 // // +listType=map // +listMapKey=name // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=64 // +kubebuilder:validation:XValidation:message="tls must be specified for protocols ['HTTPS', 'TLS']",rule="self.all(l, l.protocol in ['HTTPS', 'TLS'] ? has(l.tls) : true)" // +kubebuilder:validation:XValidation:message="tls must not be specified for protocols ['HTTP', 'TCP', 'UDP']",rule="self.all(l, l.protocol in ['HTTP', 'TCP', 'UDP'] ? !has(l.tls) : true)" // +kubebuilder:validation:XValidation:message="hostname must not be specified for protocols ['TCP', 'UDP']",rule="self.all(l, l.protocol in ['TCP', 'UDP'] ? (!has(l.hostname) || l.hostname == ”) : true)" // +kubebuilder:validation:XValidation:message="Listener name must be unique within the Gateway",rule="self.all(l1, self.exists_one(l2, l1.name == l2.name))" // +kubebuilder:validation:XValidation:message="Combination of port, protocol and hostname must be unique for each listener",rule="self.all(l1, self.exists_one(l2, l1.port == l2.port && l1.protocol == l2.protocol && (has(l1.hostname) && has(l2.hostname) ? l1.hostname == l2.hostname : true)))" Listeners []Listener `json:"listeners"` // 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 // // +optional // <gateway:validateIPAddress> // +kubebuilder:validation:MaxItems=16 // +kubebuilder:validation:XValidation:message="IPAddress values must be unique",rule="self.all(a1, a1.type == 'IPAddress' ? self.exists_one(a2, a2.type == a1.type && a2.value == a1.value) : true )" // +kubebuilder:validation:XValidation:message="Hostname values must be unique",rule="self.all(a1, a1.type == 'Hostname' ? self.exists_one(a2, a2.type == a1.type && a2.value == a1.value) : true )" Addresses []GatewayAddress `json:"addresses,omitempty"` }
GatewaySpec defines the desired state of Gateway.
Not all possible combinations of options specified in the Spec are valid. Some invalid configurations can be caught synchronously via a webhook, but there are many cases that will require asynchronous signaling via the GatewayStatus block.
func (*GatewaySpec) DeepCopy ¶
func (in *GatewaySpec) DeepCopy() *GatewaySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewaySpec.
func (*GatewaySpec) DeepCopyInto ¶
func (in *GatewaySpec) DeepCopyInto(out *GatewaySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayStatus ¶
type GatewayStatus struct { // 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. // // +optional // <gateway:validateIPAddress> // +kubebuilder:validation:MaxItems=16 Addresses []GatewayStatusAddress `json:"addresses,omitempty"` // 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" // // +optional // +listType=map // +listMapKey=type // +kubebuilder:validation:MaxItems=8 // +kubebuilder:default={{type: "Accepted", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"},{type: "Programmed", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}} Conditions []metav1.Condition `json:"conditions,omitempty"` // Listeners provide status for each unique listener port defined in the Spec. // // +optional // +listType=map // +listMapKey=name // +kubebuilder:validation:MaxItems=64 Listeners []ListenerStatus `json:"listeners,omitempty"` }
GatewayStatus defines the observed state of Gateway.
func (*GatewayStatus) DeepCopy ¶
func (in *GatewayStatus) DeepCopy() *GatewayStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayStatus.
func (*GatewayStatus) DeepCopyInto ¶
func (in *GatewayStatus) DeepCopyInto(out *GatewayStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayStatusAddress ¶ added in v0.8.0
type GatewayStatusAddress struct { // Type of the address. // // +optional // +kubebuilder:default=IPAddress Type *AddressType `json:"type,omitempty"` // 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`. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 Value string `json:"value"` }
GatewayStatusAddress describes an address that is bound to a Gateway.
+kubebuilder:validation:XValidation:message="Hostname value must only contain valid characters (matching ^(\\*\\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$)",rule="self.type == 'Hostname' ? self.value.matches('^(\\\\*\\\\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$'): true"
func (*GatewayStatusAddress) DeepCopy ¶ added in v0.8.0
func (in *GatewayStatusAddress) DeepCopy() *GatewayStatusAddress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayStatusAddress.
func (*GatewayStatusAddress) DeepCopyInto ¶ added in v0.8.0
func (in *GatewayStatusAddress) DeepCopyInto(out *GatewayStatusAddress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GatewayTLSConfig ¶
type GatewayTLSConfig struct { // 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 // // +optional // +kubebuilder:default=Terminate Mode *TLSModeType `json:"mode,omitempty"` // 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) // // +optional // +kubebuilder:validation:MaxItems=64 CertificateRefs []SecretObjectReference `json:"certificateRefs,omitempty"` // 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 // // +optional // +kubebuilder:validation:MaxProperties=16 Options map[AnnotationKey]AnnotationValue `json:"options,omitempty"` }
GatewayTLSConfig describes a TLS configuration.
+kubebuilder:validation:XValidation:message="certificateRefs must be specified when TLSModeType is Terminate",rule="self.mode == 'Terminate' ? size(self.certificateRefs) > 0 : true"
func (*GatewayTLSConfig) DeepCopy ¶
func (in *GatewayTLSConfig) DeepCopy() *GatewayTLSConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayTLSConfig.
func (*GatewayTLSConfig) DeepCopyInto ¶
func (in *GatewayTLSConfig) DeepCopyInto(out *GatewayTLSConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Group ¶
type Group string
Group refers to a Kubernetes Group. It must either be an empty string or a RFC 1123 subdomain.
This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208
Valid values include:
* "" - empty string implies core Kubernetes API group * "gateway.networking.k8s.io" * "foo.example.com"
Invalid values include:
* "example.com/bar" - "/" is an invalid character
+kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
type HTTPBackendRef ¶
type HTTPBackendRef struct { // BackendRef is a reference to a backend to forward matched requests to. // // A BackendRef can be invalid for the following reasons. In all cases, the // implementation MUST ensure the `ResolvedRefs` Condition on the Route // is set to `status: False`, with a Reason and Message that indicate // what is the cause of the error. // // A BackendRef is invalid if: // // * It refers to an unknown or unsupported kind of resource. In this // case, the Reason must be set to `InvalidKind` and Message of the // Condition must explain which kind of resource is unknown or unsupported. // // * It refers to a resource that does not exist. In this case, the Reason must // be set to `BackendNotFound` and the Message of the Condition must explain // which resource does not exist. // // * It refers a resource in another namespace when the reference has not been // explicitly allowed by a ReferenceGrant (or equivalent concept). In this // case, the Reason must be set to `RefNotPermitted` and the Message of the // Condition must explain which cross-namespace reference is not allowed. // // Support: Core for Kubernetes Service // // Support: Implementation-specific for any other resource // // Support for weight: Core // // +optional BackendRef `json:",inline"` // Filters defined at this level should be executed if and only if the // request is being forwarded to the backend defined here. // // Support: Implementation-specific (For broader support of filters, use the // Filters field in HTTPRouteRule.) // // +optional // +kubebuilder:validation:MaxItems=16 // +kubebuilder:validation:XValidation:message="May specify either httpRouteFilterRequestRedirect or httpRouteFilterRequestRewrite, but not both",rule="!(self.exists(f, f.type == 'RequestRedirect') && self.exists(f, f.type == 'URLRewrite'))" // +kubebuilder:validation:XValidation:message="May specify either httpRouteFilterRequestRedirect or httpRouteFilterRequestRewrite, but not both",rule="!(self.exists(f, f.type == 'RequestRedirect') && self.exists(f, f.type == 'URLRewrite'))" // +kubebuilder:validation:XValidation:message="RequestHeaderModifier filter cannot be repeated",rule="self.exists(f, f.type == 'RequestHeaderModifier') ? self.exists_one(f, f.type == 'RequestHeaderModifier') : true" // +kubebuilder:validation:XValidation:message="ResponseHeaderModifier filter cannot be repeated",rule="self.exists(f, f.type == 'ResponseHeaderModifier') ? self.exists_one(f, f.type == 'ResponseHeaderModifier') : true" // +kubebuilder:validation:XValidation:message="RequestRedirect filter cannot be repeated",rule="self.exists(f, f.type == 'RequestRedirect') ? self.exists_one(f, f.type == 'RequestRedirect') : true" // +kubebuilder:validation:XValidation:message="URLRewrite filter cannot be repeated",rule="self.exists(f, f.type == 'URLRewrite') ? self.exists_one(f, f.type == 'URLRewrite') : true" Filters []HTTPRouteFilter `json:"filters,omitempty"` }
HTTPBackendRef defines how a HTTPRoute should forward an HTTP request.
func (*HTTPBackendRef) DeepCopy ¶
func (in *HTTPBackendRef) DeepCopy() *HTTPBackendRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPBackendRef.
func (*HTTPBackendRef) DeepCopyInto ¶
func (in *HTTPBackendRef) DeepCopyInto(out *HTTPBackendRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPHeader ¶
type HTTPHeader struct { // 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. Name HTTPHeaderName `json:"name"` // Value is the value of HTTP Header to be matched. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=4096 Value string `json:"value"` }
HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
func (*HTTPHeader) DeepCopy ¶
func (in *HTTPHeader) DeepCopy() *HTTPHeader
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPHeader.
func (*HTTPHeader) DeepCopyInto ¶
func (in *HTTPHeader) DeepCopyInto(out *HTTPHeader)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPHeaderFilter ¶ added in v0.6.0
type HTTPHeaderFilter struct { // 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 // // +optional // +listType=map // +listMapKey=name // +kubebuilder:validation:MaxItems=16 Set []HTTPHeader `json:"set,omitempty"` // 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 // // +optional // +listType=map // +listMapKey=name // +kubebuilder:validation:MaxItems=16 Add []HTTPHeader `json:"add,omitempty"` // 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 // // +optional // +kubebuilder:validation:MaxItems=16 Remove []string `json:"remove,omitempty"` }
HTTPHeaderFilter defines a filter that modifies the headers of an HTTP request or response. Only one action for a given header name is permitted. Filters specifying multiple actions of the same or different type for any one header name are invalid and will be rejected by the webhook if installed. Configuration to set or add multiple values for a header must use RFC 7230 header value formatting, separating each value with a comma.
func (*HTTPHeaderFilter) DeepCopy ¶ added in v0.6.0
func (in *HTTPHeaderFilter) DeepCopy() *HTTPHeaderFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPHeaderFilter.
func (*HTTPHeaderFilter) DeepCopyInto ¶ added in v0.6.0
func (in *HTTPHeaderFilter) DeepCopyInto(out *HTTPHeaderFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPHeaderMatch ¶
type HTTPHeaderMatch struct { // 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. // // +optional // +kubebuilder:default=Exact Type *HeaderMatchType `json:"type,omitempty"` // 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 HTTPHeaderName `json:"name"` // Value is the value of HTTP Header to be matched. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=4096 Value string `json:"value"` }
HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers.
func (*HTTPHeaderMatch) DeepCopy ¶
func (in *HTTPHeaderMatch) DeepCopy() *HTTPHeaderMatch
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPHeaderMatch.
func (*HTTPHeaderMatch) DeepCopyInto ¶
func (in *HTTPHeaderMatch) DeepCopyInto(out *HTTPHeaderMatch)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPHeaderName ¶
type HTTPHeaderName HeaderName
HTTPHeaderName is the name of an HTTP header.
Valid values include:
* "Authorization" * "Set-Cookie"
Invalid values include:
- ":method" - ":" is an invalid character. This means that HTTP/2 pseudo headers are not currently supported by this type.
- "/invalid" - "/ " is an invalid character
type HTTPMethod ¶
type HTTPMethod string
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). The value is expected in upper case.
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`.
+kubebuilder:validation:Enum=GET;HEAD;POST;PUT;DELETE;CONNECT;OPTIONS;TRACE;PATCH
const ( HTTPMethodGet HTTPMethod = "GET" HTTPMethodHead HTTPMethod = "HEAD" HTTPMethodPost HTTPMethod = "POST" HTTPMethodPut HTTPMethod = "PUT" HTTPMethodDelete HTTPMethod = "DELETE" HTTPMethodConnect HTTPMethod = "CONNECT" HTTPMethodOptions HTTPMethod = "OPTIONS" HTTPMethodTrace HTTPMethod = "TRACE" HTTPMethodPatch HTTPMethod = "PATCH" )
type HTTPPathMatch ¶
type HTTPPathMatch struct { // Type specifies how to match against the path Value. // // Support: Core (Exact, PathPrefix) // // Support: Implementation-specific (RegularExpression) // // +optional // +kubebuilder:default=PathPrefix Type *PathMatchType `json:"type,omitempty"` // Value of the HTTP path to match against. // // +optional // +kubebuilder:default="/" // +kubebuilder:validation:MaxLength=1024 Value *string `json:"value,omitempty"` }
HTTPPathMatch describes how to select a HTTP route by matching the HTTP request path.
+kubebuilder:validation:XValidation:message="value must be an absolute path and start with '/' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? self.value.startsWith('/') : true" +kubebuilder:validation:XValidation:message="must not contain '//' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.contains('//') : true" +kubebuilder:validation:XValidation:message="must not contain '/./' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.contains('/./') : true" +kubebuilder:validation:XValidation:message="must not contain '/../' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.contains('/../') : true" +kubebuilder:validation:XValidation:message="must not contain '%2f' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.contains('%2f') : true" +kubebuilder:validation:XValidation:message="must not contain '%2F' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.contains('%2F') : true" +kubebuilder:validation:XValidation:message="must not contain '#' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.contains('#') : true" +kubebuilder:validation:XValidation:message="must not end with '/..' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.endsWith('/..') : true" +kubebuilder:validation:XValidation:message="must not end with '/.' when type one of ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? !self.value.endsWith('/.') : true" +kubebuilder:validation:XValidation:message="type must be one of ['Exact', 'PathPrefix', 'RegularExpression']",rule="self.type == 'Exact' || self.type == 'PathPrefix' || self.type == 'RegularExpression'" +kubebuilder:validation:XValidation:message="must only contain valid characters (matching ^(?:[-A-Za-z0-9/._~!$&'()*+,;=:@]|[%][0-9a-fA-F]{2})+$) for types ['Exact', 'PathPrefix']",rule="(self.type == 'Exact' || self.type == 'PathPrefix') ? self.value.matches(r\"\"\"^(?:[-A-Za-z0-9/._~!$&'()*+,;=:@]|[%][0-9a-fA-F]{2})+$\"\"\") : true"
func (*HTTPPathMatch) DeepCopy ¶
func (in *HTTPPathMatch) DeepCopy() *HTTPPathMatch
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPPathMatch.
func (*HTTPPathMatch) DeepCopyInto ¶
func (in *HTTPPathMatch) DeepCopyInto(out *HTTPPathMatch)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPPathModifier ¶
type HTTPPathModifier struct { // 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`. // // +kubebuilder:validation:Enum=ReplaceFullPath;ReplacePrefixMatch Type HTTPPathModifierType `json:"type"` // ReplaceFullPath specifies the value with which to replace the full path // of a request during a rewrite or redirect. // // +kubebuilder:validation:MaxLength=1024 // +optional ReplaceFullPath *string `json:"replaceFullPath,omitempty"` // 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 | <empty string> | /bar // /foo/ | /foo | <empty string> | / // /foo | /foo | <empty string> | / // /foo/ | /foo | / | / // /foo | /foo | / | / // // +kubebuilder:validation:MaxLength=1024 // +optional ReplacePrefixMatch *string `json:"replacePrefixMatch,omitempty"` }
HTTPPathModifier defines configuration for path modifiers.
+kubebuilder:validation:XValidation:message="replaceFullPath must be specified when type is set to 'ReplaceFullPath'",rule="self.type == 'ReplaceFullPath' ? has(self.replaceFullPath) : true" +kubebuilder:validation:XValidation:message="type must be 'ReplaceFullPath' when replaceFullPath is set",rule="has(self.replaceFullPath) ? self.type == 'ReplaceFullPath' : true" +kubebuilder:validation:XValidation:message="replacePrefixMatch must be specified when type is set to 'ReplacePrefixMatch'",rule="self.type == 'ReplacePrefixMatch' ? has(self.replacePrefixMatch) : true" +kubebuilder:validation:XValidation:message="type must be 'ReplacePrefixMatch' when replacePrefixMatch is set",rule="has(self.replacePrefixMatch) ? self.type == 'ReplacePrefixMatch' : true"
func (*HTTPPathModifier) DeepCopy ¶
func (in *HTTPPathModifier) DeepCopy() *HTTPPathModifier
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPPathModifier.
func (*HTTPPathModifier) DeepCopyInto ¶
func (in *HTTPPathModifier) DeepCopyInto(out *HTTPPathModifier)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPPathModifierType ¶
type HTTPPathModifierType string
HTTPPathModifierType defines the type of path redirect or rewrite.
const ( // This type of modifier indicates that the full path will be replaced // by the specified value. FullPathHTTPPathModifier HTTPPathModifierType = "ReplaceFullPath" // This type of modifier indicates that any prefix path matches will be // replaced by the substitution value. For example, a path with a prefix // match of "/foo" and a ReplacePrefixMatch substitution of "/bar" will have // the "/foo" prefix replaced with "/bar" in matching requests. // // 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. PrefixMatchHTTPPathModifier HTTPPathModifierType = "ReplacePrefixMatch" )
type HTTPQueryParamMatch ¶
type HTTPQueryParamMatch struct { // 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. // // +optional // +kubebuilder:default=Exact Type *QueryParamMatchType `json:"type,omitempty"` // 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. Name HTTPHeaderName `json:"name"` // Value is the value of HTTP query param to be matched. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=1024 Value string `json:"value"` }
HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters.
func (*HTTPQueryParamMatch) DeepCopy ¶
func (in *HTTPQueryParamMatch) DeepCopy() *HTTPQueryParamMatch
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPQueryParamMatch.
func (*HTTPQueryParamMatch) DeepCopyInto ¶
func (in *HTTPQueryParamMatch) DeepCopyInto(out *HTTPQueryParamMatch)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRequestMirrorFilter ¶
type HTTPRequestMirrorFilter struct { // BackendRef references a resource where mirrored requests are sent. // // 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 BackendRef BackendObjectReference `json:"backendRef"` }
HTTPRequestMirrorFilter defines configuration for the RequestMirror filter.
func (*HTTPRequestMirrorFilter) DeepCopy ¶
func (in *HTTPRequestMirrorFilter) DeepCopy() *HTTPRequestMirrorFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRequestMirrorFilter.
func (*HTTPRequestMirrorFilter) DeepCopyInto ¶
func (in *HTTPRequestMirrorFilter) DeepCopyInto(out *HTTPRequestMirrorFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRequestRedirectFilter ¶
type HTTPRequestRedirectFilter struct { // 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 // // +optional // +kubebuilder:validation:Enum=http;https Scheme *string `json:"scheme,omitempty"` // 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 // // +optional Hostname *PreciseHostname `json:"hostname,omitempty"` // 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 // // +optional Path *HTTPPathModifier `json:"path,omitempty"` // 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 // // +optional Port *PortNumber `json:"port,omitempty"` // 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 // // +optional // +kubebuilder:default=302 // +kubebuilder:validation:Enum=301;302 StatusCode *int `json:"statusCode,omitempty"` }
HTTPRequestRedirect defines a filter that redirects a request. This filter MUST NOT be used on the same Route rule as a HTTPURLRewrite filter.
func (*HTTPRequestRedirectFilter) DeepCopy ¶
func (in *HTTPRequestRedirectFilter) DeepCopy() *HTTPRequestRedirectFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRequestRedirectFilter.
func (*HTTPRequestRedirectFilter) DeepCopyInto ¶
func (in *HTTPRequestRedirectFilter) DeepCopyInto(out *HTTPRequestRedirectFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRoute ¶
type HTTPRoute struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of HTTPRoute. Spec HTTPRouteSpec `json:"spec"` // Status defines the current state of HTTPRoute. Status HTTPRouteStatus `json:"status,omitempty"` }
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.
func (*HTTPRoute) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRoute.
func (*HTTPRoute) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HTTPRoute) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HTTPRouteFilter ¶
type HTTPRouteFilter struct { // 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`. // // +unionDiscriminator // +kubebuilder:validation:Enum=RequestHeaderModifier;ResponseHeaderModifier;RequestMirror;RequestRedirect;URLRewrite;ExtensionRef Type HTTPRouteFilterType `json:"type"` // RequestHeaderModifier defines a schema for a filter that modifies request // headers. // // Support: Core // // +optional RequestHeaderModifier *HTTPHeaderFilter `json:"requestHeaderModifier,omitempty"` // ResponseHeaderModifier defines a schema for a filter that modifies response // headers. // // Support: Extended // // +optional ResponseHeaderModifier *HTTPHeaderFilter `json:"responseHeaderModifier,omitempty"` // 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 // // +optional RequestMirror *HTTPRequestMirrorFilter `json:"requestMirror,omitempty"` // RequestRedirect defines a schema for a filter that responds to the // request with an HTTP redirection. // // Support: Core // // +optional RequestRedirect *HTTPRequestRedirectFilter `json:"requestRedirect,omitempty"` // URLRewrite defines a schema for a filter that modifies a request during forwarding. // // Support: Extended // // +optional URLRewrite *HTTPURLRewriteFilter `json:"urlRewrite,omitempty"` // 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 // // +optional ExtensionRef *LocalObjectReference `json:"extensionRef,omitempty"` }
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.
+kubebuilder:validation:XValidation:message="filter.requestHeaderModifier must be nil if the filter.type is not RequestHeaderModifier",rule="!(has(self.requestHeaderModifier) && self.type != 'RequestHeaderModifier')" +kubebuilder:validation:XValidation:message="filter.requestHeaderModifier must be specified for RequestHeaderModifier filter.type",rule="!(!has(self.requestHeaderModifier) && self.type == 'RequestHeaderModifier')" +kubebuilder:validation:XValidation:message="filter.responseHeaderModifier must be nil if the filter.type is not ResponseHeaderModifier",rule="!(has(self.responseHeaderModifier) && self.type != 'ResponseHeaderModifier')" +kubebuilder:validation:XValidation:message="filter.responseHeaderModifier must be specified for ResponseHeaderModifier filter.type",rule="!(!has(self.responseHeaderModifier) && self.type == 'ResponseHeaderModifier')" +kubebuilder:validation:XValidation:message="filter.requestMirror must be nil if the filter.type is not RequestMirror",rule="!(has(self.requestMirror) && self.type != 'RequestMirror')" +kubebuilder:validation:XValidation:message="filter.requestMirror must be specified for RequestMirror filter.type",rule="!(!has(self.requestMirror) && self.type == 'RequestMirror')" +kubebuilder:validation:XValidation:message="filter.requestRedirect must be nil if the filter.type is not RequestRedirect",rule="!(has(self.requestRedirect) && self.type != 'RequestRedirect')" +kubebuilder:validation:XValidation:message="filter.requestRedirect must be specified for RequestRedirect filter.type",rule="!(!has(self.requestRedirect) && self.type == 'RequestRedirect')" +kubebuilder:validation:XValidation:message="filter.urlRewrite must be nil if the filter.type is not URLRewrite",rule="!(has(self.urlRewrite) && self.type != 'URLRewrite')" +kubebuilder:validation:XValidation:message="filter.urlRewrite must be specified for URLRewrite filter.type",rule="!(!has(self.urlRewrite) && self.type == 'URLRewrite')" +kubebuilder:validation:XValidation:message="filter.extensionRef must be nil if the filter.type is not ExtensionRef",rule="!(has(self.extensionRef) && self.type != 'ExtensionRef')" +kubebuilder:validation:XValidation:message="filter.extensionRef must be specified for ExtensionRef filter.type",rule="!(!has(self.extensionRef) && self.type == 'ExtensionRef')"
func (*HTTPRouteFilter) DeepCopy ¶
func (in *HTTPRouteFilter) DeepCopy() *HTTPRouteFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRouteFilter.
func (*HTTPRouteFilter) DeepCopyInto ¶
func (in *HTTPRouteFilter) DeepCopyInto(out *HTTPRouteFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRouteFilterType ¶
type HTTPRouteFilterType string
HTTPRouteFilterType identifies a type of HTTPRoute filter.
const ( // HTTPRouteFilterRequestHeaderModifier can be used to add or remove an HTTP // header from an HTTP request before it is sent to the upstream target. // // Support in HTTPRouteRule: Core // // Support in HTTPBackendRef: Extended HTTPRouteFilterRequestHeaderModifier HTTPRouteFilterType = "RequestHeaderModifier" // HTTPRouteFilterResponseHeaderModifier can be used to add or remove an HTTP // header from an HTTP response before it is sent to the client. // // Support in HTTPRouteRule: Extended // // Support in HTTPBackendRef: Extended HTTPRouteFilterResponseHeaderModifier HTTPRouteFilterType = "ResponseHeaderModifier" // HTTPRouteFilterRequestRedirect can be used to redirect a request to // another location. This filter can also be used for HTTP to HTTPS // redirects. This may not be used on the same Route rule or BackendRef as a // URLRewrite filter. // // Support in HTTPRouteRule: Core // // Support in HTTPBackendRef: Extended HTTPRouteFilterRequestRedirect HTTPRouteFilterType = "RequestRedirect" // HTTPRouteFilterURLRewrite can be used to modify a request during // forwarding. At most one of these filters may be used on a Route rule. // This may not be used on the same Route rule or BackendRef as a // RequestRedirect filter. // // Support in HTTPRouteRule: Extended // // Support in HTTPBackendRef: Extended HTTPRouteFilterURLRewrite HTTPRouteFilterType = "URLRewrite" // HTTPRouteFilterRequestMirror can be used to mirror HTTP requests to a // different backend. The responses from this backend MUST be ignored by // the Gateway. // // Support in HTTPRouteRule: Extended // // Support in HTTPBackendRef: Extended HTTPRouteFilterRequestMirror HTTPRouteFilterType = "RequestMirror" // HTTPRouteFilterExtensionRef should be used for configuring custom // HTTP filters. // // Support in HTTPRouteRule: Implementation-specific // // Support in HTTPBackendRef: Implementation-specific HTTPRouteFilterExtensionRef HTTPRouteFilterType = "ExtensionRef" )
type HTTPRouteList ¶
type HTTPRouteList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []HTTPRoute `json:"items"` }
HTTPRouteList contains a list of HTTPRoute.
func (*HTTPRouteList) DeepCopy ¶
func (in *HTTPRouteList) DeepCopy() *HTTPRouteList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRouteList.
func (*HTTPRouteList) DeepCopyInto ¶
func (in *HTTPRouteList) DeepCopyInto(out *HTTPRouteList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HTTPRouteList) DeepCopyObject ¶
func (in *HTTPRouteList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HTTPRouteMatch ¶
type HTTPRouteMatch struct { // Path specifies a HTTP request path matcher. If this field is not // specified, a default prefix match on the "/" path is provided. // // +optional // +kubebuilder:default={type: "PathPrefix", value: "/"} Path *HTTPPathMatch `json:"path,omitempty"` // 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. // // +listType=map // +listMapKey=name // +optional // +kubebuilder:validation:MaxItems=16 Headers []HTTPHeaderMatch `json:"headers,omitempty"` // 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 // // +listType=map // +listMapKey=name // +optional // +kubebuilder:validation:MaxItems=16 QueryParams []HTTPQueryParamMatch `json:"queryParams,omitempty"` // Method specifies HTTP method matcher. // When specified, this route will be matched only if the request has the // specified method. // // Support: Extended // // +optional Method *HTTPMethod `json:"method,omitempty"` }
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"
```
func (*HTTPRouteMatch) DeepCopy ¶
func (in *HTTPRouteMatch) DeepCopy() *HTTPRouteMatch
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRouteMatch.
func (*HTTPRouteMatch) DeepCopyInto ¶
func (in *HTTPRouteMatch) DeepCopyInto(out *HTTPRouteMatch)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRouteRule ¶
type HTTPRouteRule struct { // 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. // // +optional // +kubebuilder:validation:MaxItems=8 // +kubebuilder:default={{path:{ type: "PathPrefix", value: "/"}}} Matches []HTTPRouteMatch `json:"matches,omitempty"` // 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 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 // // +optional // +kubebuilder:validation:MaxItems=16 // +kubebuilder:validation:XValidation:message="May specify either httpRouteFilterRequestRedirect or httpRouteFilterRequestRewrite, but not both",rule="!(self.exists(f, f.type == 'RequestRedirect') && self.exists(f, f.type == 'URLRewrite'))" // +kubebuilder:validation:XValidation:message="RequestHeaderModifier filter cannot be repeated",rule="self.exists(f, f.type == 'RequestHeaderModifier') ? self.exists_one(f, f.type == 'RequestHeaderModifier') : true" // +kubebuilder:validation:XValidation:message="ResponseHeaderModifier filter cannot be repeated",rule="self.exists(f, f.type == 'ResponseHeaderModifier') ? self.exists_one(f, f.type == 'ResponseHeaderModifier') : true" // +kubebuilder:validation:XValidation:message="RequestRedirect filter cannot be repeated",rule="self.exists(f, f.type == 'RequestRedirect') ? self.exists_one(f, f.type == 'RequestRedirect') : true" // +kubebuilder:validation:XValidation:message="URLRewrite filter cannot be repeated",rule="self.exists(f, f.type == 'URLRewrite') ? self.exists_one(f, f.type == 'URLRewrite') : true" Filters []HTTPRouteFilter `json:"filters,omitempty"` // 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 // // +optional // +kubebuilder:validation:MaxItems=16 BackendRefs []HTTPBackendRef `json:"backendRefs,omitempty"` }
HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs).
+kubebuilder:validation:XValidation:message="RequestRedirect filter must not be used together with backendRefs",rule="(has(self.backendRefs) && size(self.backendRefs) > 0) ? (!has(self.filters) || self.filters.all(f, !has(f.requestRedirect))): true" +kubebuilder:validation:XValidation:message="When using RequestRedirect filter with path.replacePrefixMatch, exactly one PathPrefix match must be specified",rule="(has(self.filters) && self.filters.exists_one(f, has(f.requestRedirect) && has(f.requestRedirect.path) && f.requestRedirect.path.type == 'ReplacePrefixMatch' && has(f.requestRedirect.path.replacePrefixMatch))) ? ((size(self.matches) != 1 || !has(self.matches[0].path) || self.matches[0].path.type != 'PathPrefix') ? false : true) : true" +kubebuilder:validation:XValidation:message="When using URLRewrite filter with path.replacePrefixMatch, exactly one PathPrefix match must be specified",rule="(has(self.filters) && self.filters.exists_one(f, has(f.urlRewrite) && has(f.urlRewrite.path) && f.urlRewrite.path.type == 'ReplacePrefixMatch' && has(f.urlRewrite.path.replacePrefixMatch))) ? ((size(self.matches) != 1 || !has(self.matches[0].path) || self.matches[0].path.type != 'PathPrefix') ? false : true) : true" +kubebuilder:validation:XValidation:message="Within backendRefs, when using RequestRedirect filter with path.replacePrefixMatch, exactly one PathPrefix match must be specified",rule="(has(self.backendRefs) && self.backendRefs.exists_one(b, (has(b.filters) && b.filters.exists_one(f, has(f.requestRedirect) && has(f.requestRedirect.path) && f.requestRedirect.path.type == 'ReplacePrefixMatch' && has(f.requestRedirect.path.replacePrefixMatch))) )) ? ((size(self.matches) != 1 || !has(self.matches[0].path) || self.matches[0].path.type != 'PathPrefix') ? false : true) : true" +kubebuilder:validation:XValidation:message="Within backendRefs, When using URLRewrite filter with path.replacePrefixMatch, exactly one PathPrefix match must be specified",rule="(has(self.backendRefs) && self.backendRefs.exists_one(b, (has(b.filters) && b.filters.exists_one(f, has(f.urlRewrite) && has(f.urlRewrite.path) && f.urlRewrite.path.type == 'ReplacePrefixMatch' && has(f.urlRewrite.path.replacePrefixMatch))) )) ? ((size(self.matches) != 1 || !has(self.matches[0].path) || self.matches[0].path.type != 'PathPrefix') ? false : true) : true"
func (*HTTPRouteRule) DeepCopy ¶
func (in *HTTPRouteRule) DeepCopy() *HTTPRouteRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRouteRule.
func (*HTTPRouteRule) DeepCopyInto ¶
func (in *HTTPRouteRule) DeepCopyInto(out *HTTPRouteRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRouteSpec ¶
type HTTPRouteSpec struct { CommonRouteSpec `json:",inline"` // 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 // // +optional // +kubebuilder:validation:MaxItems=16 Hostnames []Hostname `json:"hostnames,omitempty"` // Rules are a list of HTTP matchers, filters and actions. // // +optional // +kubebuilder:validation:MaxItems=16 // +kubebuilder:default={{matches: {{path: {type: "PathPrefix", value: "/"}}}}} Rules []HTTPRouteRule `json:"rules,omitempty"` }
HTTPRouteSpec defines the desired state of HTTPRoute
func (*HTTPRouteSpec) DeepCopy ¶
func (in *HTTPRouteSpec) DeepCopy() *HTTPRouteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRouteSpec.
func (*HTTPRouteSpec) DeepCopyInto ¶
func (in *HTTPRouteSpec) DeepCopyInto(out *HTTPRouteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPRouteStatus ¶
type HTTPRouteStatus struct {
RouteStatus `json:",inline"`
}
HTTPRouteStatus defines the observed state of HTTPRoute.
func (*HTTPRouteStatus) DeepCopy ¶
func (in *HTTPRouteStatus) DeepCopy() *HTTPRouteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPRouteStatus.
func (*HTTPRouteStatus) DeepCopyInto ¶
func (in *HTTPRouteStatus) DeepCopyInto(out *HTTPRouteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPURLRewriteFilter ¶
type HTTPURLRewriteFilter struct { // Hostname is the value to be used to replace the Host header value during // forwarding. // // Support: Extended // // +optional Hostname *PreciseHostname `json:"hostname,omitempty"` // Path defines a path rewrite. // // Support: Extended // // +optional Path *HTTPPathModifier `json:"path,omitempty"` }
HTTPURLRewriteFilter defines a filter that modifies a request during forwarding. At most one of these filters may be used on a Route rule. This MUST NOT be used on the same Route rule as a HTTPRequestRedirect filter.
Support: Extended
func (*HTTPURLRewriteFilter) DeepCopy ¶
func (in *HTTPURLRewriteFilter) DeepCopy() *HTTPURLRewriteFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPURLRewriteFilter.
func (*HTTPURLRewriteFilter) DeepCopyInto ¶
func (in *HTTPURLRewriteFilter) DeepCopyInto(out *HTTPURLRewriteFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HeaderMatchType ¶
type HeaderMatchType string
HeaderMatchType specifies the semantics of how HTTP header values should be compared. Valid HeaderMatchType values, along with their conformance levels, are:
* "Exact" - Core * "RegularExpression" - Implementation Specific
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`.
+kubebuilder:validation:Enum=Exact;RegularExpression
const ( HeaderMatchExact HeaderMatchType = "Exact" HeaderMatchRegularExpression HeaderMatchType = "RegularExpression" )
HeaderMatchType constants.
type HeaderName ¶ added in v0.7.0
type HeaderName string
HeaderName is the name of a header or query parameter.
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=256 +kubebuilder:validation:Pattern=`^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$` +k8s:deepcopy-gen=false
type Hostname ¶
type Hostname string
Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label.
Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.example.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`).
Note that as per RFC1035 and RFC1123, a *label* must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed.
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
type Kind ¶
type Kind string
Kind refers to a Kubernetes Kind.
Valid values include:
* "Service" * "HTTPRoute"
Invalid values include:
* "invalid/kind" - "/" is an invalid character
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=63 +kubebuilder:validation:Pattern=`^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$`
type Listener ¶
type Listener struct { // Name is the name of the Listener. This name MUST be unique within a // Gateway. // // Support: Core Name SectionName `json:"name"` // 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 // // +optional Hostname *Hostname `json:"hostname,omitempty"` // Port is the network port. Multiple listeners may use the // same port, subject to the Listener compatibility rules. // // Support: Core Port PortNumber `json:"port"` // Protocol specifies the network protocol this listener expects to receive. // // Support: Core Protocol ProtocolType `json:"protocol"` // 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 // // +optional TLS *GatewayTLSConfig `json:"tls,omitempty"` // 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 // +kubebuilder:default={namespaces:{from: Same}} // +optional AllowedRoutes *AllowedRoutes `json:"allowedRoutes,omitempty"` }
Listener embodies the concept of a logical endpoint where a Gateway accepts network connections.
func (*Listener) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Listener.
func (*Listener) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ListenerConditionReason ¶
type ListenerConditionReason string
ListenerConditionReason defines the set of reasons that explain why a particular Listener condition type has been raised.
type ListenerConditionType ¶
type ListenerConditionType string
ListenerConditionType is a type of condition associated with the listener. This type should be used with the ListenerStatus.Conditions field.
type ListenerStatus ¶
type ListenerStatus struct { // Name is the name of the Listener that this status corresponds to. Name SectionName `json:"name"` // 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. // // +kubebuilder:validation:MaxItems=8 SupportedKinds []RouteGroupKind `json:"supportedKinds"` // AttachedRoutes represents the total number of accepted Routes that have been // successfully attached to this Listener. AttachedRoutes int32 `json:"attachedRoutes"` // Conditions describe the current condition of this listener. // // +listType=map // +listMapKey=type // +kubebuilder:validation:MaxItems=8 Conditions []metav1.Condition `json:"conditions"` }
ListenerStatus is the status associated with a Listener.
func (*ListenerStatus) DeepCopy ¶
func (in *ListenerStatus) DeepCopy() *ListenerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ListenerStatus.
func (*ListenerStatus) DeepCopyInto ¶
func (in *ListenerStatus) DeepCopyInto(out *ListenerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LocalObjectReference ¶
type LocalObjectReference struct { // Group is the group of the referent. For example, "gateway.networking.k8s.io". // When unspecified or empty string, core API group is inferred. Group Group `json:"group"` // Kind is kind of the referent. For example "HTTPRoute" or "Service". Kind Kind `json:"kind"` // Name is the name of the referent. Name ObjectName `json:"name"` }
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.
func (*LocalObjectReference) DeepCopy ¶
func (in *LocalObjectReference) DeepCopy() *LocalObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalObjectReference.
func (*LocalObjectReference) DeepCopyInto ¶
func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Namespace ¶
type Namespace string
Namespace refers to a Kubernetes namespace. It must be a RFC 1123 label.
This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L187
This is used for Namespace name validation here: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/api/validation/generic.go#L63
Valid values include:
* "example"
Invalid values include:
* "example.com" - "." is an invalid character
+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=63
type ObjectName ¶
type ObjectName string
ObjectName refers to the name of a Kubernetes object. Object names can have a variety of forms, including RFC1123 subdomains, RFC 1123 labels, or RFC 1035 labels.
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253
type ParametersReference ¶
type ParametersReference struct { // Group is the group of the referent. Group Group `json:"group"` // Kind is kind of the referent. Kind Kind `json:"kind"` // Name is the name of the referent. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 Name string `json:"name"` // 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. // // +optional Namespace *Namespace `json:"namespace,omitempty"` }
ParametersReference identifies an API object containing controller-specific configuration resource within the cluster.
func (*ParametersReference) DeepCopy ¶
func (in *ParametersReference) DeepCopy() *ParametersReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParametersReference.
func (*ParametersReference) DeepCopyInto ¶
func (in *ParametersReference) DeepCopyInto(out *ParametersReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ParentReference ¶
type ParentReference struct { // 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 // // +kubebuilder:default=gateway.networking.k8s.io // +optional Group *Group `json:"group,omitempty"` // 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. // // +kubebuilder:default=Gateway // +optional Kind *Kind `json:"kind,omitempty"` // 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 // // +optional Namespace *Namespace `json:"namespace,omitempty"` // Name is the name of the referent. // // Support: Core Name ObjectName `json:"name"` // 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 // // +optional SectionName *SectionName `json:"sectionName,omitempty"` // 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 // // +optional // <gateway:experimental> Port *PortNumber `json:"port,omitempty"` }
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.
func (*ParentReference) DeepCopy ¶
func (in *ParentReference) DeepCopy() *ParentReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParentReference.
func (*ParentReference) DeepCopyInto ¶
func (in *ParentReference) DeepCopyInto(out *ParentReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PathMatchType ¶
type PathMatchType string
PathMatchType specifies the semantics of how HTTP paths should be compared. Valid PathMatchType values, along with their support levels, are:
* "Exact" - Core * "PathPrefix" - Core * "RegularExpression" - Implementation Specific
PathPrefix and Exact paths must be syntactically valid:
- Must begin with the `/` character - Must not contain consecutive `/` characters (e.g. `/foo///`, `//`).
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`.
+kubebuilder:validation:Enum=Exact;PathPrefix;RegularExpression
const ( // Matches the URL path exactly and with case sensitivity. This means that // an exact path match on `/abc` will only match requests to `/abc`, NOT // `/abc/`, `/Abc`, or `/abcd`. PathMatchExact PathMatchType = "Exact" // Matches based on a URL path prefix split by `/`. Matching is // case sensitive and done on a path element by element basis. 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. // // "PathPrefix" is semantically equivalent to the "Prefix" path type in the // Kubernetes Ingress API. PathMatchPathPrefix PathMatchType = "PathPrefix" // Matches if the URL path matches the given regular expression with // case sensitivity. // // Since `"RegularExpression"` has implementation-specific conformance, // implementations can support POSIX, PCRE, RE2 or any other regular expression // dialect. // Please read the implementation's documentation to determine the supported // dialect. PathMatchRegularExpression PathMatchType = "RegularExpression" )
type PortNumber ¶
type PortNumber int32
PortNumber defines a network port.
+kubebuilder:validation:Minimum=1 +kubebuilder:validation:Maximum=65535
type PreciseHostname ¶
type PreciseHostname string
PreciseHostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 1 notable exception that numeric IP addresses are not allowed.
Note that as per RFC1035 and RFC1123, a *label* must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed.
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
type ProtocolType ¶
type ProtocolType string
ProtocolType defines the application protocol accepted by a Listener. Implementations are not required to accept all the defined protocols. If an implementation does not support a specified protocol, it MUST set the "Accepted" condition to False for the affected Listener with a reason of "UnsupportedProtocol".
Core ProtocolType values are listed in the table below.
Implementations can define their own protocols if a core ProtocolType does not exist. Such definitions must use prefixed name, such as `mycompany.com/my-custom-protocol`. Un-prefixed names are reserved for core protocols. Any protocol defined by implementations will fall under Implementation-specific conformance.
Valid values include:
* "HTTP" - Core support * "example.com/bar" - Implementation-specific support
Invalid values include:
* "example.com" - must include path if domain is used * "foo.example.com" - must include path if domain is used
+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=255 +kubebuilder:validation:Pattern=`^[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]+$`
const ( // Accepts cleartext HTTP/1.1 sessions over TCP. Implementations MAY also // support HTTP/2 over cleartext. If implementations support HTTP/2 over // cleartext on "HTTP" listeners, that MUST be clearly documented by the // implementation. HTTPProtocolType ProtocolType = "HTTP" // Accepts HTTP/1.1 or HTTP/2 sessions over TLS. HTTPSProtocolType ProtocolType = "HTTPS" // Accepts TLS sessions over TCP. TLSProtocolType ProtocolType = "TLS" // Accepts TCP sessions. TCPProtocolType ProtocolType = "TCP" // Accepts UDP packets. UDPProtocolType ProtocolType = "UDP" )
type QueryParamMatchType ¶
type QueryParamMatchType string
QueryParamMatchType specifies the semantics of how HTTP query parameter values should be compared. Valid QueryParamMatchType values, along with their conformance levels, are:
* "Exact" - Core * "RegularExpression" - Implementation Specific
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`.
+kubebuilder:validation:Enum=Exact;RegularExpression
const ( QueryParamMatchExact QueryParamMatchType = "Exact" QueryParamMatchRegularExpression QueryParamMatchType = "RegularExpression" )
QueryParamMatchType constants.
type ReferenceGrant ¶ added in v0.6.0
type ReferenceGrant struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of ReferenceGrant. Spec ReferenceGrantSpec `json:"spec,omitempty"` }
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
func (*ReferenceGrant) DeepCopy ¶ added in v0.6.0
func (in *ReferenceGrant) DeepCopy() *ReferenceGrant
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferenceGrant.
func (*ReferenceGrant) DeepCopyInto ¶ added in v0.6.0
func (in *ReferenceGrant) DeepCopyInto(out *ReferenceGrant)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ReferenceGrant) DeepCopyObject ¶ added in v0.6.0
func (in *ReferenceGrant) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ReferenceGrantFrom ¶ added in v0.6.0
type ReferenceGrantFrom struct { // Group is the group of the referent. // When empty, the Kubernetes core API group is inferred. // // Support: Core Group Group `json:"group"` // 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 Kind `json:"kind"` // Namespace is the namespace of the referent. // // Support: Core Namespace Namespace `json:"namespace"` }
ReferenceGrantFrom describes trusted namespaces and kinds.
func (*ReferenceGrantFrom) DeepCopy ¶ added in v0.6.0
func (in *ReferenceGrantFrom) DeepCopy() *ReferenceGrantFrom
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferenceGrantFrom.
func (*ReferenceGrantFrom) DeepCopyInto ¶ added in v0.6.0
func (in *ReferenceGrantFrom) DeepCopyInto(out *ReferenceGrantFrom)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReferenceGrantList ¶ added in v0.6.0
type ReferenceGrantList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ReferenceGrant `json:"items"` }
+kubebuilder:object:root=true ReferenceGrantList contains a list of ReferenceGrant.
func (*ReferenceGrantList) DeepCopy ¶ added in v0.6.0
func (in *ReferenceGrantList) DeepCopy() *ReferenceGrantList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferenceGrantList.
func (*ReferenceGrantList) DeepCopyInto ¶ added in v0.6.0
func (in *ReferenceGrantList) DeepCopyInto(out *ReferenceGrantList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ReferenceGrantList) DeepCopyObject ¶ added in v0.6.0
func (in *ReferenceGrantList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ReferenceGrantSpec ¶ added in v0.6.0
type ReferenceGrantSpec struct { // 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 // // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=16 From []ReferenceGrantFrom `json:"from"` // 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 // // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=16 To []ReferenceGrantTo `json:"to"` }
ReferenceGrantSpec identifies a cross namespace relationship that is trusted for Gateway API.
func (*ReferenceGrantSpec) DeepCopy ¶ added in v0.6.0
func (in *ReferenceGrantSpec) DeepCopy() *ReferenceGrantSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferenceGrantSpec.
func (*ReferenceGrantSpec) DeepCopyInto ¶ added in v0.6.0
func (in *ReferenceGrantSpec) DeepCopyInto(out *ReferenceGrantSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReferenceGrantTo ¶ added in v0.6.0
type ReferenceGrantTo struct { // Group is the group of the referent. // When empty, the Kubernetes core API group is inferred. // // Support: Core Group Group `json:"group"` // 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 Kind `json:"kind"` // 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. // // +optional Name *ObjectName `json:"name,omitempty"` }
ReferenceGrantTo describes what Kinds are allowed as targets of the references.
func (*ReferenceGrantTo) DeepCopy ¶ added in v0.6.0
func (in *ReferenceGrantTo) DeepCopy() *ReferenceGrantTo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferenceGrantTo.
func (*ReferenceGrantTo) DeepCopyInto ¶ added in v0.6.0
func (in *ReferenceGrantTo) DeepCopyInto(out *ReferenceGrantTo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteConditionReason ¶
type RouteConditionReason string
RouteConditionReason is a reason for a route condition.
type RouteConditionType ¶
type RouteConditionType string
RouteConditionType is a type of condition for a route.
type RouteGroupKind ¶
type RouteGroupKind struct { // Group is the group of the Route. // // +optional // +kubebuilder:default=gateway.networking.k8s.io Group *Group `json:"group,omitempty"` // Kind is the kind of the Route. Kind Kind `json:"kind"` }
RouteGroupKind indicates the group and kind of a Route resource.
func (*RouteGroupKind) DeepCopy ¶
func (in *RouteGroupKind) DeepCopy() *RouteGroupKind
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteGroupKind.
func (*RouteGroupKind) DeepCopyInto ¶
func (in *RouteGroupKind) DeepCopyInto(out *RouteGroupKind)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteNamespaces ¶
type RouteNamespaces struct { // 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 // // +optional // +kubebuilder:default=Same From *FromNamespaces `json:"from,omitempty"` // 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 // // +optional Selector *metav1.LabelSelector `json:"selector,omitempty"` }
RouteNamespaces indicate which namespaces Routes should be selected from.
func (*RouteNamespaces) DeepCopy ¶
func (in *RouteNamespaces) DeepCopy() *RouteNamespaces
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteNamespaces.
func (*RouteNamespaces) DeepCopyInto ¶
func (in *RouteNamespaces) DeepCopyInto(out *RouteNamespaces)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteParentStatus ¶
type RouteParentStatus struct { // ParentRef corresponds with a ParentRef in the spec that this // RouteParentStatus struct describes the status of. ParentRef ParentReference `json:"parentRef"` // 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. ControllerName GatewayController `json:"controllerName"` // 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. // // +listType=map // +listMapKey=type // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=8 Conditions []metav1.Condition `json:"conditions,omitempty"` }
RouteParentStatus describes the status of a route with respect to an associated Parent.
func (*RouteParentStatus) DeepCopy ¶
func (in *RouteParentStatus) DeepCopy() *RouteParentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteParentStatus.
func (*RouteParentStatus) DeepCopyInto ¶
func (in *RouteParentStatus) DeepCopyInto(out *RouteParentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteStatus ¶
type RouteStatus struct { // 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. // // +kubebuilder:validation:MaxItems=32 Parents []RouteParentStatus `json:"parents"` }
RouteStatus defines the common attributes that all Routes MUST include within their status.
func (*RouteStatus) DeepCopy ¶
func (in *RouteStatus) DeepCopy() *RouteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteStatus.
func (*RouteStatus) DeepCopyInto ¶
func (in *RouteStatus) DeepCopyInto(out *RouteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretObjectReference ¶
type SecretObjectReference struct { // Group is the group of the referent. For example, "gateway.networking.k8s.io". // When unspecified or empty string, core API group is inferred. // // +optional // +kubebuilder:default="" Group *Group `json:"group"` // Kind is kind of the referent. For example "Secret". // // +optional // +kubebuilder:default=Secret Kind *Kind `json:"kind"` // Name is the name of the referent. Name ObjectName `json:"name"` // 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 // // +optional Namespace *Namespace `json:"namespace,omitempty"` }
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.
func (*SecretObjectReference) DeepCopy ¶
func (in *SecretObjectReference) DeepCopy() *SecretObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretObjectReference.
func (*SecretObjectReference) DeepCopyInto ¶
func (in *SecretObjectReference) DeepCopyInto(out *SecretObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SectionName ¶
type SectionName string
SectionName is the name of a section in a Kubernetes resource.
This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208
Valid values include:
* "example.com" * "foo.example.com"
Invalid values include:
* "example.com/bar" - "/" is an invalid character
+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253
type TLSModeType ¶
type TLSModeType string
TLSModeType type defines how a Gateway handles TLS sessions.
+kubebuilder:validation:Enum=Terminate;Passthrough
const ( // In this mode, TLS session between the downstream client // and the Gateway is terminated at the Gateway. TLSModeTerminate TLSModeType = "Terminate" // In this mode, 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. // // Note that SSL passthrough is only supported by TLSRoute. TLSModePassthrough TLSModeType = "Passthrough" )
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
util
|
|
Package validation has functions for validating the correctness of api objects and explaining what's wrong with them when they're not valid.
|
Package validation has functions for validating the correctness of api objects and explaining what's wrong with them when they're not valid. |