Skip to content

Commit

Permalink
docs: improve dev guide (#743)
Browse files Browse the repository at this point in the history
  • Loading branch information
seeflood authored Jul 29, 2022
1 parent 69d04ec commit ad5050f
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions docs/zh/operation/local.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
# 如何本地开发、本地调试
## app 开发者如何本地开发、调试 app
## 1. app 开发者如何本地开发、调试 app
一般有以下几种方案:

- 本地用 docker 启动一个 Layotto sidecar, 或者 docker-compose启动 Layotto+其他存储系统(比如 Redis)
- 公司提供远端 Layotto sidecar
### 1.1. 本地启动 sidecar
本地用 docker 启动一个 Layotto sidecar, 或者 docker-compose启动 Layotto+其他存储系统(比如 Redis)

### 1.2. 公司提供远端 Layotto sidecar

比如在远端测试环境,自己拉起一个 Pod,在里面跑 Layotto sidecar。

1. 如果您能以ip直接访问远端测试环境pod:
1. 可以把 Layotto ip 修改为上述 Pod ip,本地ip直连pod
2. 如果不能以ip直接访问远端测试环境pod:
1. 可以将该pod的service类型,设置为`NodePort`或者`LoadBalancer`,本地直连pod service
2. 可以将该pod注册到gateway,本地直连gateway
- 如果您能以ip直接访问远端测试环境pod:
- 可以把 Layotto ip 修改为上述 Pod ip,本地ip直连pod
- 如果不能以ip直接访问远端测试环境pod:
- 可以将该pod的service类型,设置为`NodePort`或者`LoadBalancer`,本地直连pod service
- 可以将该pod注册到gateway,本地直连gateway

开发者在本地调试时,使用以上方式即可实现"本地 app 进程连接到远端 Layotto sidecar"。

更进一步,可以由公司里负责研发环境的团队把上述操作自动化,提供"一键申请远端 sidecar" 功能。

- 如果公司有类似于 github codespace的云端研发环境,那可以在研发环境自带 sidecar
### 1.3. 云端研发环境
如果公司有类似于 github codespace的云端研发环境,那可以在研发环境自带 sidecar


## 2. Layotto 开发者如何本地、开发调试 Layotto
本地编译运行 Layotto 即可。

例如,用 Goland IDE 运行 Layotto 时,配置如下图所示:

## Layotto 开发者如何本地、开发调试 Layotto
本地编译运行 Layotto 即可
![](https://gw.alipayobjects.com/mdn/rms_5891a1/afts/img/A*CHFYQK6kMEgAAAAAAAAAAAAAARQnAQ)

0 comments on commit ad5050f

Please sign in to comment.