docs: complete document.

2026-09-01 14:50:18 +08:00 · 2022-03-28 10:19:35 +08:00
parent 146cf85372
commit db7c976275
19 changed files with 78 additions and 33 deletions
@@ -1,12 +1,13 @@
 ## orion-ops 是什么

-`orion-ops` 一站式自动化运维平台, 无 Agent 的方式接入应用, 使用多环境的概念, 提供了机器管理、WebTerminal、 WebSftp、 机器批量执行、日志在线查看、定时调度任务、应用环境维护、应用构建及发布任务等功能, 帮助开发人员快速定位问题, 致力于企业级应用。
+`orion-ops` 一站式自动化运维及自动化部署平台, 无 Agent 的方式接入应用, 使用多环境的概念, 提供了机器管理、WebTerminal、 WebSftp、 机器批量执行、日志在线查看、定时调度任务、应用环境维护、应用构建及发布任务 (CI / CD) 等功能, 帮助开发人员快速定位问题,
+致力于企业级应用。

 Github: https://github.com/lijiahangmax/orion-ops  
 Gitee: https://gitee.com/lijiahangmax/orion-ops  
 CSDN: https://blog.csdn.net/qq_41011894  
-文档: https://lijiahangmax.github.io/orion-ops/#/    
-Demo: http://101.43.254.243/ops/#/    
+文档: https://lijiahangmax.gitee.io/orion-ops/#/    
+Demo: http://101.43.254.243/ops/#/

 演示账号: `orionadmin`    
 演示密码: `orionadmin`
@@ -17,7 +18,7 @@ Demo: http://101.43.254.243/ops/#/
 * 在线终端: 支持 Web 终端登录远程机器, 记录操作日志, 管理端可强制下线
 * 文件管理: 支持远程机器文件批量上传、批量下载、暂停断点续传、实时传输速率、实时进度、打包传输等功能
 * 环境变量: 基于不同 Profile 有着不同的应用环境变量, 命令执行时使用占位符自动替换
-* 高兼容性: 自定义 CI/CD 操作, 不论是什么项目, 都是基于 Linux 命令执行, 灵活操作
+* 高兼容性: 自定义 CI/CD 操作, 不论是什么项目, 都是基于 SSH 命令执行, 灵活操作
 * 功能强大: 命令批量执行, 任务定时调度, 远程日志查看, 操作日志全记录等
 * 高扩展性: 前后端代码规范统一, 代码质量高, 易读好拓展
 * 免费开源: 前后端代码完全开源
@@ -31,6 +32,18 @@ Demo: http://101.43.254.243/ops/#/
 * Vue 2.6.11
 * Ant Design 1.7.8

+## 系统架构
+
+> 总体架构
+
+![总体架构](https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-28/files1661632709499769734.png "总体架构")
+
+> 发布架构 (CI / CD)
+
+![发布架构](https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-28/files6312827529386043725.png "发布架构")
+
+<br/>
+
 ## 功能预览

 > 机器列表
@@ -76,10 +89,21 @@ Demo: http://101.43.254.243/ops/#/
 ![发布列表](https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-14/files4322661961526641390.png "发布列表")
 ![发布日志](https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-14/files4699926352889499394.png "发布日志")

-## 支持
+<br/>

-......
+## 联系我
+
+<img src="https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-28/files5090991341399292419.jpg" alt="微信" width="350px"/>
+
+<br/>
+
+## 支持一下
+
+<img src="https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-28/files7884174196576690325.png" alt="微信" width="350px"/>
+<img src="https://yxythpt.oss-cn-shenzhen.aliyuncs.com/2022-03-28/files8581952463146065537.jpg" alt="支付宝" width="350px"/>
+
+<br/>

 ## License

