82bbcbd137
The Markdown files were all originally named "$x/_index.md"; I renamed
them as follows:
```
for x in `ls ~/conduit-site/conduit.io/content`; do
cp ~/conduit-site/conduit.io/content/$x/_index.md doc/$x.md
done
mv doc/doc.md doc/overview.md
```
When we publish the files on conduit.io we need to do the inverse
transformation to avoid breaking existing links.
The images were embedded using a syntax GitHub doesn't support. Also, the
images were not originally in a subdirectory of docs/.
Use normal Markdown syntax for image embedding, and reference the docs
using relative links to the images/ subdirectory. This way they will show
up in the GitHub UI. When we publish the docs on conduit.io we'll need to
figure out how to deal with this change.
I took the liberty of renaming data-plane.png to dashboard-data-plane.png to
clarify it a bit.
There is no other roadmap so there's no need to qualify this one as
"public." Before it was made public we marked it "public" to emphasize
that it would become public, but that isn't needed now.
Signed-off-by: Brian Smith <brian@briansmith.org>
|
||
|---|---|---|
| .github | ||
| bin | ||
| cli | ||
| controller | ||
| doc | ||
| pkg | ||
| proto | ||
| proxy | ||
| proxy-init | ||
| web | ||
| .dockerignore | ||
| .editorconfig | ||
| .gcp.json.enc | ||
| .gitattributes | ||
| .gitignore | ||
| .prometheus.dev.yml | ||
| .travis.yml | ||
| BUILD.md | ||
| CHANGES.md | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| DCO | ||
| Dockerfile-base | ||
| Dockerfile-go-deps | ||
| Gopkg.lock | ||
| Gopkg.toml | ||
| LICENSE | ||
| README.md | ||
| docker-compose.yml | ||
README.md
🎈 Welcome to Conduit! 👋
Conduit is an ultralight service mesh for Kubernetes. It features a minimalist control plane written in Go, and a native proxy data plane written in Rust that boasts the performance of C without the heartbleed.
Conduit is alpha. It is capable of proxying all TCP traffic, and reporting
top-line metrics (success rates, latencies, etc) for all HTTP, HTTP/2, and gRPC traffic.
It currently does not work with websockets or with HTTP tunneling--see the
--skip-outbound-ports flag for how to exclude these types of traffic.
Get involved
- conduit-users mailing list: Conduit user discussion mailing list.
- conduit-dev mailing list: Conduit development discussion mailing list.
- conduit-announce mailing list: Conduit announcements only (low volume).
- Follow @RunConduit on Twitter.
- Join the #conduit channel on the Linkerd Slack.
Documentation
View Conduit docs for more a more comprehensive guide to getting started, or view the full Conduit roadmap.
Getting started with Conduit
-
Install the Conduit CLI with
curl https://run.conduit.io/install | sh. -
Add
$HOME/.conduit/binto yourPATH. -
Install Conduit into your Kubernetes cluster with:
conduit install | kubectl apply -f -. -
Verify that the installation succeeded with
conduit check. -
Explore the Conduit controller with
conduit dashboard. -
Optionally, install a demo application to run with Conduit.
-
Add your own service to the Conduit mesh!
Working in this repo
BUILD.md includes general information on how to work in this repo.
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
Conduit is copyright 2018 Buoyant, Inc. 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.