Skip to content

Commit c420460

Browse files
committed
Clarify IBKR deployment unit and naming
1 parent 808944b commit c420460

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,13 @@ Important:
156156
- The workflow only becomes strict when `ENABLE_GITHUB_ENV_SYNC=true`. If this variable is unset, the sync job is skipped.
157157
- Here "shared config" still only means the **IBKR pair** (`IBKRQuant` + `IBKRGatewayManager`). `GCP_SA_KEY` and `TELEGRAM_TOKEN` remain repository-specific.
158158

159+
### Deployment unit and naming
160+
161+
- `QuantPlatformKit` is only a shared dependency; Cloud Run still deploys `InteractiveBrokersQuant` itself.
162+
- Recommended Cloud Run service name: `interactive-brokers-quant`.
163+
- If you later rename or move this repository, reselect the GitHub source in Cloud Build / Cloud Run trigger instead of assuming the existing source binding will update itself.
164+
- For the shared deployment model and trigger migration checklist, see [`QuantPlatformKit/docs/deployment_model.md`](../QuantPlatformKit/docs/deployment_model.md).
165+
159166
### Deployment
160167

161168
1. **GCE**: Set up IB Gateway (paper or live) on a GCE instance. Ensure API access is enabled, remote clients are allowed when needed, and use `4001` for `live` or `4002` for `paper`.
@@ -301,6 +308,13 @@ NOTIFY_LANG=zh
301308
- 只有在 `ENABLE_GITHUB_ENV_SYNC=true` 时,这个 workflow 才会严格校验并执行同步。没打开时会直接跳过。
302309
- 这里说的“共享配置”仍然只针对 **IBKR 这一组系统**`GCP_SA_KEY``TELEGRAM_TOKEN` 依然是这个仓库自己的 secrets,不建议提升成所有 quant 共用的全局 secret。
303310

311+
### 部署单元和命名建议
312+
313+
- `QuantPlatformKit` 只是共享依赖,不单独部署;Cloud Run 继续只部署 `InteractiveBrokersQuant`
314+
- 推荐 Cloud Run 服务名:`interactive-brokers-quant`
315+
- 如果后面改 GitHub 仓库名或再次迁组织,Cloud Build / Cloud Run 里的 GitHub 来源需要重新选择,不要假设旧绑定会自动跟过去。
316+
- 统一部署模型和触发器迁移清单见 [`QuantPlatformKit/docs/deployment_model.md`](../QuantPlatformKit/docs/deployment_model.md)
317+
304318
### 部署
305319

306320
1. **GCE**: 部署 IB Gateway(模拟或实盘),确认 API 已开启、需要远程连接时已允许非 localhost 客户端,并确认 `live` 使用 `4001``paper` 使用 `4002`

0 commit comments

Comments
 (0)