1. 概述
1.1 版本
| FineBI服务器版本 | 功能变更 |
|---|---|
| 6.0.5 | - |
1.2 应用场景
Kubernetes 是一个开源的容器编排平台，被广泛用于容器化工作负载的管理，支持多云、多区域的部署，有助于实现高可用性和弹性。
当用户在 K8S 部署帆软应用后，需要对应用进行注册。本文讲解如何对 K8S 部署的帆软应用进行容器私有云注册。
本文示例环境为华为云 CCE，其他 K8S 云平台请自行调整操作步骤，仅供参考。
2. 准备镜像
2.1 获取授权镜像
请使用合同中指定的邮箱发送注册信息给 FineReport 商务business@fanruan.com，邮件格式如下：
商务收到邮件，核实无误后会为用户生成认证服务器的镜像文件fanruan_license_server.tar，以邮件方式发送给用户。
注：若有任何特殊情况，请在邮件中注明。
| 清单 | 要求 | 注意事项 | |
|---|---|---|---|
| 优先联系 | 请提前联系帆软销售，确认相关事项并签署合同 | - | |
| 发件人 | 请使用合同中指定的邮箱 | 如发送注册信息的邮箱，非合同中指定的邮箱，则不予注册 | |
| 收件人 | business@fanruan.com | - | |
| 标题 | XXX 公司注册 FineReport 正式授权文件 | 如发送注册信息时，未注明公司名称，则不予注册 | |
| 正文 | 基础信息 | 公司名称：XXX 公司 项目名称：XXX 项目 合同签定日期：XXXX年XX月XX日 | - |
| 注册方式 | 容器私有云认证 | - | |
| 最大可注册量 | 集群工程节点个数 | 若不提供该选项，则默认为1 单机情况下无需提供该项 | |
2.2 上传镜像
操作步骤：请将上一节获取的fanruan_license_server.tar授权镜像包，上传到镜像仓库中。如下图所示：
存放位置：建议将授权镜像与帆软应用组件镜像，存放于同一镜像仓库中。（因此如已有镜像仓库，可跳过本节操作）。
2.3 查看镜像信息
请记录下镜像的仓库地址和镜像版本。
例如下图：swr.cn-north-1.myhuaweicloud.com/fanruan/fanruan_license_server_amd64:1.0.0
3. 创建授权应用
3.1 选择/新建命名空间
一个 Kubernetes 集群支持设置多个命名空间（Namespace），每个命名空间相当于一个相对独立的虚拟空间，不同空间的资源相互隔离互不干扰。
建议授权应用和待授权的帆软应用，安装在同一华为云集群的同一命名空间下，且该命名空间中不再安装其他组件，实现多应用之间的资源隔离。
请记录下namespace的名称。例如下图：fanruan-test
3.2 创建存储
K8S集群的存储，是保存业务数据的重要组件。用户需要先创建好静态存储，下文YAML文件中需要用到。
在上一节选定的namespace中，创建静态存储。
请记录下静态存储的PVC名称。例如下图：data-fr-0
3.3 修改YAML文件
点击下载并解压，获取示例YAML文件：lic_example.zip
请根据自身情况，修改以下内容：
| 配置项 | 说明 |
|---|---|
| namespace | 请修改namespace值为3.1节选的的命名空间名称
|
claimName | 请修改claimName值为3.2节创建的存储名称
|
| image | 请修改image为2.3节的镜像信息（如果镜像拉取需要密钥，也需要写进来）
|
3.4 YAML创建资源
使用上节的YAML文件，在3.1节选定的namespace中，创建授权应用。
4. 授权认证
4.1 提交认证
1）访问授权应用地址https://<host>:<port>/license/qrcode即可进行扫码认证。
协议：使用https
host：不可使用ip，需要使用域名fanruan-license-server-headless.<namespace>，namesapce换成3.1节选定的的namespace，形如fanruan-license-server-headless.fanruan-test
端口：使用8081
2）使用手机浏览器/微信扫描生成的二维码，会返回一个 6 位的验证码，将该验证码填写到系统中，点击「提交认证」。如下图所示：
注1：二维码有效时间为 5 分钟，请于规定时间内完成注册流程。超过5分钟后，二维码会提示需要手动刷新。
注2：手机扫码返回验证码之后，工程最好立刻注册，未注册成功前不要重启工程。
注3：为了防止验证码暴力破解和接口高频访问，验证码输入错误次数若超过5次，则锁定 15 分钟。
4.2 FineBI工程验证授权
管理员登录FineBI系统，点击「管理系统>注册管理>立即注册」，如下图所示：
认证方式选择「私有云认证」，服务器地址填写上节授权应用的域名和监听端口https://<host>:<port>，点击「提交认证」，如下图所示：
注：请确保FineBI工程可以访问授权应用。
认证成功后，如下图所示：
注1：这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。
注2：若认证失败，检查防火墙设置，开放对应端口或者关闭防火墙。
