Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update 1.x README to point to 2.x repo #2416

Merged
merged 4 commits into from Mar 16, 2021
Merged

update 1.x README to point to 2.x repo #2416

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87d182b
update 1.x README to point to 2.x repo
wmorgan Feb 9, 2021
5f722d3
typo
wmorgan Feb 9, 2021
b5721f8
Update README.md
wmorgan Feb 22, 2021
fec6cd3
wording
wmorgan Feb 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Expand Up @@ -6,17 +6,15 @@
[![Docker Pulls][docker-badge]][docker]
[![CII Best Practices][cii-badge]][cii]

:balloon: Welcome to Linkerd! :wave:
**This repo is for the 1.x version of Linkerd. Feature development is now
happening in the [linkerd2][l5d2] repo. This repo is currently only used for
periodic maintenance releases of Linkerd 1.x.**

Linkerd is a transparent *service mesh*, designed to make modern applications
safe and sane by transparently adding service discovery, load balancing, failure
handling, instrumentation, and routing to all inter-service communication.

Linkerd (pronounced "linker-DEE") acts as a transparent HTTP/gRPC/thrift/etc
proxy, and can usually be dropped into existing applications with a minimum of
configuration, regardless of what language they're written in. It works with
many common protocols and service discovery backends, including scheduled
environments like Mesos and Kubernetes.
Linkerd 1.x (pronounced "linker-DEE") acts as a transparent
HTTP/gRPC/thrift/etc proxy, and can usually be dropped into existing
applications with a minimum of configuration, regardless of what language
they're written in. It works with many common protocols and service discovery
backends, including scheduled environments like Nomad, Mesos and Kubernetes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Its fully featured with powerful load balancing algorithms, failure handling, instrumentation,
distributed tracing and dynamic request routing.
It also offers a stand-alone version of the service discovery components called Namerd,
which enables a scalable architecture with centralised namers and a simple api for adaptation
to other load balancing systems.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nice description, just a bit of punctuation that is missing:

Linkerd is fully featured with powerful load balancing algorithms, failure handling, instrumentation, 
distributed tracing, and dynamic request routing.
It also offers a stand-alone version of the service discovery components, called Namerd, 
which enables a scalable architecture with centralised "namers" and a simple api for adaptation 
to other load balancing systems.

Linkerd is built on top of [Netty][netty] and [Finagle][finagle], a
production-tested RPC framework used by high-traffic companies like Twitter,
Expand All @@ -30,8 +28,8 @@ We distribute binaries which you can download from the [Linkerd releases
page][releases]. We also publish Docker images for each release, which you can
find on [Docker Hub][docker].

For instructions on how to configure and run Linkerd, see the [user
documentation on linkerd.io](https://linkerd.io).
For instructions on how to configure and run Linkerd, see the [1.x user
documentation on linkerd.io](https://linkerd.io/1/).

## Working in this repo ##

Expand All @@ -48,6 +46,8 @@ contributing changes.

## Related Repos ##

* [linkerd2][l5d2]: The main repo for Linkerd 2.x and where current development
is happening.
* [linkerd-examples][l5d-eg]: A variety of configuration examples and explanations
* [linkerd-tcp][l5d-tcp]: A lightweight TCP/TLS load balancer that uses Namerd
* [linkerd-viz][l5d-viz]: Zero-configuration service dashboard for Linkerd
Expand Down Expand Up @@ -90,6 +90,7 @@ specific language governing permissions and limitations under the License.
[l5d-tcp]: https://github.com/linkerd/linkerd-tcp
[l5d-viz]: https://github.com/linkerd/linkerd-viz
[l5d-zipkin]: https://github.com/linkerd/linkerd-zipkin
[l5d2]: https://github.com/linkerd/linkerd2
[license-badge]: https://img.shields.io/github/license/linkerd/linkerd.svg
[namerctl]: https://github.com/linkerd/namerctl
[netty]: https://netty.io/
Expand Down