diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docs/coze-deployment.md b/docs/coze-deployment.md deleted file mode 100644 index 2ec3d821..00000000 --- a/docs/coze-deployment.md +++ /dev/null @@ -1,272 +0,0 @@ -# OpenCoze 部署手册 - -## Local/VM (Docker Compose) - -### 环境准备 - -| **项目** | **说明** | -| --- | --- | -| CPU | 8 Core | -| RAM | 16 GiB | -| Go | * 已安装 Go，且版本为 1.24.2 及以上版本。
* 配置 GOPATH，同时将 `${GOPATH}/bin` 加入到环境变量 PATH 中，保证安装的二进制工具可找到并运行。 | -| Docker | 提前安装 Docker、Docker Compose，并启动 Docker 服务，详细操作请参考 Docker 文档：

* **macOS**：推荐使用 Docker Desktop 安装，参考 [Docker Desktop For Mac](https://docs.docker.com/desktop/setup/install/mac-install/) 安装指南。
* **Linux**：参考 [Docker 安装指南](https://docs.docker.com/engine/install/) 和 [Docker Compose](https://docs.docker.com/compose/install/) 安装指南。
* **Windows**：推荐使用 Docker Desktop 安装，参考 [Docker Desktop For Windows](https://docs.docker.com/desktop/setup/install/windows-install/) 安装指南。 | - -```shell -# 验证安装 -docker compose version -``` - -### 部署步骤 - -1. **获取代码** - - ```shell - git clone https://github.com/coze-dev/coze-studio.git - ``` - -2. **配置模型** - 进入目录 `coze-studio/backend/conf/model/meta` - 修改 `doubao.yaml`（或其他模型文件）： - - `api_key`: 火山方舟 API Key（[获取指南](https://www.volcengine.com/docs/82379/1541594)） - - `model`: 方舟模型 ID（[模型列表](https://www.volcengine.com/docs/82379/1330310)） - - ```yaml - id: 102 - name: Doubao-1.5-pro-32k - icon_uri: doubao_v2.png - ... - conn_config: - api_key: # 你的API Key - model: # 模型名称 - ``` - -3. **启动服务** - - ```bash - cd coze-studio/docker - cp .env.example .env - docker compose --profile '*' up -d - ``` - ---- - -## 火山容器云部署（Helm） - -### 环境准备 - -| **工具** | **安装说明** | -|------------|--------------| -| **kubectl**| **macOS**：`brew install kubectl`
**Linux**：
`curl -LO "https://dl.k8s.io/release/$(curl -Ls https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"`
`chmod +x kubectl && sudo mv kubectl /usr/local/bin/`
**Windows**：`winget install -e --id Kubernetes.kubectl` | -| **Helm** | **macOS**：`brew install helm`
**Linux**：下载[最新版本](https://github.com/helm/helm/releases)
`tar -zxvf helm-*.tar.gz && sudo mv linux-amd64/helm /usr/local/bin/`
**Windows**：下载并添加PATH | - -```shell -# 验证安装 -kubectl version --client -helm version -``` - -### 自动创建火山云基础组件（可选） -> ⚠️ 创建火山云组件可能产生云产品费用 - -1. **进入目录** - - ```shell - cd scripts/volcengine - cp .volcengine.example.env .env - ``` -2. **设置API密钥** - - 创建[API访问密钥](https://console.volcengine.com/iam/keymanage) - - ```bash - export VE_AK="your_ak" - export VE_SK="your_sk" - ``` - -3. **创建组件** - - ```shell - # ⚠️ 创建火山云组件可能产生云产品费用 - go run . - - # 输出示例： - Output Env : - # MySQL - export MYSQL_DATABASE=opencoze - export MYSQL_USER=coze - export MYSQL_PASSWORD=Opencoze123 - export MYSQL_HOST=vedbm-*****.pri.mysql.vedb.ivolces.com - export MYSQL_PORT=3306 - - # Redis - export REDIS_ADDR=redis-*****.redis.ivolces.com:6379 - - # Elasticsearch - export ES_VERSION=v7 - export ES_ADDR=http://elasticsearch-o-*****.escloud.ivolces.com:9200 - export ES_USERNAME=admin - export ES_PASSWORD=********** - - # RocketMQ - export RMQ_NAME_SERVER=http://rocketmq-*****.rocketmq.ivolces.com:9876 - export RMQ_ACCESS_KEY=Xbg8*************** - export RMQ_SECRET_KEY=smJLA*************** - ``` - -### 镜像推送 - -1. **创建镜像服务** - - 在 [火山云镜像服务控制台](https://console.volcengine.com/cr/)，按需创建自己的镜像仓库规格。 - -2. **设置仓库密码** - ![](images/85c1b50c-a745-45fc-a67c-57d702b33d57.png) - -3. **创建命名空间** - ![](images/c0f2b37a-cd2d-4e05-a349-b77bb9fbcdc0.png) - * iac：存放 mysql、redis、elasticsearch 等组件的空间 - * opencoze：存储 coze 镜像的空间 - -4. **登录仓库** - ![](images/33a41ab0-5a38-46b9-9fec-a773d0133b7e.png) - - ```shell - docker login --username=xxx opencoze-cn-beijing.cr.volces.com - ``` - -5. **推送服务镜像** - - ```shell - cd ./backend - docker buildx build \ - --platform linux/amd64,linux/arm64 \ - -t 你的仓库域名/opencoze/opencoze:0.0.1 \ - -t 你的仓库域名/opencoze/opencoze:latest \ - -f backend/Dockerfile \ - --push . - ``` - -6. **推送依赖镜像（可选）** - - ```shell - cd ./helm/charts/opencoze - # 编辑 push_imgaes_to_volcengine.sh 按需修改使用到的镜像 - ./push_imgaes_to_volcengine.sh - ``` - -### Helm 部署 - -1. **创建K8S集群** - 登录 [火山云VKE控制台](https://console.volcengine.com/vke) 创建 `K8S` 集群。 - -2. **创建节点池** - ![](images/6c52064d-6cf5-4c61-9109-949faf7d15cb.png) - -3. **配置kubectl** - ![](images/892d7557-ab74-4dab-b437-0f2367c3f915.png) - ![](images/9f212be4-1800-43ac-90c7-be6fddb356c4.png) - ![](images/fc55865d-f21e-4147-8d7a-1b0848aa975e.png) - - 复制集群`config`到 `~/.kube/config` - -4. **创建存储类（可选）** - * 如果使用了`MySQL`、`Redis`、`RocketMQ`、`Elasticsearch`等存储组件，则需要创建。 - * 名称建议：`opencoze-data`，使用其他名字需要修改 `helm/charts/opencoze/values.yaml`中`storageClassName`配置。 - ![](images/343844c2-f7df-45f7-a916-3fdc01d2b6f7.png) - - - -5. **修改Helm配置** - 编辑 `helm/charts/opencoze/values.yaml`文件，按需配置自己需要部署的组件: - - ```yaml - cozeServer: - enabled: true - ... - mysql: - enabled: true - ... - redis: - enabled: true - ... - rocketmq: - enabled: true - ... - elasticsearch: - enabled: true - ... - minio: - enabled: true - ... - etcd: - enabled: true - ... - milvus: - enabled: true - ... - kibana: - enabled: true - ``` - -6. **启动服务** - - ```shell - cd ./helm/charts/opencoze - helm upgrade --install opencoze . -n opencoze --create-namespace - ``` - -7. **查看状态** - - ```shell - kubectl get pods --namespace opencoze - # 等待所有Pod状态变为Running - # 输出 - NAME READY STATUS RESTARTS AGE - opencoze-elasticsearch-0 1/1 Running 0 4h28m - opencoze-es-init-w6q5h 0/1 Completed 0 4h28m - opencoze-etcd-0 1/1 Running 0 4h28m - opencoze-kibana-75775d5b94-jpk4h 1/1 Running 0 4h28m - opencoze-milvus-0 1/1 Running 0 4h28m - opencoze-minio-0 1/1 Running 0 4h28m - opencoze-mysql-0 1/1 Running 0 4h28m - opencoze-mysql-init-2bhxq 0/1 Completed 0 28s - opencoze-redis-0 1/1 Running 0 4h28m - opencoze-rocketmq-broker-0 1/1 Running 0 4h28m - opencoze-rocketmq-namesrv-0 1/1 Running 0 4h28m - opencoze-server-6b9f6b4d66-f2qzd 1/1 Running 0 4h28m - ``` - - 等`opencoze-server-* pod`状态变成`Running`以后，表示服务启动成功 - ![](images/11b97b9c-0426-4389-a29b-a47ce241dcbd.png) - ![](images/f351ea8f-9436-45e1-bde5-0a100f4a9728.png) - -8. **获取服务IP** - - ```shell - kubectl get service --namespace opencoze - # 使用 opencoze-server 的 EXTERNAL-IP - ``` - - 通过 `opencoze-server` 的`EXTERNAL-IP:8888`访问`coze`服务 - -9. **其他配置（可选）** - - - 端口`ACL/IP`白名单 - - 调整公网`IP`带宽（默认`1M`） - - 修改`MINIO_ENDPOINT` - - 手动上传 `docker/volumes/minio/default_icon` 和 `volumes/minio/official_plugin_icon`到 `minio` 服务。 - -10. **运维操作** - - ```shell - # 升级 - helm upgrade --install opencoze . -n opencoze --create-namespace - - # 回滚 - helm history opencoze -n opencoze - helm rollback opencoze - - # 卸载 - helm uninstall opencoze -n opencoze - - # 删除所有数据 - kubectl delete ns opencoze - ``` \ No newline at end of file diff --git a/docs/images/11b97b9c-0426-4389-a29b-a47ce241dcbd.png b/docs/images/11b97b9c-0426-4389-a29b-a47ce241dcbd.png deleted file mode 100644 index 252fa904..00000000 Binary files a/docs/images/11b97b9c-0426-4389-a29b-a47ce241dcbd.png and /dev/null differ diff --git a/docs/images/33a41ab0-5a38-46b9-9fec-a773d0133b7e.png b/docs/images/33a41ab0-5a38-46b9-9fec-a773d0133b7e.png deleted file mode 100644 index 1f819c8b..00000000 Binary files a/docs/images/33a41ab0-5a38-46b9-9fec-a773d0133b7e.png and /dev/null differ diff --git a/docs/images/343844c2-f7df-45f7-a916-3fdc01d2b6f7.png b/docs/images/343844c2-f7df-45f7-a916-3fdc01d2b6f7.png deleted file mode 100644 index d7b287de..00000000 Binary files a/docs/images/343844c2-f7df-45f7-a916-3fdc01d2b6f7.png and /dev/null differ diff --git a/docs/images/3da91f6e-ee05-452e-9bf2-ac3d9d43b7e6.png b/docs/images/3da91f6e-ee05-452e-9bf2-ac3d9d43b7e6.png deleted file mode 100644 index 59849dd8..00000000 Binary files a/docs/images/3da91f6e-ee05-452e-9bf2-ac3d9d43b7e6.png and /dev/null differ diff --git a/docs/images/6c52064d-6cf5-4c61-9109-949faf7d15cb.png b/docs/images/6c52064d-6cf5-4c61-9109-949faf7d15cb.png deleted file mode 100644 index 55db50e9..00000000 Binary files a/docs/images/6c52064d-6cf5-4c61-9109-949faf7d15cb.png and /dev/null differ diff --git a/docs/images/85c1b50c-a745-45fc-a67c-57d702b33d57.png b/docs/images/85c1b50c-a745-45fc-a67c-57d702b33d57.png deleted file mode 100644 index 85a06648..00000000 Binary files a/docs/images/85c1b50c-a745-45fc-a67c-57d702b33d57.png and /dev/null differ diff --git a/docs/images/892d7557-ab74-4dab-b437-0f2367c3f915.png b/docs/images/892d7557-ab74-4dab-b437-0f2367c3f915.png deleted file mode 100644 index adc23a65..00000000 Binary files a/docs/images/892d7557-ab74-4dab-b437-0f2367c3f915.png and /dev/null differ diff --git a/docs/images/9f212be4-1800-43ac-90c7-be6fddb356c4.png b/docs/images/9f212be4-1800-43ac-90c7-be6fddb356c4.png deleted file mode 100644 index c9fc47b9..00000000 Binary files a/docs/images/9f212be4-1800-43ac-90c7-be6fddb356c4.png and /dev/null differ diff --git a/docs/images/c0f2b37a-cd2d-4e05-a349-b77bb9fbcdc0.png b/docs/images/c0f2b37a-cd2d-4e05-a349-b77bb9fbcdc0.png deleted file mode 100644 index 246bd8d9..00000000 Binary files a/docs/images/c0f2b37a-cd2d-4e05-a349-b77bb9fbcdc0.png and /dev/null differ diff --git a/docs/images/f351ea8f-9436-45e1-bde5-0a100f4a9728.png b/docs/images/f351ea8f-9436-45e1-bde5-0a100f4a9728.png deleted file mode 100644 index ef49c5ba..00000000 Binary files a/docs/images/f351ea8f-9436-45e1-bde5-0a100f4a9728.png and /dev/null differ diff --git a/docs/images/fc55865d-f21e-4147-8d7a-1b0848aa975e.png b/docs/images/fc55865d-f21e-4147-8d7a-1b0848aa975e.png deleted file mode 100644 index 9d343643..00000000 Binary files a/docs/images/fc55865d-f21e-4147-8d7a-1b0848aa975e.png and /dev/null differ