diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 00000000..a9ece3d0 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,44 @@ +## 架构图 + +## 详细 + +### 微服务 + +存在的微服务以及选型: + +- Cockpit(Monitor,SSH Ternimal,File Browser) +- Cockpit plugins(Nodejs web) +- Container Manager(portainer container) +- Proxy&DNS(nginxproxymanager container) +- backup(kopia container) +- appstore(appmanager container) +- API gateway: Kong(待定) +- CLI(待定) + +![image](https://user-images.githubusercontent.com/16741975/216497356-3913abd2-0b75-4619-8c40-512079e35f5b.png) + +### 基础组件 + +技术选型如下: + +- 前端:Nodejs, react, cockpit app +- 后端:Python, Docker, Docker-compose, FastAPI +- API DOCS 生成与测试:swagger +- 安全:pwgen(随机密码),md5(htpasswd) +- 身份验证:(待定) +- CLI:(待定) + +### 产品文件目录 + +便于升级、便于用户使用的产品文件目录组织结构 + +- 微服务容器:/stackhub/docker +- Cockpit 插件:/stackhub/cockpit +- 安装和升级脚本: /stackhub/install +- Appstore 后台源码: /stackhub/appmanage +- cli: /stackhub/cli(待定) + +### Contributor + +- 类型标签:Bug, enhancement, Documetation +- 过程标签:PRD, Dev, QA(include deployment), Documetation diff --git a/docs/developer.md b/docs/developer.md index 6d0d2c7f..562c3b72 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -1,41 +1 @@ # Developer Guide - -## 架构 - -### 微服务 - -存在的微服务以及选型: - -* System -* MQ -* Monitor: NetData -* SSH Ternimal -* File Browser -* Storage -* User -* API gateway: Kong -* Web-Container -* Web-DB -* Proxy&DNS(待定) -* App&CLI(开发) - -![image](https://user-images.githubusercontent.com/16741975/216497356-3913abd2-0b75-4619-8c40-512079e35f5b.png) - - -### 基础组件 - -技术选型如下: - -* 架构:JS UI + API Backend -* 后端:Python, Docker, Docker-compose, FastAPI, Typer -* API生成与测试:apipost/apifox -* 身份验证:supertokens - -### 产品文件目录 - -便于升级、便于用户使用的产品文件目录组织结构 - -### Contributor - -* 类型标签:Bug, enhancement, Documetation -* 过程标签:PRD, Dev, QA(include deployment), Documetation