1. 概述
1.1 版本
工程版本 | 功能变更 |
---|---|
FineReport11.0 FineBI6.0 | - |
1.2 应用场景
相比于普通单机工程,容器化部署的工程,升级和维护成本较低。
本文方案,帮助用户将原有非容器化部署的单机工程,迁移为容器化部署的单机工程。
注:全文以FineBI作为演示。FineReport迁移步骤基本一致,仅需要两个点:
1)拷贝文件时,FineReport和FineBI需要拷贝的文件不完全相同,注意文档中的表格即可。
2)使用运维平台启停容器时,FineReport关闭的是fr组件,FineBI关闭的是bi6组件。
1.3 步骤简介
序号 | 说明 | |
---|---|---|
1 了解迁移步骤 | 请务必在执行迁移前,完整阅读本节步骤简介,了解每个步骤的作用 | |
2 新容器化工程准备 | 2.1 部署运维平台 | 容器化部署FineReport/FineBI,需要通过FineOps运维平台前端实现 因此用户需要先部署一个FineOps运维平台 |
2.2 部署新工程 | 迁移项目,是从原有非容器化工程,迁移到新的容器化工程 因此用户需要先通过FineOps运维平台部署一个新的容器化单机工程 | |
2.3 确认新工程版本 | 由于容器化部署的工程,一般为帆软发布的较新版本 因此用户需要先确认新工程版本,确保后续升级旧工程到同一版本 | |
2.4 关闭新工程 | 迁移时,需要将老工程的一些文件拷贝到新工程中,这个操作需要在新工程停止运行的状态下进行 因此用户要通过FineOps运维平台前端快速关闭新工程 | |
2.5 备份新工程config文件夹 | 容器化部署新工程时,会自动生成工程部署所用语句,后续运营维护时可能会需要使用/查找,在迁移过程中该语句所在文件会被覆盖 因此用户需要提前异地备份该文件所在config文件夹 | |
3 原非容器化工程准备 | 3.1 备份原工程 | 在进行工程迁移前,为避免迁移失败,导致工程文件丢失无法回退等问题,请务必对原工程进行备份后再进行后续操作 |
3.2 升级原工程 | 工程迁移必须基于同版本的工程进行 因此需要将原非容器化部署的工程升级到新工程同一版本,方可进行迁移 | |
3.3 确认原工程配置外接数据库 | 为了保证新老工程的平台配置完全一致,需要同步两个工程的配置库 因此用户需要先确认好原工程所用的finedb数据库信息 | |
3.4 确认原工程已安装插件 | 迁移时,需要将原工程的插件覆盖新工程,而运维平台对接项目时,部分功能对项目的插件有要求 因此需要先确认原工程已安装符合版本要求的插件 | |
3.5 关闭原工程 | 迁移时,需要将原工程的一些文件拷贝到新工程中,这个操作需要在原工程停止运行的状态下进行 因此用户需要手动关闭原工程 | |
4 迁移工程 | 4.1 拷贝文件 | 本节即为正式迁移操作 将原非容器化工程的必要文件,拷贝到新容器化工程中 |
4.2 启动新工程 | 接下来的操作需要在新工程平台上执行 因此用户要通过FineOps运维平台前端快速启动新工程 | |
4.3 迁移新工程外接数据库 | 由于此时新老工程均使用了同一个finedb数据库,而每个finedb数据库只能对接一个工程,否则可能导致使用异常 因此用户需要将新工程的外接数据库迁移到其他数据库 | |
4.4 抽取数据 | 仅FineBI工程需要执行本节操作 工程迁移后,FineBI一般需要重新进行数据抽取,业务用户方可正常使用 因此用户需要在抽取前确认并修改数据存储路径,再执行数据抽取 | |
5 启动原非容器化工程 | 如对原非容器化工程仍有使用诉求,可参考本节手动启动原工程 | |
6 迁移授权 | 若老工程进行了注册,一般需要将老工程的授权迁移到新工程 容器化工程推荐使用「容器私有云认证」方式 |
2. 新容器化工程准备
注:建议部署新工程、老工程、运维平台所用服务器内网互通,会大幅降低迁移难度。
2.1 部署运维平台
详情请参见:部署运维平台
2.2 部署新工程
详情请参见:部署新FineReport单机项目、部署新FineBI单机项目
注意事项1:迁移时,需要将老工程的一些必要文件、资源拷贝到新工程中,因此必须要确保新工程磁盘空间足够大。
1)检查原非容器化工程%Tomcat_home%\webapps\webroot文件夹的大小。假设为xG。
2)在准备新容器化单机工程所在服务器时,请根据原工程大小,适度扩大新容器化工程所在服务器节点剩余磁盘空间。
建议新工程最小剩余磁盘空间大小为 max(2x , 500) G。
注意事项2:部署新工程时,会同时部署一些必要组件,建议记录下组件的信息,方便在后续维护过程中查看。
请在「部署新项目-项目设置」环节,记录下MySQL、elasticsearch组件的相关信息。由于组件密码随机生成,请务必修改组件的密码,方便后续使用。
注意事项3:迁移时,需要将老工程的一些文件拷贝到新工程中,因此需要记录下新工程存放文件的外挂目录位置。
请在「部署新项目-节点配置」环节,记录下工程的挂载路径。
2.3 确认新工程版本
1)管理员登录FineOps运维平台,在「运维管理>项目管理」中,可查看新工程的访问地址。
2)管理员登录新容器化工程,点击「管理系统>注册管理>版本信息」,可查看新容器化工程的小版本号(精确到JAR包日期)。
2.4 关闭新工程
1)管理员登录FineOps运维平台,在「运维管理>项目管理」中,点击新容器化部署的项目后的「组件管理」按钮。
2)找到bi6/fr组件,点击「停止」按钮,即可关闭新容器化工程。
2.5 备份新工程config文件夹
1)使用终端设备访问新容器化工程所在服务器,进入2.2节记录的挂载路径/fanruanxxx/bi目录下。
2)找到config文件夹,文件夹中存放的yaml文件有着工程部署所用语句,请务必异地备份。
3. 原非容器化工程准备
3.1 备份原工程
详情请参见 工程备份还原方案 3.1节,对工程进行备份。
3.2 升级原工程
1)获取JAR包
付费用户请联系帆软技术支持,获取2.3节新工程同一小版本的工程JAR包(精确到JAR包日期)。
技术支持联系方式:前往「服务」,选择「在线支持」、电话「400-811-8890」。
2)升级原非容器化工程
请参考「FineBI小版本升级 / FineReport小版本升级」文档升级工程至指定版本。
3.3 确认原工程配置外接数据库
管理员登录原非容器化工程,点击「管理系统>系统管理>常规」,检查外接数据库是否已配置。
情况 | 说明 |
---|---|
已配置 | 说明工程已配置外接数据库,点击「已配置」,查看并记录下该外接数据库位置信息 用户必须确保新容器化工程所在服务器与该外接数据库所在服务器互通 |
未配置 | 说明工程未配置外接数据库,请先为该非容器化工程配置一个外接数据库,可使用2.2节的MySQL组件 请确保新容器化工程所在服务器与该外接数据库所在服务器互通,请在配置时勾选「迁移数据至要启用的数据库」 |
3.4 确认原工程已安装插件
管理员登录原非容器化工程,点击「管理系统>插件管理」。
1)必须确认安装以下插件,并升级至最新:系统运维、资源调度熔断插件。
2)建议升级其他已安装插件至最新版本。
3.4 关闭原工程
请参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档,关闭原非容器化部署的工程。
4. 迁移工程
4.1 拷贝文件
1)请提前检查原非容器化部署的工程,是否配置了外挂目录、是否配置共享文件服务器,确保拷贝到正确的文件。
2)新容器化工程外挂文件所在位置,为2.2节记录的挂载路径。
3)将以下文件,从原非容器化部署的工程,拷贝到新容器化部署的工程中:
注1:请勿直接 docker cp 整个webroot文件夹到容器,会导致功能异常。
注2:请勿直接拷贝整个webroot文件夹到容器化工程的外挂目录,部分文件不可以被覆盖。
注2:请勿使用3.1节备份的文件,而是使用工程最终的文件进行拷贝操作。
FineBI需要拷贝的文件
原非容器化工程目录 | 新容器化工程外挂目录 | 说明 | ||
---|---|---|---|---|
%Tomcat_HOME%/logs | %BI_HOME%/fanruanxxx/bi6/tomcat_logs | 作用:Tomcat通用日志位置 是否必须拷贝:用户自行决定,Tomcat历史访问日志,可不拷贝 | ||
%Tomcat_HOME%/webapps/webroot/backup | %BI_HOME%/fanruanxxx/bi6/backup | 作用:工程历史备份文件 是否必须拷贝:用户自行决定,可存储在原始的目录下备份,可不拷贝 | ||
%Tomcat_HOME%/webapps/webroot/bi-data | %BI_HOME%/fanruanxxx/bi6/bi-data | 作用:FineBI抽取数据 是否必须拷贝:用户自行决定 如果不拷贝,在新工程启动后需要全局更新,重新抽取数据 如果拷贝,该文件夹中文件数量很多,拷贝耗时很久,请耐心等待 | ||
%Tomcat_HOME%/webapps/webroot/logs | %BI_HOME%/fanruanxxx/bi6/logs | 作用:swift日志 是否必须拷贝:用户自行决定 如果不拷贝,会丢失工程历史操作日志(即logdb),「管理系统>平台日志」功能无数据 如对历史使用情况无要求,无需拷贝 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/assets/temp_attach | %BI_HOME%/fanruanxxx/bi6/assets/temp_attach | 作用:FineBI数据表相关信息 是否必须拷贝:必须拷贝 该文件夹中存放着工程Excel原始文件信息,如不拷贝该文件夹会导致原始Excel丢失 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/assets/vcs | %BI_HOME%/fanruanxxx/bi6/assets/vcs | 作用:FineReport模板备份文件 是否必须拷贝:用户自行决定 如果工程未使用FineReport模板,或不需要回退历史开发的FineReport模板,则无需拷贝 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/assets/其他文件 | %BI_HOME%/fanruanxxx/bi6/assets/其他文件 | 作用:通用的共享持久化目录 是否必须拷贝:必须拷贝 工程正常运行所需要的文件,如不拷贝会影响工程正常使用 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/classes | %BI_HOME%/fanruanxxx/bi6/classes | 作用:工程调用的默认和自定义class文件 是否必须拷贝:必须拷贝 有可能存在自定义的class文件,如不拷贝会影响工程正常使用 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/config | %BI_HOME%/fanruanxxx/bi6/config | 作用:配置库相关文件 是否必须拷贝:必须拷贝 平台调用的配置库(finedb),如不拷贝会影响工程正常使用 | ||
找到以下两个目录: %Tomcat_HOME%/webapps/webroot/WEB-INF/lib %Tomcat_HOME%/webapps/webroot/WEB-INF/customLib 以下为工程自带JAR,无需拷贝,除此之外的用户自定义JAR均需拷贝:
| %BI_HOME%/fanruanxxx/bi6/customlib | 作用:工程定制/外部引入的JAR包 是否必须拷贝:必须拷贝,如不拷贝会影响模板访问 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/dpworks | %BI_HOME%/fanruanxxx/bi6/dpworks | 作用:FineDataLink任务相关的配置文件 是否必须拷贝:必须拷贝,如不拷贝会影响FineDataLink任务使用 (如不存在该文件夹,说明工程没有使用FDL相关功能,略过) | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/plugins | %BI_HOME%/fanruanxxx/bi6/plugins | 作用:插件相关文件 是否必须拷贝:必须拷贝,如不拷贝会影响插件相关功能的实现。 请先删除文件夹中原有文件,再将老工程插件包拷贝进来,否则同一个插件可能共存多个版本,导致异常。 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/reportlets | %BI_HOME%/fanruanxxx/bi6/reportlets | 作用:FineReport模板存放目录 是否必须拷贝:用户自行决定 如果工程未使用FineReport模板,则无需拷贝 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/schedule | %BI_HOME%/fanruanxxx/bi6/schedule | 作用:定时调度生成的文件 是否必须拷贝:用户自行决定 如果不拷贝,定时任务挂载到决策平台的结果报表无法访问 |
FineReport需要拷贝的文件
原非容器化工程目录 | 新容器化工程外挂目录 | 说明 | ||
---|---|---|---|---|
%Tomcat_HOME%/logs | %FR_HOME%/fanruanxxx/fr/tomcat_logs | 作用:Tomcat通用日志位置 是否必须拷贝:用户自行决定,Tomcat历史访问日志,可不拷贝 | ||
%Tomcat_HOME%/webapps/webroot/backup | %FR_HOME%/fanruanxxx/fr/backup | 作用:工程历史备份文件 是否必须拷贝:用户自行决定,可存储在原始的目录下备份,可不拷贝 | ||
%Tomcat_HOME%/webapps/webroot/logs | %FR_HOME%/fanruanxxx/fr/logs | 作用:swift日志 是否必须拷贝:用户自行决定 如果不拷贝,会丢失工程历史操作日志(即logdb),「管理系统>平台日志」功能无数据 如对历史使用情况无要求,无需拷贝 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/assets/temp_attach | %FR_HOME%/fanruanxxx/fr/assets/temp_attach | 作用:读写缓存存储路径 是否必须拷贝:必须拷贝 该文件夹中存放着工程读写(图片)缓存,不拷贝可能会导致模板设置的背景图片预览为空 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/assets/vcs | %FR_HOME%/fanruanxxx/fr/assets/vcs | 作用:FineReport模板备份文件 是否必须拷贝:用户自行决定 如果工程不需要回退历史开发的FineReport模板,则无需拷贝 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/assets/其他文件 | %FR_HOME%/fanruanxxx/fr/assets/其他文件 | 作用:通用的共享持久化目录 是否必须拷贝:必须拷贝 工程正常运行所需要的文件,如不拷贝会影响工程正常使用 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/classes | %FR_HOME%/fanruanxxx/fr/classes | 作用:工程调用的默认和自定义class文件 是否必须拷贝:必须拷贝 有可能存在自定义的class文件,如不拷贝会影响工程正常使用 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/config | %FR_HOME%/fanruanxxx/fr/config | 作用:配置库相关文件 是否必须拷贝:必须拷贝 平台调用的配置库(finedb),如不拷贝会影响工程正常使用 | ||
找到以下两个目录: %Tomcat_HOME%/webapps/webroot/WEB-INF/lib %Tomcat_HOME%/webapps/webroot/WEB-INF/customLib 以下为工程自带JAR,无需拷贝,除此之外的用户自定义JAR均需拷贝:
| %FR_HOME%/fanruanxxx/fr/customlib | 作用:工程定制/外部引入的JAR包 是否必须拷贝:必须拷贝,如不拷贝会影响模板访问 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/dpworks | %FR_HOME%/fanruanxxx/fr/dpworks | 作用:FineDataLink任务相关的配置文件 是否必须拷贝:必须拷贝,如不拷贝会影响FineDataLink任务使用 (如不存在该文件夹,说明工程没有使用FDL相关功能,略过) | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/plugins | %FR_HOME%/fanruanxxx/fr/plugins | 作用:插件相关文件 是否必须拷贝:必须拷贝,如不拷贝会影响插件相关功能的实现。 请先删除文件夹中原有文件,再将老工程插件包拷贝进来,否则同一个插件可能共存多个版本,导致异常。 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/reportlets | %FR_HOME%/fanruanxxx/fr/reportlets | 作用:FineReport模板存放目录 是否必须拷贝:必须拷贝,如不拷贝会导致工程所有模板丢失 | ||
%Tomcat_HOME%/webapps/webroot/WEB-INF/schedule | %FR_HOME%/fanruanxxx/fr/schedule | 作用:定时调度生成的文件 是否必须拷贝:用户自行决定 如果不拷贝,定时任务挂载到决策平台的结果报表无法访问 |
4.2 启动新工程
用户登录运维平台,点击「运维管理>项目管理」,点击新容器化部署的工程项目后的「组件管理」按钮。
找到bi6/fr组件,点击「启动」按钮,即可启动新容器化工程。如下图所示:
4.3 迁移新工程外接数据库
1)新建空数据库
如果老工程外接数据库使用的非MySQL8类型数据库:
新工程外接数据库仍然部署在该数据库下的新库里,2.2节的MySQL数据库无需使用
请在老工程原外接数据库地址新建一个库名,作为待迁移的空库
如果老工程外接数据库使用的MySQL8类型数据库:
新工程外接数据库建议部署在2.2节的MySQL数据库里
请在2.2节容器化部署的MySQL8组件新建一个库名,作为待迁移的空库
2)迁移数据库
管理员登录新容器化工程,点击「管理系统>系统管理>常规>外接数据库」。
配置外接数据库为上一步的空库
勾选「迁移数据至要启用的数据库」
点击「启用新数据库」
当出现提示「已成功切换至目标数据库!」,则代表外接数据库切换成功。
4.4 抽取数据
注:仅FineBI工程需要执行本节操作。
1)管理员登录新工程,点击「公共数据>全局更新」,即可看到数据的存储路径。
2)请确保修改为新工程容器内数据存放路径:/usr/local/tomcat/webapps/webroot/bi-data/spider/db,点击「确定」,更改成功。
3)再次访问「公共数据>全局更新」,执行「立即全局更新」,即可抽取最新数据,并存放到正确的存储路径中。
5. 启动原非容器化工程
参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档,启动原非容器化部署的工程。