diff --git a/docs/devstar-deploy/asset/image-20251104201036920.png b/docs/devstar-deploy/asset/image-20251104201036920.png new file mode 100644 index 0000000000..e48526c917 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104201036920.png differ diff --git a/docs/devstar-deploy/asset/image-20251104201132614.png b/docs/devstar-deploy/asset/image-20251104201132614.png new file mode 100644 index 0000000000..f9a593c3a4 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104201132614.png differ diff --git a/docs/devstar-deploy/asset/image-20251104203152647.png b/docs/devstar-deploy/asset/image-20251104203152647.png new file mode 100644 index 0000000000..1ccefc43c3 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104203152647.png differ diff --git a/docs/devstar-deploy/asset/image-20251104203353406.png b/docs/devstar-deploy/asset/image-20251104203353406.png new file mode 100644 index 0000000000..1ccefc43c3 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104203353406.png differ diff --git a/docs/devstar-deploy/asset/image-20251104203454915.png b/docs/devstar-deploy/asset/image-20251104203454915.png new file mode 100644 index 0000000000..b46c8072d7 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104203454915.png differ diff --git a/docs/devstar-deploy/asset/image-20251104203757243.png b/docs/devstar-deploy/asset/image-20251104203757243.png new file mode 100644 index 0000000000..8048c6ad31 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104203757243.png differ diff --git a/docs/devstar-deploy/asset/image-20251104204421088.png b/docs/devstar-deploy/asset/image-20251104204421088.png new file mode 100644 index 0000000000..1cfd29d30f Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104204421088.png differ diff --git a/docs/devstar-deploy/asset/image-20251104204424116.png b/docs/devstar-deploy/asset/image-20251104204424116.png new file mode 100644 index 0000000000..1cfd29d30f Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104204424116.png differ diff --git a/docs/devstar-deploy/asset/image-20251104204453766.png b/docs/devstar-deploy/asset/image-20251104204453766.png new file mode 100644 index 0000000000..899306ddf8 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104204453766.png differ diff --git a/docs/devstar-deploy/asset/image-20251104221729545.png b/docs/devstar-deploy/asset/image-20251104221729545.png new file mode 100644 index 0000000000..11b36fdd4c Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104221729545.png differ diff --git a/docs/devstar-deploy/asset/image-20251104221749140.png b/docs/devstar-deploy/asset/image-20251104221749140.png new file mode 100644 index 0000000000..99ff679956 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104221749140.png differ diff --git a/docs/devstar-deploy/asset/image-20251104221811555.png b/docs/devstar-deploy/asset/image-20251104221811555.png new file mode 100644 index 0000000000..879b21a5ac Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104221811555.png differ diff --git a/docs/devstar-deploy/asset/image-20251104221928154.png b/docs/devstar-deploy/asset/image-20251104221928154.png new file mode 100644 index 0000000000..22741b1577 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104221928154.png differ diff --git a/docs/devstar-deploy/asset/image-20251104221950856.png b/docs/devstar-deploy/asset/image-20251104221950856.png new file mode 100644 index 0000000000..e8e3d306f2 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104221950856.png differ diff --git a/docs/devstar-deploy/asset/image-20251104221953043.png b/docs/devstar-deploy/asset/image-20251104221953043.png new file mode 100644 index 0000000000..e8e3d306f2 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104221953043.png differ diff --git a/docs/devstar-deploy/asset/image-20251104222023293.png b/docs/devstar-deploy/asset/image-20251104222023293.png new file mode 100644 index 0000000000..3a9b9edcf8 Binary files /dev/null and b/docs/devstar-deploy/asset/image-20251104222023293.png differ diff --git a/docs/devstar-deploy/devstar_deploy.md b/docs/devstar-deploy/devstar_deploy.md new file mode 100644 index 0000000000..53946c6b69 --- /dev/null +++ b/docs/devstar-deploy/devstar_deploy.md @@ -0,0 +1,124 @@ +# Devstar 部署文档 + +## 1. 安装 Helm + +在开始部署前,请先安装 Helm。建议使用官方提供的安装脚本,具体步骤可参考:安装 Helm | Helm。 + +推荐使用 `get_helm.sh`脚本进行安装,执行如下命令: + +``` +curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 +chmod 700 get_helm.sh +./get_helm.sh +``` + +## 2. 获取并准备部署文件 + +在待部署的机器上新建一个目录,然后将 DevStar 的 Helm Chart 仓库克隆到该目录中。请注意,该仓库为私有仓库,需先获取访问权限。 + +如部署目标为 `devstar.cn`,请确保切换到对应的分支(如图所示): + +![image-20251104221729545](C:\Users\nimesulide\AppData\Roaming\Typora\typora-user-images\image-20251104221729545.png) + +将代码仓库克隆到本地后,目录中应包含以下四个脚本文件: + +![image-20251104221749140](C:\Users\nimesulide\AppData\Roaming\Typora\typora-user-images\image-20251104221749140.png) + +## 3. 首次安装 + +执行 `step1-install-helm.sh`脚本进行首次安装。安装时间取决于网络状况和镜像拉取速度,请耐心等待。 + +安装完成后,使用以下命令检查 Pod 状态: + +``` +kubectl get pods -n devstar-studio-ns +``` + +如发现 Pod 状态异常,可使用如下命令排查: + +- 查看 Pod 日志: + + ``` + kubectl logs -n devstar-studio-ns + ``` + +- 查看 Pod 详细信息: + + ``` + kubectl describe pod -n devstar-studio-ns + ``` + +首次安装时,Pod 可能处于 `Pending`状态,通常是由于 PVC(PersistentVolumeClaim)未绑定到对应的 PV(PersistentVolume)所致。请检查 PV 与 PVC 的状态: + +``` +kubectl get pv -A +kubectl get pvc -A +``` + +![image-20251104221811555](C:\Users\nimesulide\AppData\Roaming\Typora\typora-user-images\image-20251104221811555.png) + +如发现有 PVC 处于 `Pending`状态,请手动创建并绑定对应的 PV。以下为 PV 的示例 YAML 配置,请根据实际情况修改相应字段: + +``` +apiVersion: v1 +kind: PersistentVolume +metadata: + name: node2-local-pv-gitea # 请根据实际情况修改名称 +spec: + capacity: + storage: 10Gi + accessModes: + - ReadWriteOnce + storageClassName: local + persistentVolumeReclaimPolicy: Retain + local: + path: /mnt/datadisk/devstar/gitea-storage # 修改为实际存储路径 + nodeAffinity: + required: + nodeSelectorTerms: + - matchExpressions: + - key: kubernetes.io/hostname + operator: In + values: + - node2 # 修改为实际节点名称 + volumeMode: Filesystem + claimRef: + name: gitea-shared-storage-claim + namespace: devstar-studio-ns +``` + +使用以下命令应用 PV 配置: + +``` +kubectl apply -f +``` + +## 4. 域名解析与证书配置 + +如部署环境为公网可访问(如 `devstar.cn`),请在腾讯云(或其他域名服务商)控制台中配置域名解析,并申请及配置 HTTPS 证书。具体操作请参考相关证书配置文档。 + +## 5. 更新部署 + +若修改了 `values.yaml`文件,请执行 `step2-upgrade-helm.sh`脚本进行更新。更新完成后,会看到类似如下提示: + +![image-20251104221928154](C:\Users\nimesulide\AppData\Roaming\Typora\typora-user-images\image-20251104221928154.png) + +更新后请再次检查 Pod 状态: + +``` +kubectl get pods -n devstar-studio-ns +``` + +## 6. 验证部署版本 + +您可以通过以下两种方式确认 DevStar 的版本是否更新成功: + +1. **在 DevStar 主界面查看**登录系统后,可在主界面右下角查看当前版本号。 + + ![image-20251104221953043](C:\Users\nimesulide\AppData\Roaming\Typora\typora-user-images\image-20251104221953043.png) + +2. **在流水线页面查看**进入“工作流”→“流水线”,在如图所示位置也可查看版本信息: + + ![image-20251104222023293](C:\Users\nimesulide\AppData\Roaming\Typora\typora-user-images\image-20251104222023293.png) + +通过比对版本号,即可确认系统是否已成功更新至目标版本。 \ No newline at end of file