API Reference

Validations:
Required

ControllerName is a domain/path string that indicates the name of the controller that manages the Backend.

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).

Validations:
Required

AncestorRef identifies the parent resource that this status is associated with.

Validations:
Optional

For Kubernetes API conventions, see: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties conditions represent the current state of the Backend resource. Each condition has a unique type and reflects the status of a specific aspect of the resource.

Defined condition types include:

• "Accepted": the resource has been acknowledged and accepteed by the controller

The status of each condition is one of True, False, or Unknown.

Validations:
MaxLength: 63
Optional

Name represents the name of this port. All ports in a Backend must have a unique name. Name must either be an empty string or pass DNS_LABEL validation (lowercase alphanumeric or ‘-’, starting and ending with an alphanumeric character, at most 63 characters).

Validations:
Maximum: 65535
Minimum: 1
Required

Port represents the port number of the endpoint.

Validations:
Enum: [ExternalHostname]
Required

Type defines the backend type.

Validations:
Required

Port defines the port that the implementation should use when connecting to this backend.

Validations:
Optional

ExternalHostname specifies the configuration for an ExternalHostname backend. This field must be set when type is ExternalHostname and must be unset otherwise.

Support: Extended

Validations:
Enum: [TCP HTTP HTTP2 HTTP11 H2C MCP]
Optional

Protocol defines the protocol for backend communication.

In the common case, the underlying transport protocol for the proxied traffic will already have been determined and processed by the dataplane at the routing step. Where this field is useful is either for higher level protocols or asymmetrical protocol configurations (e.g. version upgrades or h2c).

When set, the implementation uses the specified protocol when connecting to this backend. When not set, the implementation will use the protocol determined by the route or listener configuration.

Support: Core - HTTP, HTTP2, H2C, and HTTP11

Support: Extended - GRPC, MCP, TCP

Validations:
Optional

TLS defines the TLS configuration that the implementation should use when connecting to the backend.

ExternalHostname backends SHOULD have TLS configured; the lack of TLS for external hostnames should be considered insecure and a security risk.

Support: Extended

Validations:
MaxItems: 32
Optional

Ancestors is a list of parent resources associated with this Backend, and the status of the Backend with respect to each parent.

A maximum of 32 parents will be represented in this list. An empty list indicates that the Backend is not associated with any parents.

Validations:
Enum: [None ServerOnly ClientAndServer]
Required

Mode defines the TLS mode for the backend connection.

Validations:
Optional

ClientCertificateRef is a reference to a Secret containing the client TLS certificate and private key for mutual TLS. This field is required when mode is ClientAndServer and must be unset otherwise.

Validations:
Optional

Validation contains TLS validation configuration for the backend connection.

Validations:
MaxItems: 16
MinItems: 1
Required

TargetRefs identifies API object(s) to apply this policy to. Currently, Backends (A grouping of like endpoints such as Service, ServiceImport, or any implementation-specific backendRef) are the only valid API target references.

Currently, a TargetRef cannot be scoped to a specific port on a Service.

Validations:
Optional

RetryConstraint defines the configuration for when to allow or prevent further retries to a target backend, by dynamically calculating a ‘retry budget’. This budget is calculated based on the percentage of incoming traffic composed of retries over a given time interval. Once the budget is exceeded, additional retries will be rejected.

For example, if the retry budget interval is 10 seconds, there have been 1000 active requests in the past 10 seconds, and the allowed percentage of requests that can be retried is 20% (the default), then 200 of those requests may be composed of retries. Active requests will only be considered for the duration of the interval when calculating the retry budget. Retrying the same original request multiple times within the retry budget interval will lead to each retry being counted towards calculating the budget.

Configuring a RetryConstraint in BackendTrafficPolicy is compatible with HTTPRoute Retry settings for each HTTPRouteRule that targets the same backend. While the HTTPRouteRule Retry stanza can specify whether a request will be retried, and the number of retry attempts each client may perform, RetryConstraint helps prevent cascading failures such as retry storms during periods of consistent failures.

After the retry budget has been exceeded, additional retries to the backend MUST return a 503 response to the client.

Additional configurations for defining a constraint on retries MAY be defined in the future.

Support: Extended

gateway:experimental

Validations:
Optional

SessionPersistence defines and configures session persistence for the backend.

Support: Extended

Default: 20

Validations:
Maximum: 100
Minimum: 0
Optional

Percent defines the maximum percentage of active requests that may be made up of retries.

Support: Extended

Default: 10s

Validations:
Optional

Interval defines the duration in which requests will be considered for calculating the budget for retries.

Support: Extended

Validations:
Required

Hostname specifies the FQDN used to reach this backend. IP addresses are not allowed in this field.

Validations:
Required

ControllerName is the name of a controller that is managing Gateway API resources for mesh traffic management. The value of this field MUST be a domain prefixed path.

Example: "example.com/awesome-mesh".

This field is not mutable and cannot be empty.

Support: Core

Validations:
Optional

ParametersRef is an optional reference to a resource that contains implementation-specific configuration for this Mesh. If no implementation-specific parameters are needed, this field MUST be omitted.

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, refers to an unsupported kind, or when the data within that resource is malformed, the Mesh MUST be rejected with the "Accepted" status condition set to "False" and an "InvalidParameters" reason.

Support: Implementation-specific

Validations:
MaxLength: 64
Optional

Description optionally provides a human-readable description of a Mesh.

Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for controller reason:Pending status:Unknown type:Accepted] map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for controller reason:Pending status:Unknown type:Programmed]]

Validations:
MaxItems: 8
Optional

Conditions is the current status from the controller for this Mesh.

Controllers should prefer to publish conditions using values of MeshConditionType for the type of each Condition.

Validations:
MaxItems: 64
Optional

SupportedFeatures is the set of features the Mesh support. It MUST be sorted in ascending alphabetical order by the Name key.

Validations:
Maximum: 1e+06
Minimum: 1
Optional

Count specifies the number of requests per time interval.

Support: Extended

Validations:
Optional

Interval specifies the divisor of the rate of requests, the amount of time during which the given count of requests occur.

Support: Extended

Default: { interval:10s percent:20 }

Validations:
Optional

Budget holds the details of the retry budget configuration.

Default: { count:10 interval:1s }

Validations:
Optional

MinRetryRate defines the minimum rate of retries that will be allowable over a specified duration of time.

The effective overall minimum rate of retries targeting the backend service may be much higher, as there can be any number of clients which are applying this setting locally.

This ensures that requests can still be retried during periods of low traffic, where the budget for retries may be calculated as a very low value.

Support: Extended

Validations:
Optional

Validations:
Required

Spec defines the desired state of XBackend.

Validations:
Optional

Status defines the current state of XBackend.

Validations:
Optional

Validations:
Required

Spec defines the desired state of BackendTrafficPolicy.

Validations:
Optional

Status defines the current state of BackendTrafficPolicy.

Validations:
Optional

Validations:
Required

Spec defines the desired state of XMesh.

Default: { conditions:[map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for controller reason:Pending status:Unknown type:Accepted]] }

Validations:
Optional

Status defines the current state of XMesh.