manager/orion-visor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 修改文档.

Browse Source
This commit is contained in:
lijiahang
2024-05-13 10:41:03 +08:00
parent 0bde1b0c05
commit 1e819eadc2
10 changed files with 280 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
docs/operator/exec.md
View File

@@ -2,13 +2,15 @@
批量执行 ssh 主机 shell 脚本。
⚡ 如果只需要保存日志的原始输出则需要修改 `application.yaml` `app.exec-log.append-ansi` 为 `false`
* 重置: 重置全部参数
* 执行: 执行所输入的命令
* 返回: 返回到执行命令页面
* 从模板中选择: 从模板中选择需要执行的命令
* 执行历史: 点击历史命令可以快速填入
### 批量执行日志
### 执行日志
查看批量执行任务日志。
@@ -22,6 +24,35 @@
* 日志: 查看执行日志, ctrl + 左键点击会用新页面打开
* 下载: 下载执行日志
### 批量上传
将文件批量上传到远程服务器。
* 重置: 重置表单参数
* 返回: 返回到表单页面
* 开始上传: 执行文件上传
* 取消上传: 取消文件上传
* 清空: 清空已选择的文件
* 选择文件: 批量选择上传的文件
* 选择文件夹: 选择上传的文件夹
> 上传路径可以使用内置变量来替换。
| 参数 | 描述 | 参数示例 |
|:------------|:------|-------------|
| ${username} | 用户名 | admin |
| ${home} | 用户家目录 | /home/admin |
### 上传任务
查看批量上传任务列表。
* 上传: 跳转到批量上传页面
* 清空: 清空上传任务
* 删除: 删除上传任务
* 详情: 查看上传任务详情
* 取消: 取消文件上传
### 执行模板
用来维护批量执行的命令模板, 支持动态参数, 使用 `@{{ xxx }}` 来替换命令参数。
@@ -47,29 +78,29 @@
⚡ 使用 `@{{ xxx }}` 来替换命令参数
| 参数 | 描述 |
|:----------------|:--------------------------|
| source | 执行来源 (BATCH/JOB) |
| sourceId | 执行来源id (JOB特有) |
| seq | 执行序列 (JOB特有) |
| userId | 执行用户id |
| username | 执行用户名 |
| execId | 执行记录id |
| hostId | 执行主机id |
| hostName | 执行主机名称 |
| hostCode | 执行主机编码 |
| hostAddress | 执行主机地址 |
| hostUsername | 执行主机用户名 |
| osType | 执行主机系统版本 |
| port | SSH 端口 |
| charset | SSH 编码集 |
| scriptExec | 是否使用脚本执行 |
| scriptPath | 脚本文件路径 |
| uuid | 生成任务维度 uuid |
| uuidShort | 生成任务维度 uuid 无 '-' |
| hostUuid | 生成机器维度 uuid |
| hostUuidShort | 生成机器维度 uuid 无 '-' |
| timestampMillis | 时间戳毫秒 |
| timestamp | 时间戳 |
| date | 执行时间 yyyy-MM-dd |
| datetime | 执行时间 yyyy-MM-dd HH:mm :ss |
| 参数 | 描述 | 参数示例 |
|:----------------|:---------------------------|-------------------------------------------------|
| source | 执行来源 (BATCH/JOB) | JOB |
| sourceId | 执行来源id (JOB特有) | 6 |
| seq | 执行序列 (JOB特有) | 920 |
| userId | 执行用户id (JOB为0) | 1 |
| username | 执行用户名 (JOB为system) | admin |
| execId | 执行记录id | 2000 |
| hostId | 执行主机id | 1 |
| hostName | 执行主机名称 | server-127.0.0.1 |
| hostCode | 执行主机编码 | server |
| hostAddress | 执行主机地址 | 127.0.0.1 |
| hostUsername | 执行主机用户名 | root |
| osType | 执行主机系统版本 | LINUX |
| port | SSH 端口 | 22 |
| charset | SSH 编码集 | UTF-8 |
| scriptExec | 是否使用脚本执行 (0否1是) | 1 |
| scriptPath | 脚本文件路径 | /root/orion/orion-ops-pro/script/exec_2000_1.sh |
| uuid | 生成任务维度 uuid | 82b20e52-cea9-455b-a0b4-e4e25654e22b |
| uuidShort | 生成任务维度 uuid 无 '-' | 82b20e52cea9455ba0b4e4e25654e22b |
| hostUuid | 生成机器维度 uuid | 2687b09e-1046-4e8d-9cc2-a7e697836b88 |
| hostUuidShort | 生成机器维度 uuid 无 '-' | 2687b09e10464e8d9cc2a7e697836b88 |
| timestampMillis | 时间戳毫秒 | 1715173200848 |
| timestamp | 时间戳 | 1715173200 |
| date | 执行时间 `yyyy-MM-dd` | `2024-01-01` |
| datetime | 执行时间 `yyyy-MM-dd HH:mm:ss` | `2024-01-01 21:00:00` |