Update Readme #240
Update Readme #240
Conversation
README.md
Outdated
|
|
||
| ## Quick Start | ||
|
|
||
| - Prerequisite |
There was a problem hiding this comment.
| - Prerequisite | |
| ### Prerequisite |
Subheadings can be used
There was a problem hiding this comment.
I didn't mean to change this in this pr.
Actually all most of the changes are the CR LR to LR
README.md
Outdated
|
|
||
| - The complete Kmesh capability depends on the OS enhancement. Check for the [OS lists](docs/kmesh_support.md) supported by Kmesh. For other OS environments, refer to [Kmesh Compilation and Building Guide](docs/kmesh_compile.md) to build kesh image locally. | ||
|
|
||
| - Kmesh Install |
README.md
Outdated
|
|
||
| - Currently, Kmesh makes use of [Istio](https://github.com/istio/istio) as its control plane. Before starting Kmesh, please install the Istio control plane. To support ads mode, refer to [istio install guide](https://istio.io/latest/docs/setup/getting-started/#install), but to support workload mode, please refer to [ambient install guide](https://istio.io/latest/docs/ops/ambient/install/helm-installation/#installing-the-components). | ||
|
|
||
| - The complete Kmesh capability depends on the OS enhancement. Check for the [OS lists](docs/kmesh_support.md) supported by Kmesh. For other OS environments, refer to [Kmesh Compilation and Building Guide](docs/kmesh_compile.md) to build kesh image locally. |
There was a problem hiding this comment.
Wouldn't it be better to add "we will support more os versions in the future"?
README.md
Outdated
|
|
||
| - Kmesh Install | ||
|
|
||
| Install kmesh with helm |
There was a problem hiding this comment.
| Install kmesh with helm | |
| Install Kmesh with helm |
README.md
Outdated
| [root@ ~]# helm install kmesh ./deploy/helm -n kmesh-system --create-namespace | ||
| ``` | ||
|
|
||
| - Check kmesh component status |
README.md
Outdated
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint:v0.3.0" to the `default` gateway. Then gateway pod will rollout with kmesh image. Now kmesh remote L7 is enabled! | ||
|
|
||
| ```bash | ||
| kubectl annotate gateways.gateway.networking.k8s.io default "sidecar.istio.io/proxyImage=ghcr.io/kmesh-net/waypoint:v0.3.0" |
There was a problem hiding this comment.
now kmesh doesn't support multi-platform image, ref: #239 . So image name of waypoint should be "ghcr.io/kmesh-net/waypoint-{arch}:v0.3.0"
There was a problem hiding this comment.
maybe hide that atm. This should align with kmesh daemon image
|
|
||
| The service mesh software represented by Istio has gradually become popular and has become an important component of cloud infrastructure. However, the current service mesh still face some challenges: | ||
|
|
||
| - **Extra latency overhead at the proxy layer**: Single hop service access increases by [2~3ms](https://istio.io/latest/docs/ops/deployment/performance-and-scalability/#data-plane-performance), which cannot meet the SLA requirements of latency-sensitive applications. Although the community has come up with a variety of data plane solutions to this problem, the overhead introduced by agents cannot be completely reduced. |
There was a problem hiding this comment.
if you take a look at the latest document, it's not that much.
There was a problem hiding this comment.
That was tested with the istio sidecar, both kmesh and istio tests are based on a same machine, so i think it is equal
There was a problem hiding this comment.
Latency for Istio 1.21
Inside the mesh, a request traverses the client-side proxy and then the server-side proxy. In the default configuration of Istio 1.21.1 (i.e. Istio with telemetry v2), the two proxies add about 0.182 ms and 0.248 ms to the 90th and 99th percentile latency, respectively, over the baseline data plane latency. We obtained these results using the Istio benchmarks for the http/1.1 protocol, with a 1 kB payload at 1000 requests per second using 2,4,8,16,32,64 client connections, 2 proxy workers and mutual TLS enabled.
There was a problem hiding this comment.
I don't know there's so much improve in 1.21, but the what Kmesh said here(2-3ms) is not the latest.
There was a problem hiding this comment.
The test environment is same. @nlgwcy One point wanna to confirm, is the istio test with mtls and stats enabled
| Install kmesh with helm | ||
|
|
||
| ```sh | ||
| [root@ ~]# helm install kmesh ./deploy/helm -n kmesh-system --create-namespace |
There was a problem hiding this comment.
you'd better setup a chart repo or use oci image, that would be help to avoid to clone the repo.
Signed-off-by: Zhonghu Xu <xuzhonghu@huawei.com>
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: nlgwcy The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Update readme newline from CR LF to LF
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: