add kmesh l7 content to user guide #32
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| ### L7 Traffic Management | ||
|
|
||
| - Deploy the sample application | ||
| - Add default namespace to Kmesh |
There was a problem hiding this comment.
Suggested change
| - Add default namespace to Kmesh | |
| - Using the Kmesh manager default namespace |
| - Deploy bookinfo | ||
|
|
||
| ``` | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/bookinfo/platform/kube/bookinfo.yaml |
There was a problem hiding this comment.
How about putting the bookinfo configuration in the Kmesh sample?
| - Deploy sleep as curl client | ||
|
|
||
| ``` | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleep/sleep.yaml |
There was a problem hiding this comment.
sleep
Suggested change
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleep/sleep.yaml | |
| [root@ ~]# kubectl apply -f ./sample/sleep/sleep.yaml |
There was a problem hiding this comment.
Here we can use a full path
Signed-off-by: YaoZengzeng <[email protected]>
hzxuzhonghu
reviewed
Apr 30, 2024
| @@ -0,0 +1,98 @@ | |||
| --- | |||
| draft: false | |||
| linktitle: L7 Traffic Management | |||
There was a problem hiding this comment.
This is too general. We may call Try Waypoint
hzxuzhonghu
reviewed
Apr 30, 2024
There was a problem hiding this comment.
I think the content should be like:
Before you begin
- add some overall desc about this task
- some pre setup if needed
- some application install if needed
Apply weight-based routing
Here we should apply the configs and then watch the output, which can be using browser or response from the http requests
Understanding what happened
Some desc help people understand what happens
Cleanup
should cleanup all the setup/deployment/configs
Signed-off-by: YaoZengzeng <[email protected]>
Signed-off-by: YaoZengzeng <[email protected]>
Signed-off-by: YaoZengzeng <[email protected]>
hzxuzhonghu
reviewed
May 6, 2024
|
|
||
| --- | ||
|
|
||
| ### Before you begin |
There was a problem hiding this comment.
Add ordered list for each step
|
|
||
| Deploy sample application: | ||
|
|
||
| Using Kmesh manage default namespace |
|
|
||
| Deploy bookinfo: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```bash |
|
|
||
| Deploy sleep as curl client: | ||
|
|
||
| ``` |
| Deploy sleep as curl client: | ||
|
|
||
| ``` | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleepsleep.yaml |
There was a problem hiding this comment.
Suggested change
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleepsleep.yaml | |
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleep.yaml |
| sleep-9454cc476-86vgb 1/1 Running 0 4m25s | ||
| ``` | ||
|
|
||
| Replace the waypoint image with the Kmesh customized image. Based on istio-proxy, Kmesh adds an customized listener filter called [kmesh_tlv](https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv) to connect L4 and L7. |
There was a problem hiding this comment.
connect L4 and L7 is too wide. It is to parse our private protocol which takes additional target address or metadata, etc. We should better word it
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleep/sleep.yaml | ||
| ``` | ||
|
|
||
| Remove Kmesh: |
There was a problem hiding this comment.
Maybe we donot need to mention how to uninstall kmesh in each task. Generally we donot want it to be uninstalled
| sleep-9454cc476-86vgb 1/1 Running 0 4m25s | ||
| ``` | ||
|
|
||
| Replace the waypoint image with the Kmesh customized image. Based on istio-proxy, Kmesh adds an customized listener filter called [kmesh_tlv](https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv) to connect L4 and L7. |
There was a problem hiding this comment.
Suggested change
| Replace the waypoint image with the Kmesh customized image. Based on istio-proxy, Kmesh adds an customized listener filter called [kmesh_tlv](https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv) to connect L4 and L7. | |
| Replace the waypoint image with the Kmesh customized image. Based on istio-proxy, Kmesh adds an customized listener filter called [Kmesh_tlv](https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv) to connect L4 and L7. |
| bookinfo-reviews istio-waypoint 10.96.207.125 True 8m36s | ||
| ``` | ||
|
|
||
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint-{arch}:v0.3.0" to the `bookinfo-reviews` gateway, convert `{arch}` to the architecture of the host, current optional values are `x86` and `arm`. Then gateway pod will restart. Now kmesh is L7 enabled! |
There was a problem hiding this comment.
Suggested change
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint-{arch}:v0.3.0" to the `bookinfo-reviews` gateway, convert `{arch}` to the architecture of the host, current optional values are `x86` and `arm`. Then gateway pod will restart. Now kmesh is L7 enabled! | |
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint-{arch}:v0.3.0" to the `bookinfo-reviews` gateway, convert `{arch}` to the architecture of the host, current optional values are `x86` and `arm`. Then gateway pod will restart. Now Kmesh is L7 enabled! |
|
|
||
| --- | ||
|
|
||
| ### Before you begin |
There was a problem hiding this comment.
Suggested change
| ### Before you begin | |
| ### Preparation |
|
|
||
| ``` | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/bookinfo/networking/virtual-service-reviews-90-10.yaml | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/bookinfo/networking/destination-rule-reviews.yaml |
There was a problem hiding this comment.
Perhaps we can put these configurations in Kmesh's samples folder.
Or make it look like this:
kubectl apply -f -<<EOF
apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: reviews
spec:
hosts:
- reviews
http:
- route:
- destination:
host: reviews
subset: v1
weight: 90
- destination:
host: reviews
subset: v2
weight: 10
---
apiVersion: networking.istio.io/v1alpha3
kind: DestinationRule
metadata:
name: reviews
spec:
host: reviews
trafficPolicy:
loadBalancer:
simple: RANDOM
subsets:
- name: v1
labels:
version: v1
- name: v2
labels:
version: v2
- name: v3
labels:
version: v3
EOFMore intuitively show users specific configurations. No need for the user to go to another project to view
|
|
||
| ``` | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/bookinfo/networking/virtual-service-reviews-90-10.yaml | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/bookinfo/networking/destination-rule-reviews.yaml |
There was a problem hiding this comment.
Is there a mistake here?
kubectl delete -f XXX|
|
||
| ``` | ||
| [root@ ~]# kubectl delete -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/bookinfo/platform/kube/bookinfo.yaml | ||
| [root@ ~]# kubectl apply -f https://raw.githubusercontent.com/istio/istio/release-1.21/samples/sleep/sleep.yaml |
| menu: | ||
| docs: | ||
| parent: userguide | ||
| weight: 1 |
There was a problem hiding this comment.
Change to a value greater than 1 to prevent conflicts
|
|
||
| --- | ||
|
|
||
| ### 开始之前 |
There was a problem hiding this comment.
Suggested change
| ### 开始之前 | |
| ### 准备 |
| sleep-9454cc476-86vgb 1/1 Running 0 4m25s | ||
| ``` | ||
|
|
||
| 用kmesh自定义的镜像替换waypoint的原生镜像。基于istio-proxy，Kmesh增加了一个名为[kmesh_tlv](https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv)的自定义listener filter用于连接L4和L7 |
There was a problem hiding this comment.
Suggested change
| 用kmesh自定义的镜像替换waypoint的原生镜像。基于istio-proxy，Kmesh增加了一个名为[kmesh_tlv](https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv)的自定义listener filter用于连接L4和L7 | |
| 用Kmesh自定义的镜像替换waypoint的原生镜像。基于istio-proxy，Kmesh增加了一个名为[Kmesh_tlv]K(https://github.com/kmesh-net/waypoint/tree/master/source/extensions/filters/listener/kmesh_tlv)的自定义listener filter用于连接L4和L7 |
3 tasks
Signed-off-by: YaoZengzeng <[email protected]>
|
@hzxuzhonghu @LiZhenCheng9527 updated |
|
|
||
| ### Understanding what happend | ||
|
|
||
| Because `default` namespace has been managed by Kmesh and we have deployed a waypoint proxy for service account `bookinfo-reviews`, so all traffic sent to service `reviews` will be forwarded to waypoint by Kmesh. Waypoint will send 90% of requests to `reviews` v1 and 10% to `reviews` v2 according to the route rules we set. |
There was a problem hiding this comment.
Suggested change
| Because `default` namespace has been managed by Kmesh and we have deployed a waypoint proxy for service account `bookinfo-reviews`, so all traffic sent to service `reviews` will be forwarded to waypoint by Kmesh. Waypoint will send 90% of requests to `reviews` v1 and 10% to `reviews` v2 according to the route rules we set. | |
| Because `default` namespace has been managed by Kmesh and we have deployed a waypoint proxy for service account `bookinfo-reviews`, so all traffic sent to service `reviews` will be forwarded to waypoint by Kmesh. Waypoint will send 90% of requests to `reviews v1` and 10% to `reviews v2` according to the route rules we set. |
| bookinfo-reviews istio-waypoint 10.96.207.125 True 8m36s | ||
| ``` | ||
|
|
||
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint-{arch}:v0.3.0" to the `bookinfo-reviews` gateway, convert `{arch}` to the architecture of the host, current optional values are `x86` and `arm`. Then gateway pod will restart. Now Kmesh is L7 enabled! |
There was a problem hiding this comment.
Suggested change
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint-{arch}:v0.3.0" to the `bookinfo-reviews` gateway, convert `{arch}` to the architecture of the host, current optional values are `x86` and `arm`. Then gateway pod will restart. Now Kmesh is L7 enabled! | |
| Add annotation "sidecar.istio.io/proxyImage: ghcr.io/kmesh-net/waypoint-arch:v0.3.0" to the `bookinfo-reviews` gateway, convert `arch` to the architecture of the host, current optional values are `x86` and `arm`. Then gateway pod will restart. Now Kmesh is L7 enabled! |
Maybe it's better? I am not sure
| EOF | ||
| ``` | ||
|
|
||
| Confirm that roughly 90% of the traffic go to `reviews` v1 |
There was a problem hiding this comment.
Suggested change
| Confirm that roughly 90% of the traffic go to `reviews` v1 | |
| Confirm that roughly 90% of the traffic go to `reviews v1` |
|
|
||
| ### Apply weight-based routing | ||
|
|
||
| Configure traffic routing to send 90% of requests to `reviews` v1 and 10% to `reviews` v2 |
There was a problem hiding this comment.
Suggested change
| Configure traffic routing to send 90% of requests to `reviews` v1 and 10% to `reviews` v2 | |
| Configure traffic routing to send 90% of requests to `reviews v1` and 10% to `reviews v2` |
hzxuzhonghu
reviewed
May 7, 2024
| Confirm that roughly 90% of the traffic go to `reviews` v1 | ||
|
|
||
| ```bash | ||
| [root@ ~]# kubectl exec deploy/sleep -- sh -c "for i in \$(seq 1 100); do curl -s http:productpage:9080/productpage | grep reviews-v.-; done" |
Signed-off-by: YaoZengzeng <[email protected]>
|
@hzxuzhonghu @LiZhenCheng9527 updated |
hzxuzhonghu
approved these changes
May 8, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hzxuzhonghu 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 |
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.