1. 概述
1.1 版本
| 运维平台版本 | 功能变更 |
|---|---|
| V1.5.5 | - |
| V1.5.9 | 管理项目,支持「项目总览」和「新增节点」功能 |
| V1.6.0 | 部署方式措辞优化,展示为:非运维平台部署/运维平台部署 |
| V1.8.0 | 支持编辑项目访问地址; 部署新项目、接入已有项目的入口位置调整,更加醒目; 支持部署新 FineDataLink 集群项目; |
| V1.9.0 | 非运维平台部署的项目,支持「组件管理」操作,用于管理 exporter 组件和新增组件 |
| V2.0.0 | 功能视角转换为项目视角,除部分全局设置项外,管理员可在单个项目下进行所有设置 |
| V2.8.0 | 项目状态「不可用」时,支持查看原因和手动刷新状态 |
| V2.12.0 | 全局设置功能优化 1)删除原「超时时间」无效设置 2)新增相关超时检测项
3)新增高级设置项
|
| V2.24.0 | 项目概览页新增产品版本、应用 ID 等常用信息展示 |
1.2 功能简介
运维平台是对帆软 FineReport、FineBI 等应用进行运维的工具。
管理员可将已有工程接入运维平台,也可通过运维平台全新部署工程,并对接入的项目及其组件进行统一管理。

2. 新增项目
在使用运维平台其他功能前,需要先将应用项目接入运维平台。根据工程的现有状态,分为以下两种情况:
| 功能索引 | 功能说明 |
|---|---|
| 部署新项目 | 尚未部署 FineReport、FineBI、FineDataLink 工程 可通过运维平台快速部署工程并接入 |
| 接入已有项目 | 已部署好 FineReport、FineBI、FineDataLink 工程 需要将已有工程接入运维平台 |

3. 项目概览
项目管理界面展示所有已绑定的项目及其关键信息,支持卡片视图和列表视图两种展示方式。
3.1 卡片视图
以卡片形式展示项目关键信息,每张卡片包含项目名称、状态、部署方式、存活节点数等内容。
| 信息 | 说明 |
|---|---|
| 环境类型 | 正式环境或体验环境
|
| 项目名称 | 新增项目时设置的项目名称 |
| 状态 | 正常 / 未授权 / 不可用
|
| 部署信息 | 部署方式:运维平台部署 / 非运维平台部署 存活节点数:项目下存活的应用节点数量 |
| 产品版本 | 项目的主应用类型和版本号 |
| 应用ID | 项目的唯一身份 ID,一般用于与帆软技术支持对接时的身份认证 |
| 告警/访问地址 |
|
| 支持的操作 |
|

3.2 列表视图
以表格形式展示项目关键信息,包括项目名称、状态、部署方式等。
| 信息 | 说明 |
|---|---|
| 环境类型 | 正式环境或体验环境
|
| 项目名称 | 新增项目时设置的项目名称 |
| 状态 | 正常 / 未授权 / 不可用
|
| 存活详情 | 项目下存活的应用节点数量 |
| 部署方式 | 运维平台部署 / 非运维平台部署 |
| 访问地址 | 绑定的 FineReport、FineBI、FineDataLink 工程地址 |
| 操作 |
|

4. 常用操作
本节所有操作均在默认的卡片视图下演示。
4.1 进入项目管理
点击任一项目卡片的空白处,即可进入该项目的项目管理界面。
界面上方支持切换项目、跳转项目、编辑或删除项目、对比项目、返回卡片视图
界面下方支持切换使用各种功能对项目进行运维

4.2 进入组件管理
组件管理是最常用的项目管理功能,点击项目卡片右上角操作菜单中的「组件管理」,即可快速进入该项目的组件管理界面。
详情请参见:组件管理

4.3 新增节点
随着业务数据量和用户访问量的增加,原有集群节点可能无法满足需求,此时需要通过添加集群节点来提升性能和扩展能力。
管理员可使用「新增节点」功能,为运维项目接入新的服务器节点。
详情请参见:集群运维项目扩容

4.4 重命名项目
接入项目时设置的自定义名称支持后续修改。
操作步骤: 点击「编辑」,修改「项目名称」,点击「确认」即可。
命名规则:
项目名称不允许为空,不允许与其他项目重名
仅支持中文、英文大小写、数字
最大长度为 12 位

4.5 修改项目访问地址
应用场景: 运维平台默认根据接入时的 IP 自动生成访问地址。若管理员为工程配置了域名或内外网 IP,自动生成的地址可能无法正常访问,需手动修改为实际访问地址。
操作步骤:
1)鼠标悬浮到对应项目的访问地址上,出现「编辑」按钮后点击
2)在弹窗中填写实际可访问的项目地址,点击「确定」保存

4.6 删除项目
支持将项目从运维平台管理列表中移除,即取消项目与运维平台的对接关系。
注1: 删除项目仅代表运维平台与项目的对接中断,项目本身不会被删除,仍可正常运行。
注2:若提示「删除项目失败」,请将运维平台升级至最新版本后重试。

5. 全局设置
5.1 超时检测
运维管理、业务工具、日志管理等功能在使用前均需进行连接检测,超时则无法正常使用。
可在项目管理页面配置各项超时时间,该设置对运维平台内所有项目生效。
| 设置项 | 默认值 | 说明 |
|---|---|---|
| SSH连接超时时间 | 60s | 部署新项目/已有项目添加节点时,SSH 连接超时时间的设置 超出预设时长,则认为与服务器连接异常,无法成功添加节点 |
| 启动超时时间 | 10min | 部署新项目时,各个组件启动的超时时间设置 超出预设时长,则认为组件部署启动失败,部署失败,触发部署回退 |
| 容器运维客户端超时时间 | 20s | ops_agent 的 RPC 超时时间 超出预设时长,则认为运维平台与项目的 ops_agent 连接失败,运维平台无法正常监控运维项目 |
| 应用检测超时时间 | 20s | 应用和运维平台的 RPC 超时时间 超出预设时长,则认为运维项目不可用 |
| 运维代理进程检测超时时间 | 20s | 运维代理进程和运维平台的rpc超时时间设置 超出预设时长,则认为打堆栈dump超时,无法成功生成相关文件 |

5.2 备份设置
由于备份会占用服务器存储空间,需对备份数量和磁盘占用进行限制。
管理员登录运维平台,进入「设置 > 备份设置」,完成配置后点击「保存」生效。该设置对运维平台内所有项目生效。
详情请参见:备份项目

5.3 链路追踪
在正式使用链路追踪相关功能前,需先完成全局设置。该配置对运维平台中所有运维项目生效。
管理员登录运维平台,进入「设置 > 链路追踪」,配置全局设置项后点击「保存」即可。
详情请参见:链路追踪使用前提

5.4 高级设置
| 设置项 | 说明 |
|---|---|
| 启动失败后中断部署 | 开启: 部署新项目时若某个组件启动失败,将自动中断部署并回退 关闭: 关闭后可保留部署失败的状态,便于排查原因 不建议用户自行关闭,仅在帆软技术支持协助排查部署问题时考虑关闭 |
| 证书域名校验 | 开启: 上传 SSL 证书时将严格校验证书域名一致性,不匹配则无法配置 SSL 关闭: 若证书种类特殊导致运维平台无法正常解析域名,且用户确认证书与服务器域名一致,可关闭此项 关闭后即使域名不一致也可配置 SSL,但会导致项目无法正常访问,请谨慎操作 |
| 重启异常守护 | 当组件处于异常停止且重启次数达到上限时,守护进程将自动检测并启动该组件 |

