1. 概述
1.1 版本
| 工程版本 | 功能变更 |
|---|---|
FineReport11.0 FineBI6.0 | - |
1.2 应用场景
相比于普通单机工程，容器化部署的工程，升级和维护成本较低。
相比于单机工程，集群具有高可用性、高性能、易于管理、可伸缩性和安全保障等优点，适用于企业级的报表生成和管理需求。
本文方案，帮助用户将原有非容器化部署的单机工程，迁移为容器化部署的集群工程。
注：全文以FineBI作为演示。FineReport迁移步骤基本一致，仅需要两个点：
1）拷贝文件时，FineReport和FineBI需要拷贝的文件不完全相同，注意文档中的表格即可。
2）使用运维平台启停容器时，FineReport关闭的是fr组件，FineBI关闭的是bi6组件。
2. 新容器化工程准备
2.1 部署运维平台
详情请参见：部署运维平台
2.2 部署新工程
详情请参见：部署新FineBI集群项目、部署新FineReport集群项目
注意事项1：迁移时，需要将老工程的一些必要文件、资源拷贝到新工程中，因此必须要确保新工程磁盘空间足够大。
1）检查原非容器化工程%Tomcat_home%\webapps\webroot文件夹的大小。假设为xG。
2）在准备新容器化集群文件服务器时，请根据原工程大小，适度扩大新工程文件服务器所在节点剩余磁盘空间。
建议最小剩余磁盘空间大小为 max(2x , 500) G。
注意事项2：部署新工程时，会同时部署一些必要组件，建议记录下组件的信息，方便在后续维护过程中查看。
请在「部署新项目-项目设置」环节，记录下MySQL、Redis、minio、elasticsearch组件的相关信息。由于组件密码随机生成，请务必修改组件的密码，方便后续使用。
注意事项3：迁移时，需要将老工程的一些文件拷贝到新工程中，因此需要记录下新工程存放文件的外挂目录位置。
请在「部署新项目-节点配置」环节，记录下集群每个工程节点的挂载路径。
2.3 确认新工程版本
1）管理员登录FineOps运维平台，在「运维管理>项目管理」中，可查看新工程的访问地址。
2）管理员登录新容器化工程，点击「管理系统>注册管理>版本信息」，可查看新容器化工程的小版本号（精确到JAR包日期）。
2.4 关闭新工程
1）管理员登录FineOps运维平台，在「运维管理>项目管理」中，点击新容器化部署的项目后的「组件管理」按钮。
2）找到bi6/fr组件，点击「停止」按钮，即可关闭新容器化工程。
2.6 备份新工程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 确认原工程配置外接数据库
管理员登录原非容器化工程，点击「管理系统>系统管理>常规」，检查外接数据库是否已配置。
| 情况 | 说明 |
|---|---|
| 已配置 | 说明工程已配置外接数据库，点击「已配置」，查看并记录下该外接数据库位置信息 用户必须确保新容器化工程所在服务器与该外接数据库所在服务器互通 |
| 未配置 | 说明工程未配置外接数据库，请先为该非容器化工程配置一个外接数据库 请确保新容器化工程所在服务器与该外接数据库所在服务器互通，请在配置时勾选「迁移数据至要启用的数据库」 |
3.4 确认原工程已安装插件
管理员登录原非容器化工程，点击「管理系统>插件管理」。
1）必须确认安装以下插件，并升级至最新：minio资源仓库、系统运维、资源调度熔断插件。
2）建议升级其他已安装插件至最新版本。
3.5 对接集群组件
管理员登录原非容器化工程，点击「管理系统>智能运维>集群配置」。
1）开启「状态服务器」。选择「单机Redis」，输入2.2节记录的Redis组件信息。
2）开启「文件服务器共享」。选择「MinIO」，输入2.2节记录的MinIO组件信息。
3）缓存模式选择「关闭缓存」，集群通信协议选择「TCP」。
4）开启「开启集群」按钮。
请参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档，重启原非容器化部署的工程。
再次查看原非容器化工程的「管理系统>智能运维>集群配置」，在节点管理处出现本工程节点，说明单节点集群部署成功。
3.6 关闭原非容器化工程
请参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档，关闭原非容器化部署的工程。
4. 迁移工程
4.1 拷贝文件
1）请提前检查原非容器化部署的工程，是否配置了外挂目录、是否配置共享文件服务器，确保拷贝到正确的文件。
2）新容器化工程外挂文件所在位置，为2.2节记录的挂载路径。
3）将以下文件，从原非容器化部署的工程，拷贝到新容器化部署的工程中：
注1：请勿直接 docker cp 整个webroot文件夹到容器，会导致功能异常。
注2：请勿直接拷贝整个webroot文件夹到容器化工程的外挂目录，部分文件不可以被覆盖。
注3：请勿使用3.1节备份的文件，而是使用工程最终的文件进行拷贝操作。
注4：文件需要一一拷贝到新容器化部署的每一个工程节点和文件服务器对应位置。
注5：MinIO使用的是S3协议，不能直接上传文件到服务器上进行使用。详情请参见：MinIO文件服务器简介
FineBI需要拷贝的文件
| 原非容器化工程目录 | 新容器化工程外挂目录 | 说明 | ||
|---|---|---|---|---|
| %Tomcat_HOME%/logs | 每个工程节点%BI_HOME%/fanruanxxx/bi6/tomcat_logs | 作用：Tomcat通用日志位置 是否必须拷贝：用户自行决定，Tomcat历史访问日志，可不拷贝 | ||
| %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/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/plugins | 每个工程节点%BI_HOME%/fanruanxxx/bi6/plugins | 作用：插件相关文件 是否必须拷贝：必须拷贝，如不拷贝会影响插件相关功能的实现 | ||
| %Tomcat_HOME%/webapps/webroot/backup | minio文件服务器文件存放路径/backup | 作用：工程历史备份文件 是否必须拷贝：用户自行决定，可存储在原始的目录下备份，可不拷贝 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/assets/temp_attach | minio文件服务器文件存放路径/assets/temp_attach | 作用：FineBI数据表相关信息 是否必须拷贝：必须拷贝 该文件夹中存放着工程Excel原始文件信息，如不拷贝该文件夹会导致原始Excel丢失 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/assets/vcs | minio文件服务器文件存放路径/assets/vcs | 作用：FineReport模板备份文件 是否必须拷贝：用户自行决定 如果工程未使用FineReport模板，或不需要回退历史开发的FineReport模板，则无需拷贝 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/assets/其他文件 | minio文件服务器文件存放路径/assets/其他文件 | 作用：通用的共享持久化目录 是否必须拷贝：必须拷贝 工程正常运行所需要的文件，如不拷贝会影响工程正常使用 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/reportlets | minio文件服务器文件存放路径/reportlets | 作用：FineReport模板存放目录 是否必须拷贝：用户自行决定 如果工程未使用FineReport模板，则无需拷贝 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/schedule | minio文件服务器文件存放路径/schedule | 作用：定时调度生成的文件 是否必须拷贝：用户自行决定 如果不拷贝，定时任务挂载到决策平台的结果报表无法访问 |
FineReport需要拷贝的文件
| 原非容器化工程目录 | 新容器化工程外挂目录 | 说明 | ||
|---|---|---|---|---|
| %Tomcat_HOME%/logs | 每个工程节点%FR_HOME%/fanruanxxx/fr/tomcat_logs | 作用：Tomcat通用日志位置 是否必须拷贝：用户自行决定，Tomcat历史访问日志，可不拷贝 | ||
| %Tomcat_HOME%/webapps/webroot/logs | 每个工程节点%FR_HOME%/fanruanxxx/fr/logs | 作用：swift日志 是否必须拷贝：用户自行决定 如果不拷贝，会丢失工程历史操作日志（即logdb），「管理系统>平台日志」功能无数据 如对历史使用情况无要求，无需拷贝 | ||
| %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/plugins | 每个工程节点%FR_HOME%/fanruanxxx/fr/plugins | 作用：插件相关文件 是否必须拷贝：必须拷贝，如不拷贝会影响插件相关功能的实现 | ||
| %Tomcat_HOME%/webapps/webroot/backup | minio文件服务器文件存放路径/backup | 作用：工程历史备份文件 是否必须拷贝：用户自行决定，可存储在原始的目录下备份，可不拷贝 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/assets/temp_attach | minio文件服务器文件存放路径/assets/temp_attach | 作用：读写缓存存储路径 是否必须拷贝：必须拷贝 该文件夹中存放着工程读写（图片）缓存，不拷贝可能会导致模板设置的背景图片预览为空 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/assets/vcs | minio文件服务器文件存放路径/assets/vcs | 作用：FineReport模板备份文件 是否必须拷贝：用户自行决定 如果工程不需要回退历史开发的FineReport模板，则无需拷贝 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/assets/其他文件 | minio文件服务器文件存放路径/assets/其他文件 | 作用：通用的共享持久化目录 是否必须拷贝：必须拷贝 工程正常运行所需要的文件，如不拷贝会影响工程正常使用 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/reportlets | minio文件服务器文件存放路径/reportlets | 作用：FineReport模板存放目录 是否必须拷贝：必须拷贝，如不拷贝会导致工程所有模板丢失 | ||
| %Tomcat_HOME%/webapps/webroot/WEB-INF/schedule | minio文件服务器文件存放路径/schedule | 作用：定时调度生成的文件 是否必须拷贝：用户自行决定 如果不拷贝，定时任务挂载到决策平台的结果报表无法访问 |
4.2 启动单个节点
用户登录运维平台，点击「运维管理>项目管理」，点击新容器化部署的工程项目后的「组件管理」按钮。
找到bi6组件，点击其中某个节点的「启动」按钮，即可启动该工程节点。如下图所示：
4.3 迁移新工程外接数据库
1）新建空数据库
如果老工程外接数据库使用的非MySQL8类型数据库：
新工程外接数据库仍然部署在该数据库下的新库里，2.2节的MySQL数据库无需使用
请在老工程原外接数据库地址新建一个库名，作为待迁移的空库
如果老工程外接数据库使用的MySQL8类型数据库：
新工程外接数据库建议部署在2.2节的MySQL数据库里
请在2.2节容器化部署的MySQL8组件新建一个库名，作为待迁移的空库
2）迁移数据库
管理员登录启动了的新容器化工程节点，点击「管理系统>系统管理>常规>外接数据库」。
配置外接数据库为上文新建的空库
勾选「迁移数据至要启用的数据库」
点击「启用新数据库」
当出现提示「已成功切换至目标数据库！」，则代表该节点的外接数据库切换成功。
4.4 修改抽取数据存储路径
1）修改存储路径
在启动了的新容器化工程节点服务器中，找到挂载目录%BI_HOME%/fanruanxxx/bi6/config文件夹，修改/新建spider.cluster.properties文件。
在文件中添加一行：spider_local_base_path=/usr/local/tomcat/webapps/webroot/bi-data/spider/db
2）删除死节点
管理员登录启动了的新容器化工程节点，点击「管理系统>系统管理>抽取集群」，对应节点状态变为了「down」，删除该节点。
3）重启生成配置
用户登录运维平台，点击「运维管理>项目管理」，点击新容器化部署的工程项目后的「组件管理」按钮。
找到bi6组件，点击启动了的节点的「重启」按钮，即可重启该工程节点。
4）抽取数据
如果4.1节未拷贝bi-data文件，工程启动后需要全局更新，重新抽取数据到该路径。
如果4.1节拷贝了bi-data文件，工程启动后将直接指向该路径。
4.5 关闭单个节点
用户登录运维平台，点击「运维管理>项目管理」，点击新容器化部署的工程项目后的「组件管理」按钮。
找到bi6组件，点击启动了的节点的「停止」按钮，即可关闭该工程节点。
4.6 同步到其他节点
拷贝该工程节点%BI_HOME%/fanruanxxx/bi6/config文件夹到其他工程节点同位置。
4.7 启动全部工程节点
用户登录运维平台，点击「运维管理>项目管理」，点击新容器化部署的工程项目后的「组件管理」按钮。
找到bi6组件，点击组件后的「启动」按钮，即可启动该集群所有工程节点。如下图所示：
4.8 验证是否迁移成功
依次登录所有工程节点：
1）查看「管理系统>智能运维>集群配置>节点管理」中是否出现所有集群节点，说明多节点集群全部配置成功
2）查看各节点的工程配置是否相同，说明外接数据库配置成功
5. 启动原非容器化工程
1）将 3.1 节备份的webroot工程文件，覆盖原非容器化部署的工程的webroot工程
2）参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档，启动原非容器化部署的工程。
