Skip to content

Commit

Permalink
update zadig architecture description (#1923)
Browse files Browse the repository at this point in the history
Signed-off-by: fansi <[email protected]>

Signed-off-by: fansi <[email protected]>
Co-authored-by: fansi <[email protected]>
  • Loading branch information
fansi404 and PrimeRobert authored Aug 18, 2022
1 parent 830ea54 commit 5b64d73
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 35 deletions.
4 changes: 0 additions & 4 deletions System-Architecture-Overview-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,15 @@

用户入口:
- zadig-portal:Zadig 前端组件
- kodespace:Zadig 开发者命令行工具
- Zadig Toolkit:vscode 开发者插件

API 网关:
- [Gloo Edge](https://github.com/solo-io/gloo):Zadig 的 API 网关组件
- [OPA](https://github.com/open-policy-agent/opa):认证和授权组件
- [Dex](https://github.com/dexidp/dex):Zadig 的身份认证服务,用于连接其他第三方认证系统,比如 AD / LDAP / OAuth2 / GitHub / ..
- User:用户管理,Token 生成

Zadig 核心业务:
- Picket:数据聚合服务
- Aslan:项目 / 环境 / 服务 / 工作流 / 构建配置 / 系统配置等系统功能
- Policy:OPA 数据源,策略注册中心
- Config:系统配置
- Workflow Runner:
- warpdrive:工作流引擎,负责 reaper、predator 实例的创建销毁等管理操作
Expand Down
56 changes: 26 additions & 30 deletions System-Architecture-Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,30 @@

## Main Components

User Interface:
- zadig-portal:Zadig web component
- kodespace:Zadig command line tools
- Zadig Toolkit:vscode plugin

API Gateway:
- [Gloo Edge](https://github.com/solo-io/gloo):Zadig API gateway
- [OPA](https://github.com/open-policy-agent/opa):Authentication and authorization
- [Dex](https://github.com/dexidp/dex):Identity service for Zadig, acts as a portal to other identity providers like AD / LDAP / OAuth2 / GitHub / ..
- User:User management, token generation

Zadig Core:
- Picket:backend for frontend service.
- Aslan:main service for all business logic. Project, environment, service, workflow, build, system management are all in this service.
- Policy:data source of OPA and policy registration center.
- Config:system configuration center.
- Workflow Runner:
- warpdrive:workflow engine, manages reaper and predator
- reaper:workflow runner. Used for building, testing tasks.
- predator:workflow runner. Used for distribute tasks.
- plugins:workflow plugins
- Jenkins-plugin:workflow runner. Used as connector to trigger Jenkins job and retrieve job information.
- Cron:cronjob runner
- NSQ:message queue

Data Plane:
- MongoDB:database for business data.
- MySQL:dex configuration,database for user.

Kubernetes Cluster:
User Interface:
- zadig-portal: Zadig web component
- Zadig Toolkit: vscode plugin

API Gateway:
- [Gloo Edge](https://github.com/solo-io/gloo): Zadig API gateway
- [OPA](https://github.com/open-policy-agent/opa): Authentication and authorization
- [Dex](https://github.com/dexidp/dex): Identity service for Zadig, acts as a portal to other identity providers like AD / LDAP / OAuth2 / GitHub / ..

Zadig Core:
- Aslan: main service for all business logic. Project, environment, service, workflow, build, system management are all in this service.
- Config:system configuration center.
- Workflow Runner:
- warpdrive: workflow engine, manages reaper and predator
- reaper: workflow runner. Used for building, testing tasks.
- predator: workflow runner. Used for distribute tasks.
- plugins: workflow plugins
- Jenkins-plugin: workflow runner. Used as connector to trigger Jenkins job and retrieve job information.
- Cron: cronjob runner
- NSQ: message queue

Data Plane:
- MongoDB: database for business data.
- MySQL: dex configuration,database for user.

Kubernetes Cluster:
- Zadig business runs on standard K8s clusters from cloud vendors
2 changes: 1 addition & 1 deletion Zadig-System-Architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b64d73

Please sign in to comment.