From e2c0b9c44ace813ed751da1962a61cdefacce8e2 Mon Sep 17 00:00:00 2001 From: lijiahangmax Date: Wed, 10 Apr 2024 23:27:12 +0800 Subject: [PATCH] =?UTF-8?q?:page=5Ffacing=5Fup:=20=E4=BF=AE=E8=AE=A2?= =?UTF-8?q?=E5=85=8D=E8=B4=A3=E5=A3=B0=E6=98=8E.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- DISCLAIMER.md | 17 ++++++++++ README.md | 12 ++++--- docs/DISCLAIMER.md | 17 ++++++++++ docs/README.md | 7 ++-- docs/_sidebar.md | 1 + docs/about/update.md | 19 ++++++++++- docs/operator/exec.md | 69 +++++++++++++++++++++++++++++++++++++++ docs/operator/host-ops.md | 67 ------------------------------------- 8 files changed, 134 insertions(+), 75 deletions(-) create mode 100644 DISCLAIMER.md create mode 100644 docs/DISCLAIMER.md create mode 100644 docs/operator/exec.md diff --git a/DISCLAIMER.md b/DISCLAIMER.md new file mode 100644 index 00000000..59aca48f --- /dev/null +++ b/DISCLAIMER.md @@ -0,0 +1,17 @@ +## 免责声明 + +> 欢迎您选择使用 orion-ops-pro（以下简称「本项目」）。在使用本项目前，请您仔细阅读本免责声明，并确保您已充分理解其中的内容。您的使用行为将视为对本声明全部内容的认可和接受。 + +> 本项目为一款开源免费的运维管理工具，采用 Apache 2.0 许可证授权。您可在遵守相关法律法规及许可证条款的前提下，自由修改和使用本项目。 + +1. 本项目尊重并保护所有用户的个人隐私权。本项目不会收集、存储或传输用户的任何个人信息。 +2. 您承诺秉着合法、合理的原则使用本项目，不利用本项目进行任何违法、侵害他人合法利益等恶意的行为，亦不将本项目运用于任何违反我国法律法规的平台。 +3. 任何单位或个人因下载使用本项目而产生的任何意外、疏忽、合约毁坏、诽谤、版权或知识产权侵犯及其造成的损失 (包括但不限于直接、间接、附带或衍生的损失等)，本人不承担任何法律责任。 +4. 用户明确并同意本声明条款列举的全部内容，对使用本项目可能存在的风险和相关后果将完全由用户自行承担，本人不承担任何法律责任。 +5. 任何单位或个人在阅读本免责声明后，应在《Apache 2.0 + 开源许可证》所允许的范围内进行合法的发布、传播和使用本项目等行为，若违反本免责声明条款或违反法律法规所造成的法律责任(包括但不限于民事赔偿和刑事责任），由违约者自行承担。 +6. 本人对本项目拥有知识产权（包括但不限于商标权、专利权、著作权、商业秘密等），上述产品均受到相关法律法规的保护。 +7. 任何单位或个人不得在未经本人书面授权的情况下对本项目本身申请相关的知识产权。 +8. 如果本声明的任何部分被认为无效或不可执行，则该部分将被解释为反映本人的初衷，其余部分仍具有完全效力。不可执行的部分声明，并不构成我们放弃执行该声明的权利。 +9. 本人有权随时对本声明条款及附件内容进行单方面的变更，并以消息推送、网页公告等方式予以公布，公布后立即自动生效，无需另行单独通知；若您在本声明内容公告变更后继续使用的，表示您已充分阅读、理解并接受修改后的声明内容。 +10. 本人对本声明拥有最终解释权。 diff --git a/README.md b/README.md index 2e4ea585..c1ec3cb3 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ orion-ops-pro 是什么 -`orion-ops-pro` 是一款现代化、高颜值的一站式智能运维管理平台，集资产管理、资产授权、批量执行、Web终端、WebSftp、角色管理、系统管理等功能于一体，致力于简化运维团队的治理工作。它是基于 `orion-ops` +`orion-ops-pro` +是一款现代化、高颜值的一站式智能运维管理平台，集资产管理、资产授权、批量执行、Web终端、WebSftp、角色管理、系统管理等功能于一体，致力于简化运维团队的治理工作。它是基于 `orion-ops` 的产品思路进行重构，技术架构升级，并优化了交互逻辑，让操作更快捷更友好。

