package io.linkerd.proxy.destination

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Get (GetDestination, stream Update)

  destination.proto:53

  Given a destination, return all addresses in that destination as a long- running stream of updates.

  message Update

  destination.proto:73

  • oneof update

    • WeightedAddrSet add = 1

      A new set of endpoints are available for the service. The set might be empty.

    • AddrSet remove = 2

      Some endpoints have been removed from the service.

    • NoEndpoints no_endpoints = 3

      `no_endpoints{exists: false}` indicates that the service does not exist and the client MAY try an alternate service discovery method (e.g. DNS). `no_endpoints(exists: true)` indicates that the service does exist and the client MUST NOT fall back to an alternate service discovery method.

• rpc GetProfile (GetDestination, stream DestinationProfile)

  destination.proto:57

  Given a destination, return that destination's profile and send an update whenever it changes.

  message DestinationProfile

  destination.proto:221

  • string fully_qualified_name = 5

    The fully-qualified service name, if one exists. When resolving (especially by IP), this field provides the fully-qualified name of the resolved service, if one exists. This field does NOT include any port information. E.g. a lookup for 10.2.3.4:8080 might have a name like `foo.bar.svc.cluster.local`. Implementations MAY provide names for non-service IP-lookups (e.g., pod or node dns names), but this is not required. If the lookup does not refer to a known named entity, this field MUST be left empty.

  • bool opaque_protocol = 4

    Indicates that connections on this service address should be handled as opaque TCP streams. HTTP routes returned on for such services will be ignored.

  • repeated Route routes = 1

    A list of routes, each with a RequestMatch. If a request matches more than one route, the first match wins.

  • optional RetryBudget retry_budget = 2

    The retry budget controls how much additional load the proxy can generate as retries. Failured requests on retryable routes will not be retried if there is no available budget.

  • repeated WeightedDst dst_overrides = 3

    If this list is non-empty, requests to this destination should instead be split between the destinations in this list. Each destination should receive a portion of the requests proportional to its weight. If this list is empty, requests should be sent to this destination as normal.

  • optional WeightedAddr endpoint = 6

    If this field is set, it indicates that the target is a known endpoint (and not a service address). The values of `fully_qualified_name` and `dst_overrides` will be ignored for the purposes of service discovery-- traffic split and load balancing will be skipped and the single endpoint are used. No endpoint should be set If the target is unknown.

  • optional meta.Metadata parent_ref = 7

    A reference to the metadata for this destination, usually a service. May be omitted if the destination is not a service.

  • optional meta.Metadata profile_ref = 8

    A reference to the metadata for a ServiceProfile resource. This is omitted when no ServiceProfile resource exists.

Used in: Update

• repeated net.TcpAddress addrs = 1

Used in: WeightedAddr

• string authority_override = 1

Used as request type in: Destination.Get, Destination.GetProfile

• string scheme = 1

• string path = 2

• string context_token = 3

  An opaque value that is set at injection-time and sent with destintion lookups. If, for instance, the token encodes a namespace or some locality information, the service may alter its results to take this locality into account.

Configures the parameters used to initialize an HTTP/2 connection.

Used in: WeightedAddr

• optional Http2ClientParams.FlowControl flow_control = 1

  Overrides the default client flow control settings.

• optional Http2ClientParams.KeepAlive keep_alive = 2

  Enables keep-alive timeouts.

• optional Http2ClientParams.Internals internals = 3

  Configures Hyper internals.

Used in: Http2ClientParams

• uint32 initial_connection_window_size = 1

  Configures the maximum connection-level flow control window size.

• uint32 initial_stream_window_size = 2

  Configures the maximum stream-level flow control window size.

• bool adaptive_flow_control = 3

  Enables Hyper's adaptive flow control, ignoring other window settings.

Used in: Http2ClientParams

• uint32 max_concurrent_reset_streams = 1

• uint32 max_frame_size = 2

• uint32 max_send_buf_size = 3

Used in: Http2ClientParams

• optional google.protobuf.Duration interval = 1

  The time between pings.

• optional google.protobuf.Duration timeout = 2

  The time to wait for a ping response before considering the connection dead.

• bool while_idle = 3

  Whether to send pings when there is no other traffic.

If either a minimum or maximum is not specified, the range is considered to be over a discrete value.

Used in: ResponseMatch

• uint32 min = 1

  Minimum matching http status code (inclusive), if specified.

• uint32 max = 2

  Maximum matching http status code (inclusive), if specified.

Used in: Update

• bool exists = 1

Used in: RequestMatch

• string regex = 1

  Match if the request path matches this regex.

A hint of what protocol the service knows. The default value is for the `hint` field to be not be set, essentially meaning "unknown".

Used in: WeightedAddr

