1. 概述
「备份管理」用于统一备份运维项目的工程文件、配置和相关组件数据，并通过手动备份、自动备份及最小单元备份降低误操作或故障造成的数据丢失风险。
1.1 版本
| 运维平台版本 | 功能变更 |
|---|---|
| V1.5.5 | - |
| V1.12.0 | 提高备份前磁盘空间检查要求，防止备份导致磁盘爆满 调整运维项目备份还原要求，存在24小时内备份即可还原 |
| V1.16.0 | 备份管理支持FineDataLink应用 |
| V2.7.0 | 备份内容精简，取消备份以下文件夹，防止时间过长 1）FineReport单机取消备份历史版本模板：/assets/vcs 2）FineDataLink单机取消备份历史快照：/dpworks/records 3）集群取消备份Excel源文件：/assets/temp_attach 4）FineDataLink集群取消备份历史快照：/dpworks/records |
| V2.10.0 | 备份内容精简，取消备份FineBI6.1的数据存储组件内容，仅对数据存储组件的配置进行备份 |
| V2.29.0 | 1）新增「项目备份状态异常」告警，备份失败时自动触发告警提醒 2）新增备份完整性校验逻辑，以防备份文件无效 |
| V2.34.0 | 1）新增「最小单元备份」方案，定期强制备份必要内容，作为数据安全兜底 2）新增对自备配置库配置文件的备份支持，进一步保障数据安全 |
| V2.40.0 | 支持设置备份存储位置，可选择运维平台本地目录或自备 S3 存储。 |
1.2 应用场景
FineReport、FineBI、FineDataLink应用本身存在备份还原功能，但是存在一些短板：
1）应用备份文件，只能备份至工程目录下，无法异地备份，误操作时若删除工程，可能会将备份也删除掉。
2）应用中的模板、数据越多，应用备份的速度越慢。
3）应用备份时，jar包、模板、配置都是分开备份还原的，但是大多时候需要将这些内容按照时间点统一备份还原。
运维平台备份容器化项目时，对于自备的组件不会进行备份，也无法进行还原
建议用户在进行项目备份时，自行手动对这些组件进行备份，并在还原时同步还原
1.3 功能简介
运维平台提供「备份管理」功能。
支持一键备份，支持自动备份
支持将项目备份到运维平台所在服务器，实现异地备份。
支持界面化管理备份，查看备份失败记录等情况。
2. 使用前提
| 检查项目 | 说明 |
|---|---|
| 管理权限 | 使用运维平台管理员账号。无管理权限时，无法设置全局备份策略或执行项目备份。 |
| 镜像仓库 | 运维平台与镜像仓库需正常连接。 未配置镜像仓库时，系统提示「请配置镜像仓库后使用此功能」，无法执行备份。 详情请参见：镜像管理 |
| 备份范围 | 确认需备份的组件。 用户自备组件或外接组件未被覆盖时，需另行备份并在还原时同步恢复。 |
| 本地空间 | 使用本地目录时，需预留足够的磁盘空间；空间不足会阻止备份。 |
3. 设置备份策略与存储位置
「备份设置」对运维平台内所有项目生效。
3.1 设置备份上限和磁盘限制
由于备份会占用服务器内存，因此需要对备份个数和占用磁盘空间进行限制。
管理员登录运维平台，点击「设置>备份设置」，设置后点击「保存」生效。
此设置对运维平台内所有项目生效。
| 设置内容 | 说明 |
|---|---|
| 备份上限 | 限制每一个运维项目的备份个数上限 当某个项目的手动/自动备份文件个数达到上限时，会自动清理最早的一份备份文件 默认支持分别保留3份手动/自动备份文件 |
| 磁盘限制 | 支持对运维平台的备份保存目录的磁盘剩余可用空间设置一个约束值 一般存储在运维平台挂载目录/ops/resources/backup文件夹
|
3.2 设置备份存储位置
V2.40.0 及之后版本支持自定义备份存储位置。
| 备份位置 | 适用场景 |
|---|---|
| 本地目录 | 本地挂载磁盘空间充足 |
| S3 对象存储 | 本地磁盘空间不足、物理磁盘扩容或重新挂载成本较高，或需要将备份与运维平台服务器分开存放 |
1）管理员进入「设置>备份设置」。
2）在「备份位置」中选择「本地目录」/「S3 对象存储」，输入相关信息，单击「保存」即可。
选择本地目录时，路径不支持自定义，默认为运维平台挂载目录下的 /ops/resources/backup文件夹。
选择「S3对象存储」时，请填写自备的 S3 连接信息。
| 配置项 | 填写说明 |
|---|---|
| Endpoint | S3 服务的访问域名 请确保运维平台服务器能访问 S3 Endpoint |
| Region | S3 服务所在物理位置。注意不包含前缀的Bucket |
| AccessKey | 用于标识用户 请确保该账号具备目标 Bucket 的读写权限 |
| SecretKey | 与 AccessKey 配套的访问密钥 SecretKey 通常仅在创建时可见，请提前安全存档 |
| Bucket | 用于存放备份对象的存储桶名称 建议为项目备份使用独立 Bucket 或独立目录，避免与其他业务数据混放 |
| 路径前缀 | Bucket 内存放备份的目录前缀 默认为fineops-backup/ |
| Path-style access | 一般无需配置 S3 服务要求以路径样式访问，或出现证书、域名解析类连接错误时，再开启 |
| Signer | 一般留空 要求指定签名类型时再填写。 |
4. 确认备份内容
项目备份的覆盖内容取决于项目部署方式和组件来源。
4.1 运维平台部署的项目
| 组件来源 | |
|---|---|
| 运维平台部署的项目组件 | 备份范围：下文备份内容全部备份 |
| 用户自备的项目组件 |
建议用户在进行项目备份时，自行手动对这些自备组件进行备份，并在还原时同步还原。 |
主要备份内容如下：
| 组件 | 备份内容（容器内路径） | 说明 |
|---|---|---|
bi-web/bi6/fr/fdl 应用 | /usr/local/tomcat/webapps/webroot/APP/classes | 工程调用的默认和自定义class文件 |
| /usr/local/tomcat/webapps/webroot/APP/config | 平台调用的配置库（finedb）相关文件 | |
| /usr/local/tomcat/webapps/webroot/APP/customlib | 工程定制/外部引入的JAR包、字体等 | |
| /usr/local/tomcat/webapps/webroot/APP/drivers | 驱动管理上传的驱动 | |
| /usr/local/tomcat/webapps/webroot/APP/plugins | 插件相关文件 | |
bi6/fr/fdl 应用 仅单应用项目备份此部分内容 | /usr/local/tomcat/webapps/webroot/APP/assets 备份该文件夹下除temp_attach和vcs以外的内容 | 通用的共享持久化目录 |
| /usr/local/tomcat/webapps/webroot/APP/dashboards | 老版本FineBI仪表板相关文件（如无相关目录则不备份） | |
/usr/local/tomcat/webapps/webroot/APP/dpworks 备份该文件夹下除record和records以外的内容 | FineDataLink任务相关的配置文件（如无相关目录则不备份） | |
| /usr/local/tomcat/webapps/webroot/APP/reportlets | FineReport模板存放目录 | |
| /usr/local/tomcat/webapps/webroot/APP/resources | 工程相关的资源配置文件 | |
| /usr/local/tomcat/webapps/webroot/APP/schedule | 定时调度生成的文件 | |
bi-engine-master bi6.1引擎元数据 | /data/polars/rocks_data | meta信息持久化存储 |
| bi-engine-worker bi6.1引擎计算 | 不备份目录，只备份容器配置 | - |
bi-minio bi6.1数据存储 | 不备份目录，只备份容器配置 | - |
nginx 帆软内网关 | /usr/local/nginx/conf | Nginx 的配置文件 |
| /usr/local/nginx/lua | Lua 脚本文件 | |
mysql 外接配置库 | /var/lib/mysql 备份该文件夹下除mysql.sock以外的内容 | MySQL 数据库的实际数据文件 |
| elasticsearch 日志服务 | /usr/share/elasticsearch/config/elasticsearch.yml | Elasticsearch 的配置文件 |
| /run/secrets | ElasticSearch一些敏感信息或者安全相关的文件 | |
filebeat 日志采集 | /usr/share/filebeat/filebeat.yml | filebeat的配置文件 |
| /usr/share/filebeat/data | filebeat的数据目录 | |
| /usr/share/filebeat/config | input文件 | |
| redis 状态服务 | /data | redis的数据目录 |
| minio 文件存储 | assets 备份该文件夹下除temp_attach和vcs以外的内容 | 通用的共享持久化目录 |
| dashboards | 老版本FineBI仪表板相关文件（如无相关目录则不备份） | |
dpworks 备份该文件夹下除record和records以外的内容 | FineDataLink任务相关的配置文件（如无相关目录则不备份） | |
| reportlets | FineReport模板存放目录 | |
| resources | 存放工程相关的资源配置文件 | |
| schedule | 定时调度生成的文件 | |
nacos 服务注册中心 | /home/nacos/data | 数据库derby等数据 |
nacos_mysql nacos服务所需的配置存储 | /var/lib/mysql 备份该文件夹下除mysql.sock以外的内容 | MySQL 数据库的实际数据文件 |
| kafka 管道服务 | 不备份目录，只备份容器配置 | - |
4.2 非运维平台部署的项目
仅对工程相关文件进行备份。外接配置库、日志存储等组件，均不进行备份。
建议用户在进行项目备份时，自行手动对这些必要组件进行备份，并在还原时同步还原。
| 位置 | 备份内容 | 说明 |
|---|---|---|
bi/fr/fdl应用节点 | /webroot/WEB-INF/classes | 工程调用的默认和自定义class文件 |
| /webroot/WEB-INF/config | 平台调用的配置库（finedb）相关文件 | |
| /webroot/WEB-INF/customlib | 工程定制/外部引入的JAR包、字体等 | |
| /webroot/WEB-INF/drivers | 驱动管理上传的驱动 | |
| /webroot/WEB-INF/plugins | 插件相关文件 | |
单机：bi/fr/fdl应用节点下 集群：文件服务器中 | /webroot/WEB-INF/assets 备份该文件夹下除temp_attach和vcs以外的内容 | 通用的共享持久化目录 |
| /webroot/WEB-INF/dashboards | 老版本FineBI仪表板相关文件（如无相关目录则不备份） | |
/webroot/WEB-INF/dpworks 备份该文件夹下除record和records以外的内容 | FineDataLink任务相关的配置文件（如无相关目录则不备份） | |
| /webroot/WEB-INF/reportlets | FineReport模板存放目录 | |
| /webroot/WEB-INF/resources | 工程相关的资源配置文件 |
5. 备份项目
两种备份方式：
手动备份：管理员可手动触发对项目的备份
自动备份：可设定自动备份时间，运维平台在指定时间点对项目自动备份
5.1 发起手动备份
1）管理员进入「项目管理」，选择项目，再进入「维护>备份管理」。
2）按项目类型选择是否同时备份镜像或 JAR 包。
| 项目类型 | 选择 | 备份内容 |
|---|---|---|
| 运维平台部署的项目 | 不勾选 备份镜像 | 备份4.1节列出的所有内容 注：仅对运维平台部署的项目组件进行备份。用户自备组件不会备份 建议用户在进行项目备份时，自行手动对这些自备组件进行备份，并在还原时同步还原 |
勾选 备份镜像 | 1）备份项目组件当前版本的镜像文件 2）备份4.1节列出的所有内容 注：仅对运维平台部署的项目组件进行备份。用户自备组件不会备份 建议用户在进行项目备份时，自行手动对这些自备组件进行备份，并在还原时同步还原 | |
| 非运维平台部署的项目 | 不勾选 备份jar包 | 备份4.2节列出的所有内容 注：仅对工程相关文件进行备份。外接配置库、日志存储等组件，均不进行备份 建议用户在进行项目备份时，自行手动对这些必要组件进行备份，并在还原时同步还原 |
勾选 备份jar包 | 1）备份项目当前使用版本的JAR包文件 2）备份4.2节列出的所有内容 注：仅对工程相关文件进行备份。外接配置库、日志存储等组件，均不进行备份 建议用户在进行项目备份时，自行手动对这些必要组件进行备份，并在还原时同步还原 |
3）单击「开始备份」，填写不重复的备份名称，再单击「确定」。
开始备份后，用户可切换到其他页面进行操作，备份可在后台进行。
注1：手动备份超出备份上限时，提醒「此项目已存在X个手动备份，此次备份将覆盖最早一次手动备份，是否继续？」。
注2：使用本地目录且剩余空间未达到第 3.1 节要求时，备份失败。
注3：备份文件禁止命名重复。
5.2 定时自动备份
1）管理员进入「项目管理」，选择项目，再进入「维护>备份管理」。
2）按项目类型选择是否同时备份镜像或 JAR 包。
| 项目类型 | 选择 | 备份内容 |
|---|---|---|
| 运维平台部署的项目 | 不勾选 备份镜像 | 备份4.1节列出的所有内容 注：仅对运维平台部署的项目组件进行备份。用户自备组件不会备份 建议用户在进行项目备份时，自行手动对这些自备组件进行备份，并在还原时同步还原 |
勾选 备份镜像 | 1）备份项目组件当前版本的镜像文件 2）备份4.1节列出的所有内容 注：仅对运维平台部署的项目组件进行备份。用户自备组件不会备份 建议用户在进行项目备份时，自行手动对这些自备组件进行备份，并在还原时同步还原 | |
| 非运维平台部署的项目 | 不勾选 备份jar包 | 备份4.2节列出的所有内容 注：仅对工程相关文件进行备份。外接配置库、日志存储等组件，均不进行备份 建议用户在进行项目备份时，自行手动对这些必要组件进行备份，并在还原时同步还原 |
勾选 备份jar包 | 1）备份项目当前使用版本的JAR包文件 2）备份4.2节列出的所有内容 注：仅对工程相关文件进行备份。外接配置库、日志存储等组件，均不进行备份 建议用户在进行项目备份时，自行手动对这些必要组件进行备份，并在还原时同步还原 |
3）开启「自动备份」，设置执行频率和时间。
运维平台在指定时间自动创建备份，备份名称为执行时间。
注1：自动备份超出3.1节的备份上限时，自动删除最早 1 份。
注2：若备份保存目录剩余可用空间小于3.1节的限制，则不再进行自动备份。
5.3 最小单元备份
V2.34.0 及之后版本提供最小单元备份，作为未开启自动备份时的数据安全兜底。
| 项目 | 说明 |
|---|---|
| 启用规则 | 如果开启了「自动备份」，则不启用「最小单元备份」 如果未开启「自动备份」，则「最小单元备份」默认开启、强制执行，无法通过界面关闭 |
| 备份内容 | 项目外接配置库的配置文件，覆盖运维平台部署和非运维平台部署的项目，以及运维平台部署和用户自备的外接配置库。 |
| 执行频率 | 每天 1 次，默认在 02:00 执行。 |
| 保留份数 | 与第 3.1 节的备份上限一致；生成新备份后自动删除旧备份。 |
| 大小上限 | 项目外接配置库配置文件不超过 4 GB，超出时无法完成备份。 |
| 还原方式 | 不支持在前端页面还原。如需使用，请联系帆软运维人员通过底层方式操作。 |
在备份列表界面，绿色备份图标，即代表最小单元备份正常进行中。
6. 管理备份
6.1 查看备份信息
在「备份管理>全部备份」中查看以下信息。
在运维平台「全部备份」中，以明细表格式展示每一个备份的详细情况。右上角展示备份保存目录剩余可用空间。
| 展示项 | 说明 |
|---|---|
| 备份名称 | 备份文件的名称 |
| 备份类型 | 备份的类型，包括：手动备份、自动备份 |
| 开始时间 | 备份开始的时间，精确到秒 |
| 结束时间 | 备份结束的时间，精确到秒 |
| 备份大小 | 备份文件的大小 |
6.2 删除备份
勾选需要删除的备份，点击「删除」，即可删除备份。如下图所示：
6.3 重命名备份
点击备份后方的「重命名」按钮，对备份进行重命名，点击「确定」，重命名生效。
注：备份文件禁止命名重复。
6.4 备份及还原失败记录
点击「备份及还原失败记录」，可查看备份及还原失败的记录明细表。如下图所示：
V2.29.0及之后版本，运维平台内置了「项目备份状态异常」告警，当备份失败时自动触发告警提醒。
6.5 查看备份目录名
非容器化部署的工程，手动生成的备份，在运维平台的备份目录中显示的文件名均为ID。用户很难判断每个备份文件对应的前端显示内容，在进行还原时十分不方便。
对于非容器化部署的工程，手动生成的备份，鼠标悬浮即可查看备份目录名，点击按钮时可复制名称到剪贴板。
上一篇：文件管理