-[Apache-2.0](https://github.com/lijiahangmax/orion-ops/blob/main/LICENSE)
+使用 [Apache-2.0](https://github.com/lijiahangmax/orion-ops/blob/main/LICENSE) 开源许可证, 请自觉遵循。
@@ -1,12 +1,13 @@
 ## orion-ops 是什么

-`orion-ops` 一站式自动化运维平台, 无 Agent 的方式接入应用, 使用多环境的概念, 提供了机器管理、WebTerminal、 WebSftp、 机器批量执行、日志在线查看、定时调度任务、应用环境维护、应用构建及发布任务等功能, 帮助开发人员快速定位问题, 致力于企业级应用。
+`orion-ops` 一站式自动化运维及自动化部署平台, 无 Agent 的方式接入应用, 使用多环境的概念, 提供了机器管理、WebTerminal、 WebSftp、 机器批量执行、日志在线查看、定时调度任务、应用环境维护、应用构建及发布任务 (CI / CD) 等功能, 帮助开发人员快速定位问题, 致力于企业级应用。

 Github: https://github.com/lijiahangmax/orion-ops  
 Gitee: https://gitee.com/lijiahangmax/orion-ops  
 CSDN: https://blog.csdn.net/qq_41011894  
-文档: https://lijiahangmax.github.io/orion-ops/#/    
-Demo: http://101.43.254.243/ops/#/  
+文档: https://lijiahangmax.gitee.io/orion-ops/#/    
+Demo: http://101.43.254.243/ops/#/
+
 演示账号: `orionadmin`    
 演示密码: `orionadmin`

@@ -75,10 +76,13 @@ Demo: http://101.43.254.243/ops/#/
 ![发布列表](./assert/img/release_list.png "发布列表")
 ![发布日志](./assert/img/release_log.png "发布日志")

-## 支持
+## 联系我
+<img src="./assert/img/concat_wx.jpg" alt="微信" width="350px"/>

-......
+## 支持一下
+<img src="./assert/img/support_wx.png" alt="微信" width="350px"/>
+<img src="./assert/img/support_zfb.jpg" alt="支付宝" width="350px"/>

 ## License

-[Apache-2.0](https://github.com/lijiahangmax/orion-ops/blob/main/LICENSE)
+使用 [Apache-2.0](https://github.com/lijiahangmax/orion-ops/blob/main/LICENSE) 开源许可证, 请自觉遵循。
@@ -2,8 +2,8 @@

 `2022-03-24` `release`

-🌈 调度任务执行统计
-🔨 WebTerminal Modal 支持开启多个窗口以及最小化   
+🌈 调度任务执行统计     
+🔨 WebTerminal Modal 支持开启多个窗口以及最小化     
 🔨 记录终端连接, Sftp 连接的用户操作日志  
 🔨 机器默认文件追踪命令可通过机器环境变量配置   
 🔨 日志列表宿主机日志文件可选择文件追踪模式   
@@ -4,8 +4,8 @@

 ### SFTP 文件下载

-![文件下载](../assert/img/download-arch.png "文件下载")
+![文件下载](../assert/img/download_arch.png "文件下载")

 ### 应用构建&发布

-![应用构建&发布](../assert/img/release-arch.png "应用构建&发布")
+![应用构建&发布](../assert/img/release_arch.png "应用构建&发布")
@@ -41,11 +41,11 @@
    * 登陆自动续签
    * 登陆IP绑定
    * IP黑白名单
+    * 系统线程池指标

 ### 开发中 ⏱

 * 站内信通知
-* 系统线程任务统计

 ### 未开始 ⏳

@@ -1,3 +1,5 @@
+⚡ 注意: 应用不支持跨版本升级
+
 ## 1.0.0-beta > 1.0.0

 > sql 脚本
@@ -15,7 +15,8 @@
 ### 应用配置

 配置应用的基本信息, 以及不同环境下的构建与发布配置。  
-配置时 `机器环境变量` `系统环境变量` `应用环境变量` 都可以在命令执行前进行替换。
+配置时 `机器环境变量` `系统环境变量` `应用环境变量` 都可以在命令执行前进行替换。  
+⚡ 注意: 如果不配置应用的构建与发布配置, 则不能进行构建 (CI) 和发布 (CD) 操作

 应用在配置后系统会将部分配置信息存储到环境变量中。

@@ -25,6 +26,7 @@
 | transfer_path     | /data/projects/build.jar | 产物传输目标机器绝对路径                          |
 | transfer_dir_type | dir                      | 产物为文件夹传输类型 (dir/zip)                   |
 | release_serial    | parallel                 | 发布序列方式 (serial/parallel)                  |
+| exception_handler | skip_all                 | 异常处理类型 (skip_all/skip_error)              |

 > ##### 构建配置

@@ -1,15 +1,16 @@
-### 应用构建
+### 应用构建 (CI)

-选择应用进行构建。
+选择 `已配置` 的应用进行构建操作。

 * 重新构建: 基于选择的 `branch` 和 `commit` 再次执行构建操作, 如果修改了应用构建配置, 则会是新的配置。
 * 停止: 停止本次构建操作

-按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。
+⚡ 按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。  
+⚡ 只有 `已配置` 的应用才可以进行构建操作。

-### 应用发布
+### 应用发布 (CD)

-选择应用进行发布操作。
+选择 `已配置` 的应用进行发布操作。

 * 审核: 管理员按钮, 如果该环境配置了发布审核, 则需要管理员进行审核, 审核通过后才可以进行发布操作。
 * 发布: 执行应用发布操作。
@@ -19,5 +20,6 @@
 * 取消: 取消应用定时发布。
 * 停止: 停止本次发布操作。

-按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。
+⚡ 按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。  
+⚡ 只有 `已配置` 的应用才可以进行发布操作。  

@@ -6,8 +6,9 @@

 ### 执行记录

-可以查看当前用户执行的所有命令记录, `管理员` 可以查看所有用户的执行记录。  
-按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。
+可以查看当前用户执行的所有命令记录, `管理员` 可以查看所有用户的执行记录。
+
+⚡ 按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。

 ### 日志面板

@@ -31,4 +32,4 @@ cat /data/info.log
 | offset    | 500            | 偏移量(行) |  
 | file      | /data/info.log | 机器名称   |  

-按住 `Ctrl` 点击 `打开` 可以打开一个新页面, 否则将会打开一个模态框。
+⚡ 按住 `Ctrl` 点击 `打开` 可以打开一个新页面, 否则将会打开一个模态框。
@@ -1,7 +1,10 @@
 ### 机器列表

 管理和维护可操作的机器, 项目初始化后会生成一台默认机器 (本机) 可以称为 `宿主机`, 需要手动设置 `ssh` 密码或添加秘钥。  
-这里可以打开WebTerminal, WebSftp, 按住 `Ctrl` 点击 `Terminal` / `sftp` 可以打开一个新页面, 否则将会打开一个模态框。
+这里可以打开 WebTerminal, WebSftp。
+
+⚡ 按住 `Ctrl` 点击 `Terminal` 可以打开一个新页面, 否则将会打开一个模态框。  
+⚡ 按住 `Ctrl` 点击 `sftp` 可以打开一个新页面, 否则将会在当前页面跳转。

 ### 环境变量

@@ -4,8 +4,14 @@
 设计理念与批量执行相同, 只不过是不用人为去触发任务执行。  
 新建任务时鼠标悬停到执行时间上可以得到最近的执行时间。

-⚡ 注意: 修改后状态会变为停用状态, 需要手动启用
+⚡ 注意: 修改后状态会变为停用状态, 需要手动启用。

 ### 执行记录

-可以查看所有调度任务执行的记录, 查看日志时按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。
+可以查看所有调度任务执行的记录。
+
+⚡ 查看日志时按住 `Ctrl` 点击 `日志` 可以打开一个新页面, 否则将会打开一个模态框。
+
+### 执行统计
+
+可以查看近七天的调度统计数据, 以及调度统计图表。
@@ -57,4 +57,5 @@ echo /root/orion/log
 * 其他配置
    * 调度任务自动恢复开关
    * 上传文件最大阈值设置
-
+    * 统计缓存有效时间
+* 系统线程池指标
@@ -9,7 +9,7 @@

 ### 个人信息

-可以修改当前用户的基本信息, 以及查询当前用户的操作日志。
+可以修改当前用户的基本信息、用户操作日志, 以及查询站内信。

 ### 操作日志