• oneof protocol

  • ProtocolHint.H2 h2 = 1

    Hints that the service understands HTTP2 and the proxy's internal http2-upgrade mechanism.

  • ProtocolHint.Opaque opaque = 3

    Hints that the destination will handle this connection as an opaque TCP stream, and (if `opaque_transport` is set) that the proxy should not send a `SessionProtocol` as part of its transport header.

• optional ProtocolHint.OpaqueTransport opaque_transport = 2

  When set, indicates that the target supports receiving opaque traffic wrapped with the Linkerd connection header on the specified port.

Used in: ProtocolHint

(message has no fields)

Used in: ProtocolHint

(message has no fields)

Used in: ProtocolHint

• uint32 inbound_port = 1

  The target proxy's inbound port.

Used in: RequestMatch.Seq, Route

• oneof match

  • RequestMatch.Seq all = 1

  • RequestMatch.Seq any = 2

  • RequestMatch not = 3

  • PathMatch path = 4

  • http_types.HttpMethod method = 5

    TODO: match on arbitrary header

Used in: RequestMatch

• repeated RequestMatch matches = 1

Used in: Route

• optional ResponseMatch condition = 1

  This class contains responses which match this condition.

• bool is_failure = 2

  If responses in this class should be considered failures. This defaults to false (success).

Used in: ResponseClass, ResponseMatch.Seq

• oneof match

  • ResponseMatch.Seq all = 1

  • ResponseMatch.Seq any = 2

  • ResponseMatch not = 3

  • HttpStatusRange status = 4

    TODO: match on arbitrary header or trailer

Used in: ResponseMatch

• repeated ResponseMatch matches = 1

Used in: DestinationProfile

• float retry_ratio = 1

  The ratio of additional traffic that may be added by retries. A retry_ratio of 0.1 means that 1 retry may be attempted for every 10 regular requests. A retry_ratio of 1.0 means that 1 retry may be attempted for every 1 regular request (in other words, total request load may be doubled as a result of retries).

• uint32 min_retries_per_second = 2

  The proxy may always attempt this number of retries per second, even if it would violate the retry_ratio. This is to allow retries to happen even when the request rate is very low.

• optional google.protobuf.Duration ttl = 3

  This duration indicates for how long requests should be considered for the purposes of enforcing the retry_ratio. A higher value considers a larger window and therefore allows burstier retries.

Used in: DestinationProfile

• optional RequestMatch condition = 1

  This route contains requests which match this condition.

• repeated ResponseClass response_classes = 2

  A list of response classes for this route. If a response matches more than one ResponseClass, the first match wins. If a response does not match any ResponseClasses, it is considered to be a successful response.

• map<string, string> metrics_labels = 3

  Metric labels to attach to requests and responses that match this route.

• bool is_retryable = 4

  If a route is retryable, any failed requests on that route may be retried by the proxy.

• optional google.protobuf.Duration timeout = 5

  After this time has elapsed since receiving the initial request, any outstanding request will be cancelled, a timeout error response will be returned, and no more retries will be attempted.

Used in: WeightedAddr

• oneof strategy

  • TlsIdentity.DnsLikeIdentity dns_like_identity = 1

  • TlsIdentity.UriLikeIdentity uri_like_identity = 3

• optional TlsIdentity.DnsLikeIdentity server_name = 4

  The server name of the endpoint. This is the value that needs to be included by clients in the ClientHello SNI extension of the TLS handshake when they initiate TLS connections to servers.

Verify the certificate based on the Kubernetes pod identity.

Used in: TlsIdentity

• string name = 1

  A DNS-like name that encodes workload coordinates. For example: {name}.{namespace}.{type}.identity.{control-namespace}.{trust-domain...}

Verify the certificate based on an URI identity.

Used in: TlsIdentity

• string uri = 1

  A URI name that encodes workload identity. For example: spiffe://trust-domain/workload-dentifier

Used in: DestinationProfile, WeightedAddrSet, outbound.Backend

• optional net.TcpAddress addr = 1

• uint32 weight = 3

• map<string, string> metric_labels = 4

• optional TlsIdentity tls_identity = 5

• optional ProtocolHint protocol_hint = 6

• optional AuthorityOverride authority_override = 7

• optional Http2ClientParams http2 = 8

  The HTTP/2 parameters to use when connecting to the destination, if HTTP/2 is used. These parameters are used by proxies when the application traffic is HTTP/2 or when the H2 ProtocolHint is used to transport HTTP/1 connections over HTTP/2.

• optional meta.Metadata resource_ref = 9

  A reference to the metadata for this endpoint, usually a Pod. This may be omitted when the resource type is unknown.

Used in: Update

• repeated WeightedAddr addrs = 1

• map<string, string> metric_labels = 2

Used in: DestinationProfile

• string authority = 1

  This authority will be used as the `path` in a call to the Destination.Get rpc.

• uint32 weight = 2

  The proportion of requests to send to this destination. This value is relative to other weights in the same dst_overrides list.

• optional meta.Metadata backend_ref = 3

  A reference to the metadata for a Service resource.