diff --git a/.cargo/config.toml b/.cargo/config.toml new file mode 100644 index 0000000..427c43d --- /dev/null +++ b/.cargo/config.toml @@ -0,0 +1,2 @@ +[alias] +xtask = "run -q --manifest-path ./xtask/Cargo.toml --" diff --git a/.gitignore b/.gitignore index 4fffb2f..a9d37c5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -/target -/Cargo.lock +target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml index 8520f25..d5b6576 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,28 +1,2 @@ -[package] -name = "gateway-api" -version = "0.8.1" -description = "Kubernetes Gateway API bindings in Rust" -authors = ["Shane Utt "] -license = "MIT" -keywords = ["kubernetes", "gateway-api"] -categories = ["api-bindings"] -homepage = "https://gateway-api.sigs.k8s.io/" -repository = "https://github.com/kube-rs/gateway-api-rs" -edition = "2021" - -[dependencies] -kube = { version = "^0.88.0", default-features = false, features = ["derive"] } -k8s-openapi = { version = "0.21.0", features = ["v1_29"] } -schemars = "0.8.16" -serde = { version = "1.0.195", features = ["derive"] } -serde_json = "1.0.111" -serde_yaml = "0.9.30" - -[dev-dependencies] -anyhow = "1.0.79" -hyper = "0.14.28" -kube = { version = "^0.88.0" } -k8s-openapi = { version = "0.21.0" , features = ["v1_29"] } -tokio = { version = "1.35.1", features = ["macros"] } -tower = "0.4.13" -uuid = { version = "1.7.0", features = ["v4", "fast-rng"] } +[workspace] +members = ["gateway-api", "xtask"] diff --git a/gateway-api/Cargo.toml b/gateway-api/Cargo.toml new file mode 100644 index 0000000..43be861 --- /dev/null +++ b/gateway-api/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "gateway-api" +version = "0.8.1" +description = "Kubernetes Gateway API bindings in Rust" +authors = ["Shane Utt "] +license = "MIT" +keywords = ["kubernetes", "gateway-api"] +categories = ["api-bindings"] +homepage = "https://gateway-api.sigs.k8s.io/" +repository = "https://github.com/kube-rs/gateway-api-rs" +edition = "2021" + +[dependencies] +kube = { version = "^0.88.0", default-features = false, features = ["derive"] } +k8s-openapi = { version = "0.21.0", features = ["v1_29", "schemars"] } +schemars = "0.8.16" +serde = { version = "1.0.195", features = ["derive"] } +serde_json = "1.0.111" +serde_yaml = "0.9.30" + +[dev-dependencies] +anyhow = "1.0.79" +hyper = "0.14.28" +kube = { version = "^0.88.0" } +k8s-openapi = { version = "0.21.0" , features = ["v1_29"] } +tokio = { version = "1.35.1", features = ["macros"] } +tower = "0.4.13" +uuid = { version = "1.7.0", features = ["v4", "fast-rng"] } diff --git a/gateway-api/src/apis/experimental/enum_defaults.rs b/gateway-api/src/apis/experimental/enum_defaults.rs new file mode 100644 index 0000000..3fee275 --- /dev/null +++ b/gateway-api/src/apis/experimental/enum_defaults.rs @@ -0,0 +1,58 @@ +// WARNING: generated file - manual changes will be overriden + +use super::httproutes::{ + HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType, HTTPRouteRulesBackendRefsFiltersType, + HTTPRouteRulesBackendRefsFiltersUrlRewritePathType, + HTTPRouteRulesFiltersRequestRedirectPathType, HTTPRouteRulesFiltersType, + HTTPRouteRulesFiltersUrlRewritePathType, +}; + +use super::grpcroutes::{GRPCRouteRulesBackendRefsFiltersType, GRPCRouteRulesFiltersType}; + +impl Default for GRPCRouteRulesBackendRefsFiltersType { + fn default() -> Self { + GRPCRouteRulesBackendRefsFiltersType::RequestHeaderModifier + } +} + +impl Default for GRPCRouteRulesFiltersType { + fn default() -> Self { + GRPCRouteRulesFiltersType::RequestHeaderModifier + } +} + +impl Default for HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType { + fn default() -> Self { + HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType::ReplaceFullPath + } +} + +impl Default for HTTPRouteRulesBackendRefsFiltersType { + fn default() -> Self { + HTTPRouteRulesBackendRefsFiltersType::RequestHeaderModifier + } +} + +impl Default for HTTPRouteRulesBackendRefsFiltersUrlRewritePathType { + fn default() -> Self { + HTTPRouteRulesBackendRefsFiltersUrlRewritePathType::ReplaceFullPath + } +} + +impl Default for HTTPRouteRulesFiltersRequestRedirectPathType { + fn default() -> Self { + HTTPRouteRulesFiltersRequestRedirectPathType::ReplaceFullPath + } +} + +impl Default for HTTPRouteRulesFiltersType { + fn default() -> Self { + HTTPRouteRulesFiltersType::RequestHeaderModifier + } +} + +impl Default for HTTPRouteRulesFiltersUrlRewritePathType { + fn default() -> Self { + HTTPRouteRulesFiltersUrlRewritePathType::ReplaceFullPath + } +} diff --git a/gateway-api/src/apis/experimental/gatewayclasses.rs b/gateway-api/src/apis/experimental/gatewayclasses.rs new file mode 100644 index 0000000..7afb8f9 --- /dev/null +++ b/gateway-api/src/apis/experimental/gatewayclasses.rs @@ -0,0 +1,73 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of GatewayClass. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1", + kind = "GatewayClass", + plural = "gatewayclasses" +)] +#[kube(status = "GatewayClassStatus")] +pub struct GatewayClassSpec { + /// 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 + #[serde(rename = "controllerName")] + pub controller_name: String, + /// Description helps describe a GatewayClass with more details. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub description: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parametersRef" + )] + pub parameters_ref: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayClassParametersRef { + /// Group is the group of the referent. + pub group: String, + /// Kind is kind of the referent. + pub kind: String, + /// Name is the name of the referent. + pub name: String, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, +} + +/// Status defines the current state of GatewayClass. +/// Implementations MUST populate status on all GatewayClass resources which specify their controller name. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayClassStatus { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// SupportedFeatures is the set of features the GatewayClass support. It MUST be sorted in ascending alphabetical order. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "supportedFeatures" + )] + pub supported_features: Option>, +} diff --git a/gateway-api/src/apis/experimental/gateways.rs b/gateway-api/src/apis/experimental/gateways.rs new file mode 100644 index 0000000..f64725a --- /dev/null +++ b/gateway-api/src/apis/experimental/gateways.rs @@ -0,0 +1,341 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; +use std::collections::BTreeMap; + +/// Spec defines the desired state of Gateway. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1", + kind = "Gateway", + plural = "gateways" +)] +#[kube(namespaced)] +#[kube(status = "GatewayStatus")] +pub struct GatewaySpec { + /// Addresses requested for this Gateway. This is optional and behavior can depend on the implementation. If a value is set in the spec and the requested address is invalid or unavailable, the implementation MUST indicate this in the associated entry in GatewayStatus.Addresses. + /// The Addresses field represents a request for the address(es) on the "outside of the Gateway", that traffic bound for this Gateway will use. This could be the IP address or hostname of an external load balancer or other networking infrastructure, or some other address that traffic will be sent to. + /// If no Addresses are specified, the implementation MAY schedule the Gateway in an implementation-specific manner, assigning an appropriate set of Addresses. + /// The implementation MUST bind all Listeners to every GatewayAddress that it assigns to the Gateway and add a corresponding entry in GatewayStatus.Addresses. + /// Support: Extended + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub addresses: Option>, + /// GatewayClassName used for this Gateway. This is the name of a GatewayClass resource. + #[serde(rename = "gatewayClassName")] + pub gateway_class_name: String, + /// Infrastructure defines infrastructure level attributes about this Gateway instance. + /// Support: Core + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub infrastructure: Option, + /// Listeners associated with this Gateway. Listeners define logical endpoints that are bound on this Gateway's addresses. At least one Listener MUST be specified. + /// Each Listener in a set of Listeners (for example, in a single Gateway) MUST be _distinct_, in that a traffic flow MUST be able to be assigned to exactly one listener. (This section uses "set of Listeners" rather than "Listeners in a single Gateway" because implementations MAY merge configuration from multiple Gateways onto a single data plane, and these rules _also_ apply in that case). + /// Practically, this means that each listener in a set MUST have a unique combination of Port, Protocol, and, if supported by the protocol, Hostname. + /// Some combinations of port, protocol, and TLS settings are considered Core support and MUST be supported by implementations based on their targeted conformance profile: + /// HTTP Profile + /// 1. HTTPRoute, Port: 80, Protocol: HTTP 2. HTTPRoute, Port: 443, Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided + /// TLS Profile + /// 1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode: Passthrough + /// "Distinct" Listeners have the following property: + /// The implementation can match inbound requests to a single distinct Listener. When multiple Listeners share values for fields (for example, two Listeners with the same Port value), the implementation can match requests to only one of the Listeners using other Listener fields. + /// For example, the following Listener scenarios are distinct: + /// 1. Multiple Listeners with the same Port that all use the "HTTP" Protocol that all have unique Hostname values. 2. Multiple Listeners with the same Port that use either the "HTTPS" or "TLS" Protocol that all have unique Hostname values. 3. A mixture of "TCP" and "UDP" Protocol Listeners, where no Listener with the same Protocol has the same Port value. + /// Some fields in the Listener struct have possible values that affect whether the Listener is distinct. Hostname is particularly relevant for HTTP or HTTPS protocols. + /// When using the Hostname value to select between same-Port, same-Protocol Listeners, the Hostname value must be different on each Listener for the Listener to be distinct. + /// When the Listeners are distinct based on Hostname, inbound request hostnames MUST match from the most specific to least specific Hostname values to choose the correct Listener and its associated set of Routes. + /// Exact matches must be processed before wildcard matches, and wildcard matches must be processed before fallback (empty Hostname value) matches. For example, `"foo.example.com"` takes precedence over `"*.example.com"`, and `"*.example.com"` takes precedence over `""`. + /// Additionally, if there are multiple wildcard entries, more specific wildcard entries must be processed before less specific wildcard entries. For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. The precise definition here is that the higher the number of dots in the hostname to the right of the wildcard character, the higher the precedence. + /// The wildcard character will match any number of characters _and dots_ to the left, however, so `"*.example.com"` will match both `"foo.bar.example.com"` _and_ `"bar.example.com"`. + /// If a set of Listeners contains Listeners that are not distinct, then those Listeners are Conflicted, and the implementation MUST set the "Conflicted" condition in the Listener Status to "True". + /// Implementations MAY choose to accept a Gateway with some Conflicted Listeners only if they only accept the partial Listener set that contains no Conflicted Listeners. To put this another way, implementations may accept a partial Listener set only if they throw out *all* the conflicting Listeners. No picking one of the conflicting listeners as the winner. This also means that the Gateway must have at least one non-conflicting Listener in this case, otherwise it violates the requirement that at least one Listener must be present. + /// The implementation MUST set a "ListenersNotValid" condition on the Gateway Status when the Gateway contains Conflicted Listeners whether or not they accept the Gateway. That Condition SHOULD clearly indicate in the Message which Listeners are conflicted, and which are Accepted. Additionally, the Listener status for those listeners SHOULD indicate which Listeners are conflicted and not Accepted. + /// A Gateway's Listeners are considered "compatible" if: + /// 1. They are distinct. 2. The implementation can serve them in compliance with the Addresses requirement that all Listeners are available on all assigned addresses. + /// Compatible combinations in Extended support are expected to vary across implementations. A combination that is compatible for one implementation may not be compatible for another. + /// For example, an implementation that cannot serve both TCP and UDP listeners on the same address, or cannot mix HTTPS and generic TLS listens on the same port would not consider those cases compatible, even though they are distinct. + /// Note that requests SHOULD match at most one Listener. For example, if Listeners are defined for "foo.example.com" and "*.example.com", a request to "foo.example.com" SHOULD only be routed using routes attached to the "foo.example.com" Listener (and not the "*.example.com" Listener). This concept is known as "Listener Isolation". Implementations that do not support Listener Isolation MUST clearly document this. + /// Implementations MAY merge separate Gateways onto a single set of Addresses if all Listeners across all Gateways are compatible. + /// Support: Core + pub listeners: Vec, +} + +/// GatewayAddress describes an address that can be bound to a Gateway. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayAddresses { + /// Type of the address. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// 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`. + pub value: String, +} + +/// Infrastructure defines infrastructure level attributes about this Gateway instance. +/// Support: Core +/// +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayInfrastructure { + /// Annotations that SHOULD be applied to any resources created in response to this Gateway. + /// For implementations creating other Kubernetes objects, this should be the `metadata.annotations` field on resources. For other implementations, this refers to any relevant (implementation specific) "annotations" concepts. + /// An implementation may chose to add additional implementation-specific annotations as they see fit. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub annotations: Option>, + /// Labels that SHOULD be applied to any resources created in response to this Gateway. + /// For implementations creating other Kubernetes objects, this should be the `metadata.labels` field on resources. For other implementations, this refers to any relevant (implementation specific) "labels" concepts. + /// An implementation may chose to add additional implementation-specific labels as they see fit. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub labels: Option>, +} + +/// Listener embodies the concept of a logical endpoint where a Gateway accepts network connections. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListeners { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "allowedRoutes" + )] + pub allowed_routes: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// Name is the name of the Listener. This name MUST be unique within a Gateway. + /// Support: Core + pub name: String, + /// Port is the network port. Multiple listeners may use the same port, subject to the Listener compatibility rules. + /// Support: Core + pub port: i32, + /// Protocol specifies the network protocol this listener expects to receive. + /// Support: Core + pub protocol: String, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub tls: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutes { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kinds: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespaces: Option, +} + +/// RouteGroupKind indicates the group and kind of a Route resource. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesKinds { + /// Group is the group of the Route. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Kind is the kind of the Route. + pub kind: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesNamespaces { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub from: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub selector: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GatewayListenersAllowedRoutesNamespacesFrom { + All, + Selector, + Same, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesNamespacesSelector { + /// matchExpressions is a list of label selector requirements. The requirements are ANDed. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "matchExpressions" + )] + pub match_expressions: + Option>, + /// matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "matchLabels" + )] + pub match_labels: Option>, +} + +/// A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesNamespacesSelectorMatchExpressions { + /// key is the label key that the selector applies to. + pub key: String, + /// operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. + pub operator: String, + /// values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub values: Option>, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersTls { + /// 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) + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "certificateRefs" + )] + pub certificate_refs: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub options: Option>, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersTlsCertificateRefs { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Kind is kind of the referent. For example "Secret". + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the referenced object. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GatewayListenersTlsMode { + Terminate, + Passthrough, +} + +/// Status defines the current state of Gateway. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatus { + /// Addresses lists the network addresses that have been bound to the Gateway. + /// This list may differ from the addresses provided in the spec under some conditions: + /// * no addresses are specified, all addresses are dynamically assigned * a combination of specified and dynamic addresses are assigned * a specified address was unusable (e.g. already in use) + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub addresses: Option>, + /// 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" + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// Listeners provide status for each unique listener port defined in the Spec. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub listeners: Option>, +} + +/// GatewayStatusAddress describes a network address that is bound to a Gateway. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatusAddresses { + /// Type of the address. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// 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`. + pub value: String, +} + +/// ListenerStatus is the status associated with a Listener. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatusListeners { + /// AttachedRoutes represents the total number of Routes that have been successfully attached to this Listener. + /// Successful attachment of a Route to a Listener is based solely on the combination of the AllowedRoutes field on the corresponding Listener and the Route's ParentRefs field. A Route is successfully attached to a Listener when it is selected by the Listener's AllowedRoutes field AND the Route has a valid ParentRef selecting the whole Gateway resource or a specific Listener as a parent resource (more detail on attachment semantics can be found in the documentation on the various Route kinds ParentRefs fields). Listener or Route status does not impact successful attachment, i.e. the AttachedRoutes field count MUST be set for Listeners with condition Accepted: false and MUST count successfully attached Routes that may themselves have Accepted: false conditions. + /// Uses for this field include troubleshooting Route attachment and measuring blast radius/impact of changes to a Listener. + #[serde(rename = "attachedRoutes")] + pub attached_routes: i32, + /// Conditions describe the current condition of this listener. + pub conditions: Vec, + /// Name is the name of the Listener that this status corresponds to. + pub name: String, + /// 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. + #[serde(rename = "supportedKinds")] + pub supported_kinds: Vec, +} + +/// RouteGroupKind indicates the group and kind of a Route resource. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatusListenersSupportedKinds { + /// Group is the group of the Route. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Kind is the kind of the Route. + pub kind: String, +} diff --git a/gateway-api/src/apis/experimental/grpcroutes.rs b/gateway-api/src/apis/experimental/grpcroutes.rs new file mode 100644 index 0000000..1a30c37 --- /dev/null +++ b/gateway-api/src/apis/experimental/grpcroutes.rs @@ -0,0 +1,731 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of GRPCRoute. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1alpha2", + kind = "GRPCRoute", + plural = "grpcroutes" +)] +#[kube(namespaced)] +#[kube(status = "GRPCRouteStatus")] +pub struct GRPCRouteSpec { + /// Hostnames defines a set of hostnames to match against the GRPC Host header to select a GRPCRoute to process the request. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: + /// 1. IPs are not allowed. 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard label MUST appear by itself as the first label. + /// If a hostname is specified by both the Listener and GRPCRoute, there MUST be at least one intersecting hostname for the GRPCRoute to be attached to the Listener. For example: + /// * A Listener with `test.example.com` as the hostname matches GRPCRoutes that have either not specified any hostnames, or have specified at least one of `test.example.com` or `*.example.com`. * A Listener with `*.example.com` as the hostname matches GRPCRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example, `test.example.com` and `*.example.com` would both match. On the other hand, `example.com` and `test.example.net` would not match. + /// Hostnames that are prefixed with a wildcard label (`*.`) are interpreted as a suffix match. That means that a match for `*.example.com` would match both `test.example.com`, and `foo.test.example.com`, but not `example.com`. + /// If both the Listener and GRPCRoute have specified hostnames, any GRPCRoute hostnames that do not match the Listener hostname MUST be ignored. For example, if a Listener specified `*.example.com`, and the GRPCRoute specified `test.example.com` and `test.example.net`, `test.example.net` MUST NOT be considered for a match. + /// If both the Listener and GRPCRoute have specified hostnames, and none match with the criteria above, then the GRPCRoute MUST NOT be accepted by the implementation. The implementation MUST raise an 'Accepted' Condition with a status of `False` in the corresponding RouteParentStatus. + /// If a Route (A) of type HTTPRoute or GRPCRoute is attached to a Listener and that listener already has another Route (B) of the other type attached and the intersection of the hostnames of A and B is non-empty, then the implementation MUST accept exactly one of these two routes, determined by the following criteria, in order: + /// * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by "{namespace}/{name}". + /// The rejected Route MUST raise an 'Accepted' condition with a status of 'False' in the corresponding RouteParentStatus. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostnames: Option>, + /// ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. + /// There are two kinds of parent resources with "Core" support: + /// * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. + /// ParentRefs must be _distinct_. This means either that: + /// * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + /// Some examples: + /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. + /// It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. + /// Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable 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. + /// + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parentRefs" + )] + pub parent_refs: Option>, + /// Rules are a list of GRPC matchers, filters and actions. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub rules: Option>, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteParentRefs { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} + +/// GRPCRouteRule defines the semantics for matching a gRPC request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs). +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRules { + /// BackendRefs defines the backend(s) where matching requests should be sent. + /// Failure behavior here depends on how many BackendRefs are specified and how many are invalid. + /// If *all* entries in BackendRefs are invalid, and there are also no filters specified in this route rule, *all* traffic which matches this rule MUST receive an `UNAVAILABLE` status. + /// See the GRPCBackendRef definition for the rules about what makes a single GRPCBackendRef invalid. + /// When a GRPCBackendRef is invalid, `UNAVAILABLE` statuses MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive an `UNAVAILABLE` status. + /// For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic MUST receive an `UNAVAILABLE` status. Implementations may choose how that 50 percent is determined. + /// Support: Core for Kubernetes Service + /// Support: Implementation-specific for any other resource + /// Support for weight: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRefs" + )] + pub backend_refs: Option>, + /// Filters define the filters that are applied to requests that match this rule. + /// The effects of ordering of multiple behaviors are currently unspecified. This can change in the future based on feedback during the alpha stage. + /// Conformance-levels at this level are defined based on the type of filter: + /// - ALL core filters MUST be supported by all implementations that support GRPCRoute. - Implementers are encouraged to support extended filters. - Implementation-specific custom filters have no API guarantees across implementations. + /// Specifying the same filter multiple times is not supported unless explicitly indicated in the filter. + /// If an implementation can not support a combination of filters, it must clearly document that limitation. In cases where incompatible or unsupported filters are specified and cause the `Accepted` condition to be set to status `False`, implementations may use the `IncompatibleFilters` reason to specify this configuration error. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub filters: Option>, + /// Matches define conditions used for matching the rule against incoming gRPC requests. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. + /// For example, take the following matches configuration: + /// ``` matches: - method: service: foo.bar headers: values: version: 2 - method: service: foo.bar.v2 ``` + /// For a request to match against this rule, it MUST satisfy EITHER of the two conditions: + /// - service of foo.bar AND contains the header `version: 2` - service of foo.bar.v2 + /// See the documentation for GRPCRouteMatch on how to specify multiple match conditions to be ANDed together. + /// If no matches are specified, the implementation MUST match every gRPC request. + /// Proxy or Load Balancer routing configuration generated from GRPCRoutes MUST prioritize rules based on the following criteria, continuing on ties. Merging MUST not be done between GRPCRoutes and HTTPRoutes. Precedence MUST be given to the rule with the largest number of: + /// * Characters in a matching non-wildcard hostname. * Characters in a matching hostname. * Characters in a matching service. * Characters in a matching method. * Header matches. + /// If ties still exist across multiple Routes, matching precedence MUST be determined in order of the following criteria, continuing on ties: + /// * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by "{namespace}/{name}". + /// If ties still exist within the Route that has been given precedence, matching precedence MUST be granted to the first matching rule meeting the above criteria. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub matches: Option>, +} + +/// GRPCBackendRef defines how a GRPCRoute forwards a gRPC request. +/// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +/// +/// When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. +/// Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. +/// If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. +/// If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. +/// +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefs { + /// Filters defined at this level MUST be executed if and only if the request is being forwarded to the backend defined here. + /// Support: Implementation-specific (For broader support of filters, use the Filters field in GRPCRouteRule.) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub filters: Option>, + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub weight: Option, +} + +/// GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFilters { + /// ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters. + /// Support: Implementation-specific + /// This filter can be used multiple times within the same rule. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "extensionRef" + )] + pub extension_ref: Option, + /// RequestHeaderModifier defines a schema for a filter that modifies request headers. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestHeaderModifier" + )] + pub request_header_modifier: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestMirror" + )] + pub request_mirror: Option, + /// ResponseHeaderModifier defines a schema for a filter that modifies response headers. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "responseHeaderModifier" + )] + pub response_header_modifier: Option, + /// Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels: + /// - Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations supporting GRPCRoute MUST support core filters. + /// - Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters. + /// - Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field. `Type` MUST be set to "ExtensionRef" for custom filters. + /// Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior. + /// If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response. + /// + #[serde(rename = "type")] + pub r#type: GRPCRouteRulesBackendRefsFiltersType, +} + +/// ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters. +/// Support: Implementation-specific +/// This filter can be used multiple times within the same rule. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersExtensionRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + pub group: String, + /// Kind is kind of the referent. For example "HTTPRoute" or "Service". + pub kind: String, + /// Name is the name of the referent. + pub name: String, +} + +/// RequestHeaderModifier defines a schema for a filter that modifies request headers. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersRequestHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersRequestHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersRequestHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersRequestMirror { + /// BackendRef references a resource where mirrored requests are sent. + /// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. + /// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. + /// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. + /// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. + /// Support: Extended for Kubernetes Service + /// Support: Implementation-specific for any other resource + #[serde(rename = "backendRef")] + pub backend_ref: GRPCRouteRulesBackendRefsFiltersRequestMirrorBackendRef, +} + +/// BackendRef references a resource where mirrored requests are sent. +/// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. +/// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. +/// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. +/// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. +/// Support: Extended for Kubernetes Service +/// Support: Implementation-specific for any other resource +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersRequestMirrorBackendRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, +} + +/// ResponseHeaderModifier defines a schema for a filter that modifies response headers. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersResponseHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersResponseHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesBackendRefsFiltersResponseHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GRPCRouteRulesBackendRefsFiltersType { + ResponseHeaderModifier, + RequestHeaderModifier, + RequestMirror, + ExtensionRef, +} + +/// GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFilters { + /// ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters. + /// Support: Implementation-specific + /// This filter can be used multiple times within the same rule. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "extensionRef" + )] + pub extension_ref: Option, + /// RequestHeaderModifier defines a schema for a filter that modifies request headers. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestHeaderModifier" + )] + pub request_header_modifier: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestMirror" + )] + pub request_mirror: Option, + /// ResponseHeaderModifier defines a schema for a filter that modifies response headers. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "responseHeaderModifier" + )] + pub response_header_modifier: Option, + /// Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels: + /// - Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations supporting GRPCRoute MUST support core filters. + /// - Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters. + /// - Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field. `Type` MUST be set to "ExtensionRef" for custom filters. + /// Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior. + /// If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response. + /// + #[serde(rename = "type")] + pub r#type: GRPCRouteRulesFiltersType, +} + +/// ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters. +/// Support: Implementation-specific +/// This filter can be used multiple times within the same rule. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersExtensionRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + pub group: String, + /// Kind is kind of the referent. For example "HTTPRoute" or "Service". + pub kind: String, + /// Name is the name of the referent. + pub name: String, +} + +/// RequestHeaderModifier defines a schema for a filter that modifies request headers. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersRequestHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersRequestHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersRequestHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersRequestMirror { + /// BackendRef references a resource where mirrored requests are sent. + /// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. + /// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. + /// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. + /// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. + /// Support: Extended for Kubernetes Service + /// Support: Implementation-specific for any other resource + #[serde(rename = "backendRef")] + pub backend_ref: GRPCRouteRulesFiltersRequestMirrorBackendRef, +} + +/// BackendRef references a resource where mirrored requests are sent. +/// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. +/// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. +/// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. +/// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. +/// Support: Extended for Kubernetes Service +/// Support: Implementation-specific for any other resource +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersRequestMirrorBackendRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, +} + +/// ResponseHeaderModifier defines a schema for a filter that modifies response headers. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersResponseHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersResponseHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesFiltersResponseHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// GRPCRouteFilter defines processing steps that must be completed during the request or response lifecycle. GRPCRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GRPCRouteRulesFiltersType { + ResponseHeaderModifier, + RequestHeaderModifier, + RequestMirror, + ExtensionRef, +} + +/// GRPCRouteMatch defines the predicate used to match requests to a given action. Multiple match types are ANDed together, i.e. the match will evaluate to true only if all conditions are satisfied. +/// For example, the match below will match a gRPC request only if its service is `foo` AND it contains the `version: v1` header: +/// ``` matches: - method: type: Exact service: "foo" headers: - name: "version" value "v1" +/// ``` +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesMatches { + /// Headers specifies gRPC request header matchers. Multiple match values are ANDed together, meaning, a request MUST match all the specified headers to select the route. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub headers: Option>, + /// Method specifies a gRPC request service/method matcher. If this field is not specified, all services and methods will match. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub method: Option, +} + +/// GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request headers. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesMatchesHeaders { + /// Name is the name of the gRPC Header to be matched. + /// If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent. + pub name: String, + /// Type specifies how to match against the value of the header. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value is the value of the gRPC Header to be matched. + pub value: String, +} + +/// GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request headers. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GRPCRouteRulesMatchesHeadersType { + Exact, + RegularExpression, +} + +/// Method specifies a gRPC request service/method matcher. If this field is not specified, all services and methods will match. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteRulesMatchesMethod { + /// Value of the method to match against. If left empty or omitted, will match all services. + /// At least one of Service and Method MUST be a non-empty string. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub method: Option, + /// Value of the service to match against. If left empty or omitted, will match any service. + /// At least one of Service and Method MUST be a non-empty string. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub service: Option, + /// Type specifies how to match against the service and/or method. Support: Core (Exact with service and method specified) + /// Support: Implementation-specific (Exact with method specified but no service specified) + /// Support: Implementation-specific (RegularExpression) + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, +} + +/// Method specifies a gRPC request service/method matcher. If this field is not specified, all services and methods will match. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GRPCRouteRulesMatchesMethodType { + Exact, + RegularExpression, +} + +/// Status defines the current state of GRPCRoute. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteStatus { + /// 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. + pub parents: Vec, +} + +/// RouteParentStatus describes the status of a route with respect to an associated Parent. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteStatusParents { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// 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. + #[serde(rename = "controllerName")] + pub controller_name: String, + /// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. + #[serde(rename = "parentRef")] + pub parent_ref: GRPCRouteStatusParentsParentRef, +} + +/// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GRPCRouteStatusParentsParentRef { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} diff --git a/gateway-api/src/apis/experimental/httproutes.rs b/gateway-api/src/apis/experimental/httproutes.rs new file mode 100644 index 0000000..b91d60e --- /dev/null +++ b/gateway-api/src/apis/experimental/httproutes.rs @@ -0,0 +1,1159 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of HTTPRoute. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1", + kind = "HTTPRoute", + plural = "httproutes" +)] +#[kube(namespaced)] +#[kube(status = "HTTPRouteStatus")] +pub struct HTTPRouteSpec { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostnames: Option>, + /// ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. + /// There are two kinds of parent resources with "Core" support: + /// * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. + /// ParentRefs must be _distinct_. This means either that: + /// * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + /// Some examples: + /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. + /// It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. + /// Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable 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. + /// + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parentRefs" + )] + pub parent_refs: Option>, + /// Rules are a list of HTTP matchers, filters and actions. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub rules: Option>, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteParentRefs { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} + +/// HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs). +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRules { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRefs" + )] + pub backend_refs: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub filters: Option>, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub matches: Option>, + /// Timeouts defines the timeouts that can be configured for an HTTP request. + /// Support: Extended + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub timeouts: Option, +} + +/// HTTPBackendRef defines how a HTTPRoute forwards a HTTP request. +/// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +/// +/// When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. +/// Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. +/// If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. +/// If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. +/// +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefs { + /// 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.) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub filters: Option>, + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub weight: Option, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFilters { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "extensionRef" + )] + pub extension_ref: Option, + /// RequestHeaderModifier defines a schema for a filter that modifies request headers. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestHeaderModifier" + )] + pub request_header_modifier: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestMirror" + )] + pub request_mirror: Option, + /// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestRedirect" + )] + pub request_redirect: Option, + /// ResponseHeaderModifier defines a schema for a filter that modifies response headers. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "responseHeaderModifier" + )] + pub response_header_modifier: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesBackendRefsFiltersType, + /// URLRewrite defines a schema for a filter that modifies a request during forwarding. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "urlRewrite" + )] + pub url_rewrite: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersExtensionRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + pub group: String, + /// Kind is kind of the referent. For example "HTTPRoute" or "Service". + pub kind: String, + /// Name is the name of the referent. + pub name: String, +} + +/// RequestHeaderModifier defines a schema for a filter that modifies request headers. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestMirror { + /// BackendRef references a resource where mirrored requests are sent. + /// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. + /// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. + /// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. + /// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. + /// Support: Extended for Kubernetes Service + /// Support: Implementation-specific for any other resource + #[serde(rename = "backendRef")] + pub backend_ref: HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef, +} + +/// BackendRef references a resource where mirrored requests are sent. +/// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. +/// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. +/// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. +/// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. +/// Support: Extended for Kubernetes Service +/// Support: Implementation-specific for any other resource +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirect { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub scheme: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "statusCode" + )] + pub status_code: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirectPath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectScheme { + #[serde(rename = "http")] + Http, + #[serde(rename = "https")] + Https, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectStatusCode { + #[serde(rename = "301")] + r#_301, + #[serde(rename = "302")] + r#_302, +} + +/// ResponseHeaderModifier defines a schema for a filter that modifies response headers. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersType { + RequestHeaderModifier, + ResponseHeaderModifier, + RequestMirror, + RequestRedirect, + #[serde(rename = "URLRewrite")] + UrlRewrite, + ExtensionRef, +} + +/// URLRewrite defines a schema for a filter that modifies a request during forwarding. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersUrlRewrite { + /// Hostname is the value to be used to replace the Host header value during forwarding. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// Path defines a path rewrite. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersUrlRewritePath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesBackendRefsFiltersUrlRewritePathType, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersUrlRewritePathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFilters { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "extensionRef" + )] + pub extension_ref: Option, + /// RequestHeaderModifier defines a schema for a filter that modifies request headers. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestHeaderModifier" + )] + pub request_header_modifier: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestMirror" + )] + pub request_mirror: Option, + /// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestRedirect" + )] + pub request_redirect: Option, + /// ResponseHeaderModifier defines a schema for a filter that modifies response headers. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "responseHeaderModifier" + )] + pub response_header_modifier: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesFiltersType, + /// URLRewrite defines a schema for a filter that modifies a request during forwarding. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "urlRewrite" + )] + pub url_rewrite: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersExtensionRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + pub group: String, + /// Kind is kind of the referent. For example "HTTPRoute" or "Service". + pub kind: String, + /// Name is the name of the referent. + pub name: String, +} + +/// RequestHeaderModifier defines a schema for a filter that modifies request headers. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestMirror { + /// BackendRef references a resource where mirrored requests are sent. + /// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. + /// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. + /// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. + /// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. + /// Support: Extended for Kubernetes Service + /// Support: Implementation-specific for any other resource + #[serde(rename = "backendRef")] + pub backend_ref: HTTPRouteRulesFiltersRequestMirrorBackendRef, +} + +/// BackendRef references a resource where mirrored requests are sent. +/// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. +/// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. +/// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. +/// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. +/// Support: Extended for Kubernetes Service +/// Support: Implementation-specific for any other resource +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestMirrorBackendRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestRedirect { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub scheme: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "statusCode" + )] + pub status_code: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestRedirectPath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesFiltersRequestRedirectPathType, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersRequestRedirectPathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersRequestRedirectScheme { + #[serde(rename = "http")] + Http, + #[serde(rename = "https")] + Https, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersRequestRedirectStatusCode { + #[serde(rename = "301")] + r#_301, + #[serde(rename = "302")] + r#_302, +} + +/// ResponseHeaderModifier defines a schema for a filter that modifies response headers. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersResponseHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersResponseHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersResponseHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersType { + RequestHeaderModifier, + ResponseHeaderModifier, + RequestMirror, + RequestRedirect, + #[serde(rename = "URLRewrite")] + UrlRewrite, + ExtensionRef, +} + +/// URLRewrite defines a schema for a filter that modifies a request during forwarding. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersUrlRewrite { + /// Hostname is the value to be used to replace the Host header value during forwarding. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// Path defines a path rewrite. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersUrlRewritePath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesFiltersUrlRewritePathType, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersUrlRewritePathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// 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" +/// ``` +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatches { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub headers: Option>, + /// Method specifies HTTP method matcher. When specified, this route will be matched only if the request has the specified method. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub method: Option, + /// Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "queryParams" + )] + pub query_params: Option>, +} + +/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatchesHeaders { + /// 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". + pub name: String, + /// Type specifies how to match against the value of the header. + /// Support: Core (Exact) + /// Support: Implementation-specific (RegularExpression) + /// Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesHeadersType { + Exact, + RegularExpression, +} + +/// 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" +/// ``` +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesMethod { + #[serde(rename = "GET")] + Get, + #[serde(rename = "HEAD")] + Head, + #[serde(rename = "POST")] + Post, + #[serde(rename = "PUT")] + Put, + #[serde(rename = "DELETE")] + Delete, + #[serde(rename = "CONNECT")] + Connect, + #[serde(rename = "OPTIONS")] + Options, + #[serde(rename = "TRACE")] + Trace, + #[serde(rename = "PATCH")] + Patch, +} + +/// Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatchesPath { + /// Type specifies how to match against the path Value. + /// Support: Core (Exact, PathPrefix) + /// Support: Implementation-specific (RegularExpression) + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value of the HTTP path to match against. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub value: Option, +} + +/// Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesPathType { + Exact, + PathPrefix, + RegularExpression, +} + +/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatchesQueryParams { + /// 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. + pub name: String, + /// Type specifies how to match against the value of the query parameter. + /// Support: Extended (Exact) + /// Support: Implementation-specific (RegularExpression) + /// Since RegularExpression QueryParamMatchType has Implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value is the value of HTTP query param to be matched. + pub value: String, +} + +/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesQueryParamsType { + Exact, + RegularExpression, +} + +/// Timeouts defines the timeouts that can be configured for an HTTP request. +/// Support: Extended +/// +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesTimeouts { + /// BackendRequest specifies a timeout for an individual request from the gateway to a backend. This covers the time from when the request first starts being sent from the gateway to when the full response has been received from the backend. + /// An entire client HTTP transaction with a gateway, covered by the Request timeout, may result in more than one call from the gateway to the destination backend, for example, if automatic retries are supported. + /// Because the Request timeout encompasses the BackendRequest timeout, the value of BackendRequest must be <= the value of Request timeout. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRequest" + )] + pub backend_request: Option, + /// Request specifies the maximum duration for a gateway to respond to an HTTP request. If the gateway has not been able to respond before this deadline is met, the gateway MUST return a timeout error. + /// For example, setting the `rules.timeouts.request` field to the value `10s` in an `HTTPRoute` will cause a timeout if a client request is taking longer than 10 seconds to complete. + /// This timeout is intended to cover as close to the whole request-response transaction as possible although an implementation MAY choose to start the timeout after the entire request stream has been received instead of immediately after the transaction is initiated by the client. + /// When this field is unspecified, request timeout behavior is implementation-specific. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub request: Option, +} + +/// Status defines the current state of HTTPRoute. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteStatus { + /// 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. + pub parents: Vec, +} + +/// RouteParentStatus describes the status of a route with respect to an associated Parent. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteStatusParents { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// 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. + #[serde(rename = "controllerName")] + pub controller_name: String, + /// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. + #[serde(rename = "parentRef")] + pub parent_ref: HTTPRouteStatusParentsParentRef, +} + +/// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteStatusParentsParentRef { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} diff --git a/src/apis/experimental/mod.rs b/gateway-api/src/apis/experimental/mod.rs similarity index 91% rename from src/apis/experimental/mod.rs rename to gateway-api/src/apis/experimental/mod.rs index 6c94625..0cbda9c 100644 --- a/src/apis/experimental/mod.rs +++ b/gateway-api/src/apis/experimental/mod.rs @@ -1,9 +1,10 @@ // WARNING! generated file do not edit +mod enum_defaults; pub mod gatewayclasses; pub mod gateways; +pub mod grpcroutes; pub mod httproutes; pub mod referencegrants; -pub mod grpcroutes; pub mod tcproutes; pub mod tlsroutes; pub mod udproutes; diff --git a/gateway-api/src/apis/experimental/referencegrants.rs b/gateway-api/src/apis/experimental/referencegrants.rs new file mode 100644 index 0000000..88c6dbe --- /dev/null +++ b/gateway-api/src/apis/experimental/referencegrants.rs @@ -0,0 +1,56 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of ReferenceGrant. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1beta1", + kind = "ReferenceGrant", + plural = "referencegrants" +)] +#[kube(namespaced)] +pub struct ReferenceGrantSpec { + /// 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 + pub from: Vec, + /// 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 + pub to: Vec, +} + +/// ReferenceGrantFrom describes trusted namespaces and kinds. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct ReferenceGrantFrom { + /// Group is the group of the referent. When empty, the Kubernetes core API group is inferred. + /// Support: Core + pub group: String, + /// 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 + pub kind: String, + /// Namespace is the namespace of the referent. + /// Support: Core + pub namespace: String, +} + +/// ReferenceGrantTo describes what Kinds are allowed as targets of the references. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct ReferenceGrantTo { + /// Group is the group of the referent. When empty, the Kubernetes core API group is inferred. + /// Support: Core + pub group: String, + /// 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 + pub kind: String, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub name: Option, +} diff --git a/gateway-api/src/apis/experimental/tcproutes.rs b/gateway-api/src/apis/experimental/tcproutes.rs new file mode 100644 index 0000000..e466016 --- /dev/null +++ b/gateway-api/src/apis/experimental/tcproutes.rs @@ -0,0 +1,218 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of TCPRoute. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1alpha2", + kind = "TCPRoute", + plural = "tcproutes" +)] +#[kube(namespaced)] +#[kube(status = "TCPRouteStatus")] +pub struct TCPRouteSpec { + /// ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. + /// There are two kinds of parent resources with "Core" support: + /// * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. + /// ParentRefs must be _distinct_. This means either that: + /// * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + /// Some examples: + /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. + /// It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. + /// Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable 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. + /// + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parentRefs" + )] + pub parent_refs: Option>, + /// Rules are a list of TCP matchers and actions. + pub rules: Vec, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TCPRouteParentRefs { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} + +/// TCPRouteRule is the configuration for a given rule. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TCPRouteRules { + /// BackendRefs defines the backend(s) where matching requests should be sent. If unspecified or invalid (refers to a non-existent resource or a Service with no endpoints), the underlying implementation MUST actively reject connection attempts to this backend. Connection rejections must respect weight; if an invalid backend is requested to have 80% of connections, then 80% of connections must be rejected instead. + /// Support: Core for Kubernetes Service + /// Support: Extended for Kubernetes ServiceImport + /// Support: Implementation-specific for any other resource + /// Support for weight: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRefs" + )] + pub backend_refs: Option>, +} + +/// BackendRef defines how a Route should forward a request to a Kubernetes resource. +/// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +/// +/// When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. +/// Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. +/// If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. +/// If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. +/// +/// Note that when the BackendTLSPolicy object is enabled by the implementation, there are some extra rules about validity to consider here. See the fields where this struct is used for more information about the exact behavior. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TCPRouteRulesBackendRefs { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub weight: Option, +} + +/// Status defines the current state of TCPRoute. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TCPRouteStatus { + /// 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. + pub parents: Vec, +} + +/// RouteParentStatus describes the status of a route with respect to an associated Parent. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TCPRouteStatusParents { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// 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. + #[serde(rename = "controllerName")] + pub controller_name: String, + /// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. + #[serde(rename = "parentRef")] + pub parent_ref: TCPRouteStatusParentsParentRef, +} + +/// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TCPRouteStatusParentsParentRef { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} diff --git a/gateway-api/src/apis/experimental/tlsroutes.rs b/gateway-api/src/apis/experimental/tlsroutes.rs new file mode 100644 index 0000000..d2a0b8d --- /dev/null +++ b/gateway-api/src/apis/experimental/tlsroutes.rs @@ -0,0 +1,227 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of TLSRoute. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1alpha2", + kind = "TLSRoute", + plural = "tlsroutes" +)] +#[kube(namespaced)] +#[kube(status = "TLSRouteStatus")] +pub struct TLSRouteSpec { + /// Hostnames defines a set of SNI names that should match against the SNI attribute of TLS ClientHello message in TLS handshake. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: + /// 1. IPs are not allowed in SNI names per RFC 6066. 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. + /// If a hostname is specified by both the Listener and TLSRoute, there must be at least one intersecting hostname for the TLSRoute to be attached to the Listener. For example: + /// * A Listener with `test.example.com` as the hostname matches TLSRoutes that have either not specified any hostnames, or have specified at least one of `test.example.com` or `*.example.com`. * A Listener with `*.example.com` as the hostname matches TLSRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example, `test.example.com` and `*.example.com` would both match. On the other hand, `example.com` and `test.example.net` would not match. + /// If both the Listener and TLSRoute have specified hostnames, any TLSRoute hostnames that do not match the Listener hostname MUST be ignored. For example, if a Listener specified `*.example.com`, and the TLSRoute specified `test.example.com` and `test.example.net`, `test.example.net` must not be considered for a match. + /// If both the Listener and TLSRoute have specified hostnames, and none match with the criteria above, then the TLSRoute is not accepted. The implementation must raise an 'Accepted' Condition with a status of `False` in the corresponding RouteParentStatus. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostnames: Option>, + /// ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. + /// There are two kinds of parent resources with "Core" support: + /// * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. + /// ParentRefs must be _distinct_. This means either that: + /// * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + /// Some examples: + /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. + /// It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. + /// Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable 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. + /// + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parentRefs" + )] + pub parent_refs: Option>, + /// Rules are a list of TLS matchers and actions. + pub rules: Vec, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TLSRouteParentRefs { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} + +/// TLSRouteRule is the configuration for a given rule. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TLSRouteRules { + /// BackendRefs defines the backend(s) where matching requests should be sent. If unspecified or invalid (refers to a non-existent resource or a Service with no endpoints), the rule performs no forwarding; if no filters are specified that would result in a response being sent, the underlying implementation must actively reject request attempts to this backend, by rejecting the connection or returning a 500 status code. Request rejections must respect weight; if an invalid backend is requested to have 80% of requests, then 80% of requests must be rejected instead. + /// Support: Core for Kubernetes Service + /// Support: Extended for Kubernetes ServiceImport + /// Support: Implementation-specific for any other resource + /// Support for weight: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRefs" + )] + pub backend_refs: Option>, +} + +/// BackendRef defines how a Route should forward a request to a Kubernetes resource. +/// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +/// +/// When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. +/// Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. +/// If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. +/// If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. +/// +/// Note that when the BackendTLSPolicy object is enabled by the implementation, there are some extra rules about validity to consider here. See the fields where this struct is used for more information about the exact behavior. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TLSRouteRulesBackendRefs { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub weight: Option, +} + +/// Status defines the current state of TLSRoute. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TLSRouteStatus { + /// 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. + pub parents: Vec, +} + +/// RouteParentStatus describes the status of a route with respect to an associated Parent. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TLSRouteStatusParents { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// 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. + #[serde(rename = "controllerName")] + pub controller_name: String, + /// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. + #[serde(rename = "parentRef")] + pub parent_ref: TLSRouteStatusParentsParentRef, +} + +/// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct TLSRouteStatusParentsParentRef { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} diff --git a/gateway-api/src/apis/experimental/udproutes.rs b/gateway-api/src/apis/experimental/udproutes.rs new file mode 100644 index 0000000..56b0dd9 --- /dev/null +++ b/gateway-api/src/apis/experimental/udproutes.rs @@ -0,0 +1,218 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of UDPRoute. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1alpha2", + kind = "UDPRoute", + plural = "udproutes" +)] +#[kube(namespaced)] +#[kube(status = "UDPRouteStatus")] +pub struct UDPRouteSpec { + /// ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. + /// There are two kinds of parent resources with "Core" support: + /// * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. + /// ParentRefs must be _distinct_. This means either that: + /// * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + /// Some examples: + /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. + /// It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. + /// Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable 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. + /// + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parentRefs" + )] + pub parent_refs: Option>, + /// Rules are a list of UDP matchers and actions. + pub rules: Vec, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct UDPRouteParentRefs { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} + +/// UDPRouteRule is the configuration for a given rule. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct UDPRouteRules { + /// BackendRefs defines the backend(s) where matching requests should be sent. If unspecified or invalid (refers to a non-existent resource or a Service with no endpoints), the underlying implementation MUST actively reject connection attempts to this backend. Packet drops must respect weight; if an invalid backend is requested to have 80% of the packets, then 80% of packets must be dropped instead. + /// Support: Core for Kubernetes Service + /// Support: Extended for Kubernetes ServiceImport + /// Support: Implementation-specific for any other resource + /// Support for weight: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRefs" + )] + pub backend_refs: Option>, +} + +/// BackendRef defines how a Route should forward a request to a Kubernetes resource. +/// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +/// +/// When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. +/// Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. +/// If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. +/// If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. +/// +/// Note that when the BackendTLSPolicy object is enabled by the implementation, there are some extra rules about validity to consider here. See the fields where this struct is used for more information about the exact behavior. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct UDPRouteRulesBackendRefs { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub weight: Option, +} + +/// Status defines the current state of UDPRoute. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct UDPRouteStatus { + /// 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. + pub parents: Vec, +} + +/// RouteParentStatus describes the status of a route with respect to an associated Parent. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct UDPRouteStatusParents { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// 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. + #[serde(rename = "controllerName")] + pub controller_name: String, + /// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. + #[serde(rename = "parentRef")] + pub parent_ref: UDPRouteStatusParentsParentRef, +} + +/// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct UDPRouteStatusParentsParentRef { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} diff --git a/src/apis/mod.rs b/gateway-api/src/apis/mod.rs similarity index 100% rename from src/apis/mod.rs rename to gateway-api/src/apis/mod.rs diff --git a/gateway-api/src/apis/standard/enum_defaults.rs b/gateway-api/src/apis/standard/enum_defaults.rs new file mode 100644 index 0000000..95996d5 --- /dev/null +++ b/gateway-api/src/apis/standard/enum_defaults.rs @@ -0,0 +1,44 @@ +// WARNING: generated file - manual changes will be overriden + +use super::httproutes::{ + HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType, HTTPRouteRulesBackendRefsFiltersType, + HTTPRouteRulesBackendRefsFiltersUrlRewritePathType, + HTTPRouteRulesFiltersRequestRedirectPathType, HTTPRouteRulesFiltersType, + HTTPRouteRulesFiltersUrlRewritePathType, +}; + +impl Default for HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType { + fn default() -> Self { + HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType::ReplaceFullPath + } +} + +impl Default for HTTPRouteRulesBackendRefsFiltersType { + fn default() -> Self { + HTTPRouteRulesBackendRefsFiltersType::RequestHeaderModifier + } +} + +impl Default for HTTPRouteRulesBackendRefsFiltersUrlRewritePathType { + fn default() -> Self { + HTTPRouteRulesBackendRefsFiltersUrlRewritePathType::ReplaceFullPath + } +} + +impl Default for HTTPRouteRulesFiltersRequestRedirectPathType { + fn default() -> Self { + HTTPRouteRulesFiltersRequestRedirectPathType::ReplaceFullPath + } +} + +impl Default for HTTPRouteRulesFiltersType { + fn default() -> Self { + HTTPRouteRulesFiltersType::RequestHeaderModifier + } +} + +impl Default for HTTPRouteRulesFiltersUrlRewritePathType { + fn default() -> Self { + HTTPRouteRulesFiltersUrlRewritePathType::ReplaceFullPath + } +} diff --git a/gateway-api/src/apis/standard/gatewayclasses.rs b/gateway-api/src/apis/standard/gatewayclasses.rs new file mode 100644 index 0000000..750b45f --- /dev/null +++ b/gateway-api/src/apis/standard/gatewayclasses.rs @@ -0,0 +1,66 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of GatewayClass. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1", + kind = "GatewayClass", + plural = "gatewayclasses" +)] +#[kube(status = "GatewayClassStatus")] +pub struct GatewayClassSpec { + /// 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 + #[serde(rename = "controllerName")] + pub controller_name: String, + /// Description helps describe a GatewayClass with more details. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub description: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parametersRef" + )] + pub parameters_ref: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayClassParametersRef { + /// Group is the group of the referent. + pub group: String, + /// Kind is kind of the referent. + pub kind: String, + /// Name is the name of the referent. + pub name: String, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, +} + +/// Status defines the current state of GatewayClass. +/// Implementations MUST populate status on all GatewayClass resources which specify their controller name. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayClassStatus { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, +} diff --git a/gateway-api/src/apis/standard/gateways.rs b/gateway-api/src/apis/standard/gateways.rs new file mode 100644 index 0000000..13997e2 --- /dev/null +++ b/gateway-api/src/apis/standard/gateways.rs @@ -0,0 +1,317 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; +use std::collections::BTreeMap; + +/// Spec defines the desired state of Gateway. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1", + kind = "Gateway", + plural = "gateways" +)] +#[kube(namespaced)] +#[kube(status = "GatewayStatus")] +pub struct GatewaySpec { + /// Addresses requested for this Gateway. This is optional and behavior can depend on the implementation. If a value is set in the spec and the requested address is invalid or unavailable, the implementation MUST indicate this in the associated entry in GatewayStatus.Addresses. + /// The Addresses field represents a request for the address(es) on the "outside of the Gateway", that traffic bound for this Gateway will use. This could be the IP address or hostname of an external load balancer or other networking infrastructure, or some other address that traffic will be sent to. + /// If no Addresses are specified, the implementation MAY schedule the Gateway in an implementation-specific manner, assigning an appropriate set of Addresses. + /// The implementation MUST bind all Listeners to every GatewayAddress that it assigns to the Gateway and add a corresponding entry in GatewayStatus.Addresses. + /// Support: Extended + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub addresses: Option>, + /// GatewayClassName used for this Gateway. This is the name of a GatewayClass resource. + #[serde(rename = "gatewayClassName")] + pub gateway_class_name: String, + /// Listeners associated with this Gateway. Listeners define logical endpoints that are bound on this Gateway's addresses. At least one Listener MUST be specified. + /// Each Listener in a set of Listeners (for example, in a single Gateway) MUST be _distinct_, in that a traffic flow MUST be able to be assigned to exactly one listener. (This section uses "set of Listeners" rather than "Listeners in a single Gateway" because implementations MAY merge configuration from multiple Gateways onto a single data plane, and these rules _also_ apply in that case). + /// Practically, this means that each listener in a set MUST have a unique combination of Port, Protocol, and, if supported by the protocol, Hostname. + /// Some combinations of port, protocol, and TLS settings are considered Core support and MUST be supported by implementations based on their targeted conformance profile: + /// HTTP Profile + /// 1. HTTPRoute, Port: 80, Protocol: HTTP 2. HTTPRoute, Port: 443, Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided + /// TLS Profile + /// 1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode: Passthrough + /// "Distinct" Listeners have the following property: + /// The implementation can match inbound requests to a single distinct Listener. When multiple Listeners share values for fields (for example, two Listeners with the same Port value), the implementation can match requests to only one of the Listeners using other Listener fields. + /// For example, the following Listener scenarios are distinct: + /// 1. Multiple Listeners with the same Port that all use the "HTTP" Protocol that all have unique Hostname values. 2. Multiple Listeners with the same Port that use either the "HTTPS" or "TLS" Protocol that all have unique Hostname values. 3. A mixture of "TCP" and "UDP" Protocol Listeners, where no Listener with the same Protocol has the same Port value. + /// Some fields in the Listener struct have possible values that affect whether the Listener is distinct. Hostname is particularly relevant for HTTP or HTTPS protocols. + /// When using the Hostname value to select between same-Port, same-Protocol Listeners, the Hostname value must be different on each Listener for the Listener to be distinct. + /// When the Listeners are distinct based on Hostname, inbound request hostnames MUST match from the most specific to least specific Hostname values to choose the correct Listener and its associated set of Routes. + /// Exact matches must be processed before wildcard matches, and wildcard matches must be processed before fallback (empty Hostname value) matches. For example, `"foo.example.com"` takes precedence over `"*.example.com"`, and `"*.example.com"` takes precedence over `""`. + /// Additionally, if there are multiple wildcard entries, more specific wildcard entries must be processed before less specific wildcard entries. For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. The precise definition here is that the higher the number of dots in the hostname to the right of the wildcard character, the higher the precedence. + /// The wildcard character will match any number of characters _and dots_ to the left, however, so `"*.example.com"` will match both `"foo.bar.example.com"` _and_ `"bar.example.com"`. + /// If a set of Listeners contains Listeners that are not distinct, then those Listeners are Conflicted, and the implementation MUST set the "Conflicted" condition in the Listener Status to "True". + /// Implementations MAY choose to accept a Gateway with some Conflicted Listeners only if they only accept the partial Listener set that contains no Conflicted Listeners. To put this another way, implementations may accept a partial Listener set only if they throw out *all* the conflicting Listeners. No picking one of the conflicting listeners as the winner. This also means that the Gateway must have at least one non-conflicting Listener in this case, otherwise it violates the requirement that at least one Listener must be present. + /// The implementation MUST set a "ListenersNotValid" condition on the Gateway Status when the Gateway contains Conflicted Listeners whether or not they accept the Gateway. That Condition SHOULD clearly indicate in the Message which Listeners are conflicted, and which are Accepted. Additionally, the Listener status for those listeners SHOULD indicate which Listeners are conflicted and not Accepted. + /// A Gateway's Listeners are considered "compatible" if: + /// 1. They are distinct. 2. The implementation can serve them in compliance with the Addresses requirement that all Listeners are available on all assigned addresses. + /// Compatible combinations in Extended support are expected to vary across implementations. A combination that is compatible for one implementation may not be compatible for another. + /// For example, an implementation that cannot serve both TCP and UDP listeners on the same address, or cannot mix HTTPS and generic TLS listens on the same port would not consider those cases compatible, even though they are distinct. + /// Note that requests SHOULD match at most one Listener. For example, if Listeners are defined for "foo.example.com" and "*.example.com", a request to "foo.example.com" SHOULD only be routed using routes attached to the "foo.example.com" Listener (and not the "*.example.com" Listener). This concept is known as "Listener Isolation". Implementations that do not support Listener Isolation MUST clearly document this. + /// Implementations MAY merge separate Gateways onto a single set of Addresses if all Listeners across all Gateways are compatible. + /// Support: Core + pub listeners: Vec, +} + +/// GatewayAddress describes an address that can be bound to a Gateway. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayAddresses { + /// Type of the address. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// 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`. + pub value: String, +} + +/// Listener embodies the concept of a logical endpoint where a Gateway accepts network connections. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListeners { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "allowedRoutes" + )] + pub allowed_routes: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// Name is the name of the Listener. This name MUST be unique within a Gateway. + /// Support: Core + pub name: String, + /// Port is the network port. Multiple listeners may use the same port, subject to the Listener compatibility rules. + /// Support: Core + pub port: i32, + /// Protocol specifies the network protocol this listener expects to receive. + /// Support: Core + pub protocol: String, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub tls: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutes { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kinds: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespaces: Option, +} + +/// RouteGroupKind indicates the group and kind of a Route resource. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesKinds { + /// Group is the group of the Route. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Kind is the kind of the Route. + pub kind: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesNamespaces { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub from: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub selector: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GatewayListenersAllowedRoutesNamespacesFrom { + All, + Selector, + Same, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesNamespacesSelector { + /// matchExpressions is a list of label selector requirements. The requirements are ANDed. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "matchExpressions" + )] + pub match_expressions: + Option>, + /// matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "matchLabels" + )] + pub match_labels: Option>, +} + +/// A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersAllowedRoutesNamespacesSelectorMatchExpressions { + /// key is the label key that the selector applies to. + pub key: String, + /// operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. + pub operator: String, + /// values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub values: Option>, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersTls { + /// 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) + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "certificateRefs" + )] + pub certificate_refs: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub mode: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub options: Option>, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayListenersTlsCertificateRefs { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Kind is kind of the referent. For example "Secret". + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the referenced object. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum GatewayListenersTlsMode { + Terminate, + Passthrough, +} + +/// Status defines the current state of Gateway. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatus { + /// Addresses lists the network addresses that have been bound to the Gateway. + /// This list may differ from the addresses provided in the spec under some conditions: + /// * no addresses are specified, all addresses are dynamically assigned * a combination of specified and dynamic addresses are assigned * a specified address was unusable (e.g. already in use) + /// + #[serde(default, skip_serializing_if = "Option::is_none")] + pub addresses: Option>, + /// 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" + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// Listeners provide status for each unique listener port defined in the Spec. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub listeners: Option>, +} + +/// GatewayStatusAddress describes a network address that is bound to a Gateway. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatusAddresses { + /// Type of the address. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// 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`. + pub value: String, +} + +/// ListenerStatus is the status associated with a Listener. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatusListeners { + /// AttachedRoutes represents the total number of Routes that have been successfully attached to this Listener. + /// Successful attachment of a Route to a Listener is based solely on the combination of the AllowedRoutes field on the corresponding Listener and the Route's ParentRefs field. A Route is successfully attached to a Listener when it is selected by the Listener's AllowedRoutes field AND the Route has a valid ParentRef selecting the whole Gateway resource or a specific Listener as a parent resource (more detail on attachment semantics can be found in the documentation on the various Route kinds ParentRefs fields). Listener or Route status does not impact successful attachment, i.e. the AttachedRoutes field count MUST be set for Listeners with condition Accepted: false and MUST count successfully attached Routes that may themselves have Accepted: false conditions. + /// Uses for this field include troubleshooting Route attachment and measuring blast radius/impact of changes to a Listener. + #[serde(rename = "attachedRoutes")] + pub attached_routes: i32, + /// Conditions describe the current condition of this listener. + pub conditions: Vec, + /// Name is the name of the Listener that this status corresponds to. + pub name: String, + /// 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. + #[serde(rename = "supportedKinds")] + pub supported_kinds: Vec, +} + +/// RouteGroupKind indicates the group and kind of a Route resource. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct GatewayStatusListenersSupportedKinds { + /// Group is the group of the Route. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// Kind is the kind of the Route. + pub kind: String, +} diff --git a/gateway-api/src/apis/standard/httproutes.rs b/gateway-api/src/apis/standard/httproutes.rs new file mode 100644 index 0000000..1239d0a --- /dev/null +++ b/gateway-api/src/apis/standard/httproutes.rs @@ -0,0 +1,1109 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition; +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of HTTPRoute. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1", + kind = "HTTPRoute", + plural = "httproutes" +)] +#[kube(namespaced)] +#[kube(status = "HTTPRouteStatus")] +pub struct HTTPRouteSpec { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostnames: Option>, + /// 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) This API may be extended in the future to support additional kinds of parent resources. + /// ParentRefs must be _distinct_. This means either that: + /// * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. + /// Some examples: + /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. + /// It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. + /// Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable other kinds of cross-namespace reference. + /// + /// + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "parentRefs" + )] + pub parent_refs: Option>, + /// Rules are a list of HTTP matchers, filters and actions. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub rules: Option>, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteParentRefs { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} + +/// HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs). +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRules { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "backendRefs" + )] + pub backend_refs: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub filters: Option>, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub matches: Option>, +} + +/// HTTPBackendRef defines how a HTTPRoute forwards a HTTP request. +/// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +/// +/// When the BackendRef points to a Kubernetes Service, implementations SHOULD honor the appProtocol field if it is set for the target Service Port. +/// Implementations supporting appProtocol SHOULD recognize the Kubernetes Standard Application Protocols defined in KEP-3726. +/// If a Service appProtocol isn't specified, an implementation MAY infer the backend protocol through its own means. Implementations MAY infer the protocol from the Route type referring to the backend Service. +/// If a Route is not able to send traffic to the backend using the specified protocol then the backend is considered invalid. Implementations MUST set the "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. +/// +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefs { + /// 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.) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub filters: Option>, + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub weight: Option, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFilters { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "extensionRef" + )] + pub extension_ref: Option, + /// RequestHeaderModifier defines a schema for a filter that modifies request headers. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestHeaderModifier" + )] + pub request_header_modifier: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestMirror" + )] + pub request_mirror: Option, + /// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestRedirect" + )] + pub request_redirect: Option, + /// ResponseHeaderModifier defines a schema for a filter that modifies response headers. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "responseHeaderModifier" + )] + pub response_header_modifier: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesBackendRefsFiltersType, + /// URLRewrite defines a schema for a filter that modifies a request during forwarding. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "urlRewrite" + )] + pub url_rewrite: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersExtensionRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + pub group: String, + /// Kind is kind of the referent. For example "HTTPRoute" or "Service". + pub kind: String, + /// Name is the name of the referent. + pub name: String, +} + +/// RequestHeaderModifier defines a schema for a filter that modifies request headers. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestMirror { + /// BackendRef references a resource where mirrored requests are sent. + /// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. + /// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. + /// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. + /// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. + /// Support: Extended for Kubernetes Service + /// Support: Implementation-specific for any other resource + #[serde(rename = "backendRef")] + pub backend_ref: HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef, +} + +/// BackendRef references a resource where mirrored requests are sent. +/// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. +/// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. +/// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. +/// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. +/// Support: Extended for Kubernetes Service +/// Support: Implementation-specific for any other resource +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirect { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub scheme: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "statusCode" + )] + pub status_code: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirectPath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectScheme { + #[serde(rename = "http")] + Http, + #[serde(rename = "https")] + Https, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectStatusCode { + #[serde(rename = "301")] + r#_301, + #[serde(rename = "302")] + r#_302, +} + +/// ResponseHeaderModifier defines a schema for a filter that modifies response headers. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersType { + RequestHeaderModifier, + ResponseHeaderModifier, + RequestMirror, + RequestRedirect, + #[serde(rename = "URLRewrite")] + UrlRewrite, + ExtensionRef, +} + +/// URLRewrite defines a schema for a filter that modifies a request during forwarding. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersUrlRewrite { + /// Hostname is the value to be used to replace the Host header value during forwarding. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// Path defines a path rewrite. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesBackendRefsFiltersUrlRewritePath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesBackendRefsFiltersUrlRewritePathType, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesBackendRefsFiltersUrlRewritePathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFilters { + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "extensionRef" + )] + pub extension_ref: Option, + /// RequestHeaderModifier defines a schema for a filter that modifies request headers. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestHeaderModifier" + )] + pub request_header_modifier: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestMirror" + )] + pub request_mirror: Option, + /// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. + /// Support: Core + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "requestRedirect" + )] + pub request_redirect: Option, + /// ResponseHeaderModifier defines a schema for a filter that modifies response headers. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "responseHeaderModifier" + )] + pub response_header_modifier: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesFiltersType, + /// URLRewrite defines a schema for a filter that modifies a request during forwarding. + /// Support: Extended + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "urlRewrite" + )] + pub url_rewrite: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersExtensionRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + pub group: String, + /// Kind is kind of the referent. For example "HTTPRoute" or "Service". + pub kind: String, + /// Name is the name of the referent. + pub name: String, +} + +/// RequestHeaderModifier defines a schema for a filter that modifies request headers. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestMirror { + /// BackendRef references a resource where mirrored requests are sent. + /// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. + /// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. + /// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. + /// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. + /// Support: Extended for Kubernetes Service + /// Support: Implementation-specific for any other resource + #[serde(rename = "backendRef")] + pub backend_ref: HTTPRouteRulesFiltersRequestMirrorBackendRef, +} + +/// BackendRef references a resource where mirrored requests are sent. +/// Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. +/// If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. +/// If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. +/// In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. +/// Support: Extended for Kubernetes Service +/// Support: Implementation-specific for any other resource +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestMirrorBackendRef { + /// Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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) + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + pub name: String, + /// Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. + /// Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestRedirect { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub port: Option, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub scheme: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "statusCode" + )] + pub status_code: Option, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersRequestRedirectPath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesFiltersRequestRedirectPathType, +} + +/// 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 +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersRequestRedirectPathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersRequestRedirectScheme { + #[serde(rename = "http")] + Http, + #[serde(rename = "https")] + Https, +} + +/// RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. +/// Support: Core +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersRequestRedirectStatusCode { + #[serde(rename = "301")] + r#_301, + #[serde(rename = "302")] + r#_302, +} + +/// ResponseHeaderModifier defines a schema for a filter that modifies response headers. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersResponseHeaderModifier { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub add: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub remove: Option>, + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub set: Option>, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersResponseHeaderModifierAdd { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersResponseHeaderModifierSet { + /// 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. + pub name: String, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// 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. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersType { + RequestHeaderModifier, + ResponseHeaderModifier, + RequestMirror, + RequestRedirect, + #[serde(rename = "URLRewrite")] + UrlRewrite, + ExtensionRef, +} + +/// URLRewrite defines a schema for a filter that modifies a request during forwarding. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersUrlRewrite { + /// Hostname is the value to be used to replace the Host header value during forwarding. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub hostname: Option, + /// Path defines a path rewrite. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesFiltersUrlRewritePath { + /// ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replaceFullPath" + )] + pub replace_full_path: Option, + /// ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". + /// Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. + /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. + /// Request Path | Prefix Match | Replace Prefix | Modified Path -------------|--------------|----------------|---------- /foo/bar | /foo | /xyz | /xyz/bar /foo/bar | /foo | /xyz/ | /xyz/bar /foo/bar | /foo/ | /xyz | /xyz/bar /foo/bar | /foo/ | /xyz/ | /xyz/bar /foo | /foo | /xyz | /xyz /foo/ | /foo | /xyz | /xyz/ /foo/bar | /foo | | /bar /foo/ | /foo | | / /foo | /foo | | / /foo/ | /foo | / | / /foo | /foo | / | / + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "replacePrefixMatch" + )] + pub replace_prefix_match: Option, + /// 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`. + #[serde(rename = "type")] + pub r#type: HTTPRouteRulesFiltersUrlRewritePathType, +} + +/// Path defines a path rewrite. +/// Support: Extended +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesFiltersUrlRewritePathType { + ReplaceFullPath, + ReplacePrefixMatch, +} + +/// 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" +/// ``` +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatches { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub headers: Option>, + /// Method specifies HTTP method matcher. When specified, this route will be matched only if the request has the specified method. + /// Support: Extended + #[serde(default, skip_serializing_if = "Option::is_none")] + pub method: Option, + /// Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub path: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "queryParams" + )] + pub query_params: Option>, +} + +/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatchesHeaders { + /// 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". + pub name: String, + /// Type specifies how to match against the value of the header. + /// Support: Core (Exact) + /// Support: Implementation-specific (RegularExpression) + /// Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value is the value of HTTP Header to be matched. + pub value: String, +} + +/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesHeadersType { + Exact, + RegularExpression, +} + +/// 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" +/// ``` +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesMethod { + #[serde(rename = "GET")] + Get, + #[serde(rename = "HEAD")] + Head, + #[serde(rename = "POST")] + Post, + #[serde(rename = "PUT")] + Put, + #[serde(rename = "DELETE")] + Delete, + #[serde(rename = "CONNECT")] + Connect, + #[serde(rename = "OPTIONS")] + Options, + #[serde(rename = "TRACE")] + Trace, + #[serde(rename = "PATCH")] + Patch, +} + +/// Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatchesPath { + /// Type specifies how to match against the path Value. + /// Support: Core (Exact, PathPrefix) + /// Support: Implementation-specific (RegularExpression) + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value of the HTTP path to match against. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub value: Option, +} + +/// Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesPathType { + Exact, + PathPrefix, + RegularExpression, +} + +/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteRulesMatchesQueryParams { + /// 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. + pub name: String, + /// Type specifies how to match against the value of the query parameter. + /// Support: Extended (Exact) + /// Support: Implementation-specific (RegularExpression) + /// Since RegularExpression QueryParamMatchType has Implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect. + #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] + pub r#type: Option, + /// Value is the value of HTTP query param to be matched. + pub value: String, +} + +/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] +pub enum HTTPRouteRulesMatchesQueryParamsType { + Exact, + RegularExpression, +} + +/// Status defines the current state of HTTPRoute. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteStatus { + /// 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. + pub parents: Vec, +} + +/// RouteParentStatus describes the status of a route with respect to an associated Parent. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteStatusParents { + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub conditions: Option>, + /// 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. + #[serde(rename = "controllerName")] + pub controller_name: String, + /// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. + #[serde(rename = "parentRef")] + pub parent_ref: HTTPRouteStatusParentsParentRef, +} + +/// ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct HTTPRouteStatusParentsParentRef { + /// 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 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub group: Option, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub kind: Option, + /// Name is the name of the referent. + /// Support: Core + pub name: String, + /// Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. + /// Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. + /// + /// Support: Core + #[serde(default, skip_serializing_if = "Option::is_none")] + pub namespace: Option, + /// 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 + #[serde( + default, + skip_serializing_if = "Option::is_none", + rename = "sectionName" + )] + pub section_name: Option, +} diff --git a/src/apis/standard/mod.rs b/gateway-api/src/apis/standard/mod.rs similarity index 86% rename from src/apis/standard/mod.rs rename to gateway-api/src/apis/standard/mod.rs index 5aa4193..1588383 100644 --- a/src/apis/standard/mod.rs +++ b/gateway-api/src/apis/standard/mod.rs @@ -1,4 +1,5 @@ // WARNING! generated file do not edit +mod enum_defaults; pub mod gatewayclasses; pub mod gateways; pub mod httproutes; diff --git a/gateway-api/src/apis/standard/referencegrants.rs b/gateway-api/src/apis/standard/referencegrants.rs new file mode 100644 index 0000000..88c6dbe --- /dev/null +++ b/gateway-api/src/apis/standard/referencegrants.rs @@ -0,0 +1,56 @@ +// WARNING: generated by kopium - manual changes will be overwritten +// kopium command: kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - +// kopium version: 0.17.2 + +use kube::CustomResource; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Spec defines the desired state of ReferenceGrant. +#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +#[kube( + group = "gateway.networking.k8s.io", + version = "v1beta1", + kind = "ReferenceGrant", + plural = "referencegrants" +)] +#[kube(namespaced)] +pub struct ReferenceGrantSpec { + /// 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 + pub from: Vec, + /// 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 + pub to: Vec, +} + +/// ReferenceGrantFrom describes trusted namespaces and kinds. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct ReferenceGrantFrom { + /// Group is the group of the referent. When empty, the Kubernetes core API group is inferred. + /// Support: Core + pub group: String, + /// 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 + pub kind: String, + /// Namespace is the namespace of the referent. + /// Support: Core + pub namespace: String, +} + +/// ReferenceGrantTo describes what Kinds are allowed as targets of the references. +#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema, Default)] +pub struct ReferenceGrantTo { + /// Group is the group of the referent. When empty, the Kubernetes core API group is inferred. + /// Support: Core + pub group: String, + /// 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 + pub kind: String, + /// 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. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub name: Option, +} diff --git a/src/lib.rs b/gateway-api/src/lib.rs similarity index 81% rename from src/lib.rs rename to gateway-api/src/lib.rs index 100663f..5f69846 100644 --- a/src/lib.rs +++ b/gateway-api/src/lib.rs @@ -5,17 +5,21 @@ mod tests { use std::process::Command; use anyhow::Error; - use kube::api::PostParams; + use k8s_openapi::apimachinery::pkg::apis::meta::v1::{Condition, Time}; + use k8s_openapi::chrono::Utc; + use kube::api::{Patch, PatchParams, PostParams}; use kube::client::ConfigExt; use kube::config::{KubeConfigOptions, Kubeconfig}; use kube::core::ObjectMeta; use kube::{Api, Config, CustomResourceExt}; + use serde_json::json; use tower::ServiceBuilder; use uuid::Uuid; + use crate::apis::standard::gateways::GatewayStatusAddresses; use crate::apis::standard::{ gatewayclasses::{GatewayClass, GatewayClassSpec}, - gateways::{Gateway, GatewaySpec}, + gateways::{Gateway, GatewaySpec, GatewayStatus}, }; // ------------------------------------------------------------------------- @@ -63,13 +67,37 @@ mod tests { status: None, }; gw.metadata.name = Some("test-gateway".to_string()); - gw = Api::default_namespaced(client) + gw = Api::default_namespaced(client.clone()) .create(&PostParams::default(), &gw) .await?; assert!(gw.metadata.name.is_some()); assert!(gw.metadata.uid.is_some()); + let mut gw_status = GatewayStatus::default(); + gw_status.addresses = Some(vec![GatewayStatusAddresses::default()]); + gw_status.conditions = Some(vec![Condition { + last_transition_time: Time(Utc::now()), + message: "testing gateway".to_string(), + observed_generation: Some(1), + reason: "GatewayTesting".to_string(), + status: "True".to_string(), + type_: "IntegrationTest".to_string(), + }]); + + gw = Api::default_namespaced(client) + .patch_status( + gw.metadata.name.clone().unwrap().as_str(), + &PatchParams::default(), + &Patch::Merge(json!({ + "status": Some(gw_status) + })), + ) + .await?; + assert!(gw.status.is_some()); + assert!(gw.status.clone().unwrap().addresses.is_some()); + assert!(gw.status.clone().unwrap().conditions.is_some()); + Ok(()) } diff --git a/src/apis/experimental/gatewayclasses.rs b/src/apis/experimental/gatewayclasses.rs deleted file mode 100644 index 5744d18..0000000 --- a/src/apis/experimental/gatewayclasses.rs +++ /dev/null @@ -1,172 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of GatewayClass. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1", kind = "GatewayClass", plural = "gatewayclasses")] -#[kube(status = "GatewayClassStatus")] -pub struct GatewayClassSpec { - /// 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 - #[serde(rename = "controllerName")] - pub controller_name: String, - /// Description helps describe a GatewayClass with more details. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub description: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parametersRef")] - pub parameters_ref: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayClassParametersRef { - /// Group is the group of the referent. - pub group: String, - /// Kind is kind of the referent. - pub kind: String, - /// Name is the name of the referent. - pub name: String, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, -} - -/// Status defines the current state of GatewayClass. -/// -/// -/// Implementations MUST populate status on all GatewayClass resources which -/// specify their controller name. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayClassStatus { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// SupportedFeatures is the set of features the GatewayClass support. - /// It MUST be sorted in ascending alphabetical order. - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "supportedFeatures")] - pub supported_features: Option>, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayClassStatusConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GatewayClassStatusConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayClassStatusConditionsStatus { - True, - False, - Unknown, -} - diff --git a/src/apis/experimental/gateways.rs b/src/apis/experimental/gateways.rs deleted file mode 100644 index 9656ee2..0000000 --- a/src/apis/experimental/gateways.rs +++ /dev/null @@ -1,886 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; -use std::collections::BTreeMap; - -/// Spec defines the desired state of Gateway. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1", kind = "Gateway", plural = "gateways")] -#[kube(namespaced)] -#[kube(status = "GatewayStatus")] -pub struct GatewaySpec { - /// Addresses requested for this Gateway. This is optional and behavior can - /// depend on the implementation. If a value is set in the spec and the - /// requested address is invalid or unavailable, the implementation MUST - /// indicate this in the associated entry in GatewayStatus.Addresses. - /// - /// - /// The Addresses field represents a request for the address(es) on the - /// "outside of the Gateway", that traffic bound for this Gateway will use. - /// This could be the IP address or hostname of an external load balancer or - /// other networking infrastructure, or some other address that traffic will - /// be sent to. - /// - /// - /// If no Addresses are specified, the implementation MAY schedule the - /// Gateway in an implementation-specific manner, assigning an appropriate - /// set of Addresses. - /// - /// - /// The implementation MUST bind all Listeners to every GatewayAddress that - /// it assigns to the Gateway and add a corresponding entry in - /// GatewayStatus.Addresses. - /// - /// - /// Support: Extended - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub addresses: Option>, - /// GatewayClassName used for this Gateway. This is the name of a - /// GatewayClass resource. - #[serde(rename = "gatewayClassName")] - pub gateway_class_name: String, - /// Infrastructure defines infrastructure level attributes about this Gateway instance. - /// - /// - /// Support: Core - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub infrastructure: Option, - /// Listeners associated with this Gateway. Listeners define - /// logical endpoints that are bound on this Gateway's addresses. - /// At least one Listener MUST be specified. - /// - /// - /// Each Listener in a set of Listeners (for example, in a single Gateway) - /// MUST be _distinct_, in that a traffic flow MUST be able to be assigned to - /// exactly one listener. (This section uses "set of Listeners" rather than - /// "Listeners in a single Gateway" because implementations MAY merge configuration - /// from multiple Gateways onto a single data plane, and these rules _also_ - /// apply in that case). - /// - /// - /// Practically, this means that each listener in a set MUST have a unique - /// combination of Port, Protocol, and, if supported by the protocol, Hostname. - /// - /// - /// Some combinations of port, protocol, and TLS settings are considered - /// Core support and MUST be supported by implementations based on their - /// targeted conformance profile: - /// - /// - /// HTTP Profile - /// - /// - /// 1. HTTPRoute, Port: 80, Protocol: HTTP - /// 2. HTTPRoute, Port: 443, Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided - /// - /// - /// TLS Profile - /// - /// - /// 1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode: Passthrough - /// - /// - /// "Distinct" Listeners have the following property: - /// - /// - /// The implementation can match inbound requests to a single distinct - /// Listener. When multiple Listeners share values for fields (for - /// example, two Listeners with the same Port value), the implementation - /// can match requests to only one of the Listeners using other - /// Listener fields. - /// - /// - /// For example, the following Listener scenarios are distinct: - /// - /// - /// 1. Multiple Listeners with the same Port that all use the "HTTP" - /// Protocol that all have unique Hostname values. - /// 2. Multiple Listeners with the same Port that use either the "HTTPS" or - /// "TLS" Protocol that all have unique Hostname values. - /// 3. A mixture of "TCP" and "UDP" Protocol Listeners, where no Listener - /// with the same Protocol has the same Port value. - /// - /// - /// Some fields in the Listener struct have possible values that affect - /// whether the Listener is distinct. Hostname is particularly relevant - /// for HTTP or HTTPS protocols. - /// - /// - /// When using the Hostname value to select between same-Port, same-Protocol - /// Listeners, the Hostname value must be different on each Listener for the - /// Listener to be distinct. - /// - /// - /// When the Listeners are distinct based on Hostname, inbound request - /// hostnames MUST match from the most specific to least specific Hostname - /// values to choose the correct Listener and its associated set of Routes. - /// - /// - /// Exact matches must be processed before wildcard matches, and wildcard - /// matches must be processed before fallback (empty Hostname value) - /// matches. For example, `"foo.example.com"` takes precedence over - /// `"*.example.com"`, and `"*.example.com"` takes precedence over `""`. - /// - /// - /// Additionally, if there are multiple wildcard entries, more specific - /// wildcard entries must be processed before less specific wildcard entries. - /// For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. - /// The precise definition here is that the higher the number of dots in the - /// hostname to the right of the wildcard character, the higher the precedence. - /// - /// - /// The wildcard character will match any number of characters _and dots_ to - /// the left, however, so `"*.example.com"` will match both - /// `"foo.bar.example.com"` _and_ `"bar.example.com"`. - /// - /// - /// If a set of Listeners contains Listeners that are not distinct, then those - /// Listeners are Conflicted, and the implementation MUST set the "Conflicted" - /// condition in the Listener Status to "True". - /// - /// - /// Implementations MAY choose to accept a Gateway with some Conflicted - /// Listeners only if they only accept the partial Listener set that contains - /// no Conflicted Listeners. To put this another way, implementations may - /// accept a partial Listener set only if they throw out *all* the conflicting - /// Listeners. No picking one of the conflicting listeners as the winner. - /// This also means that the Gateway must have at least one non-conflicting - /// Listener in this case, otherwise it violates the requirement that at - /// least one Listener must be present. - /// - /// - /// The implementation MUST set a "ListenersNotValid" condition on the - /// Gateway Status when the Gateway contains Conflicted Listeners whether or - /// not they accept the Gateway. That Condition SHOULD clearly - /// indicate in the Message which Listeners are conflicted, and which are - /// Accepted. Additionally, the Listener status for those listeners SHOULD - /// indicate which Listeners are conflicted and not Accepted. - /// - /// - /// A Gateway's Listeners are considered "compatible" if: - /// - /// - /// 1. They are distinct. - /// 2. The implementation can serve them in compliance with the Addresses - /// requirement that all Listeners are available on all assigned - /// addresses. - /// - /// - /// Compatible combinations in Extended support are expected to vary across - /// implementations. A combination that is compatible for one implementation - /// may not be compatible for another. - /// - /// - /// For example, an implementation that cannot serve both TCP and UDP listeners - /// on the same address, or cannot mix HTTPS and generic TLS listens on the same port - /// would not consider those cases compatible, even though they are distinct. - /// - /// - /// Note that requests SHOULD match at most one Listener. For example, if - /// Listeners are defined for "foo.example.com" and "*.example.com", a - /// request to "foo.example.com" SHOULD only be routed using routes attached - /// to the "foo.example.com" Listener (and not the "*.example.com" Listener). - /// This concept is known as "Listener Isolation". Implementations that do - /// not support Listener Isolation MUST clearly document this. - /// - /// - /// Implementations MAY merge separate Gateways onto a single set of - /// Addresses if all Listeners across all Gateways are compatible. - /// - /// - /// Support: Core - pub listeners: Vec, -} - -/// GatewayAddress describes an address that can be bound to a Gateway. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayAddresses { - /// Type of the address. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// 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`. - pub value: String, -} - -/// Infrastructure defines infrastructure level attributes about this Gateway instance. -/// -/// -/// Support: Core -/// -/// -/// -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayInfrastructure { - /// Annotations that SHOULD be applied to any resources created in response to this Gateway. - /// - /// - /// For implementations creating other Kubernetes objects, this should be the `metadata.annotations` field on resources. - /// For other implementations, this refers to any relevant (implementation specific) "annotations" concepts. - /// - /// - /// An implementation may chose to add additional implementation-specific annotations as they see fit. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub annotations: Option>, - /// Labels that SHOULD be applied to any resources created in response to this Gateway. - /// - /// - /// For implementations creating other Kubernetes objects, this should be the `metadata.labels` field on resources. - /// For other implementations, this refers to any relevant (implementation specific) "labels" concepts. - /// - /// - /// An implementation may chose to add additional implementation-specific labels as they see fit. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub labels: Option>, -} - -/// Listener embodies the concept of a logical endpoint where a Gateway accepts -/// network connections. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListeners { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "allowedRoutes")] - pub allowed_routes: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// Name is the name of the Listener. This name MUST be unique within a - /// Gateway. - /// - /// - /// Support: Core - pub name: String, - /// Port is the network port. Multiple listeners may use the - /// same port, subject to the Listener compatibility rules. - /// - /// - /// Support: Core - pub port: i32, - /// Protocol specifies the network protocol this listener expects to receive. - /// - /// - /// Support: Core - pub protocol: String, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub tls: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutes { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kinds: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespaces: Option, -} - -/// RouteGroupKind indicates the group and kind of a Route resource. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesKinds { - /// Group is the group of the Route. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Kind is the kind of the Route. - pub kind: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesNamespaces { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub from: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub selector: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayListenersAllowedRoutesNamespacesFrom { - All, - Selector, - Same, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesNamespacesSelector { - /// matchExpressions is a list of label selector requirements. The requirements are ANDed. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "matchExpressions")] - pub match_expressions: Option>, - /// matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels - /// map is equivalent to an element of matchExpressions, whose key field is "key", the - /// operator is "In", and the values array contains only "value". The requirements are ANDed. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "matchLabels")] - pub match_labels: Option>, -} - -/// A label selector requirement is a selector that contains values, a key, and an operator that -/// relates the key and values. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesNamespacesSelectorMatchExpressions { - /// key is the label key that the selector applies to. - pub key: String, - /// operator represents a key's relationship to a set of values. - /// Valid operators are In, NotIn, Exists and DoesNotExist. - pub operator: String, - /// values is an array of string values. If the operator is In or NotIn, - /// the values array must be non-empty. If the operator is Exists or DoesNotExist, - /// the values array must be empty. This array is replaced during a strategic - /// merge patch. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub values: Option>, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersTls { - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none", rename = "certificateRefs")] - pub certificate_refs: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub mode: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub options: Option>, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersTlsCertificateRefs { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Kind is kind of the referent. For example "Secret". - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the referenced object. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayListenersTlsMode { - Terminate, - Passthrough, -} - -/// Status defines the current state of Gateway. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatus { - /// Addresses lists the network addresses that have been bound to the - /// Gateway. - /// - /// - /// This list may differ from the addresses provided in the spec under some - /// conditions: - /// - /// - /// * no addresses are specified, all addresses are dynamically assigned - /// * a combination of specified and dynamic addresses are assigned - /// * a specified address was unusable (e.g. already in use) - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub addresses: Option>, - /// 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" - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// Listeners provide status for each unique listener port defined in the Spec. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub listeners: Option>, -} - -/// GatewayStatusAddress describes a network address that is bound to a Gateway. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusAddresses { - /// Type of the address. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// 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`. - pub value: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GatewayStatusConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayStatusConditionsStatus { - True, - False, - Unknown, -} - -/// ListenerStatus is the status associated with a Listener. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusListeners { - /// AttachedRoutes represents the total number of Routes that have been - /// successfully attached to this Listener. - /// - /// - /// Successful attachment of a Route to a Listener is based solely on the - /// combination of the AllowedRoutes field on the corresponding Listener - /// and the Route's ParentRefs field. A Route is successfully attached to - /// a Listener when it is selected by the Listener's AllowedRoutes field - /// AND the Route has a valid ParentRef selecting the whole Gateway - /// resource or a specific Listener as a parent resource (more detail on - /// attachment semantics can be found in the documentation on the various - /// Route kinds ParentRefs fields). Listener or Route status does not impact - /// successful attachment, i.e. the AttachedRoutes field count MUST be set - /// for Listeners with condition Accepted: false and MUST count successfully - /// attached Routes that may themselves have Accepted: false conditions. - /// - /// - /// Uses for this field include troubleshooting Route attachment and - /// measuring blast radius/impact of changes to a Listener. - #[serde(rename = "attachedRoutes")] - pub attached_routes: i32, - /// Conditions describe the current condition of this listener. - pub conditions: Vec, - /// Name is the name of the Listener that this status corresponds to. - pub name: String, - /// 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. - #[serde(rename = "supportedKinds")] - pub supported_kinds: Vec, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusListenersConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GatewayStatusListenersConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayStatusListenersConditionsStatus { - True, - False, - Unknown, -} - -/// RouteGroupKind indicates the group and kind of a Route resource. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusListenersSupportedKinds { - /// Group is the group of the Route. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Kind is the kind of the Route. - pub kind: String, -} - diff --git a/src/apis/experimental/grpcroutes.rs b/src/apis/experimental/grpcroutes.rs deleted file mode 100644 index d6c52ca..0000000 --- a/src/apis/experimental/grpcroutes.rs +++ /dev/null @@ -1,1842 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of GRPCRoute. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1alpha2", kind = "GRPCRoute", plural = "grpcroutes")] -#[kube(namespaced)] -#[kube(status = "GRPCRouteStatus")] -pub struct GRPCRouteSpec { - /// Hostnames defines a set of hostnames to match against the GRPC - /// Host header to select a GRPCRoute to process the request. This matches - /// the RFC 1123 definition of a hostname with 2 notable exceptions: - /// - /// - /// 1. IPs are not allowed. - /// 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard - /// label MUST appear by itself as the first label. - /// - /// - /// If a hostname is specified by both the Listener and GRPCRoute, there - /// MUST be at least one intersecting hostname for the GRPCRoute to be - /// attached to the Listener. For example: - /// - /// - /// * A Listener with `test.example.com` as the hostname matches GRPCRoutes - /// that have either not specified any hostnames, or have specified at - /// least one of `test.example.com` or `*.example.com`. - /// * A Listener with `*.example.com` as the hostname matches GRPCRoutes - /// that have either not specified any hostnames or have specified at least - /// one hostname that matches the Listener hostname. For example, - /// `test.example.com` and `*.example.com` would both match. On the other - /// hand, `example.com` and `test.example.net` would not match. - /// - /// - /// Hostnames that are prefixed with a wildcard label (`*.`) are interpreted - /// as a suffix match. That means that a match for `*.example.com` would match - /// both `test.example.com`, and `foo.test.example.com`, but not `example.com`. - /// - /// - /// If both the Listener and GRPCRoute have specified hostnames, any - /// GRPCRoute hostnames that do not match the Listener hostname MUST be - /// ignored. For example, if a Listener specified `*.example.com`, and the - /// GRPCRoute specified `test.example.com` and `test.example.net`, - /// `test.example.net` MUST NOT be considered for a match. - /// - /// - /// If both the Listener and GRPCRoute have specified hostnames, and none - /// match with the criteria above, then the GRPCRoute MUST NOT be accepted by - /// the implementation. The implementation MUST raise an 'Accepted' Condition - /// with a status of `False` in the corresponding RouteParentStatus. - /// - /// - /// If a Route (A) of type HTTPRoute or GRPCRoute is attached to a - /// Listener and that listener already has another Route (B) of the other - /// type attached and the intersection of the hostnames of A and B is - /// non-empty, then the implementation MUST accept exactly one of these two - /// routes, determined by the following criteria, in order: - /// - /// - /// * The oldest Route based on creation timestamp. - /// * The Route appearing first in alphabetical order by - /// "{namespace}/{name}". - /// - /// - /// The rejected Route MUST raise an 'Accepted' condition with a status of - /// 'False' in the corresponding RouteParentStatus. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostnames: Option>, - /// ParentRefs references the resources (usually Gateways) that a Route wants - /// to be attached to. Note that the referenced parent resource needs to - /// allow this for the attachment to be complete. For Gateways, that means - /// the Gateway needs to allow attachment from Routes of this kind and - /// namespace. For Services, that means the Service must either be in the same - /// namespace for a "producer" route, or the mesh implementation must support - /// and allow "consumer" routes for the referenced Service. ReferenceGrant is - /// not applicable for governing ParentRefs to Services - it is not possible to - /// create a "producer" route for a Service in a different namespace from the - /// Route. - /// - /// - /// There are two kinds of parent resources with "Core" support: - /// - /// - /// * Gateway (Gateway conformance profile) - /// - /// * Service (Mesh conformance profile, experimental, ClusterIP Services only) - /// - /// This API may be extended in the future to support additional kinds of parent - /// resources. - /// - /// - /// ParentRefs must be _distinct_. This means either that: - /// - /// - /// * They select different objects. If this is the case, then parentRef - /// entries are distinct. In terms of fields, this means that the - /// multi-part key defined by `group`, `kind`, `namespace`, and `name` must - /// be unique across all parentRef entries in the Route. - /// * They do not select different objects, but for each optional field used, - /// each ParentRef that selects the same object must set the same set of - /// optional fields to different values. If one ParentRef sets a - /// combination of optional fields, all must set the same combination. - /// - /// - /// Some examples: - /// - /// - /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the - /// same object must also set `sectionName`. - /// * If one ParentRef sets `port`, all ParentRefs referencing the same - /// object must also set `port`. - /// * If one ParentRef sets `sectionName` and `port`, all ParentRefs - /// referencing the same object must also set `sectionName` and `port`. - /// - /// - /// It is possible to separately reference multiple distinct objects that may - /// be collapsed by an implementation. For example, some implementations may - /// choose to merge compatible Gateway Listeners together. If that is the - /// case, the list of routes attached to those resources should also be - /// merged. - /// - /// - /// Note that for ParentRefs that cross namespace boundaries, there are specific - /// rules. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example, - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable 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. - /// - /// - /// - /// - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parentRefs")] - pub parent_refs: Option>, - /// Rules are a list of GRPC matchers, filters and actions. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub rules: Option>, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteParentRefs { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - -/// GRPCRouteRule defines the semantics for matching a gRPC request based on -/// conditions (matches), processing it (filters), and forwarding the request to -/// an API object (backendRefs). -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRules { - /// BackendRefs defines the backend(s) where matching requests should be - /// sent. - /// - /// - /// Failure behavior here depends on how many BackendRefs are specified and - /// how many are invalid. - /// - /// - /// If *all* entries in BackendRefs are invalid, and there are also no filters - /// specified in this route rule, *all* traffic which matches this rule MUST - /// receive an `UNAVAILABLE` status. - /// - /// - /// See the GRPCBackendRef definition for the rules about what makes a single - /// GRPCBackendRef invalid. - /// - /// - /// When a GRPCBackendRef is invalid, `UNAVAILABLE` statuses MUST be returned for - /// requests that would have otherwise been routed to an invalid backend. If - /// multiple backends are specified, and some are invalid, the proportion of - /// requests that would otherwise have been routed to an invalid backend - /// MUST receive an `UNAVAILABLE` status. - /// - /// - /// For example, if two backends are specified with equal weights, and one is - /// invalid, 50 percent of traffic MUST receive an `UNAVAILABLE` status. - /// Implementations may choose how that 50 percent is determined. - /// - /// - /// Support: Core for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - /// - /// - /// Support for weight: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRefs")] - pub backend_refs: Option>, - /// Filters define the filters that are applied to requests that match - /// this rule. - /// - /// - /// The effects of ordering of multiple behaviors are currently unspecified. - /// This can change in the future based on feedback during the alpha stage. - /// - /// - /// Conformance-levels at this level are defined based on the type of filter: - /// - /// - /// - ALL core filters MUST be supported by all implementations that support - /// GRPCRoute. - /// - Implementers are encouraged to support extended filters. - /// - Implementation-specific custom filters have no API guarantees across - /// implementations. - /// - /// - /// Specifying the same filter multiple times is not supported unless explicitly - /// indicated in the filter. - /// - /// - /// If an implementation can not support a combination of filters, it must clearly - /// document that limitation. In cases where incompatible or unsupported - /// filters are specified and cause the `Accepted` condition to be set to status - /// `False`, implementations may use the `IncompatibleFilters` reason to specify - /// this configuration error. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub filters: Option>, - /// Matches define conditions used for matching the rule against incoming - /// gRPC requests. Each match is independent, i.e. this rule will be matched - /// if **any** one of the matches is satisfied. - /// - /// - /// For example, take the following matches configuration: - /// - /// - /// ``` - /// matches: - /// - method: - /// service: foo.bar - /// headers: - /// values: - /// version: 2 - /// - method: - /// service: foo.bar.v2 - /// ``` - /// - /// - /// For a request to match against this rule, it MUST satisfy - /// EITHER of the two conditions: - /// - /// - /// - service of foo.bar AND contains the header `version: 2` - /// - service of foo.bar.v2 - /// - /// - /// See the documentation for GRPCRouteMatch on how to specify multiple - /// match conditions to be ANDed together. - /// - /// - /// If no matches are specified, the implementation MUST match every gRPC request. - /// - /// - /// Proxy or Load Balancer routing configuration generated from GRPCRoutes - /// MUST prioritize rules based on the following criteria, continuing on - /// ties. Merging MUST not be done between GRPCRoutes and HTTPRoutes. - /// Precedence MUST be given to the rule with the largest number of: - /// - /// - /// * Characters in a matching non-wildcard hostname. - /// * Characters in a matching hostname. - /// * Characters in a matching service. - /// * Characters in a matching method. - /// * Header matches. - /// - /// - /// If ties still exist across multiple Routes, matching precedence MUST be - /// determined in order of the following criteria, continuing on ties: - /// - /// - /// * The oldest Route based on creation timestamp. - /// * The Route appearing first in alphabetical order by - /// "{namespace}/{name}". - /// - /// - /// If ties still exist within the Route that has been given precedence, - /// matching precedence MUST be granted to the first matching rule meeting - /// the above criteria. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub matches: Option>, -} - -/// GRPCBackendRef defines how a GRPCRoute forwards a gRPC request. -/// -/// -/// Note that when a namespace different than the local namespace is specified, a -/// ReferenceGrant object is required in the referent namespace to allow that -/// namespace's owner to accept the reference. See the ReferenceGrant -/// documentation for details. -/// -/// -/// -/// -/// -/// When the BackendRef points to a Kubernetes Service, implementations SHOULD -/// honor the appProtocol field if it is set for the target Service Port. -/// -/// -/// Implementations supporting appProtocol SHOULD recognize the Kubernetes -/// Standard Application Protocols defined in KEP-3726. -/// -/// -/// If a Service appProtocol isn't specified, an implementation MAY infer the -/// backend protocol through its own means. Implementations MAY infer the -/// protocol from the Route type referring to the backend Service. -/// -/// -/// If a Route is not able to send traffic to the backend using the specified -/// protocol then the backend is considered invalid. Implementations MUST set the -/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. -/// -/// -/// -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefs { - /// Filters defined at this level MUST be executed if and only if the - /// request is being forwarded to the backend defined here. - /// - /// - /// Support: Implementation-specific (For broader support of filters, use the - /// Filters field in GRPCRouteRule.) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub filters: Option>, - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub weight: Option, -} - -/// GRPCRouteFilter defines processing steps that must be completed during the -/// request or response lifecycle. GRPCRouteFilters are meant as an extension -/// point to express processing that may be done in Gateway implementations. Some -/// examples include request or response modification, implementing -/// authentication strategies, rate-limiting, and traffic shaping. API -/// guarantee/conformance is defined based on the type of the filter. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFilters { - /// ExtensionRef is an optional, implementation-specific extension to the - /// "filter" behavior. For example, resource "myroutefilter" in group - /// "networking.example.net"). ExtensionRef MUST NOT be used for core and - /// extended filters. - /// - /// - /// Support: Implementation-specific - /// - /// - /// This filter can be used multiple times within the same rule. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "extensionRef")] - pub extension_ref: Option, - /// RequestHeaderModifier defines a schema for a filter that modifies request - /// headers. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestHeaderModifier")] - pub request_header_modifier: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestMirror")] - pub request_mirror: Option, - /// ResponseHeaderModifier defines a schema for a filter that modifies response - /// headers. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "responseHeaderModifier")] - pub response_header_modifier: Option, - /// Type identifies the type of filter to apply. As with other API fields, - /// types are classified into three conformance levels: - /// - /// - /// - Core: Filter types and their corresponding configuration defined by - /// "Support: Core" in this package, e.g. "RequestHeaderModifier". All - /// implementations supporting GRPCRoute MUST support core filters. - /// - /// - /// - Extended: Filter types and their corresponding configuration defined by - /// "Support: Extended" in this package, e.g. "RequestMirror". Implementers - /// are encouraged to support extended filters. - /// - /// - /// - Implementation-specific: Filters that are defined and supported by specific vendors. - /// In the future, filters showing convergence in behavior across multiple - /// implementations will be considered for inclusion in extended or core - /// conformance levels. Filter-specific configuration for such filters - /// is specified using the ExtensionRef field. `Type` MUST be set to - /// "ExtensionRef" for custom filters. - /// - /// - /// Implementers are encouraged to define custom implementation types to - /// extend the core API with implementation-specific behavior. - /// - /// - /// If a reference to a custom filter type cannot be resolved, the filter - /// MUST NOT be skipped. Instead, requests that would have been processed by - /// that filter MUST receive a HTTP error response. - /// - /// - /// - #[serde(rename = "type")] - pub r#type: GRPCRouteRulesBackendRefsFiltersType, -} - -/// ExtensionRef is an optional, implementation-specific extension to the -/// "filter" behavior. For example, resource "myroutefilter" in group -/// "networking.example.net"). ExtensionRef MUST NOT be used for core and -/// extended filters. -/// -/// -/// Support: Implementation-specific -/// -/// -/// This filter can be used multiple times within the same rule. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersExtensionRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - pub group: String, - /// Kind is kind of the referent. For example "HTTPRoute" or "Service". - pub kind: String, - /// Name is the name of the referent. - pub name: String, -} - -/// RequestHeaderModifier defines a schema for a filter that modifies request -/// headers. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersRequestHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersRequestHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersRequestHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersRequestMirror { - /// BackendRef references a resource where mirrored requests are sent. - /// - /// - /// Mirrored requests must be sent only to a single destination endpoint - /// within this BackendRef, irrespective of how many endpoints are present - /// within this BackendRef. - /// - /// - /// If the referent cannot be found, this BackendRef is invalid and must be - /// dropped from the Gateway. The controller must ensure the "ResolvedRefs" - /// condition on the Route status is set to `status: False` and not configure - /// this backend in the underlying implementation. - /// - /// - /// If there is a cross-namespace reference to an *existing* object - /// that is not allowed by a ReferenceGrant, the controller must ensure the - /// "ResolvedRefs" condition on the Route is set to `status: False`, - /// with the "RefNotPermitted" reason and not configure this backend in the - /// underlying implementation. - /// - /// - /// In either error case, the Message of the `ResolvedRefs` Condition - /// should be used to provide more detail about the problem. - /// - /// - /// Support: Extended for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - #[serde(rename = "backendRef")] - pub backend_ref: GRPCRouteRulesBackendRefsFiltersRequestMirrorBackendRef, -} - -/// BackendRef references a resource where mirrored requests are sent. -/// -/// -/// Mirrored requests must be sent only to a single destination endpoint -/// within this BackendRef, irrespective of how many endpoints are present -/// within this BackendRef. -/// -/// -/// If the referent cannot be found, this BackendRef is invalid and must be -/// dropped from the Gateway. The controller must ensure the "ResolvedRefs" -/// condition on the Route status is set to `status: False` and not configure -/// this backend in the underlying implementation. -/// -/// -/// If there is a cross-namespace reference to an *existing* object -/// that is not allowed by a ReferenceGrant, the controller must ensure the -/// "ResolvedRefs" condition on the Route is set to `status: False`, -/// with the "RefNotPermitted" reason and not configure this backend in the -/// underlying implementation. -/// -/// -/// In either error case, the Message of the `ResolvedRefs` Condition -/// should be used to provide more detail about the problem. -/// -/// -/// Support: Extended for Kubernetes Service -/// -/// -/// Support: Implementation-specific for any other resource -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersRequestMirrorBackendRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, -} - -/// ResponseHeaderModifier defines a schema for a filter that modifies response -/// headers. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersResponseHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersResponseHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesBackendRefsFiltersResponseHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// GRPCRouteFilter defines processing steps that must be completed during the -/// request or response lifecycle. GRPCRouteFilters are meant as an extension -/// point to express processing that may be done in Gateway implementations. Some -/// examples include request or response modification, implementing -/// authentication strategies, rate-limiting, and traffic shaping. API -/// guarantee/conformance is defined based on the type of the filter. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GRPCRouteRulesBackendRefsFiltersType { - ResponseHeaderModifier, - RequestHeaderModifier, - RequestMirror, - ExtensionRef, -} - -/// GRPCRouteFilter defines processing steps that must be completed during the -/// request or response lifecycle. GRPCRouteFilters are meant as an extension -/// point to express processing that may be done in Gateway implementations. Some -/// examples include request or response modification, implementing -/// authentication strategies, rate-limiting, and traffic shaping. API -/// guarantee/conformance is defined based on the type of the filter. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFilters { - /// ExtensionRef is an optional, implementation-specific extension to the - /// "filter" behavior. For example, resource "myroutefilter" in group - /// "networking.example.net"). ExtensionRef MUST NOT be used for core and - /// extended filters. - /// - /// - /// Support: Implementation-specific - /// - /// - /// This filter can be used multiple times within the same rule. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "extensionRef")] - pub extension_ref: Option, - /// RequestHeaderModifier defines a schema for a filter that modifies request - /// headers. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestHeaderModifier")] - pub request_header_modifier: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestMirror")] - pub request_mirror: Option, - /// ResponseHeaderModifier defines a schema for a filter that modifies response - /// headers. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "responseHeaderModifier")] - pub response_header_modifier: Option, - /// Type identifies the type of filter to apply. As with other API fields, - /// types are classified into three conformance levels: - /// - /// - /// - Core: Filter types and their corresponding configuration defined by - /// "Support: Core" in this package, e.g. "RequestHeaderModifier". All - /// implementations supporting GRPCRoute MUST support core filters. - /// - /// - /// - Extended: Filter types and their corresponding configuration defined by - /// "Support: Extended" in this package, e.g. "RequestMirror". Implementers - /// are encouraged to support extended filters. - /// - /// - /// - Implementation-specific: Filters that are defined and supported by specific vendors. - /// In the future, filters showing convergence in behavior across multiple - /// implementations will be considered for inclusion in extended or core - /// conformance levels. Filter-specific configuration for such filters - /// is specified using the ExtensionRef field. `Type` MUST be set to - /// "ExtensionRef" for custom filters. - /// - /// - /// Implementers are encouraged to define custom implementation types to - /// extend the core API with implementation-specific behavior. - /// - /// - /// If a reference to a custom filter type cannot be resolved, the filter - /// MUST NOT be skipped. Instead, requests that would have been processed by - /// that filter MUST receive a HTTP error response. - /// - /// - /// - #[serde(rename = "type")] - pub r#type: GRPCRouteRulesFiltersType, -} - -/// ExtensionRef is an optional, implementation-specific extension to the -/// "filter" behavior. For example, resource "myroutefilter" in group -/// "networking.example.net"). ExtensionRef MUST NOT be used for core and -/// extended filters. -/// -/// -/// Support: Implementation-specific -/// -/// -/// This filter can be used multiple times within the same rule. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersExtensionRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - pub group: String, - /// Kind is kind of the referent. For example "HTTPRoute" or "Service". - pub kind: String, - /// Name is the name of the referent. - pub name: String, -} - -/// RequestHeaderModifier defines a schema for a filter that modifies request -/// headers. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersRequestHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersRequestHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersRequestHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersRequestMirror { - /// BackendRef references a resource where mirrored requests are sent. - /// - /// - /// Mirrored requests must be sent only to a single destination endpoint - /// within this BackendRef, irrespective of how many endpoints are present - /// within this BackendRef. - /// - /// - /// If the referent cannot be found, this BackendRef is invalid and must be - /// dropped from the Gateway. The controller must ensure the "ResolvedRefs" - /// condition on the Route status is set to `status: False` and not configure - /// this backend in the underlying implementation. - /// - /// - /// If there is a cross-namespace reference to an *existing* object - /// that is not allowed by a ReferenceGrant, the controller must ensure the - /// "ResolvedRefs" condition on the Route is set to `status: False`, - /// with the "RefNotPermitted" reason and not configure this backend in the - /// underlying implementation. - /// - /// - /// In either error case, the Message of the `ResolvedRefs` Condition - /// should be used to provide more detail about the problem. - /// - /// - /// Support: Extended for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - #[serde(rename = "backendRef")] - pub backend_ref: GRPCRouteRulesFiltersRequestMirrorBackendRef, -} - -/// BackendRef references a resource where mirrored requests are sent. -/// -/// -/// Mirrored requests must be sent only to a single destination endpoint -/// within this BackendRef, irrespective of how many endpoints are present -/// within this BackendRef. -/// -/// -/// If the referent cannot be found, this BackendRef is invalid and must be -/// dropped from the Gateway. The controller must ensure the "ResolvedRefs" -/// condition on the Route status is set to `status: False` and not configure -/// this backend in the underlying implementation. -/// -/// -/// If there is a cross-namespace reference to an *existing* object -/// that is not allowed by a ReferenceGrant, the controller must ensure the -/// "ResolvedRefs" condition on the Route is set to `status: False`, -/// with the "RefNotPermitted" reason and not configure this backend in the -/// underlying implementation. -/// -/// -/// In either error case, the Message of the `ResolvedRefs` Condition -/// should be used to provide more detail about the problem. -/// -/// -/// Support: Extended for Kubernetes Service -/// -/// -/// Support: Implementation-specific for any other resource -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersRequestMirrorBackendRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, -} - -/// ResponseHeaderModifier defines a schema for a filter that modifies response -/// headers. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersResponseHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersResponseHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesFiltersResponseHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// GRPCRouteFilter defines processing steps that must be completed during the -/// request or response lifecycle. GRPCRouteFilters are meant as an extension -/// point to express processing that may be done in Gateway implementations. Some -/// examples include request or response modification, implementing -/// authentication strategies, rate-limiting, and traffic shaping. API -/// guarantee/conformance is defined based on the type of the filter. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GRPCRouteRulesFiltersType { - ResponseHeaderModifier, - RequestHeaderModifier, - RequestMirror, - ExtensionRef, -} - -/// GRPCRouteMatch defines the predicate used to match requests to a given -/// action. Multiple match types are ANDed together, i.e. the match will -/// evaluate to true only if all conditions are satisfied. -/// -/// -/// For example, the match below will match a gRPC request only if its service -/// is `foo` AND it contains the `version: v1` header: -/// -/// -/// ``` -/// matches: -/// - method: -/// type: Exact -/// service: "foo" -/// headers: -/// - name: "version" -/// value "v1" -/// -/// -/// ``` -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesMatches { - /// Headers specifies gRPC request header matchers. Multiple match values are - /// ANDed together, meaning, a request MUST match all the specified headers - /// to select the route. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub headers: Option>, - /// Method specifies a gRPC request service/method matcher. If this field is - /// not specified, all services and methods will match. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub method: Option, -} - -/// GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request -/// headers. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesMatchesHeaders { - /// Name is the name of the gRPC Header to be matched. - /// - /// - /// If multiple entries specify equivalent header names, only the first - /// entry with an equivalent name MUST be considered for a match. Subsequent - /// entries with an equivalent header name MUST be ignored. Due to the - /// case-insensitivity of header names, "foo" and "Foo" are considered - /// equivalent. - pub name: String, - /// Type specifies how to match against the value of the header. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value is the value of the gRPC Header to be matched. - pub value: String, -} - -/// GRPCHeaderMatch describes how to select a gRPC route by matching gRPC request -/// headers. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GRPCRouteRulesMatchesHeadersType { - Exact, - RegularExpression, -} - -/// Method specifies a gRPC request service/method matcher. If this field is -/// not specified, all services and methods will match. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteRulesMatchesMethod { - /// Value of the method to match against. If left empty or omitted, will - /// match all services. - /// - /// - /// At least one of Service and Method MUST be a non-empty string. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub method: Option, - /// Value of the service to match against. If left empty or omitted, will - /// match any service. - /// - /// - /// At least one of Service and Method MUST be a non-empty string. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub service: Option, - /// Type specifies how to match against the service and/or method. - /// Support: Core (Exact with service and method specified) - /// - /// - /// Support: Implementation-specific (Exact with method specified but no service specified) - /// - /// - /// Support: Implementation-specific (RegularExpression) - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, -} - -/// Method specifies a gRPC request service/method matcher. If this field is -/// not specified, all services and methods will match. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GRPCRouteRulesMatchesMethodType { - Exact, - RegularExpression, -} - -/// Status defines the current state of GRPCRoute. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteStatus { - /// 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. - pub parents: Vec, -} - -/// RouteParentStatus describes the status of a route with respect to an -/// associated Parent. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteStatusParents { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// 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. - #[serde(rename = "controllerName")] - pub controller_name: String, - /// ParentRef corresponds with a ParentRef in the spec that this - /// RouteParentStatus struct describes the status of. - #[serde(rename = "parentRef")] - pub parent_ref: GRPCRouteStatusParentsParentRef, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteStatusParentsConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GRPCRouteStatusParentsConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GRPCRouteStatusParentsConditionsStatus { - True, - False, - Unknown, -} - -/// ParentRef corresponds with a ParentRef in the spec that this -/// RouteParentStatus struct describes the status of. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GRPCRouteStatusParentsParentRef { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - diff --git a/src/apis/experimental/httproutes.rs b/src/apis/experimental/httproutes.rs deleted file mode 100644 index 89f2fbf..0000000 --- a/src/apis/experimental/httproutes.rs +++ /dev/null @@ -1,2650 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of HTTPRoute. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1", kind = "HTTPRoute", plural = "httproutes")] -#[kube(namespaced)] -#[kube(status = "HTTPRouteStatus")] -pub struct HTTPRouteSpec { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostnames: Option>, - /// ParentRefs references the resources (usually Gateways) that a Route wants - /// to be attached to. Note that the referenced parent resource needs to - /// allow this for the attachment to be complete. For Gateways, that means - /// the Gateway needs to allow attachment from Routes of this kind and - /// namespace. For Services, that means the Service must either be in the same - /// namespace for a "producer" route, or the mesh implementation must support - /// and allow "consumer" routes for the referenced Service. ReferenceGrant is - /// not applicable for governing ParentRefs to Services - it is not possible to - /// create a "producer" route for a Service in a different namespace from the - /// Route. - /// - /// - /// There are two kinds of parent resources with "Core" support: - /// - /// - /// * Gateway (Gateway conformance profile) - /// - /// * Service (Mesh conformance profile, experimental, ClusterIP Services only) - /// - /// This API may be extended in the future to support additional kinds of parent - /// resources. - /// - /// - /// ParentRefs must be _distinct_. This means either that: - /// - /// - /// * They select different objects. If this is the case, then parentRef - /// entries are distinct. In terms of fields, this means that the - /// multi-part key defined by `group`, `kind`, `namespace`, and `name` must - /// be unique across all parentRef entries in the Route. - /// * They do not select different objects, but for each optional field used, - /// each ParentRef that selects the same object must set the same set of - /// optional fields to different values. If one ParentRef sets a - /// combination of optional fields, all must set the same combination. - /// - /// - /// Some examples: - /// - /// - /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the - /// same object must also set `sectionName`. - /// * If one ParentRef sets `port`, all ParentRefs referencing the same - /// object must also set `port`. - /// * If one ParentRef sets `sectionName` and `port`, all ParentRefs - /// referencing the same object must also set `sectionName` and `port`. - /// - /// - /// It is possible to separately reference multiple distinct objects that may - /// be collapsed by an implementation. For example, some implementations may - /// choose to merge compatible Gateway Listeners together. If that is the - /// case, the list of routes attached to those resources should also be - /// merged. - /// - /// - /// Note that for ParentRefs that cross namespace boundaries, there are specific - /// rules. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example, - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable 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. - /// - /// - /// - /// - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parentRefs")] - pub parent_refs: Option>, - /// Rules are a list of HTTP matchers, filters and actions. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub rules: Option>, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteParentRefs { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - -/// HTTPRouteRule defines semantics for matching an HTTP request based on -/// conditions (matches), processing it (filters), and forwarding the request to -/// an API object (backendRefs). -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRules { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRefs")] - pub backend_refs: Option>, - /// Filters define the filters that are applied to requests that match - /// this rule. - /// - /// - /// Wherever possible, implementations SHOULD implement filters in the order - /// they are specified. - /// - /// - /// Implementations MAY choose to implement this ordering strictly, rejecting - /// any combination or order of filters that can not be supported. If implementations - /// choose a strict interpretation of filter ordering, they MUST clearly document - /// that behavior. - /// - /// - /// To reject an invalid combination or order of filters, implementations SHOULD - /// consider the Route Rules with this configuration invalid. If all Route Rules - /// in a Route are invalid, the entire Route would be considered invalid. If only - /// a portion of Route Rules are invalid, implementations MUST set the - /// "PartiallyInvalid" condition for the Route. - /// - /// - /// Conformance-levels at this level are defined based on the type of filter: - /// - /// - /// - ALL core filters MUST be supported by all implementations. - /// - Implementers are encouraged to support extended filters. - /// - Implementation-specific custom filters have no API guarantees across - /// implementations. - /// - /// - /// Specifying the same filter multiple times is not supported unless explicitly - /// indicated in the filter. - /// - /// - /// All filters are expected to be compatible with each other except for the - /// URLRewrite and RequestRedirect filters, which may not be combined. If an - /// implementation can not support other combinations of filters, they must clearly - /// document that limitation. In cases where incompatible or unsupported - /// filters are specified and cause the `Accepted` condition to be set to status - /// `False`, implementations may use the `IncompatibleFilters` reason to specify - /// this configuration error. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub filters: Option>, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub matches: Option>, - /// Timeouts defines the timeouts that can be configured for an HTTP request. - /// - /// - /// Support: Extended - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub timeouts: Option, -} - -/// HTTPBackendRef defines how a HTTPRoute forwards a HTTP request. -/// -/// -/// Note that when a namespace different than the local namespace is specified, a -/// ReferenceGrant object is required in the referent namespace to allow that -/// namespace's owner to accept the reference. See the ReferenceGrant -/// documentation for details. -/// -/// -/// -/// -/// -/// When the BackendRef points to a Kubernetes Service, implementations SHOULD -/// honor the appProtocol field if it is set for the target Service Port. -/// -/// -/// Implementations supporting appProtocol SHOULD recognize the Kubernetes -/// Standard Application Protocols defined in KEP-3726. -/// -/// -/// If a Service appProtocol isn't specified, an implementation MAY infer the -/// backend protocol through its own means. Implementations MAY infer the -/// protocol from the Route type referring to the backend Service. -/// -/// -/// If a Route is not able to send traffic to the backend using the specified -/// protocol then the backend is considered invalid. Implementations MUST set the -/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. -/// -/// -/// -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefs { - /// 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.) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub filters: Option>, - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub weight: Option, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFilters { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "extensionRef")] - pub extension_ref: Option, - /// RequestHeaderModifier defines a schema for a filter that modifies request - /// headers. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestHeaderModifier")] - pub request_header_modifier: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestMirror")] - pub request_mirror: Option, - /// RequestRedirect defines a schema for a filter that responds to the - /// request with an HTTP redirection. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestRedirect")] - pub request_redirect: Option, - /// ResponseHeaderModifier defines a schema for a filter that modifies response - /// headers. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "responseHeaderModifier")] - pub response_header_modifier: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesBackendRefsFiltersType, - /// URLRewrite defines a schema for a filter that modifies a request during forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "urlRewrite")] - pub url_rewrite: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersExtensionRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - pub group: String, - /// Kind is kind of the referent. For example "HTTPRoute" or "Service". - pub kind: String, - /// Name is the name of the referent. - pub name: String, -} - -/// RequestHeaderModifier defines a schema for a filter that modifies request -/// headers. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestMirror { - /// BackendRef references a resource where mirrored requests are sent. - /// - /// - /// Mirrored requests must be sent only to a single destination endpoint - /// within this BackendRef, irrespective of how many endpoints are present - /// within this BackendRef. - /// - /// - /// If the referent cannot be found, this BackendRef is invalid and must be - /// dropped from the Gateway. The controller must ensure the "ResolvedRefs" - /// condition on the Route status is set to `status: False` and not configure - /// this backend in the underlying implementation. - /// - /// - /// If there is a cross-namespace reference to an *existing* object - /// that is not allowed by a ReferenceGrant, the controller must ensure the - /// "ResolvedRefs" condition on the Route is set to `status: False`, - /// with the "RefNotPermitted" reason and not configure this backend in the - /// underlying implementation. - /// - /// - /// In either error case, the Message of the `ResolvedRefs` Condition - /// should be used to provide more detail about the problem. - /// - /// - /// Support: Extended for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - #[serde(rename = "backendRef")] - pub backend_ref: HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef, -} - -/// BackendRef references a resource where mirrored requests are sent. -/// -/// -/// Mirrored requests must be sent only to a single destination endpoint -/// within this BackendRef, irrespective of how many endpoints are present -/// within this BackendRef. -/// -/// -/// If the referent cannot be found, this BackendRef is invalid and must be -/// dropped from the Gateway. The controller must ensure the "ResolvedRefs" -/// condition on the Route status is set to `status: False` and not configure -/// this backend in the underlying implementation. -/// -/// -/// If there is a cross-namespace reference to an *existing* object -/// that is not allowed by a ReferenceGrant, the controller must ensure the -/// "ResolvedRefs" condition on the Route is set to `status: False`, -/// with the "RefNotPermitted" reason and not configure this backend in the -/// underlying implementation. -/// -/// -/// In either error case, the Message of the `ResolvedRefs` Condition -/// should be used to provide more detail about the problem. -/// -/// -/// Support: Extended for Kubernetes Service -/// -/// -/// Support: Implementation-specific for any other resource -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirect { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub scheme: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "statusCode")] - pub status_code: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirectPath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectScheme { - #[serde(rename = "http")] - Http, - #[serde(rename = "https")] - Https, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectStatusCode { - #[serde(rename = "301")] - r#_301, - #[serde(rename = "302")] - r#_302, -} - -/// ResponseHeaderModifier defines a schema for a filter that modifies response -/// headers. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersType { - RequestHeaderModifier, - ResponseHeaderModifier, - RequestMirror, - RequestRedirect, - #[serde(rename = "URLRewrite")] - UrlRewrite, - ExtensionRef, -} - -/// URLRewrite defines a schema for a filter that modifies a request during forwarding. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersUrlRewrite { - /// Hostname is the value to be used to replace the Host header value during - /// forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// Path defines a path rewrite. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersUrlRewritePath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesBackendRefsFiltersUrlRewritePathType, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersUrlRewritePathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFilters { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "extensionRef")] - pub extension_ref: Option, - /// RequestHeaderModifier defines a schema for a filter that modifies request - /// headers. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestHeaderModifier")] - pub request_header_modifier: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestMirror")] - pub request_mirror: Option, - /// RequestRedirect defines a schema for a filter that responds to the - /// request with an HTTP redirection. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestRedirect")] - pub request_redirect: Option, - /// ResponseHeaderModifier defines a schema for a filter that modifies response - /// headers. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "responseHeaderModifier")] - pub response_header_modifier: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesFiltersType, - /// URLRewrite defines a schema for a filter that modifies a request during forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "urlRewrite")] - pub url_rewrite: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersExtensionRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - pub group: String, - /// Kind is kind of the referent. For example "HTTPRoute" or "Service". - pub kind: String, - /// Name is the name of the referent. - pub name: String, -} - -/// RequestHeaderModifier defines a schema for a filter that modifies request -/// headers. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestMirror { - /// BackendRef references a resource where mirrored requests are sent. - /// - /// - /// Mirrored requests must be sent only to a single destination endpoint - /// within this BackendRef, irrespective of how many endpoints are present - /// within this BackendRef. - /// - /// - /// If the referent cannot be found, this BackendRef is invalid and must be - /// dropped from the Gateway. The controller must ensure the "ResolvedRefs" - /// condition on the Route status is set to `status: False` and not configure - /// this backend in the underlying implementation. - /// - /// - /// If there is a cross-namespace reference to an *existing* object - /// that is not allowed by a ReferenceGrant, the controller must ensure the - /// "ResolvedRefs" condition on the Route is set to `status: False`, - /// with the "RefNotPermitted" reason and not configure this backend in the - /// underlying implementation. - /// - /// - /// In either error case, the Message of the `ResolvedRefs` Condition - /// should be used to provide more detail about the problem. - /// - /// - /// Support: Extended for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - #[serde(rename = "backendRef")] - pub backend_ref: HTTPRouteRulesFiltersRequestMirrorBackendRef, -} - -/// BackendRef references a resource where mirrored requests are sent. -/// -/// -/// Mirrored requests must be sent only to a single destination endpoint -/// within this BackendRef, irrespective of how many endpoints are present -/// within this BackendRef. -/// -/// -/// If the referent cannot be found, this BackendRef is invalid and must be -/// dropped from the Gateway. The controller must ensure the "ResolvedRefs" -/// condition on the Route status is set to `status: False` and not configure -/// this backend in the underlying implementation. -/// -/// -/// If there is a cross-namespace reference to an *existing* object -/// that is not allowed by a ReferenceGrant, the controller must ensure the -/// "ResolvedRefs" condition on the Route is set to `status: False`, -/// with the "RefNotPermitted" reason and not configure this backend in the -/// underlying implementation. -/// -/// -/// In either error case, the Message of the `ResolvedRefs` Condition -/// should be used to provide more detail about the problem. -/// -/// -/// Support: Extended for Kubernetes Service -/// -/// -/// Support: Implementation-specific for any other resource -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestMirrorBackendRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestRedirect { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub scheme: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "statusCode")] - pub status_code: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestRedirectPath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesFiltersRequestRedirectPathType, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersRequestRedirectPathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersRequestRedirectScheme { - #[serde(rename = "http")] - Http, - #[serde(rename = "https")] - Https, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersRequestRedirectStatusCode { - #[serde(rename = "301")] - r#_301, - #[serde(rename = "302")] - r#_302, -} - -/// ResponseHeaderModifier defines a schema for a filter that modifies response -/// headers. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersResponseHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersResponseHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersResponseHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersType { - RequestHeaderModifier, - ResponseHeaderModifier, - RequestMirror, - RequestRedirect, - #[serde(rename = "URLRewrite")] - UrlRewrite, - ExtensionRef, -} - -/// URLRewrite defines a schema for a filter that modifies a request during forwarding. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersUrlRewrite { - /// Hostname is the value to be used to replace the Host header value during - /// forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// Path defines a path rewrite. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersUrlRewritePath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesFiltersUrlRewritePathType, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersUrlRewritePathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// 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" -/// -/// -/// ``` -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatches { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub headers: Option>, - /// Method specifies HTTP method matcher. - /// When specified, this route will be matched only if the request has the - /// specified method. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub method: Option, - /// Path specifies a HTTP request path matcher. If this field is not - /// specified, a default prefix match on the "/" path is provided. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "queryParams")] - pub query_params: Option>, -} - -/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request -/// headers. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatchesHeaders { - /// 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". - pub name: String, - /// Type specifies how to match against the value of the header. - /// - /// - /// Support: Core (Exact) - /// - /// - /// Support: Implementation-specific (RegularExpression) - /// - /// - /// Since RegularExpression HeaderMatchType has implementation-specific - /// conformance, implementations can support POSIX, PCRE or any other dialects - /// of regular expressions. Please read the implementation's documentation to - /// determine the supported dialect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request -/// headers. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesHeadersType { - Exact, - RegularExpression, -} - -/// 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" -/// -/// -/// ``` -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesMethod { - #[serde(rename = "GET")] - Get, - #[serde(rename = "HEAD")] - Head, - #[serde(rename = "POST")] - Post, - #[serde(rename = "PUT")] - Put, - #[serde(rename = "DELETE")] - Delete, - #[serde(rename = "CONNECT")] - Connect, - #[serde(rename = "OPTIONS")] - Options, - #[serde(rename = "TRACE")] - Trace, - #[serde(rename = "PATCH")] - Patch, -} - -/// Path specifies a HTTP request path matcher. If this field is not -/// specified, a default prefix match on the "/" path is provided. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatchesPath { - /// Type specifies how to match against the path Value. - /// - /// - /// Support: Core (Exact, PathPrefix) - /// - /// - /// Support: Implementation-specific (RegularExpression) - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value of the HTTP path to match against. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub value: Option, -} - -/// Path specifies a HTTP request path matcher. If this field is not -/// specified, a default prefix match on the "/" path is provided. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesPathType { - Exact, - PathPrefix, - RegularExpression, -} - -/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP -/// query parameters. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatchesQueryParams { - /// 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. - pub name: String, - /// Type specifies how to match against the value of the query parameter. - /// - /// - /// Support: Extended (Exact) - /// - /// - /// Support: Implementation-specific (RegularExpression) - /// - /// - /// Since RegularExpression QueryParamMatchType has Implementation-specific - /// conformance, implementations can support POSIX, PCRE or any other - /// dialects of regular expressions. Please read the implementation's - /// documentation to determine the supported dialect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value is the value of HTTP query param to be matched. - pub value: String, -} - -/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP -/// query parameters. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesQueryParamsType { - Exact, - RegularExpression, -} - -/// Timeouts defines the timeouts that can be configured for an HTTP request. -/// -/// -/// Support: Extended -/// -/// -/// -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesTimeouts { - /// BackendRequest specifies a timeout for an individual request from the gateway - /// to a backend. This covers the time from when the request first starts being - /// sent from the gateway to when the full response has been received from the backend. - /// - /// - /// An entire client HTTP transaction with a gateway, covered by the Request timeout, - /// may result in more than one call from the gateway to the destination backend, - /// for example, if automatic retries are supported. - /// - /// - /// Because the Request timeout encompasses the BackendRequest timeout, the value of - /// BackendRequest must be <= the value of Request timeout. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRequest")] - pub backend_request: Option, - /// Request specifies the maximum duration for a gateway to respond to an HTTP request. - /// If the gateway has not been able to respond before this deadline is met, the gateway - /// MUST return a timeout error. - /// - /// - /// For example, setting the `rules.timeouts.request` field to the value `10s` in an - /// `HTTPRoute` will cause a timeout if a client request is taking longer than 10 seconds - /// to complete. - /// - /// - /// This timeout is intended to cover as close to the whole request-response transaction - /// as possible although an implementation MAY choose to start the timeout after the entire - /// request stream has been received instead of immediately after the transaction is - /// initiated by the client. - /// - /// - /// When this field is unspecified, request timeout behavior is implementation-specific. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub request: Option, -} - -/// Status defines the current state of HTTPRoute. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatus { - /// 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. - pub parents: Vec, -} - -/// RouteParentStatus describes the status of a route with respect to an -/// associated Parent. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatusParents { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// 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. - #[serde(rename = "controllerName")] - pub controller_name: String, - /// ParentRef corresponds with a ParentRef in the spec that this - /// RouteParentStatus struct describes the status of. - #[serde(rename = "parentRef")] - pub parent_ref: HTTPRouteStatusParentsParentRef, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatusParentsConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: HTTPRouteStatusParentsConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteStatusParentsConditionsStatus { - True, - False, - Unknown, -} - -/// ParentRef corresponds with a ParentRef in the spec that this -/// RouteParentStatus struct describes the status of. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatusParentsParentRef { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - diff --git a/src/apis/experimental/referencegrants.rs b/src/apis/experimental/referencegrants.rs deleted file mode 100644 index 73bd5cf..0000000 --- a/src/apis/experimental/referencegrants.rs +++ /dev/null @@ -1,92 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of ReferenceGrant. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1beta1", kind = "ReferenceGrant", plural = "referencegrants")] -#[kube(namespaced)] -pub struct ReferenceGrantSpec { - /// 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 - pub from: Vec, - /// 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 - pub to: Vec, -} - -/// ReferenceGrantFrom describes trusted namespaces and kinds. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct ReferenceGrantFrom { - /// Group is the group of the referent. - /// When empty, the Kubernetes core API group is inferred. - /// - /// - /// Support: Core - pub group: String, - /// 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 - pub kind: String, - /// Namespace is the namespace of the referent. - /// - /// - /// Support: Core - pub namespace: String, -} - -/// ReferenceGrantTo describes what Kinds are allowed as targets of the -/// references. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct ReferenceGrantTo { - /// Group is the group of the referent. - /// When empty, the Kubernetes core API group is inferred. - /// - /// - /// Support: Core - pub group: String, - /// 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 - pub kind: String, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub name: Option, -} - diff --git a/src/apis/experimental/tcproutes.rs b/src/apis/experimental/tcproutes.rs deleted file mode 100644 index a3e8647..0000000 --- a/src/apis/experimental/tcproutes.rs +++ /dev/null @@ -1,654 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of TCPRoute. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1alpha2", kind = "TCPRoute", plural = "tcproutes")] -#[kube(namespaced)] -#[kube(status = "TCPRouteStatus")] -pub struct TCPRouteSpec { - /// ParentRefs references the resources (usually Gateways) that a Route wants - /// to be attached to. Note that the referenced parent resource needs to - /// allow this for the attachment to be complete. For Gateways, that means - /// the Gateway needs to allow attachment from Routes of this kind and - /// namespace. For Services, that means the Service must either be in the same - /// namespace for a "producer" route, or the mesh implementation must support - /// and allow "consumer" routes for the referenced Service. ReferenceGrant is - /// not applicable for governing ParentRefs to Services - it is not possible to - /// create a "producer" route for a Service in a different namespace from the - /// Route. - /// - /// - /// There are two kinds of parent resources with "Core" support: - /// - /// - /// * Gateway (Gateway conformance profile) - /// - /// * Service (Mesh conformance profile, experimental, ClusterIP Services only) - /// - /// This API may be extended in the future to support additional kinds of parent - /// resources. - /// - /// - /// ParentRefs must be _distinct_. This means either that: - /// - /// - /// * They select different objects. If this is the case, then parentRef - /// entries are distinct. In terms of fields, this means that the - /// multi-part key defined by `group`, `kind`, `namespace`, and `name` must - /// be unique across all parentRef entries in the Route. - /// * They do not select different objects, but for each optional field used, - /// each ParentRef that selects the same object must set the same set of - /// optional fields to different values. If one ParentRef sets a - /// combination of optional fields, all must set the same combination. - /// - /// - /// Some examples: - /// - /// - /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the - /// same object must also set `sectionName`. - /// * If one ParentRef sets `port`, all ParentRefs referencing the same - /// object must also set `port`. - /// * If one ParentRef sets `sectionName` and `port`, all ParentRefs - /// referencing the same object must also set `sectionName` and `port`. - /// - /// - /// It is possible to separately reference multiple distinct objects that may - /// be collapsed by an implementation. For example, some implementations may - /// choose to merge compatible Gateway Listeners together. If that is the - /// case, the list of routes attached to those resources should also be - /// merged. - /// - /// - /// Note that for ParentRefs that cross namespace boundaries, there are specific - /// rules. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example, - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable 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. - /// - /// - /// - /// - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parentRefs")] - pub parent_refs: Option>, - /// Rules are a list of TCP matchers and actions. - pub rules: Vec, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteParentRefs { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - -/// TCPRouteRule is the configuration for a given rule. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteRules { - /// BackendRefs defines the backend(s) where matching requests should be - /// sent. If unspecified or invalid (refers to a non-existent resource or a - /// Service with no endpoints), the underlying implementation MUST actively - /// reject connection attempts to this backend. Connection rejections must - /// respect weight; if an invalid backend is requested to have 80% of - /// connections, then 80% of connections must be rejected instead. - /// - /// - /// Support: Core for Kubernetes Service - /// - /// - /// Support: Extended for Kubernetes ServiceImport - /// - /// - /// Support: Implementation-specific for any other resource - /// - /// - /// Support for weight: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRefs")] - pub backend_refs: Option>, -} - -/// BackendRef defines how a Route should forward a request to a Kubernetes -/// resource. -/// -/// -/// Note that when a namespace different than the local namespace is specified, a -/// ReferenceGrant object is required in the referent namespace to allow that -/// namespace's owner to accept the reference. See the ReferenceGrant -/// documentation for details. -/// -/// -/// -/// -/// -/// When the BackendRef points to a Kubernetes Service, implementations SHOULD -/// honor the appProtocol field if it is set for the target Service Port. -/// -/// -/// Implementations supporting appProtocol SHOULD recognize the Kubernetes -/// Standard Application Protocols defined in KEP-3726. -/// -/// -/// If a Service appProtocol isn't specified, an implementation MAY infer the -/// backend protocol through its own means. Implementations MAY infer the -/// protocol from the Route type referring to the backend Service. -/// -/// -/// If a Route is not able to send traffic to the backend using the specified -/// protocol then the backend is considered invalid. Implementations MUST set the -/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. -/// -/// -/// -/// -/// -/// Note that when the BackendTLSPolicy object is enabled by the implementation, -/// there are some extra rules about validity to consider here. See the fields -/// where this struct is used for more information about the exact behavior. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteRulesBackendRefs { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub weight: Option, -} - -/// Status defines the current state of TCPRoute. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteStatus { - /// 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. - pub parents: Vec, -} - -/// RouteParentStatus describes the status of a route with respect to an -/// associated Parent. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteStatusParents { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// 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. - #[serde(rename = "controllerName")] - pub controller_name: String, - /// ParentRef corresponds with a ParentRef in the spec that this - /// RouteParentStatus struct describes the status of. - #[serde(rename = "parentRef")] - pub parent_ref: TCPRouteStatusParentsParentRef, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteStatusParentsConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: TCPRouteStatusParentsConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum TCPRouteStatusParentsConditionsStatus { - True, - False, - Unknown, -} - -/// ParentRef corresponds with a ParentRef in the spec that this -/// RouteParentStatus struct describes the status of. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TCPRouteStatusParentsParentRef { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - diff --git a/src/apis/experimental/tlsroutes.rs b/src/apis/experimental/tlsroutes.rs deleted file mode 100644 index 5eea252..0000000 --- a/src/apis/experimental/tlsroutes.rs +++ /dev/null @@ -1,698 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of TLSRoute. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1alpha2", kind = "TLSRoute", plural = "tlsroutes")] -#[kube(namespaced)] -#[kube(status = "TLSRouteStatus")] -pub struct TLSRouteSpec { - /// Hostnames defines a set of SNI names that should match against the - /// SNI attribute of TLS ClientHello message in TLS handshake. This matches - /// the RFC 1123 definition of a hostname with 2 notable exceptions: - /// - /// - /// 1. IPs are not allowed in SNI names per RFC 6066. - /// 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard - /// label must appear by itself as the first label. - /// - /// - /// If a hostname is specified by both the Listener and TLSRoute, there - /// must be at least one intersecting hostname for the TLSRoute to be - /// attached to the Listener. For example: - /// - /// - /// * A Listener with `test.example.com` as the hostname matches TLSRoutes - /// that have either not specified any hostnames, or have specified at - /// least one of `test.example.com` or `*.example.com`. - /// * A Listener with `*.example.com` as the hostname matches TLSRoutes - /// that have either not specified any hostnames or have specified at least - /// one hostname that matches the Listener hostname. For example, - /// `test.example.com` and `*.example.com` would both match. On the other - /// hand, `example.com` and `test.example.net` would not match. - /// - /// - /// If both the Listener and TLSRoute have specified hostnames, any - /// TLSRoute hostnames that do not match the Listener hostname MUST be - /// ignored. For example, if a Listener specified `*.example.com`, and the - /// TLSRoute specified `test.example.com` and `test.example.net`, - /// `test.example.net` must not be considered for a match. - /// - /// - /// If both the Listener and TLSRoute have specified hostnames, and none - /// match with the criteria above, then the TLSRoute is not accepted. The - /// implementation must raise an 'Accepted' Condition with a status of - /// `False` in the corresponding RouteParentStatus. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostnames: Option>, - /// ParentRefs references the resources (usually Gateways) that a Route wants - /// to be attached to. Note that the referenced parent resource needs to - /// allow this for the attachment to be complete. For Gateways, that means - /// the Gateway needs to allow attachment from Routes of this kind and - /// namespace. For Services, that means the Service must either be in the same - /// namespace for a "producer" route, or the mesh implementation must support - /// and allow "consumer" routes for the referenced Service. ReferenceGrant is - /// not applicable for governing ParentRefs to Services - it is not possible to - /// create a "producer" route for a Service in a different namespace from the - /// Route. - /// - /// - /// There are two kinds of parent resources with "Core" support: - /// - /// - /// * Gateway (Gateway conformance profile) - /// - /// * Service (Mesh conformance profile, experimental, ClusterIP Services only) - /// - /// This API may be extended in the future to support additional kinds of parent - /// resources. - /// - /// - /// ParentRefs must be _distinct_. This means either that: - /// - /// - /// * They select different objects. If this is the case, then parentRef - /// entries are distinct. In terms of fields, this means that the - /// multi-part key defined by `group`, `kind`, `namespace`, and `name` must - /// be unique across all parentRef entries in the Route. - /// * They do not select different objects, but for each optional field used, - /// each ParentRef that selects the same object must set the same set of - /// optional fields to different values. If one ParentRef sets a - /// combination of optional fields, all must set the same combination. - /// - /// - /// Some examples: - /// - /// - /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the - /// same object must also set `sectionName`. - /// * If one ParentRef sets `port`, all ParentRefs referencing the same - /// object must also set `port`. - /// * If one ParentRef sets `sectionName` and `port`, all ParentRefs - /// referencing the same object must also set `sectionName` and `port`. - /// - /// - /// It is possible to separately reference multiple distinct objects that may - /// be collapsed by an implementation. For example, some implementations may - /// choose to merge compatible Gateway Listeners together. If that is the - /// case, the list of routes attached to those resources should also be - /// merged. - /// - /// - /// Note that for ParentRefs that cross namespace boundaries, there are specific - /// rules. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example, - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable 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. - /// - /// - /// - /// - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parentRefs")] - pub parent_refs: Option>, - /// Rules are a list of TLS matchers and actions. - pub rules: Vec, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteParentRefs { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - -/// TLSRouteRule is the configuration for a given rule. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteRules { - /// BackendRefs defines the backend(s) where matching requests should be - /// sent. If unspecified or invalid (refers to a non-existent resource or - /// a Service with no endpoints), the rule performs no forwarding; if no - /// filters are specified that would result in a response being sent, the - /// underlying implementation must actively reject request attempts to this - /// backend, by rejecting the connection or returning a 500 status code. - /// Request rejections must respect weight; if an invalid backend is - /// requested to have 80% of requests, then 80% of requests must be rejected - /// instead. - /// - /// - /// Support: Core for Kubernetes Service - /// - /// - /// Support: Extended for Kubernetes ServiceImport - /// - /// - /// Support: Implementation-specific for any other resource - /// - /// - /// Support for weight: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRefs")] - pub backend_refs: Option>, -} - -/// BackendRef defines how a Route should forward a request to a Kubernetes -/// resource. -/// -/// -/// Note that when a namespace different than the local namespace is specified, a -/// ReferenceGrant object is required in the referent namespace to allow that -/// namespace's owner to accept the reference. See the ReferenceGrant -/// documentation for details. -/// -/// -/// -/// -/// -/// When the BackendRef points to a Kubernetes Service, implementations SHOULD -/// honor the appProtocol field if it is set for the target Service Port. -/// -/// -/// Implementations supporting appProtocol SHOULD recognize the Kubernetes -/// Standard Application Protocols defined in KEP-3726. -/// -/// -/// If a Service appProtocol isn't specified, an implementation MAY infer the -/// backend protocol through its own means. Implementations MAY infer the -/// protocol from the Route type referring to the backend Service. -/// -/// -/// If a Route is not able to send traffic to the backend using the specified -/// protocol then the backend is considered invalid. Implementations MUST set the -/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. -/// -/// -/// -/// -/// -/// Note that when the BackendTLSPolicy object is enabled by the implementation, -/// there are some extra rules about validity to consider here. See the fields -/// where this struct is used for more information about the exact behavior. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteRulesBackendRefs { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub weight: Option, -} - -/// Status defines the current state of TLSRoute. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteStatus { - /// 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. - pub parents: Vec, -} - -/// RouteParentStatus describes the status of a route with respect to an -/// associated Parent. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteStatusParents { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// 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. - #[serde(rename = "controllerName")] - pub controller_name: String, - /// ParentRef corresponds with a ParentRef in the spec that this - /// RouteParentStatus struct describes the status of. - #[serde(rename = "parentRef")] - pub parent_ref: TLSRouteStatusParentsParentRef, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteStatusParentsConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: TLSRouteStatusParentsConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum TLSRouteStatusParentsConditionsStatus { - True, - False, - Unknown, -} - -/// ParentRef corresponds with a ParentRef in the spec that this -/// RouteParentStatus struct describes the status of. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct TLSRouteStatusParentsParentRef { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - diff --git a/src/apis/experimental/udproutes.rs b/src/apis/experimental/udproutes.rs deleted file mode 100644 index f882f74..0000000 --- a/src/apis/experimental/udproutes.rs +++ /dev/null @@ -1,654 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of UDPRoute. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1alpha2", kind = "UDPRoute", plural = "udproutes")] -#[kube(namespaced)] -#[kube(status = "UDPRouteStatus")] -pub struct UDPRouteSpec { - /// ParentRefs references the resources (usually Gateways) that a Route wants - /// to be attached to. Note that the referenced parent resource needs to - /// allow this for the attachment to be complete. For Gateways, that means - /// the Gateway needs to allow attachment from Routes of this kind and - /// namespace. For Services, that means the Service must either be in the same - /// namespace for a "producer" route, or the mesh implementation must support - /// and allow "consumer" routes for the referenced Service. ReferenceGrant is - /// not applicable for governing ParentRefs to Services - it is not possible to - /// create a "producer" route for a Service in a different namespace from the - /// Route. - /// - /// - /// There are two kinds of parent resources with "Core" support: - /// - /// - /// * Gateway (Gateway conformance profile) - /// - /// * Service (Mesh conformance profile, experimental, ClusterIP Services only) - /// - /// This API may be extended in the future to support additional kinds of parent - /// resources. - /// - /// - /// ParentRefs must be _distinct_. This means either that: - /// - /// - /// * They select different objects. If this is the case, then parentRef - /// entries are distinct. In terms of fields, this means that the - /// multi-part key defined by `group`, `kind`, `namespace`, and `name` must - /// be unique across all parentRef entries in the Route. - /// * They do not select different objects, but for each optional field used, - /// each ParentRef that selects the same object must set the same set of - /// optional fields to different values. If one ParentRef sets a - /// combination of optional fields, all must set the same combination. - /// - /// - /// Some examples: - /// - /// - /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the - /// same object must also set `sectionName`. - /// * If one ParentRef sets `port`, all ParentRefs referencing the same - /// object must also set `port`. - /// * If one ParentRef sets `sectionName` and `port`, all ParentRefs - /// referencing the same object must also set `sectionName` and `port`. - /// - /// - /// It is possible to separately reference multiple distinct objects that may - /// be collapsed by an implementation. For example, some implementations may - /// choose to merge compatible Gateway Listeners together. If that is the - /// case, the list of routes attached to those resources should also be - /// merged. - /// - /// - /// Note that for ParentRefs that cross namespace boundaries, there are specific - /// rules. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example, - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable 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. - /// - /// - /// - /// - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parentRefs")] - pub parent_refs: Option>, - /// Rules are a list of UDP matchers and actions. - pub rules: Vec, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteParentRefs { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - -/// UDPRouteRule is the configuration for a given rule. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteRules { - /// BackendRefs defines the backend(s) where matching requests should be - /// sent. If unspecified or invalid (refers to a non-existent resource or a - /// Service with no endpoints), the underlying implementation MUST actively - /// reject connection attempts to this backend. Packet drops must - /// respect weight; if an invalid backend is requested to have 80% of - /// the packets, then 80% of packets must be dropped instead. - /// - /// - /// Support: Core for Kubernetes Service - /// - /// - /// Support: Extended for Kubernetes ServiceImport - /// - /// - /// Support: Implementation-specific for any other resource - /// - /// - /// Support for weight: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRefs")] - pub backend_refs: Option>, -} - -/// BackendRef defines how a Route should forward a request to a Kubernetes -/// resource. -/// -/// -/// Note that when a namespace different than the local namespace is specified, a -/// ReferenceGrant object is required in the referent namespace to allow that -/// namespace's owner to accept the reference. See the ReferenceGrant -/// documentation for details. -/// -/// -/// -/// -/// -/// When the BackendRef points to a Kubernetes Service, implementations SHOULD -/// honor the appProtocol field if it is set for the target Service Port. -/// -/// -/// Implementations supporting appProtocol SHOULD recognize the Kubernetes -/// Standard Application Protocols defined in KEP-3726. -/// -/// -/// If a Service appProtocol isn't specified, an implementation MAY infer the -/// backend protocol through its own means. Implementations MAY infer the -/// protocol from the Route type referring to the backend Service. -/// -/// -/// If a Route is not able to send traffic to the backend using the specified -/// protocol then the backend is considered invalid. Implementations MUST set the -/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. -/// -/// -/// -/// -/// -/// Note that when the BackendTLSPolicy object is enabled by the implementation, -/// there are some extra rules about validity to consider here. See the fields -/// where this struct is used for more information about the exact behavior. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteRulesBackendRefs { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub weight: Option, -} - -/// Status defines the current state of UDPRoute. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteStatus { - /// 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. - pub parents: Vec, -} - -/// RouteParentStatus describes the status of a route with respect to an -/// associated Parent. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteStatusParents { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// 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. - #[serde(rename = "controllerName")] - pub controller_name: String, - /// ParentRef corresponds with a ParentRef in the spec that this - /// RouteParentStatus struct describes the status of. - #[serde(rename = "parentRef")] - pub parent_ref: UDPRouteStatusParentsParentRef, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteStatusParentsConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: UDPRouteStatusParentsConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum UDPRouteStatusParentsConditionsStatus { - True, - False, - Unknown, -} - -/// ParentRef corresponds with a ParentRef in the spec that this -/// RouteParentStatus struct describes the status of. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct UDPRouteStatusParentsParentRef { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - diff --git a/src/apis/standard/gatewayclasses.rs b/src/apis/standard/gatewayclasses.rs deleted file mode 100644 index c43bd16..0000000 --- a/src/apis/standard/gatewayclasses.rs +++ /dev/null @@ -1,167 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of GatewayClass. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1", kind = "GatewayClass", plural = "gatewayclasses")] -#[kube(status = "GatewayClassStatus")] -pub struct GatewayClassSpec { - /// 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 - #[serde(rename = "controllerName")] - pub controller_name: String, - /// Description helps describe a GatewayClass with more details. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub description: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parametersRef")] - pub parameters_ref: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayClassParametersRef { - /// Group is the group of the referent. - pub group: String, - /// Kind is kind of the referent. - pub kind: String, - /// Name is the name of the referent. - pub name: String, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, -} - -/// Status defines the current state of GatewayClass. -/// -/// -/// Implementations MUST populate status on all GatewayClass resources which -/// specify their controller name. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayClassStatus { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayClassStatusConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GatewayClassStatusConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayClassStatusConditionsStatus { - True, - False, - Unknown, -} - diff --git a/src/apis/standard/gateways.rs b/src/apis/standard/gateways.rs deleted file mode 100644 index 9f6e124..0000000 --- a/src/apis/standard/gateways.rs +++ /dev/null @@ -1,840 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; -use std::collections::BTreeMap; - -/// Spec defines the desired state of Gateway. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1", kind = "Gateway", plural = "gateways")] -#[kube(namespaced)] -#[kube(status = "GatewayStatus")] -pub struct GatewaySpec { - /// Addresses requested for this Gateway. This is optional and behavior can - /// depend on the implementation. If a value is set in the spec and the - /// requested address is invalid or unavailable, the implementation MUST - /// indicate this in the associated entry in GatewayStatus.Addresses. - /// - /// - /// The Addresses field represents a request for the address(es) on the - /// "outside of the Gateway", that traffic bound for this Gateway will use. - /// This could be the IP address or hostname of an external load balancer or - /// other networking infrastructure, or some other address that traffic will - /// be sent to. - /// - /// - /// If no Addresses are specified, the implementation MAY schedule the - /// Gateway in an implementation-specific manner, assigning an appropriate - /// set of Addresses. - /// - /// - /// The implementation MUST bind all Listeners to every GatewayAddress that - /// it assigns to the Gateway and add a corresponding entry in - /// GatewayStatus.Addresses. - /// - /// - /// Support: Extended - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub addresses: Option>, - /// GatewayClassName used for this Gateway. This is the name of a - /// GatewayClass resource. - #[serde(rename = "gatewayClassName")] - pub gateway_class_name: String, - /// Listeners associated with this Gateway. Listeners define - /// logical endpoints that are bound on this Gateway's addresses. - /// At least one Listener MUST be specified. - /// - /// - /// Each Listener in a set of Listeners (for example, in a single Gateway) - /// MUST be _distinct_, in that a traffic flow MUST be able to be assigned to - /// exactly one listener. (This section uses "set of Listeners" rather than - /// "Listeners in a single Gateway" because implementations MAY merge configuration - /// from multiple Gateways onto a single data plane, and these rules _also_ - /// apply in that case). - /// - /// - /// Practically, this means that each listener in a set MUST have a unique - /// combination of Port, Protocol, and, if supported by the protocol, Hostname. - /// - /// - /// Some combinations of port, protocol, and TLS settings are considered - /// Core support and MUST be supported by implementations based on their - /// targeted conformance profile: - /// - /// - /// HTTP Profile - /// - /// - /// 1. HTTPRoute, Port: 80, Protocol: HTTP - /// 2. HTTPRoute, Port: 443, Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided - /// - /// - /// TLS Profile - /// - /// - /// 1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode: Passthrough - /// - /// - /// "Distinct" Listeners have the following property: - /// - /// - /// The implementation can match inbound requests to a single distinct - /// Listener. When multiple Listeners share values for fields (for - /// example, two Listeners with the same Port value), the implementation - /// can match requests to only one of the Listeners using other - /// Listener fields. - /// - /// - /// For example, the following Listener scenarios are distinct: - /// - /// - /// 1. Multiple Listeners with the same Port that all use the "HTTP" - /// Protocol that all have unique Hostname values. - /// 2. Multiple Listeners with the same Port that use either the "HTTPS" or - /// "TLS" Protocol that all have unique Hostname values. - /// 3. A mixture of "TCP" and "UDP" Protocol Listeners, where no Listener - /// with the same Protocol has the same Port value. - /// - /// - /// Some fields in the Listener struct have possible values that affect - /// whether the Listener is distinct. Hostname is particularly relevant - /// for HTTP or HTTPS protocols. - /// - /// - /// When using the Hostname value to select between same-Port, same-Protocol - /// Listeners, the Hostname value must be different on each Listener for the - /// Listener to be distinct. - /// - /// - /// When the Listeners are distinct based on Hostname, inbound request - /// hostnames MUST match from the most specific to least specific Hostname - /// values to choose the correct Listener and its associated set of Routes. - /// - /// - /// Exact matches must be processed before wildcard matches, and wildcard - /// matches must be processed before fallback (empty Hostname value) - /// matches. For example, `"foo.example.com"` takes precedence over - /// `"*.example.com"`, and `"*.example.com"` takes precedence over `""`. - /// - /// - /// Additionally, if there are multiple wildcard entries, more specific - /// wildcard entries must be processed before less specific wildcard entries. - /// For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. - /// The precise definition here is that the higher the number of dots in the - /// hostname to the right of the wildcard character, the higher the precedence. - /// - /// - /// The wildcard character will match any number of characters _and dots_ to - /// the left, however, so `"*.example.com"` will match both - /// `"foo.bar.example.com"` _and_ `"bar.example.com"`. - /// - /// - /// If a set of Listeners contains Listeners that are not distinct, then those - /// Listeners are Conflicted, and the implementation MUST set the "Conflicted" - /// condition in the Listener Status to "True". - /// - /// - /// Implementations MAY choose to accept a Gateway with some Conflicted - /// Listeners only if they only accept the partial Listener set that contains - /// no Conflicted Listeners. To put this another way, implementations may - /// accept a partial Listener set only if they throw out *all* the conflicting - /// Listeners. No picking one of the conflicting listeners as the winner. - /// This also means that the Gateway must have at least one non-conflicting - /// Listener in this case, otherwise it violates the requirement that at - /// least one Listener must be present. - /// - /// - /// The implementation MUST set a "ListenersNotValid" condition on the - /// Gateway Status when the Gateway contains Conflicted Listeners whether or - /// not they accept the Gateway. That Condition SHOULD clearly - /// indicate in the Message which Listeners are conflicted, and which are - /// Accepted. Additionally, the Listener status for those listeners SHOULD - /// indicate which Listeners are conflicted and not Accepted. - /// - /// - /// A Gateway's Listeners are considered "compatible" if: - /// - /// - /// 1. They are distinct. - /// 2. The implementation can serve them in compliance with the Addresses - /// requirement that all Listeners are available on all assigned - /// addresses. - /// - /// - /// Compatible combinations in Extended support are expected to vary across - /// implementations. A combination that is compatible for one implementation - /// may not be compatible for another. - /// - /// - /// For example, an implementation that cannot serve both TCP and UDP listeners - /// on the same address, or cannot mix HTTPS and generic TLS listens on the same port - /// would not consider those cases compatible, even though they are distinct. - /// - /// - /// Note that requests SHOULD match at most one Listener. For example, if - /// Listeners are defined for "foo.example.com" and "*.example.com", a - /// request to "foo.example.com" SHOULD only be routed using routes attached - /// to the "foo.example.com" Listener (and not the "*.example.com" Listener). - /// This concept is known as "Listener Isolation". Implementations that do - /// not support Listener Isolation MUST clearly document this. - /// - /// - /// Implementations MAY merge separate Gateways onto a single set of - /// Addresses if all Listeners across all Gateways are compatible. - /// - /// - /// Support: Core - pub listeners: Vec, -} - -/// GatewayAddress describes an address that can be bound to a Gateway. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayAddresses { - /// Type of the address. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// 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`. - pub value: String, -} - -/// Listener embodies the concept of a logical endpoint where a Gateway accepts -/// network connections. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListeners { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "allowedRoutes")] - pub allowed_routes: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// Name is the name of the Listener. This name MUST be unique within a - /// Gateway. - /// - /// - /// Support: Core - pub name: String, - /// Port is the network port. Multiple listeners may use the - /// same port, subject to the Listener compatibility rules. - /// - /// - /// Support: Core - pub port: i32, - /// Protocol specifies the network protocol this listener expects to receive. - /// - /// - /// Support: Core - pub protocol: String, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub tls: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutes { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kinds: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespaces: Option, -} - -/// RouteGroupKind indicates the group and kind of a Route resource. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesKinds { - /// Group is the group of the Route. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Kind is the kind of the Route. - pub kind: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesNamespaces { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub from: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub selector: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayListenersAllowedRoutesNamespacesFrom { - All, - Selector, - Same, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesNamespacesSelector { - /// matchExpressions is a list of label selector requirements. The requirements are ANDed. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "matchExpressions")] - pub match_expressions: Option>, - /// matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels - /// map is equivalent to an element of matchExpressions, whose key field is "key", the - /// operator is "In", and the values array contains only "value". The requirements are ANDed. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "matchLabels")] - pub match_labels: Option>, -} - -/// A label selector requirement is a selector that contains values, a key, and an operator that -/// relates the key and values. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersAllowedRoutesNamespacesSelectorMatchExpressions { - /// key is the label key that the selector applies to. - pub key: String, - /// operator represents a key's relationship to a set of values. - /// Valid operators are In, NotIn, Exists and DoesNotExist. - pub operator: String, - /// values is an array of string values. If the operator is In or NotIn, - /// the values array must be non-empty. If the operator is Exists or DoesNotExist, - /// the values array must be empty. This array is replaced during a strategic - /// merge patch. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub values: Option>, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersTls { - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none", rename = "certificateRefs")] - pub certificate_refs: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub mode: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub options: Option>, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayListenersTlsCertificateRefs { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Kind is kind of the referent. For example "Secret". - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the referenced object. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayListenersTlsMode { - Terminate, - Passthrough, -} - -/// Status defines the current state of Gateway. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatus { - /// Addresses lists the network addresses that have been bound to the - /// Gateway. - /// - /// - /// This list may differ from the addresses provided in the spec under some - /// conditions: - /// - /// - /// * no addresses are specified, all addresses are dynamically assigned - /// * a combination of specified and dynamic addresses are assigned - /// * a specified address was unusable (e.g. already in use) - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none")] - pub addresses: Option>, - /// 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" - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// Listeners provide status for each unique listener port defined in the Spec. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub listeners: Option>, -} - -/// GatewayStatusAddress describes a network address that is bound to a Gateway. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusAddresses { - /// Type of the address. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// 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`. - pub value: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GatewayStatusConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayStatusConditionsStatus { - True, - False, - Unknown, -} - -/// ListenerStatus is the status associated with a Listener. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusListeners { - /// AttachedRoutes represents the total number of Routes that have been - /// successfully attached to this Listener. - /// - /// - /// Successful attachment of a Route to a Listener is based solely on the - /// combination of the AllowedRoutes field on the corresponding Listener - /// and the Route's ParentRefs field. A Route is successfully attached to - /// a Listener when it is selected by the Listener's AllowedRoutes field - /// AND the Route has a valid ParentRef selecting the whole Gateway - /// resource or a specific Listener as a parent resource (more detail on - /// attachment semantics can be found in the documentation on the various - /// Route kinds ParentRefs fields). Listener or Route status does not impact - /// successful attachment, i.e. the AttachedRoutes field count MUST be set - /// for Listeners with condition Accepted: false and MUST count successfully - /// attached Routes that may themselves have Accepted: false conditions. - /// - /// - /// Uses for this field include troubleshooting Route attachment and - /// measuring blast radius/impact of changes to a Listener. - #[serde(rename = "attachedRoutes")] - pub attached_routes: i32, - /// Conditions describe the current condition of this listener. - pub conditions: Vec, - /// Name is the name of the Listener that this status corresponds to. - pub name: String, - /// 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. - #[serde(rename = "supportedKinds")] - pub supported_kinds: Vec, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusListenersConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: GatewayStatusListenersConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum GatewayStatusListenersConditionsStatus { - True, - False, - Unknown, -} - -/// RouteGroupKind indicates the group and kind of a Route resource. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct GatewayStatusListenersSupportedKinds { - /// Group is the group of the Route. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// Kind is the kind of the Route. - pub kind: String, -} - diff --git a/src/apis/standard/httproutes.rs b/src/apis/standard/httproutes.rs deleted file mode 100644 index 86d1451..0000000 --- a/src/apis/standard/httproutes.rs +++ /dev/null @@ -1,2476 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of HTTPRoute. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1", kind = "HTTPRoute", plural = "httproutes")] -#[kube(namespaced)] -#[kube(status = "HTTPRouteStatus")] -pub struct HTTPRouteSpec { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostnames: Option>, - /// 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) - /// - /// This API may be extended in the future to support additional kinds of parent - /// resources. - /// - /// - /// ParentRefs must be _distinct_. This means either that: - /// - /// - /// * They select different objects. If this is the case, then parentRef - /// entries are distinct. In terms of fields, this means that the - /// multi-part key defined by `group`, `kind`, `namespace`, and `name` must - /// be unique across all parentRef entries in the Route. - /// * They do not select different objects, but for each optional field used, - /// each ParentRef that selects the same object must set the same set of - /// optional fields to different values. If one ParentRef sets a - /// combination of optional fields, all must set the same combination. - /// - /// - /// Some examples: - /// - /// - /// * If one ParentRef sets `sectionName`, all ParentRefs referencing the - /// same object must also set `sectionName`. - /// * If one ParentRef sets `port`, all ParentRefs referencing the same - /// object must also set `port`. - /// * If one ParentRef sets `sectionName` and `port`, all ParentRefs - /// referencing the same object must also set `sectionName` and `port`. - /// - /// - /// It is possible to separately reference multiple distinct objects that may - /// be collapsed by an implementation. For example, some implementations may - /// choose to merge compatible Gateway Listeners together. If that is the - /// case, the list of routes attached to those resources should also be - /// merged. - /// - /// - /// Note that for ParentRefs that cross namespace boundaries, there are specific - /// rules. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example, - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable other kinds of cross-namespace reference. - /// - /// - /// - /// - /// - /// - /// - /// - /// - #[serde(default, skip_serializing_if = "Option::is_none", rename = "parentRefs")] - pub parent_refs: Option>, - /// Rules are a list of HTTP matchers, filters and actions. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub rules: Option>, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteParentRefs { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - -/// HTTPRouteRule defines semantics for matching an HTTP request based on -/// conditions (matches), processing it (filters), and forwarding the request to -/// an API object (backendRefs). -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRules { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "backendRefs")] - pub backend_refs: Option>, - /// Filters define the filters that are applied to requests that match - /// this rule. - /// - /// - /// Wherever possible, implementations SHOULD implement filters in the order - /// they are specified. - /// - /// - /// Implementations MAY choose to implement this ordering strictly, rejecting - /// any combination or order of filters that can not be supported. If implementations - /// choose a strict interpretation of filter ordering, they MUST clearly document - /// that behavior. - /// - /// - /// To reject an invalid combination or order of filters, implementations SHOULD - /// consider the Route Rules with this configuration invalid. If all Route Rules - /// in a Route are invalid, the entire Route would be considered invalid. If only - /// a portion of Route Rules are invalid, implementations MUST set the - /// "PartiallyInvalid" condition for the Route. - /// - /// - /// Conformance-levels at this level are defined based on the type of filter: - /// - /// - /// - ALL core filters MUST be supported by all implementations. - /// - Implementers are encouraged to support extended filters. - /// - Implementation-specific custom filters have no API guarantees across - /// implementations. - /// - /// - /// Specifying the same filter multiple times is not supported unless explicitly - /// indicated in the filter. - /// - /// - /// All filters are expected to be compatible with each other except for the - /// URLRewrite and RequestRedirect filters, which may not be combined. If an - /// implementation can not support other combinations of filters, they must clearly - /// document that limitation. In cases where incompatible or unsupported - /// filters are specified and cause the `Accepted` condition to be set to status - /// `False`, implementations may use the `IncompatibleFilters` reason to specify - /// this configuration error. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub filters: Option>, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub matches: Option>, -} - -/// HTTPBackendRef defines how a HTTPRoute forwards a HTTP request. -/// -/// -/// Note that when a namespace different than the local namespace is specified, a -/// ReferenceGrant object is required in the referent namespace to allow that -/// namespace's owner to accept the reference. See the ReferenceGrant -/// documentation for details. -/// -/// -/// -/// -/// -/// When the BackendRef points to a Kubernetes Service, implementations SHOULD -/// honor the appProtocol field if it is set for the target Service Port. -/// -/// -/// Implementations supporting appProtocol SHOULD recognize the Kubernetes -/// Standard Application Protocols defined in KEP-3726. -/// -/// -/// If a Service appProtocol isn't specified, an implementation MAY infer the -/// backend protocol through its own means. Implementations MAY infer the -/// protocol from the Route type referring to the backend Service. -/// -/// -/// If a Route is not able to send traffic to the backend using the specified -/// protocol then the backend is considered invalid. Implementations MUST set the -/// "ResolvedRefs" condition to "False" with the "UnsupportedProtocol" reason. -/// -/// -/// -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefs { - /// 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.) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub filters: Option>, - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub weight: Option, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFilters { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "extensionRef")] - pub extension_ref: Option, - /// RequestHeaderModifier defines a schema for a filter that modifies request - /// headers. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestHeaderModifier")] - pub request_header_modifier: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestMirror")] - pub request_mirror: Option, - /// RequestRedirect defines a schema for a filter that responds to the - /// request with an HTTP redirection. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestRedirect")] - pub request_redirect: Option, - /// ResponseHeaderModifier defines a schema for a filter that modifies response - /// headers. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "responseHeaderModifier")] - pub response_header_modifier: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesBackendRefsFiltersType, - /// URLRewrite defines a schema for a filter that modifies a request during forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "urlRewrite")] - pub url_rewrite: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersExtensionRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - pub group: String, - /// Kind is kind of the referent. For example "HTTPRoute" or "Service". - pub kind: String, - /// Name is the name of the referent. - pub name: String, -} - -/// RequestHeaderModifier defines a schema for a filter that modifies request -/// headers. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestMirror { - /// BackendRef references a resource where mirrored requests are sent. - /// - /// - /// Mirrored requests must be sent only to a single destination endpoint - /// within this BackendRef, irrespective of how many endpoints are present - /// within this BackendRef. - /// - /// - /// If the referent cannot be found, this BackendRef is invalid and must be - /// dropped from the Gateway. The controller must ensure the "ResolvedRefs" - /// condition on the Route status is set to `status: False` and not configure - /// this backend in the underlying implementation. - /// - /// - /// If there is a cross-namespace reference to an *existing* object - /// that is not allowed by a ReferenceGrant, the controller must ensure the - /// "ResolvedRefs" condition on the Route is set to `status: False`, - /// with the "RefNotPermitted" reason and not configure this backend in the - /// underlying implementation. - /// - /// - /// In either error case, the Message of the `ResolvedRefs` Condition - /// should be used to provide more detail about the problem. - /// - /// - /// Support: Extended for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - #[serde(rename = "backendRef")] - pub backend_ref: HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef, -} - -/// BackendRef references a resource where mirrored requests are sent. -/// -/// -/// Mirrored requests must be sent only to a single destination endpoint -/// within this BackendRef, irrespective of how many endpoints are present -/// within this BackendRef. -/// -/// -/// If the referent cannot be found, this BackendRef is invalid and must be -/// dropped from the Gateway. The controller must ensure the "ResolvedRefs" -/// condition on the Route status is set to `status: False` and not configure -/// this backend in the underlying implementation. -/// -/// -/// If there is a cross-namespace reference to an *existing* object -/// that is not allowed by a ReferenceGrant, the controller must ensure the -/// "ResolvedRefs" condition on the Route is set to `status: False`, -/// with the "RefNotPermitted" reason and not configure this backend in the -/// underlying implementation. -/// -/// -/// In either error case, the Message of the `ResolvedRefs` Condition -/// should be used to provide more detail about the problem. -/// -/// -/// Support: Extended for Kubernetes Service -/// -/// -/// Support: Implementation-specific for any other resource -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestMirrorBackendRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirect { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub scheme: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "statusCode")] - pub status_code: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersRequestRedirectPath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectScheme { - #[serde(rename = "http")] - Http, - #[serde(rename = "https")] - Https, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersRequestRedirectStatusCode { - #[serde(rename = "301")] - r#_301, - #[serde(rename = "302")] - r#_302, -} - -/// ResponseHeaderModifier defines a schema for a filter that modifies response -/// headers. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersResponseHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersType { - RequestHeaderModifier, - ResponseHeaderModifier, - RequestMirror, - RequestRedirect, - #[serde(rename = "URLRewrite")] - UrlRewrite, - ExtensionRef, -} - -/// URLRewrite defines a schema for a filter that modifies a request during forwarding. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersUrlRewrite { - /// Hostname is the value to be used to replace the Host header value during - /// forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// Path defines a path rewrite. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesBackendRefsFiltersUrlRewritePath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesBackendRefsFiltersUrlRewritePathType, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesBackendRefsFiltersUrlRewritePathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFilters { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "extensionRef")] - pub extension_ref: Option, - /// RequestHeaderModifier defines a schema for a filter that modifies request - /// headers. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestHeaderModifier")] - pub request_header_modifier: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestMirror")] - pub request_mirror: Option, - /// RequestRedirect defines a schema for a filter that responds to the - /// request with an HTTP redirection. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none", rename = "requestRedirect")] - pub request_redirect: Option, - /// ResponseHeaderModifier defines a schema for a filter that modifies response - /// headers. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "responseHeaderModifier")] - pub response_header_modifier: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesFiltersType, - /// URLRewrite defines a schema for a filter that modifies a request during forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none", rename = "urlRewrite")] - pub url_rewrite: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersExtensionRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - pub group: String, - /// Kind is kind of the referent. For example "HTTPRoute" or "Service". - pub kind: String, - /// Name is the name of the referent. - pub name: String, -} - -/// RequestHeaderModifier defines a schema for a filter that modifies request -/// headers. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestMirror { - /// BackendRef references a resource where mirrored requests are sent. - /// - /// - /// Mirrored requests must be sent only to a single destination endpoint - /// within this BackendRef, irrespective of how many endpoints are present - /// within this BackendRef. - /// - /// - /// If the referent cannot be found, this BackendRef is invalid and must be - /// dropped from the Gateway. The controller must ensure the "ResolvedRefs" - /// condition on the Route status is set to `status: False` and not configure - /// this backend in the underlying implementation. - /// - /// - /// If there is a cross-namespace reference to an *existing* object - /// that is not allowed by a ReferenceGrant, the controller must ensure the - /// "ResolvedRefs" condition on the Route is set to `status: False`, - /// with the "RefNotPermitted" reason and not configure this backend in the - /// underlying implementation. - /// - /// - /// In either error case, the Message of the `ResolvedRefs` Condition - /// should be used to provide more detail about the problem. - /// - /// - /// Support: Extended for Kubernetes Service - /// - /// - /// Support: Implementation-specific for any other resource - #[serde(rename = "backendRef")] - pub backend_ref: HTTPRouteRulesFiltersRequestMirrorBackendRef, -} - -/// BackendRef references a resource where mirrored requests are sent. -/// -/// -/// Mirrored requests must be sent only to a single destination endpoint -/// within this BackendRef, irrespective of how many endpoints are present -/// within this BackendRef. -/// -/// -/// If the referent cannot be found, this BackendRef is invalid and must be -/// dropped from the Gateway. The controller must ensure the "ResolvedRefs" -/// condition on the Route status is set to `status: False` and not configure -/// this backend in the underlying implementation. -/// -/// -/// If there is a cross-namespace reference to an *existing* object -/// that is not allowed by a ReferenceGrant, the controller must ensure the -/// "ResolvedRefs" condition on the Route is set to `status: False`, -/// with the "RefNotPermitted" reason and not configure this backend in the -/// underlying implementation. -/// -/// -/// In either error case, the Message of the `ResolvedRefs` Condition -/// should be used to provide more detail about the problem. -/// -/// -/// Support: Extended for Kubernetes Service -/// -/// -/// Support: Implementation-specific for any other resource -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestMirrorBackendRef { - /// Group is the group of the referent. For example, "gateway.networking.k8s.io". - /// When unspecified or empty string, core API group is inferred. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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) - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - pub name: String, - /// Namespace is the namespace of the backend. When unspecified, the local - /// namespace is inferred. - /// - /// - /// Note that when a namespace different than the local namespace is specified, - /// a ReferenceGrant object is required in the referent namespace to allow that - /// namespace's owner to accept the reference. See the ReferenceGrant - /// documentation for details. - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestRedirect { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub port: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub scheme: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "statusCode")] - pub status_code: Option, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersRequestRedirectPath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesFiltersRequestRedirectPathType, -} - -/// 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 -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersRequestRedirectPathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersRequestRedirectScheme { - #[serde(rename = "http")] - Http, - #[serde(rename = "https")] - Https, -} - -/// RequestRedirect defines a schema for a filter that responds to the -/// request with an HTTP redirection. -/// -/// -/// Support: Core -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersRequestRedirectStatusCode { - #[serde(rename = "301")] - r#_301, - #[serde(rename = "302")] - r#_302, -} - -/// ResponseHeaderModifier defines a schema for a filter that modifies response -/// headers. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersResponseHeaderModifier { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub add: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub remove: Option>, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub set: Option>, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersResponseHeaderModifierAdd { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersResponseHeaderModifierSet { - /// 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. - pub name: String, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// 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. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersType { - RequestHeaderModifier, - ResponseHeaderModifier, - RequestMirror, - RequestRedirect, - #[serde(rename = "URLRewrite")] - UrlRewrite, - ExtensionRef, -} - -/// URLRewrite defines a schema for a filter that modifies a request during forwarding. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersUrlRewrite { - /// Hostname is the value to be used to replace the Host header value during - /// forwarding. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub hostname: Option, - /// Path defines a path rewrite. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesFiltersUrlRewritePath { - /// ReplaceFullPath specifies the value with which to replace the full path - /// of a request during a rewrite or redirect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replaceFullPath")] - pub replace_full_path: Option, - /// ReplacePrefixMatch specifies the value with which to replace the prefix - /// match of a request during a rewrite or redirect. For example, a request - /// to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch - /// of "/xyz" would be modified to "/xyz/bar". - /// - /// - /// Note that this matches the behavior of the PathPrefix match type. This - /// matches full path elements. A path element refers to the list of labels - /// in the path split by the `/` separator. When specified, a trailing `/` is - /// ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all - /// match the prefix `/abc`, but the path `/abcd` would not. - /// - /// - /// ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. - /// Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in - /// the implementation setting the Accepted Condition for the Route to `status: False`. - /// - /// - /// Request Path | Prefix Match | Replace Prefix | Modified Path - /// -------------|--------------|----------------|---------- - /// /foo/bar | /foo | /xyz | /xyz/bar - /// /foo/bar | /foo | /xyz/ | /xyz/bar - /// /foo/bar | /foo/ | /xyz | /xyz/bar - /// /foo/bar | /foo/ | /xyz/ | /xyz/bar - /// /foo | /foo | /xyz | /xyz - /// /foo/ | /foo | /xyz | /xyz/ - /// /foo/bar | /foo | | /bar - /// /foo/ | /foo | | / - /// /foo | /foo | | / - /// /foo/ | /foo | / | / - /// /foo | /foo | / | / - #[serde(default, skip_serializing_if = "Option::is_none", rename = "replacePrefixMatch")] - pub replace_prefix_match: Option, - /// 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`. - #[serde(rename = "type")] - pub r#type: HTTPRouteRulesFiltersUrlRewritePathType, -} - -/// Path defines a path rewrite. -/// -/// -/// Support: Extended -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesFiltersUrlRewritePathType { - ReplaceFullPath, - ReplacePrefixMatch, -} - -/// 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" -/// -/// -/// ``` -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatches { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub headers: Option>, - /// Method specifies HTTP method matcher. - /// When specified, this route will be matched only if the request has the - /// specified method. - /// - /// - /// Support: Extended - #[serde(default, skip_serializing_if = "Option::is_none")] - pub method: Option, - /// Path specifies a HTTP request path matcher. If this field is not - /// specified, a default prefix match on the "/" path is provided. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub path: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "queryParams")] - pub query_params: Option>, -} - -/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request -/// headers. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatchesHeaders { - /// 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". - pub name: String, - /// Type specifies how to match against the value of the header. - /// - /// - /// Support: Core (Exact) - /// - /// - /// Support: Implementation-specific (RegularExpression) - /// - /// - /// Since RegularExpression HeaderMatchType has implementation-specific - /// conformance, implementations can support POSIX, PCRE or any other dialects - /// of regular expressions. Please read the implementation's documentation to - /// determine the supported dialect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value is the value of HTTP Header to be matched. - pub value: String, -} - -/// HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request -/// headers. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesHeadersType { - Exact, - RegularExpression, -} - -/// 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" -/// -/// -/// ``` -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesMethod { - #[serde(rename = "GET")] - Get, - #[serde(rename = "HEAD")] - Head, - #[serde(rename = "POST")] - Post, - #[serde(rename = "PUT")] - Put, - #[serde(rename = "DELETE")] - Delete, - #[serde(rename = "CONNECT")] - Connect, - #[serde(rename = "OPTIONS")] - Options, - #[serde(rename = "TRACE")] - Trace, - #[serde(rename = "PATCH")] - Patch, -} - -/// Path specifies a HTTP request path matcher. If this field is not -/// specified, a default prefix match on the "/" path is provided. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatchesPath { - /// Type specifies how to match against the path Value. - /// - /// - /// Support: Core (Exact, PathPrefix) - /// - /// - /// Support: Implementation-specific (RegularExpression) - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value of the HTTP path to match against. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub value: Option, -} - -/// Path specifies a HTTP request path matcher. If this field is not -/// specified, a default prefix match on the "/" path is provided. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesPathType { - Exact, - PathPrefix, - RegularExpression, -} - -/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP -/// query parameters. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteRulesMatchesQueryParams { - /// 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. - pub name: String, - /// Type specifies how to match against the value of the query parameter. - /// - /// - /// Support: Extended (Exact) - /// - /// - /// Support: Implementation-specific (RegularExpression) - /// - /// - /// Since RegularExpression QueryParamMatchType has Implementation-specific - /// conformance, implementations can support POSIX, PCRE or any other - /// dialects of regular expressions. Please read the implementation's - /// documentation to determine the supported dialect. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "type")] - pub r#type: Option, - /// Value is the value of HTTP query param to be matched. - pub value: String, -} - -/// HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP -/// query parameters. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteRulesMatchesQueryParamsType { - Exact, - RegularExpression, -} - -/// Status defines the current state of HTTPRoute. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatus { - /// 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. - pub parents: Vec, -} - -/// RouteParentStatus describes the status of a route with respect to an -/// associated Parent. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatusParents { - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub conditions: Option>, - /// 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. - #[serde(rename = "controllerName")] - pub controller_name: String, - /// ParentRef corresponds with a ParentRef in the spec that this - /// RouteParentStatus struct describes the status of. - #[serde(rename = "parentRef")] - pub parent_ref: HTTPRouteStatusParentsParentRef, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatusParentsConditions { - /// lastTransitionTime is the last time the condition transitioned from one status to another. - /// This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - #[serde(rename = "lastTransitionTime")] - pub last_transition_time: String, - /// message is a human readable message indicating details about the transition. - /// This may be an empty string. - pub message: String, - /// observedGeneration represents the .metadata.generation that the condition was set based upon. - /// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date - /// with respect to the current state of the instance. - #[serde(default, skip_serializing_if = "Option::is_none", rename = "observedGeneration")] - pub observed_generation: Option, - /// reason contains a programmatic identifier indicating the reason for the condition's last transition. - /// Producers of specific condition types may define expected values and meanings for this field, - /// and whether the values are considered a guaranteed API. - /// The value should be a CamelCase string. - /// This field may not be empty. - pub reason: String, - /// status of the condition, one of True, False, Unknown. - pub status: HTTPRouteStatusParentsConditionsStatus, - /// type of condition in CamelCase or in foo.example.com/CamelCase. - /// --- - /// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be - /// useful (see .node.status.conditions), the ability to deconflict is important. - /// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) - #[serde(rename = "type")] - pub r#type: String, -} - -/// Condition contains details for one aspect of the current state of this API Resource. -/// --- -/// This struct is intended for direct use as an array at the field path .status.conditions. For example, -/// -/// -/// type FooStatus struct{ -/// // Represents the observations of a foo's current state. -/// // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" -/// // +patchMergeKey=type -/// // +patchStrategy=merge -/// // +listType=map -/// // +listMapKey=type -/// Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` -/// -/// -/// // other fields -/// } -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub enum HTTPRouteStatusParentsConditionsStatus { - True, - False, - Unknown, -} - -/// ParentRef corresponds with a ParentRef in the spec that this -/// RouteParentStatus struct describes the status of. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct HTTPRouteStatusParentsParentRef { - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none")] - pub group: Option, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub kind: Option, - /// Name is the name of the referent. - /// - /// - /// Support: Core - pub name: String, - /// Namespace is the namespace of the referent. When unspecified, this refers - /// to the local namespace of the Route. - /// - /// - /// Note that there are specific rules for ParentRefs which cross namespace - /// boundaries. Cross-namespace references are only valid if they are explicitly - /// allowed by something in the namespace they are referring to. For example: - /// Gateway has the AllowedRoutes field, and ReferenceGrant provides a - /// generic way to enable any other kind of cross-namespace reference. - /// - /// - /// - /// - /// - /// Support: Core - #[serde(default, skip_serializing_if = "Option::is_none")] - pub namespace: Option, - /// 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 - #[serde(default, skip_serializing_if = "Option::is_none", rename = "sectionName")] - pub section_name: Option, -} - diff --git a/src/apis/standard/referencegrants.rs b/src/apis/standard/referencegrants.rs deleted file mode 100644 index 73bd5cf..0000000 --- a/src/apis/standard/referencegrants.rs +++ /dev/null @@ -1,92 +0,0 @@ -// WARNING: generated by kopium - manual changes will be overwritten -// kopium command: kopium -Af - -// kopium version: 0.16.5 - -use kube::CustomResource; -use schemars::JsonSchema; -use serde::{Serialize, Deserialize}; - -/// Spec defines the desired state of ReferenceGrant. -#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, JsonSchema)] -#[kube(group = "gateway.networking.k8s.io", version = "v1beta1", kind = "ReferenceGrant", plural = "referencegrants")] -#[kube(namespaced)] -pub struct ReferenceGrantSpec { - /// 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 - pub from: Vec, - /// 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 - pub to: Vec, -} - -/// ReferenceGrantFrom describes trusted namespaces and kinds. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct ReferenceGrantFrom { - /// Group is the group of the referent. - /// When empty, the Kubernetes core API group is inferred. - /// - /// - /// Support: Core - pub group: String, - /// 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 - pub kind: String, - /// Namespace is the namespace of the referent. - /// - /// - /// Support: Core - pub namespace: String, -} - -/// ReferenceGrantTo describes what Kinds are allowed as targets of the -/// references. -#[derive(Serialize, Deserialize, Clone, Debug, JsonSchema)] -pub struct ReferenceGrantTo { - /// Group is the group of the referent. - /// When empty, the Kubernetes core API group is inferred. - /// - /// - /// Support: Core - pub group: String, - /// 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 - pub kind: String, - /// 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. - #[serde(default, skip_serializing_if = "Option::is_none")] - pub name: Option, -} - diff --git a/update.sh b/update.sh index 6cf47a4..7b86629 100755 --- a/update.sh +++ b/update.sh @@ -33,31 +33,69 @@ EXPERIMENTAL_APIS=( udproutes ) -rm -rf src/apis/ +rm -rf gateway-api/src/apis/ -mkdir -p src/apis/ -cat << EOF > src/apis/mod.rs +mkdir -p gateway-api/src/apis/ +cat << EOF > gateway-api/src/apis/mod.rs pub mod experimental; pub mod standard; EOF -mkdir -p src/apis/standard/ -mkdir -p src/apis/experimental/ +mkdir -p gateway-api/src/apis/standard/ +mkdir -p gateway-api/src/apis/experimental/ -echo "// WARNING! generated file do not edit" > src/apis/standard/mod.rs +echo "// WARNING! generated file do not edit" > gateway-api/src/apis/standard/mod.rs for API in "${STANDARD_APIS[@]}" do echo "generating standard api ${API}" - curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/standard/gateway.networking.k8s.io_${API}.yaml" | kopium -Af - > src/apis/standard/${API}.rs - echo "pub mod ${API};" >> src/apis/standard/mod.rs + curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/standard/gateway.networking.k8s.io_${API}.yaml" | kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - > gateway-api/src/apis/standard/${API}.rs + echo "pub mod ${API};" >> gateway-api/src/apis/standard/mod.rs done -echo "// WARNING! generated file do not edit" > src/apis/experimental/mod.rs +# Standard API enums that need a Default trait impl along with their respective default variant. +ENUMS=( + HTTPRouteRulesFiltersRequestRedirectPathType=ReplaceFullPath + HTTPRouteRulesFiltersUrlRewritePathType=ReplaceFullPath + HTTPRouteRulesFiltersType=RequestHeaderModifier + HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType=ReplaceFullPath + HTTPRouteRulesBackendRefsFiltersUrlRewritePathType=ReplaceFullPath + HTTPRouteRulesBackendRefsFiltersType=RequestHeaderModifier +) + +# Create a comma separated string out of $ENUMS. +ENUMS_WITH_DEFAULTS=$(printf ",%s" "${ENUMS[@]}") +ENUMS_WITH_DEFAULTS=${ENUMS_WITH_DEFAULTS:1} + +# The task searches for $GATEWAY_API_ENUMS in the enviornment to get the enum names and their default variants. +GATEWAY_API_ENUMS=${ENUMS_WITH_DEFAULTS} cargo xtask gen_enum_defaults >> gateway-api/src/apis/standard/enum_defaults.rs +echo "mod enum_defaults;" >> gateway-api/src/apis/standard/mod.rs + +echo "// WARNING! generated file do not edit" > gateway-api/src/apis/experimental/mod.rs for API in "${EXPERIMENTAL_APIS[@]}" do echo "generating experimental api $API" - curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/experimental/gateway.networking.k8s.io_${API}.yaml" | kopium -Af - > src/apis/experimental/${API}.rs - echo "pub mod ${API};" >> src/apis/experimental/mod.rs + curl -sSL "https://raw.githubusercontent.com/kubernetes-sigs/gateway-api/${VERSION}/config/crd/experimental/gateway.networking.k8s.io_${API}.yaml" | kopium --schema=derived --derive=JsonSchema --derive=Default --docs -f - > gateway-api/src/apis/experimental/${API}.rs + echo "pub mod ${API};" >> gateway-api/src/apis/experimental/mod.rs done + +# Experimental API enums that need a Default trait impl along with their respective default variant. +ENUMS=( + HTTPRouteRulesFiltersRequestRedirectPathType=ReplaceFullPath + HTTPRouteRulesFiltersUrlRewritePathType=ReplaceFullPath + HTTPRouteRulesFiltersType=RequestHeaderModifier + HTTPRouteRulesBackendRefsFiltersRequestRedirectPathType=ReplaceFullPath + HTTPRouteRulesBackendRefsFiltersUrlRewritePathType=ReplaceFullPath + HTTPRouteRulesBackendRefsFiltersType=RequestHeaderModifier + GRPCRouteRulesFiltersType=RequestHeaderModifier + GRPCRouteRulesBackendRefsFiltersType=RequestHeaderModifier +) + +ENUMS_WITH_DEFAULTS=$(printf ",%s" "${ENUMS[@]}") +ENUMS_WITH_DEFAULTS=${ENUMS_WITH_DEFAULTS:1} +GATEWAY_API_ENUMS=${ENUMS_WITH_DEFAULTS} cargo xtask gen_enum_defaults >> gateway-api/src/apis/experimental/enum_defaults.rs +echo "mod enum_defaults;" >> gateway-api/src/apis/experimental/mod.rs + +# Format the code. +cargo fmt diff --git a/xtask/Cargo.toml b/xtask/Cargo.toml new file mode 100644 index 0000000..70a3a00 --- /dev/null +++ b/xtask/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "enum_default_generator" +version = "0.1.0" +edition = "2021" +description = "Codegen tool to generate Default trait impls for Gateway API enums" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +codegen = "0.2.0" diff --git a/xtask/src/main.rs b/xtask/src/main.rs new file mode 100644 index 0000000..843fb1c --- /dev/null +++ b/xtask/src/main.rs @@ -0,0 +1,91 @@ +use std::{collections::BTreeMap, env}; + +use codegen::{Function, Scope}; + +fn main() { + let task = env::args().nth(1); + + match task.as_deref() { + Some("gen_enum_defaults") => gen_enum_defaults().unwrap(), + _ => print_help(), + } +} + +fn print_help() { + eprintln!( + "Tasks: + +gen_enum_defaults generates Default trait impls for enums +" + ) +} + +type DynError = Box; + +fn gen_enum_defaults() -> Result<(), DynError> { + // GATEWAY_API_ENUMS provides the enum names along with their default variant to be used in the + // generated Default impl. For eg: GATEWAY_API_ENUMS=enum1=default1,enum2=default2. + let gw_api_enums = env::var("GATEWAY_API_ENUMS")?; + let enums_with_defaults = get_enums_with_defaults_map(gw_api_enums); + + let mut scope = Scope::new(); + let mut httproute_enums = vec![]; + let mut grpcroute_enums = vec![]; + + for (e, d) in enums_with_defaults { + // The `fn default()` function. + let mut func = Function::new("default".to_string()); + func.ret("Self").line(format!("{}::{}", e, d)); + + // The impl Default for implementation. + scope + .new_impl(e.as_str()) + .impl_trait("Default") + .push_fn(func); + + // Determine which enums belong to the httproute module and which belong to the + // grpcroute module. + if e.starts_with("HTTPRoute") { + httproute_enums.push(e); + } else if e.starts_with("GRPCRoute") { + grpcroute_enums.push(e); + } + } + + println!("// WARNING: generated file - manual changes will be overriden\n"); + + // Generate use statements for the enums. + if httproute_enums.len() > 0 { + let use_http_stmt = gen_use_stmt(httproute_enums, "httproutes".to_string()); + println!("{}\n", use_http_stmt); + } + if grpcroute_enums.len() > 0 { + let use_grpc_stmt = gen_use_stmt(grpcroute_enums, "grpcroutes".to_string()); + println!("{}\n", use_grpc_stmt); + } + + println!("{}", scope.to_string()); + Ok(()) +} + +fn gen_use_stmt(items: Vec, module: String) -> String { + let mut stmt = String::from(format!("use super::{}::{{", module)); + for item in items { + stmt.push_str(format!("{}, ", item).as_str()); + } + stmt.push_str("};"); + stmt +} + +fn get_enums_with_defaults_map(env_var_val: String) -> BTreeMap { + let mut enums_with_defaults = BTreeMap::new(); + env_var_val.split(',').for_each(|enum_with_default| { + let enum_and_default: Vec<&str> = enum_with_default.split('=').collect(); + enums_with_defaults.insert( + enum_and_default[0].to_string(), + enum_and_default[1].to_string(), + ); + }); + + enums_with_defaults +}