Repository files navigation

This repo contains the gRPC bindings that theLinkerd Proxy uses tocommunicate with theLinkerd control plane.

Generally, the proxy's APIs are Kubernetes-agnostic and expose abstractions thatallow proxies to discover runtime configuration.

The destination API is used by proxies to discover information about outboundtraffic. This configuration includes:

• the protocol of the destination, if known
• whether the destination is a load balanced service or individual endpoint
• labels to describe the destination in telemetry
• the mTLS identity of destination pods

The identity API is used by proxies to obtain TLS certificates used forauthenticed pod-to-pod communication.

The inbound API is used by the proxy to discover inbound servingpolicies, i.e. per-port authorization requirements and rate-limiting poilcy.

The proxy can be configured to expose a gRPC server that allows the controlplane to query metadata about live requests transiting the proxy.

The./proto directory includes protobuf definitions.

The./go directory contains statically generated Go bindings, which aregenerally used bycontroller implementations.

This repository publishes thelinkerd2-proxy-api crate,which usestonic to expose client and server implementations for eachAPI. Each API may be enabled independently with cargo feature flags.

Theproxy generally uses API clients. Some server implementationsare also used by thecontrol plane.

Issues may be opened in thelinkerd2 repository.

Copyright 2022 The Linkerd AuthorsLicensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at    http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.