linkerd/linkerd-tcp is tracked by TopGit as a backend project, with 530 stars on GitHub, written primarily in Rust. A TCP/TLS load balancer for Linkerd 1.x.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Lightweight, native TCP and TLS load balancer built on tokio.
Weighted-least-loaded P2C load balancing.
Minimal resource utilization: typically <.5 cores with ~2MB RSS.
Tightly integrated with the linkerd service mesh.
Supports endpoint weighting (i.e. for "red line" testing).
Modern Transport Layer Security via rustls:
TLS1.2 and TLS1.3 (draft 18) only.
ECDSA or RSA server authentication by clients.
RSA server authentication by servers.
Forward secrecy using ECDHE; with curve25519, nistp256 or nistp384 curves.
AES128-GCM and AES256-GCM bulk encryption, with safe nonces.
Chacha20Poly1305 bulk encryption.
ALPN support.
SNI support.
Quickstart
Install Rust and Cargo.
Run namerd. ./namerd.sh fetches, configures, and runs namerd using a local-fs-backed discovery (in ./tmp.discovery).
From this repository, run: cargo run -- example.yml
We :heart: pull requests! See CONTRIBUTING.md for info on
contributing changes.
Usage
linkerd-tcp 0.1.0
A native TCP proxy for the linkerd service mesh
USAGE:
linkerd-tcp <PATH>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
<PATH> Config file path
Example configuration
# Administrative control endpoints are exposed on a dedicated HTTP server. Endpoints
# include:
# - /metrics -- produces a snapshot of metrics formatted for prometheus.
# - /shutdown -- POSTing to this endpoint initiates graceful shutdown.
# - /abort -- POSTing to this terminates the process immediately.
admin:
port: 9989
# By default, the admin server listens only on localhost. We can force it to bind
# on all interfaces by overriding the IP.
ip: 0.0.0.0
# Metrics are snapshot at a fixed interval of 10s.
metricsIntervalSecs: 10
# A process exposes one or more 'routers'. Routers connect server traffic to
# load balancers.
routers:
# Each router has a 'label' for reporting purposes.
- label: default
# Each router is configured to resolve names.
# Currently, only namerd's HTTP interface is supported:
interpreter:
kind: io.l5d.namerd.http
baseUrl: http://localhost:4180
namespace: default
periodSecs: 20
servers:
# Each router has one or more 'servers' listening for incoming connections.
# By default, routers listen on localhost. You need to specify a port.
- port: 7474
dstName: /svc/default
# You can limit the amount of time that a server will wait to obtain a
# connection from the router.
connectTimeoutMs: 500
# By default each server listens on 'localhost' to avoid exposing an open
# relay by default. Servers may be configured to listen on a specific local
# address or all local addresses (0.0.0.0).
- port: 7575
ip: 0.0.0.0
# Note that each server may route to a different destination through a
# single router:
dstName: /svc/google
# Servers may be configured to perform a TLS handshake.
tls:
defaultIdentity:
privateKey: private.pem
certs:
- cert.pem
- ../eg-ca/ca/intermediate/certs/ca-chain.cert.pem
# Clients may also be configured to perform a TLS handshake.
client:
kind: io.l5d.static
# We can also apply linkerd-style per-client configuration:
configs:
- prefix: /svc/google
connectTimeoutMs: 400
# Require that the downstream connection be TLS'd, with a
# `subjectAltName` including the DNS name _www.google.com_
# using either our local CA or the host's default openssl
# certificate.
tls:
dnsName: "www.google.com"
trustCerts:
- ../eg-ca/ca/intermediate/certs/ca-chain.cert.pem
- /usr/local/etc/openssl/cert.pem
Logging
Logging may be enabled by setting RUST_LOG=linkerd_tcp=info on the environment. When
debugging, set RUST_LOG=trace.
Docker
To build the linkerd/linkerd-tcp docker image, run:
./dockerize latest
Replace latest with the version that you want to build.
Try running the image with:
docker run -v `pwd`/example.yml:/example.yml linkerd/linkerd-tcp:latest /example.yml
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
Copyright 2017-2018 Linkerd-TCP 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.
The most recent commit recorded on linkerd/linkerd-tcp was 3.2 years ago, based on the GitHub push timestamp. The repository has 27 forks — one of the better signals of community interest.
Is linkerd/linkerd-tcp open source?
Yes — linkerd/linkerd-tcp ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/linkerd/linkerd-tcp.
What license does linkerd/linkerd-tcp use?
linkerd/linkerd-tcp is released under the Apache-2.0 license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is linkerd/linkerd-tcp associated with?
GitHub's repository topics for linkerd/linkerd-tcp: "linkerd", "load-balancer", "rust", "service-mesh", "tcp", "tls", "tokio". TopGit's editorial category is Backend.
Where can I see linkerd/linkerd-tcp in action?
The project maintains a homepage at https://linkerd.io. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about linkerd/linkerd-tcp?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/linkerd/linkerd-tcp is the definitive source.
Read full README in the tab above.
Want a second opinion on linkerd-tcp?
Ask an AI that can read this page — one click and you get its take on linkerd-tcp.