keyfil/教程/20250402-使用KtConnect实现本地Debug.md

67 lines
3.0 KiB
Markdown
Raw Normal View History

2025-04-01 20:46:01 +08:00
<!-- Space: qifu -->
<!-- Parent: 后端技术&知识&规范 -->
<!-- Parent: 技术方案 -->
<!-- Parent: 基建 -->
<!-- Parent: 04-使用教程 -->
<!-- Title: 20250402-使用KtConnect实现本地Debug -->
<!-- Macro: :anchor\((.*)\):
Template: ac:anchor
Anchor: ${1} -->
<!-- Macro: \!\[.*\]\((.+)\)\<\!\-\- width=(.*) \-\-\>
Template: ac:image
Url: ${1}
Width: ${2} -->
<!-- Macro: \<\!\-\- :toc: \-\-\>
Template: ac:toc
Printable: 'false'
MinLevel: 2
MaxLevel: 4 -->
<!-- Include: 杂项/声明文件.md -->
<!-- :toc: -->
# 20250402-使用KtConnect实现本地Debug
## 前置说明
- 快速开始https://github.com/alibaba/kt-connect/blob/master/docs/zh-cn/guide/quickstart.md
## 使用
### 下载 kt-connect
- 访问 release 页面https://github.com/alibaba/kt-connect/releases/tag/v0.3.7
- 或者直接使用wget下载
```shell
wget https://github.com/alibaba/kt-connect/releases/download/v0.3.7/ktctl_0.3.7_Windows_x86_64.zip
```
### Mesh 服务
用于将指定服务的部分流量重定向到本地。基本用法如下:
```bash
ktctl mesh <目标服务名> --expose <本地端口>:<目标服务端口>
```
命令可选参数:
```
--mode value 实现流量重定向的路由方式,可选值为 "auto"(默认)和 "manual"
--expose value 指定目标服务的一个或多个端口,格式为`port``local:remote`多个端口用逗号分隔例如7001,8080:80
--versionMark value 指定本地服务路由的版本标签值,格式可以是 `<标签值>``<标签名>:``<标签名>:<标签值>`
--skipPortChecking 不必检查指定的本地端口是否有服务监听
--routerImage value 仅用于auto模式指定Router Pod使用的镜像地址
```
关键参数说明:
- `--mode`提供了两种服务重定向路由的方式。
默认的`auto`模式采用Router Pod实现HTTP请求的自动路由无需额外配置服务网格组件适用于集群中未部署服务网格的场景。
`manual`模式仅将本地服务"混入"集群中并打上特定的版本Label开发者自行通过服务网格组件如Istio灵活配置路由规则。
- `--expose`是一个必须的参数它的值应当与目标Service的`port`属性值相同若本地运行服务的端口与目标Service的`port`属性值不一致,则应当使用`<本地端口>:<目标Service端口>`的方式来指定。
- `--versionMark`用于指定路由到本地的Header或Label名称和值。默认值为"version:\<随机生成值\>",可仅指定标签值,如`--versionMark demo`;可用标签名加冒号的格式仅指定标签名,如`--versionMark kt-mark:`;也可以同时指定标签的名称和值,如`--versionMark kt-mark:demo`
`auto`模式下该值实际上是用于路由的Header。在`manual`模式下该值为附加在通往本地服务的Shadow Pod上额外的Label。
#### 例子
- KubeConfig 文件需要找运维拿
```shell
.\ktctl.exe mesh <目标服务名> --namespace qifu --expose <本地端口>:<目标服务端口> --kubeconfig /env/.kube/KubeConfig
```