add architecture

This commit is contained in:
qiaofeng1227 2023-05-30 11:12:10 +08:00
parent bf01b8ee7f
commit 976a2ffab2
2 changed files with 44 additions and 40 deletions

44
docs/architecture.md Normal file
View file

@ -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

View file

@ -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