@@ -48,11 +49,10 @@ demo: http://101.43.254.243:1081/ * 在线终端: 提供便捷的在线 Web 终端服务, 支持快捷命令、自定义快捷键和主题风格。 * 文件管理: 实现远程主机大文件的批量上传、下载和在线编辑等操作。 * 批量操作: 支持远程主机批量执行 shell 命令。 +* 计划执行: 支持配置 cron 表达式, 定时执行主机 shell 命令。 * 操作日志: 记录用户操作日志，确保操作可追溯, 提高系统安全性。 * 可扩展性: 前后端代码规范统一、代码质量高、健壮且易于阅读和扩展。 -[comment]: <> ( FIXME * 调度任务: 维护 cron 表达式, 定时执行主机命令) - ## 快速开始 docker安装: https://lijiahangmax.gitee.io/orion-ops-pro/#/quickstart/docker-install @@ -71,8 +71,6 @@ roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap * Vue3 * Arco Design -[//]: # ( fixme 免责声明 (注意事项) (在使用平台之前, 请确保您已经了解并同意相关的使用协议和隐私政策。) (为了数据安全, 请定期备份数据和配置, 以防意外丢失或损坏。)) - ## 功能预览 > 工作台 @@ -126,6 +124,10 @@ roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap 🎁 为了项目能健康持续的发展, 我期望获得相应的资金支持, 你们的支持是我不断更新前进的动力! +## 免责声明 + +在使用本项目之前, 请确保您已经了解并同意相关的使用协议和隐私政策。[免责声明](https://github.com/lijiahangmax/orion-ops-pro/blob/main/DISCLAIMER.md) + ## License 本项目遵循 [Apache-2.0](https://github.com/lijiahangmax/orion-ops-pro/blob/main/LICENSE) 开源许可证。 diff --git a/docs/DISCLAIMER.md b/docs/DISCLAIMER.md new file mode 100644 index 00000000..59aca48f --- /dev/null +++ b/docs/DISCLAIMER.md @@ -0,0 +1,17 @@ +## 免责声明 + +> 欢迎您选择使用 orion-ops-pro（以下简称「本项目」）。在使用本项目前，请您仔细阅读本免责声明，并确保您已充分理解其中的内容。您的使用行为将视为对本声明全部内容的认可和接受。 + +> 本项目为一款开源免费的运维管理工具，采用 Apache 2.0 许可证授权。您可在遵守相关法律法规及许可证条款的前提下，自由修改和使用本项目。 + +1. 本项目尊重并保护所有用户的个人隐私权。本项目不会收集、存储或传输用户的任何个人信息。 +2. 您承诺秉着合法、合理的原则使用本项目，不利用本项目进行任何违法、侵害他人合法利益等恶意的行为，亦不将本项目运用于任何违反我国法律法规的平台。 +3. 任何单位或个人因下载使用本项目而产生的任何意外、疏忽、合约毁坏、诽谤、版权或知识产权侵犯及其造成的损失 (包括但不限于直接、间接、附带或衍生的损失等)，本人不承担任何法律责任。 +4. 用户明确并同意本声明条款列举的全部内容，对使用本项目可能存在的风险和相关后果将完全由用户自行承担，本人不承担任何法律责任。 +5. 任何单位或个人在阅读本免责声明后，应在《Apache 2.0 + 开源许可证》所允许的范围内进行合法的发布、传播和使用本项目等行为，若违反本免责声明条款或违反法律法规所造成的法律责任(包括但不限于民事赔偿和刑事责任），由违约者自行承担。 +6. 本人对本项目拥有知识产权（包括但不限于商标权、专利权、著作权、商业秘密等），上述产品均受到相关法律法规的保护。 +7. 任何单位或个人不得在未经本人书面授权的情况下对本项目本身申请相关的知识产权。 +8. 如果本声明的任何部分被认为无效或不可执行，则该部分将被解释为反映本人的初衷，其余部分仍具有完全效力。不可执行的部分声明，并不构成我们放弃执行该声明的权利。 +9. 本人有权随时对本声明条款及附件内容进行单方面的变更，并以消息推送、网页公告等方式予以公布，公布后立即自动生效，无需另行单独通知；若您在本声明内容公告变更后继续使用的，表示您已充分阅读、理解并接受修改后的声明内容。 +10. 本人对本声明拥有最终解释权。 diff --git a/docs/README.md b/docs/README.md index 7e33ecaf..8046d922 100644 --- a/docs/README.md +++ b/docs/README.md @@ -49,6 +49,7 @@ demo: http://101.43.254.243:1081/ * 在线终端: 提供便捷的在线 Web 终端服务, 支持快捷命令、自定义快捷键和主题风格。 * 文件管理: 实现远程主机大文件的批量上传、下载和在线编辑等操作。 * 批量操作: 支持远程主机批量执行 shell 命令。 +* 计划执行: 支持配置 cron 表达式, 定时执行主机 shell 命令。 * 操作日志: 记录用户操作日志，确保操作可追溯, 提高系统安全性。 * 可扩展性: 前后端代码规范统一、代码质量高、健壮且易于阅读和扩展。 @@ -70,8 +71,6 @@ roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap * Vue3 * Arco Design -[//]: # ( fixme 免责声明 (注意事项) (在使用平台之前, 请确保您已经了解并同意相关的使用协议和隐私政策。) (为了数据安全, 请定期备份数据和配置, 以防意外丢失或损坏。)) - ## 功能预览 > 工作台 @@ -125,6 +124,10 @@ roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap 🎁 为了项目能健康持续的发展, 我期望获得相应的资金支持, 你们的支持是我不断更新前进的动力! +## 免责声明 + +在使用本项目之前, 请确保您已经了解并同意相关的使用协议和隐私政策。[免责声明](DISCLAIMER.md) + ## License 本项目遵循 [Apache-2.0](https://github.com/lijiahangmax/orion-ops-pro/blob/main/LICENSE) 开源许可证。 diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 0de2b3b2..efcffa77 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -10,6 +10,7 @@ * 操作手册 * [资产管理](operator/asset.md) * [主机运维](operator/host-ops.md) + * [命令执行](operator/exec.md) * [运维审计](operator/asset-audit.md) * [用户管理](operator/user.md) * [系统管理](operator/system.md) diff --git a/docs/about/update.md b/docs/about/update.md index 5173c202..324a9d0a 100644 --- a/docs/about/update.md +++ b/docs/about/update.md @@ -5,11 +5,28 @@ > sql 脚本 ```sql +-- 修改字段 ALTER TABLE `exec_template` CHANGE COLUMN `parameter` `parameter_schema` json NULL COMMENT '参数定义' AFTER `timeout`; - ALTER TABLE `exec_log` ADD COLUMN `exec_seq` int(0) NULL DEFAULT 0 COMMENT '执行序列' AFTER `description`; +-- 字典值修改 +UPDATE dict_value SET value = 'asset:exec-command' WHERE value = 'asset:exec'; +UPDATE dict_value SET value = 'exec-command:exec' WHERE value = 'exec:exec-command'; +UPDATE dict_value SET value = 'exec-command:interrupt-exec' WHERE value = 'exec:interrupt-exec'; +UPDATE dict_value SET value = 'exec-command:interrupt-host' WHERE value = 'exec:interrupt-host'; +UPDATE dict_value SET value = 'exec-command-log:delete' WHERE value = 'exec:delete-log'; +UPDATE dict_value SET value = 'exec-command-log:clear' WHERE value = 'exec:clear-log'; +UPDATE dict_value SET value = 'exec-command-log:delete-host' WHERE value = 'exec:delete-host-log'; +UPDATE dict_value SET value = 'exec-command-log:download' WHERE value = 'exec:download-host-log'; +-- 操作日志修改 +UPDATE operator_log SET module = 'asset:exec-command', type = 'exec-command:exec' WHERE type = 'exec:exec-command'; +UPDATE operator_log SET module = 'asset:exec-command', type = 'exec-command:interrupt-exec' WHERE type = 'exec:interrupt-exec'; +UPDATE operator_log SET module = 'asset:exec-command', type = 'exec-command:interrupt-host' WHERE type = 'exec:interrupt-host'; +UPDATE operator_log SET module = 'asset:exec-command-log', type = 'exec-command-log:delete' WHERE type = 'exec:delete-log'; +UPDATE operator_log SET module = 'asset:exec-command-log', type = 'exec-command-log:clear' WHERE type = 'exec:clear-log'; +UPDATE operator_log SET module = 'asset:exec-command-log', type = 'exec-command-log:delete-host' WHERE type = 'exec:delete-host-log'; +UPDATE operator_log SET module = 'asset:exec-command-log', type = 'exec-command-log:download' WHERE type = 'exec:download-host-log'; ``` ## v1.0.3 diff --git a/docs/operator/exec.md b/docs/operator/exec.md new file mode 100644 index 00000000..01c30515 --- /dev/null +++ b/docs/operator/exec.md @@ -0,0 +1,69 @@ +### 批量执行 + +批量执行 ssh 主机 shell 脚本。 + +##### 日志面板中有几个内置的快捷键 + +* 回车: `Enter` +* 向上滚动一行: `↑` +* 向上滚动一页: `Home` +* 向下滚动一行: `↓` +* 向下滚动一页: `End` +* 全选: `ctrl` `A` +* 复制: `ctrl` `C` +* 搜索: `ctrl` `F` +* 清空: `ctrl` `L` + +⭐ 内置参数同执行模板参数 + +* 重置: 重置全部参数 +* 执行: 执行所输入的命令 +* 返回: 返回到执行命令页面 +* 从模板中选择: 从模板中选择需要执行的命令 +* 执行历史: 点击历史命令可以快速填入 + +### 执行记录 + +查看批量执行任务记录。 + +* 执行命令: 跳转到批量执行页面 +* 清空: 清空执行记录 +* 删除: 删除执行记录 +* 重新执行: 重新执行此命令 +* 命令: 查看执行时的命令 +* 参数: 查看执行时的参数 +* 日志: 查看执行日志, ctrl + 左键点击会用新页面打开 +* 下载: 下载执行日志 + +### 执行模板 + +用来维护批量执行的命令模板, 支持动态参数, 使用 `@{{ xxx }}` 来替换命令参数。 + +* 新增: 新增执行模板 +* 执行: 打开命令执行框并且带入模板参数 +* 修改: 修改执行模板 +* 删除: 删除执行模板 + +> 内置参数 + +| 参数 | 描述 | +|:----------------|:--------------------------| +| source | 执行来源 (BATCH/JOB) | +| sourceId | 执行来源id (job特有) | +| seq | 执行序列 (job特有) | +| execId | 执行记录id | +| hostId | 执行主机id | +| hostName | 执行主机名称 | +| hostCode | 执行主机编码 | +| hostAddress | 执行主机地址 | +| userId | 执行用户id | +| username | 执行用户名 | +| uuid | 生成任务维度 uuid | +| uuidShort | 生成任务维度 uuid 无 '-' | +| hostUuid | 生成机器维度 uuid | +| hostUuidShort | 生成机器维度 uuid 无 '-' | +| timestampMillis | 时间戳毫秒 | +| timestamp | 时间戳 | +| date | 执行时间 yyyy-MM-dd | +| datetime | 执行时间 yyyy-MM-dd HH:mm :ss | + diff --git a/docs/operator/host-ops.md b/docs/operator/host-ops.md index f9059b41..39b8f9dc 100644 --- a/docs/operator/host-ops.md +++ b/docs/operator/host-ops.md @@ -42,70 +42,3 @@ > 终端面板 ⭐ 双击终端标签可快速复制会话 - -### 批量执行 - -批量执行 ssh 主机 shell 脚本。 - -##### 日志面板中有几个内置的快捷键 - -* 回车: `Enter` -* 向上滚动一行: `↑` -* 向上滚动一页: `Home` -* 向下滚动一行: `↓` -* 向下滚动一页: `End` -* 全选: `ctrl` `A` -* 复制: `ctrl` `C` -* 搜索: `ctrl` `F` -* 清空: `ctrl` `L` - -⭐ 内置参数同执行模板参数 - -* 重置: 重置全部参数 -* 执行: 执行所输入的命令 -* 返回: 返回到执行命令页面 -* 从模板中选择: 从模板中选择需要执行的命令 -* 执行历史: 点击历史命令可以快速填入 - -### 执行记录 - -查看批量执行任务记录。 - -* 执行命令: 跳转到批量执行页面 -* 清空: 清空执行记录 -* 删除: 删除执行记录 -* 重新执行: 重新执行此命令 -* 命令: 查看执行时的命令 -* 参数: 查看执行时的参数 -* 日志: 查看执行日志, ctrl + 左键点击会用新页面打开 -* 下载: 下载执行日志 - -### 执行模板 - -用来维护批量执行的命令模板, 支持动态参数, 使用 `@{{ xxx }}` 来替换命令参数。 - -* 新增: 新增执行模板 -* 执行: 打开命令执行框并且带入模板参数 -* 修改: 修改执行模板 -* 删除: 删除执行模板 - -> 内置参数 - -| 参数 | 描述 | -|:----------------|:-------------------------| -| execId | 执行记录id | -| hostId | 执行主机id | -| hostName | 执行主机名称 | -| hostCode | 执行主机编码 | -| hostAddress | 执行主机地址 | -| userId | 执行用户id | -| username | 执行用户名 | -| uuid | 生成任务维度 uuid | -| uuidShort | 生成任务维度 uuid 无 '-' | -| hostUuid | 生成机器维度 uuid | -| hostUuidShort | 生成机器维度 uuid 无 '-' | -| timestampMillis | 时间戳毫秒 | -| timestamp | 时间戳 | -| date | 执行时间 yyyy-MM-dd | -| datetime | 执行时间 yyyy-MM-dd HH:mm:ss | -