1. 概述
1.1 版本說明
維運平台版本 | 功能變更 |
---|---|
V1.5.6 | 維運平台瘦身,取消內建和安裝部分冗餘維運組件鏡像:loki、promtail、sherlock、nacos-server、skywalking_ui |
V1.5.7 | elasticsearch、skywalking_oap組件安裝後預設啟動 |
V1.11.0 | 新增瀏覽器版本檢查提醒 |
V1.12.0 | 部署成功提示工程地址,方便使用者存取 |
V1.14.0 | 若檢查掛載磁碟空間不足,可快速更換部署路徑,無需手動更改yaml |
V1.15.0 | 調整部分維運組件預設埠,防止與維運專案衝突
|
V2.0.0 | 降低資源要求 1)刪除node_exporter、nginx_exporter、elasticsearch_exporter組件,功能合併至ops-agent,用於收集ops所在伺服器的指標資訊、收集nginx、elasticSearch組件的指標資訊 2)新增pushgateway組件,臨時儲存ops-agent收集到的指標,並供prometheus獲取 3)支援部署基礎版維運平台,不部署elasticSearch、skywalking_oap組件,不啟動鏈路追蹤相關功能 |
1.2 應用場景
FineOps維運平台是帆軟軟體推出的,為企業提供帆軟應用穩定運作和全方位維運管理的解決方案。
幫助使用者解決,管理帆軟應用(FineReport、FineBI)的程式遇到一些痛點和挑戰,詳情請參見:維運平台簡介
如需標準部署帆軟專案(FineBI、FineReport、FineDataLink),必須基於FineOps維運平台進行。
1.3 功能簡介
本文介紹,如何部署FineOps維運平台。
本文主要提供給伺服器資源較為緊張的客戶,如能提供全新伺服器用於部署,可參考:快速入門
2. 準備伺服器
請按照以下文檔,依次檢查所準備的伺服器是否滿足部署維運平台的需求。
文檔 | 說明 |
---|---|
瞭解維運平台標準版與基礎版 | 基礎版維運平台資源要求低,部分功能不支援使用。 標準版維運平台支援全量功能,但資源要求較高 使用者需要按照實際情況選擇 |
瞭解維運平台組件作用 | FineOps維運平台,由多個維運組件共用構成 使用者應當在部署前瞭解每個維運組件的作用 |
準備維運平台伺服器 | 確認部署維運平台的伺服器的記憶體、磁碟、作業系統等 確認維運平台是否已有docker以及版本 確認伺服器需要為維運組件預留的埠 確認伺服器需要對外開放的埠 準備安裝維運平台的合適位置確認部署維運平台的使用者權限是否滿足需求 |
3. 準備FineKey工具
3.1 獲取FineKey安裝包
點選可跳轉至下載頁下載安裝包:FineOps維運平台下載
有三種類型的安裝包,使用者可根據伺服器環境和自身訴求自行選擇:
安裝包類型 | 說明 |
---|---|
線上版安裝包 | 1)伺服器可存取外網,支援下載維運組件鏡像,安裝包體積小 2)支援從雲端下載FineReport/ FineBI專案組件鏡像,可透過FineOps視覺化部署工程 3)可對接已有FineReport/ FineBI工程 |
純淨版離線安裝包 | 1)伺服器為內網,內建全部維運組件鏡像,安裝包體積大 2)未內建FineReport/ FineBI專案組件鏡像,無法透過FineOps視覺化部署工程 3)用於對接已有FineReport/ FineBI工程 |
全量版離線安裝包 | 1)伺服器為內網,內建全部維運組件鏡像,安裝包體積大 2)內建FineReport/ FineBI專案組件鏡像,可透過FineOps視覺化部署工程 3)可對接已有FineReport/ FineBI工程 |
注:如希望使用線上版安裝包,且只開放指定外網地址,請確定鏡像倉庫所在伺服器支援存取以下外網地址:
(維運平台自帶的鏡像倉庫與維運平台在同一伺服器下)
功能 | 地址 |
---|---|
獲取鏡像/更新維運平台/更新專案組件 | 域名:fineops-registry.cn-hangzhou.cr.aliyuncs.com,埠:443 |
獲取更新資訊 | 四選一,有一個能聯通即可: https://cloud.fanruan.com/config |
3.2 上傳FineKey安裝包
獲得工具包後,需要將它上傳到 Linux,上傳檔案的方法請自行查閱相關資料。
本文範例是將工具包上傳到了 CentOS 7.6.1810 的 /home/ops 路徑下,如下圖所示:
3.3 解壓FineKey安裝包
1)先使用 cd 命令進入工具包所在資料夾下。
2)根據下載的安裝包類型,鍵入命令進行解壓:
安裝包類型 | 解壓語句 |
---|---|
線上版安裝包 | tar -xvf finekey-operation-online.tar |
純淨版離線安裝包 | tar zxvf finekey-operation-lite.tar.gz |
全量版離線安裝包 | tar zxvf finekey-operation-all.tar.gz |
解壓後的檔案如下表所示:
資料夾/檔案 | 檔案說明 | |
---|---|---|
finekey/bin | 運作finekey的可執行檔案 | |
finekey/conf | finekey.yaml | 新部署維運平台配置檔案 |
finekey.push.yaml | 拉取鏡像配置檔案 | |
finekey/resources | 資源檔案,鏡像包放在其中images資料夾中 |
3.4 配置finekey.yaml檔案
yaml檔案指的是工具解壓目錄下conf資料夾裏的finekey.yaml,該檔案是控制後面整個自動部署流程的。
如完全採用預設部署配置(包括安裝目錄、組件埠,倉庫配置等),使用者可不對yaml檔案做任何配置,可以直接在當前宿主機本地部署。
如需更改維運平台相關配置、組件佔用埠等,可以開啟yaml檔案自行配置,yaml檔案的配置需要在啟動FineKey之前完成。
1)檔案內容說明
配置 | 配置項 | 說明 |
---|---|---|
基礎配置 | nodes | 值為部署的FineOps維運平台相關配置 包括:ip,port,user,password 如果ssh方式為金鑰,則將password配置註釋,新增keypath: 金鑰絕對路徑/金鑰檔案 注1:如果finekey與維運平台處於同一台伺服器,部署使用者與當前終端使用者一致,無需修改此部分內容 注2:如填寫金鑰路徑,請填寫絕對路徑,不支援相對路徑 |
dataRootPath | 根掛載目錄 請確定掛載目錄所在分割槽,磁碟閒置空間≥100G 預設安裝目錄為~/data,即安裝使用者主目錄下的data資料夾 例如使用root使用者部署,則~/data代表的目錄為/root/data 注:掛載目錄請填寫絕對路徑,不支援相對路徑 | |
repo | 1)全新安裝一個registry鏡像倉庫,可指定倉庫埠,預設5000 2)如已有鏡像倉庫,可輸入指定倉庫的url、username、password、ssl | |
online | 是否線上安裝: false:離線安裝 true:線上安裝 不建議修改該配置項,該配置項與下載的安裝包類型有關,詳情請參見3.1節 | |
組件配置 | - | components下,配置的是2.1節列舉的待安裝的組件 每個組件都可以自訂埠,參數為:portMapping: {存取用的埠: 鏡像中固定的埠 } 注1:安裝的組件和預設埠如2.2節,請排查埠是否可用,是否開放,並按需修改yaml檔案中的埠 注2:埠portMapping為{映射埠:容器內埠} ,其中映射埠可改,容器內埠不要修改,不要刪除。 注3:如果修改了components下的組件配置,需要將components和組件前面的#註釋符號刪掉 例如修改ops的埠8081為8088
#組件埠配置|Component port configuration #components: # nginx: # portMapping: {80: 8080} # # ops: # portMapping: {8081: 8080}
#組件埠配置|Component port configuration components: # nginx: # portMapping: {80: 8080} # ops: portMapping: {8088: 8080} |
2)檔案範例
node:
ip: localhost #節點ip|Node IP
port: 22 #節點ssh埠|Node SSH port
user: #節點ssh使用者|Node SSH username
password: #節點ssh密碼|Node SSH password
dataRootPath: ~/data
repo:
port: 5000 #待安裝的registry倉庫埠|Registry Port
#指定已有repo|Specifies an existing container registry
url: #已有repo的url|Registry URL
username: #已有repo的帳號|Registry username
password: #已有repo的密碼|Registry password
ssl: true #是否有ssl設定|Repository with SSL set or not
online: false #線上安裝|Online installation
#組件埠配置|Component port configuration
#components:
# nginx:
# portMapping: {80: 8080}
#
# ops:
# portMapping: {8081: 8080}
#
# ops_agent:
# portMapping: {9071: 9070}
#
# grafana:
# portMapping: {3000: 3000}
#
# prometheus:
# portMapping: {9090: 9090}
#
# alertmanager:
# portMapping: {9093: 9093}
#
# skywalking_oap:
# portMapping: {11800: 11800, 12800: 12800}
#
# elasticsearch:
# portMapping: {9200: 9200}
# password: elasticadmin
4. 部署操作
4.1 啟動部署
1)使用 cd 命令進入工具解壓目錄下 bin 資料夾
2)鍵入如下命令執行自動化部署:
注1:請嚴格按照文檔所述命令執行,不要自行變更為sudo ./finekey之類的命令。否則可能導致部署失敗。
部署版本 | 命令 |
---|---|
標準版維運平台 | ./finekey |
基礎版維運平台 | ./finekey --lite |
3)整個部署程式需要花費一段時間,請耐心等待
注1:如果部署程式中出現報錯,請參考 容器化部署常見問題 ,查看有無對應的解決方案。
請注意~/data目錄不代表/data目錄,而是對應使用者主目錄下的/data目錄。例如使用root使用者部署,則~/data代表的目錄為/root/data
注2:如果部署程式中,檢查到掛載目錄磁碟可用空間不足100G,會提示「The current path capacity check failed, Please re-enter the path」
使用者無需跳出部署環節,手動修改yaml檔案。可直接輸入滿足條件的目錄,繼續部署。
4.2 完成部署
當出現 deployment success!bye~ 提示時,表示已經成功部署。
在該行提示中,會展示維運平台的工程地址,可複製,用於下一步存取。如下圖所示:
注:地址中的埠,是部署時設定的Nginx組件佔用的埠。
若為root使用者部署,預設埠為80,維運平台存取地址中可以省略埠,直接用IP存取,存取地址為http://ip/ops/decision
若為非root使用者部署,預設埠為8090,存取地址為http://ip:8090/ops/decision
若finekey.yaml檔案中,手動修改了Nginx埠,存取地址為http://ip:Nginx埠/ops/decision
4.3 存取工程
部署完成後,服務會自動啟動,此時可以在瀏覽器地址欄輸入上一步獲取的工程地址,存取FineOps維運平台。
1)選擇瀏覽器
請使用以下版本的瀏覽器存取維運平台,否則可能導致介面展示異常。
瀏覽器類型 | 推薦版本 |
---|---|
Chrome | 88以上版本 |
Edge | 88以上版本 |
Safari | 14以上版本 |
Firefox | 78以上版本 |
IE | 不推薦 |
如使用不符合版本要求的瀏覽器進行存取,部分介面會出現彈窗提醒「檢查到當前瀏覽器版本過低,可能導致部分組件顯示異常,建議升級瀏覽器版本」。
2)存取工程
在瀏覽器地址欄輸入上一節獲取的工程地址,存取FineOps維運平台。
例如本文範例,瀏覽器地址欄鍵入:http://IP/ops/decision,即可存取維運平台,如下圖所示: