CSGShip
1. 概述
CSGShip 是 CSGHub 平台的 智能编码助手后端服务,为 CodeSouler(IDE 插件) 提供智能补全、语义搜索、对话式编程、AI 代码生成与知识检索等能力。该组件以独立服务形式部署,可单独扩展计算节点,支持多实例水平扩展,并可与主服务(CSGHUB Server)协同运行。
2. 环境要求
| 资源项 | 最低配置 | 推荐配置 |
|---|---|---|
| CPU / 内存 | 4C / 8 GB | 8C / 16 GB |
| 磁盘空间 | 10 GB | 50 GB+ |
| 架构支持 | AMD64 / ARM64 | 支持多架构部署 |
软件依赖
| 组件 | 版本要求 | 说明 |
|---|---|---|
| Kubernetes | 1.32+ | 集群环境 |
| Helm | 3.12+ | Chart 管理工具 |
| PostgreSQL / Redis | 可选(外部) | 可使用外部托管资源 |
3. 开始安装
-
添加 Helm 仓库
helm repo add csghub https://charts.opencsg.com/csghubhelm repo update -
创建命名空间(可选)
kubectl create namespace csghub -
安装 CSGShip
以下信息从 CSGHub 主服务处获取:
-
domain这里需要提供一个二级域名用于暴露 runner 服务。
如果提供的域名是
example.com,服务将暴露在csgship.example.com和csgship-api.example.com下。 -
externalUrlhelm get notes csghub -n csghub | grep -A 6 'Access your CSGHub'获取 CSGHub 对应的URL。
-
hubAPITokenkubectl get cm csghub-core -o yaml -n csghub | grep 'API_TOKEN' | awk '{print $NF}' -
natskubectl get secret -n csghub csghub-nats \-o jsonpath='{.data.NATS_USERNAME}' | base64 -d && \echo -n " / " && \kubectl get secret -n csghub csghub-nats \-o jsonpath='{.data.NATS_PASSWORD}' | base64 -d- 以上命令提供
user,password host目前仅支持使用服务名(即和 CSGHub 同集群部署,也可自行暴露服务)port固定值 4222
💡 提示:建议将自定义配置写入
custom-values.yaml,方便后续升级与版本管理。helm install csgship csghub/csgship \--namespace csghub \--create-namespace \--set global.gateway.external.domain="example.com" \--set externalUrl="<csghub externalUrl>" \--set hubAPIToken="<csghub hub_api_token>" \--set billing.nats.host="<csghub nats service>" \--set billing.nats.port=4222 \--set billing.nats.user="<csghub nats username>" \--set billing.nats.password="<csghub nats password>"国内部署(使用国内镜像仓库加速拉取镜像):
helm install csgship csghub/csgship \--namespace csghub \--create-namespace \--set global.gateway.external.domain="example.com" \--set externalUrl="<csghub externalUrl>" \--set hubAPIToken="<csghub hub_api_token>" \--set billing.nats.host="<csghub nats service>" \--set billing.nats.port=4222 \--set billing.nats.user="<csghub nats username>" \--set billing.nats.password="<csghub nats password>" \--set global.image.registry="registry.opencsg.com" \--set global.imageRegistry="registry.opencsg.com/opencsghq" - 以上命令提供
-
-
访问路径示例
| 服务 | 地址 | 说明 |
|---|---|---|
| CSGShip 前端 | http://csgship.example.com | 安装时需要配置--set web.oauth,见问问 |
| CSGShip API | http://csgship-api.example.com |
4. 参数配置说明
4.1 全局配置
| 参数 | 默认值 | 说明 |
|---|---|---|
| global.gateway.external.domain | csghub.example.com | 平台访问域名 |
| global.gateway.tls.enabled | false | 是否启用 HTTPS / TLS |
| global.persistence.size | 10Gi | 默认持久化卷大小 |
| global.postgresql.enabled | true | 启用内置 PostgreSQL |
| global.redis.enabled | true | 启用内置 Redis |
| global.chartContext.isBuiltIn | false | 是否作为主 Chart 子模块安装 |