1# Linkerd
2
3![Linkerd][logo]
4
5[](https://bestpractices.coreinfrastructure.org/projects/4629)
6[![GitHub Actions Status][github-actions-badge]][github-actions]
7[](LICENSE)
8[![Go Report Card][go-report-card-badge]][go-report-card]
9[![Go Reference][go-doc-badge]][go-doc]
10[![Slack Status][slack-badge]][slack]
11
12:balloon: Welcome to Linkerd! :wave:
13
14Linkerd is an ultralight, security-first service mesh for Kubernetes. Linkerd
15adds critical security, observability, and reliability features to your
16Kubernetes stack with no code change required.
17
18Linkerd is a Cloud Native Computing Foundation ([CNCF][cncf]) project.
19
20## Repo layout
21
22This is the primary repo for the Linkerd 2.x line of development.
23
24The complete list of Linkerd repos is:
25
26* [linkerd2][linkerd2]: Main Linkerd 2.x repo, including control plane and CLI
27* [linkerd2-proxy][proxy]: Linkerd 2.x data plane proxy
28* [linkerd2-proxy-api][proxy-api]: Linkerd 2.x gRPC API bindings
29* [linkerd][linkerd1]: Linkerd 1.x
30* [website][linkerd-website]: linkerd.io website (including docs for 1.x and
31 2.x)
32
33## Quickstart and documentation
34
35You can run Linkerd on any modern Kubernetes cluster in a matter of seconds.
36See the [Linkerd Getting Started Guide][getting-started] for how.
37
38For more comprehensive documentation, start with the [Linkerd
39docs][linkerd-docs]. (The doc source code is available in the
40[website][linkerd-website] repo.)
41
42## Working in this repo
43
44[`BUILD.md`](BUILD.md) includes general information on how to work in this repo.
45
46We :heart: pull requests! See [`CONTRIBUTING.md`](CONTRIBUTING.md) for info on
47contributing changes.
48
49## Get involved
50
51* Join Linkerd's [user mailing list][linkerd-users], [developer mailing
52 list][linkerd-dev], and [announcements mailing list][linkerd-announce].
53* Follow [@Linkerd][twitter] on Twitter.
54* Join the [Linkerd Slack][slack].
55* Join us in the regular online community meetings!
56
57## Community meetings
58
59We host regular online meetings for contributors, adopters, maintainers, and
60anyone else interested to connect in a synchronous fashion. These meetings
61usually take place the last Thursday of the month at 9am Pacific / 4pm UTC.
62
63* [Zoom link](https://zoom.us/my/cncflinkerd)
64* [Google calendar](https://calendar.google.com/calendar/embed?src=buoyant.io_j28ik70vrl3418f4oldkdici7o%40group.calendar.google.com)
65* [Minutes from previous meetings](https://docs.google.com/document/d/1OvXYL5Q53klQFZPokQJas72YqkWXplkPQUguFbRW7Wo/edit)
66* [Recordings from previous meetings](https://www.youtube.com/playlist?list=PLI9FkLPXDscBHP91Ud3lyJScI4ZCjRG6F)
67
68We're a friendly group, so please feel free to join us!
69
70## Steering Committee meetings
71
72We host regular online meetings for the Linkerd Steering Committee. All are
73welcome to attend, but audio and video participation is limited to Steering
74Committee members and maintainers. These meetings are currently scheduled on an
75ad-hoc basis and announced on the [linkerd-users][linkerd-users] mailing list.
76
77* [Zoom link](https://zoom.us/my/cncflinkerd)
78* [Minutes from previous meetings](https://docs.google.com/document/d/1GDNM5eosiyjVDo6YHXBMsvlpyzUldgg-XLMNzf7I404/edit)
79* [Recordings from previous meetings](https://www.youtube.com/playlist?list=PLI9FkLPXDscBHP91Ud3lyJScI4ZCjRG6F)
80
81## Code of Conduct
82
83This project is for everyone. We ask that our users and contributors take a few
84minutes to review our [Code of Conduct][CoC].
85
86## Security
87
88See [SECURITY.md](SECURITY.md) for our security policy, including how to report
89vulnerabilities.
90
91Linkerd undergoes periodic third-party security audits and we
92[publish the results here](https://github.com/linkerd/linkerd2/tree/main/audits).
93
94## License
95
96Copyright 2023 the Linkerd Authors. All rights reserved.
97
98Licensed under the Apache License, Version 2.0 (the "License"); you may not use
99these files except in compliance with the License. You may obtain a copy of the
100License at
101
102 http://www.apache.org/licenses/LICENSE-2.0
103
104Unless required by applicable law or agreed to in writing, software distributed
105under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
106CONDITIONS OF ANY KIND, either express or implied. See the License for the
107specific language governing permissions and limitations under the License.
108
109<!-- refs -->
110[github-actions]: https://github.com/linkerd/linkerd2/actions
111[github-actions-badge]: https://github.com/linkerd/linkerd2/actions/workflows/actions.yml/badge.svg
112[cncf]: https://www.cncf.io/
113[CoC]: https://github.com/linkerd/linkerd/wiki/Linkerd-code-of-conduct
114[getting-started]: https://linkerd.io/2/getting-started/
115[go-report-card]: https://goreportcard.com/report/github.com/linkerd/linkerd2
116[go-report-card-badge]: https://goreportcard.com/badge/github.com/linkerd/linkerd2
117[go-doc-badge]: https://pkg.go.dev/badge/github.com/linkerd/linkerd2.svg
118[go-doc]: https://pkg.go.dev/github.com/linkerd/linkerd2
119[linkerd1]: https://github.com/linkerd/linkerd
120[linkerd2]: https://github.com/linkerd/linkerd2
121[linkerd-announce]: https://lists.cncf.io/g/cncf-linkerd-announce
122[linkerd-dev]: https://lists.cncf.io/g/cncf-linkerd-dev
123[linkerd-docs]: https://linkerd.io/2/overview/
124[linkerd-users]: https://lists.cncf.io/g/cncf-linkerd-users
125[linkerd-website]: https://github.com/linkerd/website
126[logo]: https://user-images.githubusercontent.com/9226/33582867-3e646e02-d90c-11e7-85a2-2e238737e859.png
127[proxy]: https://github.com/linkerd/linkerd2-proxy
128[proxy-api]: https://github.com/linkerd/linkerd2-proxy-api
129[slack-badge]: http://slack.linkerd.io/badge.svg
130[slack]: http://slack.linkerd.io
131[twitter]: https://twitter.com/linkerd
View as plain text