容器私有雲認證-面向非維運平台部署專案

1.1 版本

1.2 應用場景

工程部署在docker容器中，工程無法綁定機器碼/MAC地址，因此無法使用本地機器資訊認證/私有雲認證。

FineReport 無法連結外網，因此無法使用線上註冊。

使用者需要一台授權伺服器給多個 FineReport 專案授權，因此無法使用本地容器認證。

1.3 功能簡介

FineReport提供「容器私有雲認證」方案，主要適用於容器化部署的工程。

使用者需要準備兩個環境。

1）授權伺服器：docker容器化環境中，用於上傳啟動私有雲鏡像檔案。

2）工程伺服器：FineReport/FineBI工程所在伺服器。

1.4 注意事項

1）授權伺服器與工程伺服器可以共用同一伺服器，也可以分開部署於兩個伺服器，只需確定工程伺服器跟授權伺服器網路互通即可 。

2）授權伺服器重啟後，是否需要重新掃碼認證取決於工程版本、Lic 獲取時間及工程配置類型。詳見第 5 節 。

3）11.0.18 及之後版本，將在「管理系統>註冊管理」頁面內以列表形式顯示每次認證的失敗時間和失敗原因，幫助使用者排查問題，如下圖所示：

注：叢集環境下，每個節點的失敗原因可能不同，將顯示每個節點的失敗原因。

2.1 獲取授權檔案

請使用合同中指定的信箱傳送註冊資訊給 FineReport 商務business@fanruan.com，郵件格式如下： 

商務收到郵件，覈實無誤後會為使用者生成認證伺服器的鏡像檔案fanruan_license_server.tar，以郵件方式傳送給使用者。

注：若有任何特殊情況，請在郵件中註明。

2.2 啟動授權伺服器

1）載入鏡像檔案fanruan_license_server.tar

docker load < fanruan_license_server.tar

2）查看匯入的鏡像檔案

預設會有arm64和amd64兩種檔案包，使用者可選擇適合自己的。下文以amd64包作為示範

docker images

3）透過docker鏡像生成容器，並進行目錄映射

例如將/app/config映射到D:\William\lic\config

docker run -v /D/William/lic/config:/app/config -P -d fanruan_license_server_amd64:1.0.0

注1：映射目錄名不要包含空格、中文、特殊字元等，否則可能會導致報錯。

注2：啟動鏡像時，預設使用容器自帶的https證件，僅支援localhost/127.0.0.1兩個地址。

       如需支援其他IP和域名，可以啟動映射證件所在目錄，使用自己的證件檔案。

注3：當使用-P時，Docker會隨機從49153 和65535之間尋找一個未被佔用的埠綁定到容器，即為下文宿主機的49155埠。

        如需指定宿主機埠，啟動命令中-P可調整為-p 宿主機埠:容器埠

注4：容器目錄說明如下表所示，如需映射多個目錄，需要在各個目錄間連結-v

         例如將/app/config映射到D:\William\lic\config、將/app/log映射到D:\William\lic\log

         命令為：docker run -v /D/William/lic/config:/app/config -v /D/William/lic/log:/app/log -P -d fanruan_license_server_amd64:1.0.0

4）列出在運作的容器資訊

docker ps

2.3 提交認證

從上節可知道，docker容器的8081埠映射到宿主機的49155埠。

存取https://172.16.63.131:49155/license/qrcode即可進行掃碼認證。（IP和埠需要按照自己實際情況調整）

使用手機瀏覽器/微信掃描生成的QRCODE，會傳回一個 6 位的檢驗碼，將該檢驗碼填寫到系統中，點選「提交認證」。如下圖所示：

注1：QRCODE有效時間為 5 分鐘，請於規定時間內完成註冊流程。超過5分鐘後，QRCODE會提示需要手動重新整理。

注2：手機掃碼傳回檢驗碼之後，工程最好立刻註冊，未註冊成功前不要重啟工程。

