444174a194
If we run make in a cross-compile environment where the strip binary we want to use is something else than strip, it is useful to have a STRIP variable in the Makefile. If STRIP is not set, the default value is the common strip. Signed-off-by: Joakim Roubert <joakim.roubert@axis.com> |
||
|---|---|---|
| .github | ||
| hyper-balance | ||
| linkerd | ||
| linkerd2-proxy | ||
| opencensus-proto | ||
| profiling | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| DCO | ||
| Dockerfile | ||
| GOVERNANCE.md | ||
| LICENSE | ||
| MAINTAINERS.md | ||
| Makefile | ||
| README.md | ||
| rust-toolchain | ||
| update-rust-version.sh | ||
README.md
This repo contains the transparent proxy component of Linkerd2. While the Linkerd2 proxy is heavily influenced by the Linkerd 1.X proxy, it comprises an entirely new codebase implemented in the Rust programming language.
This proxy's features include:
- Transparent, zero-config proxying for HTTP, HTTP/2, and arbitrary TCP protocols.
- Automatic Prometheus metrics export for HTTP and TCP traffic;
- Transparent, zero-config WebSocket proxying;
- Automatic, latency-aware, layer-7 load balancing;
- Automatic layer-4 load balancing for non-HTTP traffic;
- Automatic TLS (experimental);
- An on-demand diagnostic
tapAPI.
This proxy is primarily intended to run on Linux in containerized environments like Kubernetes, though it may also work on other Unix-like systems (like macOS).
The proxy supports service discovery via DNS and the linkerd2
Destination gRPC API.
The Linkerd project is hosted by the Cloud Native Computing Foundation (CNCF).
Building the project
A Makefile is provided to automate most build tasks. It provides the
following targets:
make build-- Compiles the proxy on your local system usingcargomake clean-- Cleans the build target on the local system usingcargo cleanmake test-- Runs unit and integration tests on your local system usingcargomake test-flakey-- Runs all tests, including those that may fail spuriouslymake package-- Builds a tarball attarget/release/linkerd2-proxy-${PACKAGE_VERSION}.tar.gz. IfPACKAGE_VERSIONis not set in the environment, the local git SHA is used.make docker-- Builds a Docker container image that can be used for testing. If theDOCKER_TAGenvironment variable is set, the image is given this name. Otherwise, the image is not named.
Cargo
Usually, Cargo, Rust's package manager, is used to build and test this project. If you don't have Cargo installed, we suggest getting it via https://rustup.rs/.
Repository Structure
This project is broken into many small libraries, or crates, so that components may be compiled & tested independently. The following crate targets are especially important:
linkerd2-proxycontains the proxy executable;linkerd2-app-integrationcontains the proxy's integration tests;linkerd2-appbundles thelinkerd2-app-inboundandlinkerd2-app-outboundcrates so that they may be run by the executable or integration tests.
Code of conduct
This project is for everyone. We ask that our users and contributors take a few minutes to review our code of conduct.
License
linkerd2-proxy is copyright 2018 the linkerd2-proxy authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed 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 and limitations under the License.