mirror of
https://gitee.com/lijiahangmax/orion-ops.git
synced 2026-08-29 02:04:13 +08:00
📝 修改文档.
This commit is contained in:
lijiahang
@@ -1,3 +1,4 @@
|
||||
<div align="center"><img src="https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/8c687ef1-5711-4a93-9db0-79c010af7902.png" alt="logo" width="32" /></div>
|
||||
<p style="margin-top: 12px" align="center"><b>一站式自动化运维及自动化部署平台, 使用多环境的概念, 提供了机器管理、机器监控报警、Web终端、WebSftp、机器批量执行、机器批量上传、在线查看日志、定时调度任务、应用环境维护、应用构建及发布任务、操作流水线等功能,
|
||||
帮助企业实现一站式轻量化运维治理, 致力于企业级应用的智能运维。</b></p>
|
||||
<p align="center">
|
||||
@@ -89,15 +90,15 @@
|
||||
|
||||
## 功能预览
|
||||
|
||||
> 控制台
|
||||
### 控制台
|
||||
|
||||
|
||||
|
||||
> 机器列表
|
||||
### 机器列表
|
||||
|
||||
|
||||
|
||||
> 在线终端
|
||||
### 在线终端
|
||||
|
||||
|
||||
|
||||
@@ -105,61 +106,61 @@
|
||||
|
||||
|
||||
|
||||
> 在线文件管理
|
||||
### 在线文件管理
|
||||
|
||||
|
||||
|
||||
|
||||
> 机器监控
|
||||
### 机器监控
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 批量执行
|
||||
### 批量执行
|
||||
|
||||
|
||||
|
||||
> 日志文件
|
||||
### 日志文件
|
||||
|
||||
|
||||
|
||||
> 调度任务
|
||||
### 调度任务
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 应用配置
|
||||
### 应用配置
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 构建列表
|
||||
### 构建列表
|
||||
|
||||
|
||||
|
||||
|
||||
> 发布列表
|
||||
### 发布列表
|
||||
|
||||
|
||||
|
||||
|
||||
> 流水线任务
|
||||
### 流水线任务
|
||||
|
||||
|
||||
|
||||
|
||||
> 登陆日志
|
||||
### 登陆日志
|
||||
|
||||
|
||||
|
||||
> 安全配置
|
||||
### 安全配置
|
||||
|
||||
|
||||
|
||||
> 消息
|
||||
### 消息
|
||||
|
||||
|
||||
|
||||
|
||||
+16
-15
@@ -1,3 +1,4 @@
|
||||
<div align="center"><img src="./assert/logo.svg" alt="logo" width="32" /></div>
|
||||
<p style="margin-top: 12px" align="center"><b>一站式自动化运维及自动化部署平台, 使用多环境的概念, 提供了机器管理、机器监控报警、Web终端、WebSftp、机器批量执行、机器批量上传、在线查看日志、定时调度任务、应用环境维护、应用构建及发布任务、操作流水线等功能,
|
||||
帮助企业实现一站式轻量化运维治理, 致力于企业级应用的智能运维。</b></p>
|
||||
<p align="center">
|
||||
@@ -89,15 +90,15 @@
|
||||
|
||||
## 功能预览
|
||||
|
||||
> 控制台
|
||||
### 控制台
|
||||
|
||||
|
||||
|
||||
> 机器列表
|
||||
### 机器列表
|
||||
|
||||
|
||||
|
||||
> 在线终端
|
||||
### 在线终端
|
||||
|
||||
|
||||
|
||||
@@ -105,61 +106,61 @@
|
||||
|
||||
|
||||
|
||||
> 在线文件管理
|
||||
### 在线文件管理
|
||||
|
||||
|
||||
|
||||
|
||||
> 机器监控
|
||||
### 机器监控
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 批量执行
|
||||
### 批量执行
|
||||
|
||||
|
||||
|
||||
> 日志文件
|
||||
### 日志文件
|
||||
|
||||
|
||||
|
||||
> 调度任务
|
||||
### 调度任务
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 应用配置
|
||||
### 应用配置
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 构建列表
|
||||
### 构建列表
|
||||
|
||||
|
||||
|
||||
|
||||
> 发布列表
|
||||
### 发布列表
|
||||
|
||||
|
||||
|
||||
|
||||
> 流水线任务
|
||||
### 流水线任务
|
||||
|
||||
|
||||
|
||||
|
||||
> 登陆日志
|
||||
### 登陆日志
|
||||
|
||||
|
||||
|
||||
> 安全配置
|
||||
### 安全配置
|
||||
|
||||
|
||||
|
||||
> 消息
|
||||
### 消息
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
1. 拉取代码
|
||||
|
||||
```
|
||||
```shell
|
||||
# github
|
||||
git clone https://github.com/lijiahangmax/orion-ops
|
||||
# gitee
|
||||
@@ -42,7 +42,7 @@ orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties
|
||||
|
||||
4. 修改前端配置
|
||||
|
||||
```
|
||||
```shell
|
||||
# 进入代码目录
|
||||
cd orion-ops/orion-ops-vue
|
||||
# 下载 yarn
|
||||
|
||||
@@ -19,7 +19,7 @@ Dashboard 修改)
|
||||
|
||||
### 拉取代码
|
||||
|
||||
```
|
||||
```shell
|
||||
# github
|
||||
git clone https://github.com/lijiahangmax/orion-ops
|
||||
# gitee
|
||||
@@ -40,11 +40,11 @@ git clone https://gitee.com/lijiahangmax/orion-ops
|
||||
|
||||
### 启动镜像
|
||||
|
||||
```
|
||||
```shell
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### 连接 mysql (如果需要在 navicat 中连接)
|
||||
### 修改加密方式
|
||||
|
||||
```
|
||||
访问 adminer: http://localhost:18080
|
||||
|
||||
+51
-70
@@ -1,46 +1,44 @@
|
||||
> ##### 1. 什么时候会进行版本迭代?
|
||||
### 日志文件在哪?
|
||||
|
||||
因为前后端都是我一个人在开发, 都是在抽时间写, 我的大部分的闲暇时间都贡献在这个上面了。而且我对代码要求比较高, 也在不断打磨之前的代码, 所以开发周期比较长。
|
||||
<br/>
|
||||
```shell
|
||||
# 宿主机
|
||||
tail -f -n 200 /data/orion-ops-space/docker-volumes/root/orion/logs/orion-ops/orion-ops.log
|
||||
# 容器内
|
||||
tail -f -n 200 /root/orion/logs/orion-ops/orion-ops.log
|
||||
# 滚动日志 .../logs/orion-ops/rolling/*
|
||||
```
|
||||
|
||||
> ##### 2. 忘记了默认管理员密码无法登陆怎么办?
|
||||
### 忘记了默认管理员密码无法登陆怎么办?
|
||||
|
||||
重启后端服务 添加启动参数 `--reset-admin` 会将 `orionadmin` 的密码重置为 `orionadmin`
|
||||
|
||||
```
|
||||
nohup java -jar orion-ops-web-1.2.5.jar --spring.profiles.active=prod --reset-admin &
|
||||
nohup java -jar app.jar --spring.profiles.active=prod --reset-admin &
|
||||
```
|
||||
|
||||
<br/>
|
||||
|
||||
> ##### 3. 开启了IP黑白名单, 无法访问系统了怎么办?
|
||||
### 开启了IP黑白名单, 无法访问系统了怎么办?
|
||||
|
||||
重启后端服务 添加启动参数 `--disable-ip-filter` 会将禁用ip过滤器
|
||||
|
||||
```
|
||||
nohup java -jar orion-ops-web-1.2.5.jar --spring.profiles.active=prod --disable-ip-filter &
|
||||
nohup java -jar app.jar --spring.profiles.active=prod --disable-ip-filter &
|
||||
```
|
||||
|
||||
<br/>
|
||||
|
||||
> ##### 4. 数据误删除怎么办?
|
||||
### 数据误删除怎么办?
|
||||
|
||||
数据库的数据都采用了逻辑删除, 可以将已删除的数据中的 `deleted` 字段改为 `1`
|
||||
如果不知道数据是哪一条, 可以查询用户操作日志, 点击 `参数` 寻找操作的id
|
||||
<br/>
|
||||
如果不知道数据是哪一条, 可以查询用户操作日志, 点击 `参数` 寻找操作的id
|
||||
|
||||
> ##### 5. 可以将宿主机 IP 修改为其他远程机器吗?
|
||||
### 可以将宿主机 IP 修改为其他远程机器吗?
|
||||
|
||||
CI 功能底层暂时不支持, 如果不使用 CI 功能则可以修改
|
||||
⚡ 不推荐这么做, 设计的初衷是宿主机就是部署 orion-ops 机器, 用来做数据存储以及数据交换
|
||||
<br/>
|
||||
⚡ 不推荐这么做, 设计的初衷是宿主机就是部署 orion-ops 机器, 用来做数据存储以及数据交换
|
||||
|
||||
> ##### 6. orion-ops 可以实现异地构建吗?
|
||||
### orion-ops 可以实现异地构建吗?
|
||||
|
||||
暂时不支持
|
||||
<br/>
|
||||
暂时不支持
|
||||
|
||||
> ##### 7. 为什么 SFTP 无法上传特大文件?
|
||||
### 为什么 SFTP 无法上传特大文件?
|
||||
|
||||
考虑到系统性能和内存占用 默认限制单次上传最大阈值为 512MB
|
||||
|
||||
@@ -56,60 +54,50 @@ server {
|
||||
}
|
||||
```
|
||||
|
||||
⛔ 不建议上传特别大的文件, 可能会出现 `OOM`
|
||||
<br/>
|
||||
⛔ 不建议上传特别大的文件, 可能会出现 `OOM`
|
||||
|
||||
> ##### 8. 应用构建时提示 '版本控制仓库操作执行失败'?
|
||||
### 应用构建时提示 '版本控制仓库操作执行失败'?
|
||||
|
||||
应用管理 > 版本仓库 找到应用关联的仓库, 检查密码/私人令牌后 重新初始化即可
|
||||
<br/>
|
||||
应用管理 > 版本仓库 找到应用关联的仓库, 检查密码/私人令牌后 重新初始化即可
|
||||
|
||||
> ##### 9. orion-ops 是否支持 Windows 部署?
|
||||
### orion-ops 是否支持 Windows 部署?
|
||||
|
||||
可以支持, 前提是 Windows 安装了 OpenSSH Server
|
||||
但是不建议, 因为 Windows 的 ssh 命令兼容性不好, 一切需要执行ssh命令的地方都不友好
|
||||
如: 批量执行, 应用构建发布, 调度任务兼容性非常不友好
|
||||
<br/>
|
||||
|
||||
> ##### 10. orion-ops 是否支持 svn 作为版本仓库?
|
||||
### orion-ops 是否支持 svn 作为版本仓库?
|
||||
|
||||
仅支持 git, 但是构建时可以执行 svn 命令
|
||||
<br/>
|
||||
仅支持 git, 但是构建时可以执行 svn 命令
|
||||
|
||||
> ##### 11. 如果构建不会生成产物, 怎么防止构建失败?
|
||||
### 如果构建不会生成产物, 怎么防止构建失败?
|
||||
|
||||
将构建产物路径设置为一个已存在的文件的绝对路径即可
|
||||
<br/>
|
||||
将构建产物路径设置为一个已存在的文件的绝对路径即可
|
||||
|
||||
> ##### 12. 如果应用没有构建操作, 该如何执行发布操作?
|
||||
### 如果应用没有构建操作, 该如何执行发布操作?
|
||||
|
||||
`同问题 11` 将构建产物路径设置为一个已存在的文件的绝对路径, 构建操作随便设置一个命令即可, 如: echo 1
|
||||
<br/>
|
||||
`同上问题` 将构建产物路径设置为一个已存在的文件的绝对路径, 构建操作随便设置一个命令即可, 如: echo 1
|
||||
|
||||
> ##### 13. 为什么会找不到环境变量?
|
||||
### 为什么会找不到环境变量?
|
||||
|
||||
可以在执行命令的第一行设置 `source /etc/profile` 来加载环境变量
|
||||
<br/>
|
||||
可以在执行命令的第一行设置 `source /etc/profile` 来加载环境变量
|
||||
|
||||
> ##### 14. nohup 为什么无法启动程序?
|
||||
### nohup 为什么无法启动程序?
|
||||
|
||||
执行命令行使用的伪终端关闭时会停止终端进程, 可以使用 sleep 来跳过
|
||||
`(nohup java -jar springboot-0.0.1-SNAPSHOT.jar >> run.log 2>&1 &) && sleep 1`
|
||||
<br/>
|
||||
`(nohup java -jar springboot-0.0.1-SNAPSHOT.jar >> run.log 2>&1 &) && sleep 1`
|
||||
|
||||
> ##### 15. 命令中途执行失败如何设置中断执行?
|
||||
### 命令中途执行失败如何设置中断执行?
|
||||
|
||||
可以在执行命令的第一行设置 `set -e`
|
||||
作用是: 当执行出现意料之外的情况时, 立即退出
|
||||
<br/>
|
||||
作用是: 当执行出现意料之外的情况时, 立即退出
|
||||
|
||||
> ##### 16. 在调度任务、应用构建、应用发布 命令执行成功的依据是什么?
|
||||
### 在调度任务、应用构建、应用发布 命令执行成功的依据是什么?
|
||||
|
||||
是获取命令的 `exitcode` 判断是否为 `0` 如果非0则代表命令执行失败
|
||||
同理, 在命令的最后一行设置 `exit 1` 结果将会是失败, 可以用此来中断后续流程
|
||||
<br/>
|
||||
同理, 在命令的最后一行设置 `exit 1` 结果将会是失败, 可以用此来中断后续流程
|
||||
|
||||
> ##### 17. 为什么使用密钥认证还是无法连接机器?
|
||||
### 为什么使用密钥认证还是无法连接机器?
|
||||
|
||||
```
|
||||
# 升级 openssh
|
||||
@@ -130,36 +118,29 @@ AuthorizedKeysFile .ssh/authorized_keys
|
||||
service sshd restart
|
||||
```
|
||||
|
||||
<br/>
|
||||
### 应用发布中选择 SCP 作为传输方式, 为什么还需要手动输入密码?
|
||||
|
||||
> ##### 18. 应用发布中选择 SCP 作为传输方式, 为什么还需要手动输入密码?
|
||||
需要配置宿主机与目标机器的 ssh 免密登陆, 配置好后就无需输入密码了
|
||||
|
||||
需要配置宿主机与目标机器的 ssh 免密登陆, 配置好后就无需输入密码了
|
||||
<br/>
|
||||
|
||||
> ##### 19. 下载的日志中为什么会有这么多乱码 如: \x1b[0m?
|
||||
### 下载的日志中为什么会有这么多乱码 如: \x1b[0m?
|
||||
|
||||
这是 ANSI 码, 用于日志展示中的着色
|
||||
系统提供了批量清除的功能, 在 `执行管理` > `日志面板` > `清除ANSI`
|
||||
<br/>
|
||||
|
||||
> ##### 20. 执行命令时 可以用哪些环境变量?
|
||||
### 执行命令时 可以用哪些环境变量?
|
||||
|
||||
| 环境变量 | 描述 |
|
||||
| :---- | :--- |
|
||||
| `@{app.xxx}` | 应用信息以及应用环境变量 |
|
||||
| `@{machine.xxx}` | 机器信息以及机器环境变量 |
|
||||
| `@{system.xxx}` | 系统环境变量 |
|
||||
| `@{build.xxx}` | 应用构建业务上下文 |
|
||||
| `@{release.xxx}` | 应用发布业务上下文 |
|
||||
| 环境变量 | 描述 |
|
||||
|:-----------------|:-------------|
|
||||
| `@{app.xxx}` | 应用信息以及应用环境变量 |
|
||||
| `@{machine.xxx}` | 机器信息以及机器环境变量 |
|
||||
| `@{system.xxx}` | 系统环境变量 |
|
||||
| `@{build.xxx}` | 应用构建业务上下文 |
|
||||
| `@{release.xxx}` | 应用发布业务上下文 |
|
||||
|
||||
| 业务场景 | 可用变量 |
|
||||
| :---- | :--- |
|
||||
| 业务场景 | 可用变量 |
|
||||
|:-----|:-----------------------------------|
|
||||
| 批量执行 | `machine` `system` |
|
||||
| 定时任务 | `machine` `system` |
|
||||
| 构建配置 | `build` `app` `machine` `system` |
|
||||
| 发布配置 | `release` `app` `machine` `system` |
|
||||
|
||||
⚡ 详细使用请参考操作手册~
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
1. 拉取代码
|
||||
|
||||
```
|
||||
```shell
|
||||
# github
|
||||
git clone https://github.com/lijiahangmax/orion-ops
|
||||
# gitee
|
||||
@@ -46,7 +46,7 @@ mvn -U clean install -DskipTests
|
||||
|
||||
4. 构建前端代码
|
||||
|
||||
```
|
||||
```shell
|
||||
# 进入代码目录
|
||||
cd orion-ops/orion-ops-vue
|
||||
# 下载 yarn
|
||||
|
||||
+5
-5
@@ -1,20 +1,20 @@
|
||||
#### springboot 项目模板
|
||||
### springboot 项目模板
|
||||
|
||||
以一个普通的 maven 构建的 springboot 项目为例
|
||||
构建操作为: `checkout` > `maven build`
|
||||
发布操作为: `删除旧版文件` > `传输文件` > `nohup java -jar demo-1.0.0-SNAPSHOT.jar &`
|
||||
<br/>
|
||||
|
||||
> 构建配置
|
||||
> 构建配置预览
|
||||
|
||||
|
||||
|
||||
> 发布配置
|
||||
> 发布配置预览
|
||||
|
||||
|
||||
|
||||
|
||||
#### 构建配置
|
||||
### 构建配置
|
||||
|
||||
> 构建产物路径
|
||||
|
||||
@@ -37,7 +37,7 @@ mvn -U clean install -DskipTests
|
||||
echo '构建完成'
|
||||
```
|
||||
|
||||
#### 发布配置
|
||||
### 发布配置
|
||||
|
||||
> 发布操作1 删除旧版文件
|
||||
|
||||
|
||||
+5
-5
@@ -1,20 +1,20 @@
|
||||
#### tomcat 项目模板
|
||||
### tomcat 项目模板
|
||||
|
||||
以一个普通的 maven 构建的 web 项目为例
|
||||
构建操作为: `checkout` > `maven build`
|
||||
发布操作为: `删除 tomcat/webapps/ROOT 和 ROOT.war` > `传输ROOT.war` > `shutdown.sh` > `startup.sh`
|
||||
<br/>
|
||||
|
||||
> 构建配置
|
||||
> 构建配置预览
|
||||
|
||||
|
||||
|
||||
> 发布配置
|
||||
> 发布配置预览
|
||||
|
||||
|
||||
|
||||
|
||||
#### 构建配置
|
||||
### 构建配置
|
||||
|
||||
> 构建产物路径
|
||||
|
||||
@@ -37,7 +37,7 @@ mvn -U clean install -DskipTests
|
||||
echo '构建完成'
|
||||
```
|
||||
|
||||
#### 发布配置
|
||||
### 发布配置
|
||||
|
||||
> 发布操作1 删除原有文件
|
||||
|
||||
|
||||
Vendored
+5
-5
@@ -1,21 +1,21 @@
|
||||
#### vue 项目模板
|
||||
### vue 项目模板
|
||||
|
||||
以一个普通的 npm 构建的 vue 项目为例
|
||||
构建操作为: `checkout` > `npm i` > `npm run build`
|
||||
发布操作为: `删除旧版文件` > `传输文件` > `复制到 nginx 静态目录` > `启动nginx`
|
||||
<br/>
|
||||
|
||||
> 构建配置
|
||||
> 构建配置预览
|
||||
|
||||
|
||||
|
||||
|
||||
> 发布配置
|
||||
> 发布配置预览
|
||||
|
||||
|
||||
|
||||
|
||||
#### 构建配置
|
||||
### 构建配置
|
||||
|
||||
> 构建产物路径
|
||||
|
||||
@@ -50,7 +50,7 @@ cnpm run build
|
||||
echo '构建完成'
|
||||
```
|
||||
|
||||
#### 发布配置
|
||||
### 发布配置
|
||||
|
||||
> 发布操作1 删除原有文件
|
||||
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
# orion-ops-vue
|
||||
|
||||
## Project setup
|
||||
```
|
||||
yarn install
|
||||
```
|
||||
|
||||
### Compiles and hot-reloads for development
|
||||
```
|
||||
yarn serve
|
||||
```
|
||||
|
||||
### Compiles and minifies for production
|
||||
```
|
||||
yarn build
|
||||
```
|
||||
|
||||
### Lints and fixes files
|
||||
```
|
||||
yarn lint
|
||||
```
|
||||
|
||||
### Customize configuration
|
||||
See [Configuration Reference](https://cli.vuejs.org/config/).
|
||||
@@ -13,6 +13,8 @@
|
||||
<div class="login-form-wrapper">
|
||||
<!-- 标题 -->
|
||||
<h3 class="login-label">用户登录</h3>
|
||||
<!-- 预览模式 -->
|
||||
<div v-if="demoMode" class="demo-tips">演示环境账号: orionadmin/orionadmin</div>
|
||||
<!-- 表单 -->
|
||||
<a-form-model class="login-form"
|
||||
:model="form"
|
||||
@@ -215,4 +217,9 @@ export default {
|
||||
}
|
||||
}
|
||||
|
||||
.demo-tips {
|
||||
margin: -18px 0 8px 0;
|
||||
color: #868e96;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
Reference in New Issue
Block a user