注3：為了防止檢驗碼暴力破解和API高頻存取，檢驗碼輸入錯誤次數若超過5次，則鎖定 15 分鐘。

2.4 報表伺服器驗證授權

管理者登入數據決策系統，點選「管理系統>註冊管理>立即註冊」，如下圖所示：

認證方式選擇「私有雲認證」，伺服器地址填寫上面授權伺服器顯示的 IP 和監聽埠，例如https://172.16.63.131:49155，點選「提交認證」，如下圖所示：

注：請確定報表伺服器可以存取授權伺服器。

認證成功後，如下圖所示：

注1：這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權註冊。

注2：若認證失敗，檢查防火牆設定，開放對應埠或者關閉防火牆。

11.0.18 之前版本，若註冊失敗，頁面將出現提示彈窗：認證失敗，請重新認證。

11.0.18 及之後版本，註冊失敗提示資訊優化，若註冊失敗，頁面將彈窗提示具體失敗原因，使用者可根據提示資訊進行排查。

3.1 單機環境註冊失敗

若註冊失敗，頁面將彈窗提示具體失敗原因，點選「詳細資訊」按鈕，即可查看具體失敗原因或問題排查方案，如下圖所示：

點選「傳回」回到註冊管理頁面，「註冊資訊」處會顯示註冊失敗和失敗原因，點選「查看錯誤詳情」即可查看具體失敗原因或問題排查方案，如下圖所示：

3.2 叢集環境註冊失敗

若註冊失敗，不同節點的註冊失敗原因可能不同，頁面將彈窗提示每個節點的具體失敗原因，點選「詳細資訊」按鈕，即可查看具體失敗原因或問題排查方案，如下圖所示：

點選「傳回」回到註冊管理頁面，「註冊資訊」處會以列表形式顯示每個節點的失敗原因，點選「查看錯誤詳情」即可查看對應的失敗原因或問題排查方案，如下圖所示：

3.3 失敗原因

註冊失敗原因匯總如下，使用者可根據具體失敗原因或錯誤詳情中提示的排查方案進行排查。

注1：除以下外失敗原因外，其他統一報錯：證件內容不正確。

注2：一次註冊程式中有多個失敗原因時，僅展示第一次失敗的原因。

進行了容器私有雲認證的工程，如需遷移授權伺服器，請按照以下步驟進行。

4.1 銷燬原工程授權

請使用合同中指定的信箱傳送郵件給 FineReport 商務business@fanruan.com。

請在信箱正文描述清楚待遷移的授權伺服器地址，例如2.4節填寫的https://172.16.63.131:49155

商務收到郵件，覈實無誤後會為使用者銷燬對應授權，並以郵件方式通知使用者。

注：在得到商務明確答覆前，請勿重啟待遷移的授權伺服器。

4.2 copyprivateConfig檔案

此操作需要掌握一定的docker知識，如有需要請聯絡帆軟技術支援協助完成 。

1）關閉待遷移的授權服務容器 。

使用docker ps | grep fanruan_license_server命令找到 license 容器 ID

執行docker stop <容器ID>命令停止 license 容器

2）在容器內的/app/config路徑下獲取自動生成的privateConfig檔案 。

4.3 獲取新授權檔案

請使用合同中指定的信箱傳送郵件給 FineReport 商務business@fanruan.com。

郵件格式請參考本文2.1節，額外附上上一步獲取的 privateConfig 檔案。

商務收到郵件，覈實無誤後會為使用者生成認證伺服器的鏡像檔案fanruan_license_server.tar，以郵件方式傳送給使用者。

使用者再按照第二章的步驟啟動新授權伺服器進行註冊即可。

授權服務重啟後，是否需要重新掃碼認證取決於工程版本、授權服務鏡像獲取時間及工程配置類型。

若容器私有雲認證失效，無需重新上傳鏡像檔案，只需重新完成 2.3 節掃碼認證操作即可。