WeCube是一套開(kāi)源的，一站式IT架構(gòu)管理和運(yùn)維管理工具，主要用于簡(jiǎn)化分布式架構(gòu)IT管理，并可以通過(guò)插件進(jìn)行功能擴(kuò)展。

起源

微眾銀行在分布式架構(gòu)實(shí)踐的過(guò)程中，發(fā)現(xiàn)將銀行核心系統(tǒng)構(gòu)建于分布式架構(gòu)之上，會(huì)遇到一些與傳統(tǒng)單體應(yīng)用不同的痛點(diǎn)（例如，服務(wù)器增多，部署難度大；調(diào)用鏈長(zhǎng)，全鏈路跟蹤困難； 系統(tǒng)復(fù)雜，問(wèn)題定位時(shí)間長(zhǎng)等），在逐步解決這些痛點(diǎn)的過(guò)程中，總結(jié)了一套IT管理的方法論和最佳實(shí)踐，并研發(fā)了與之配套的IT管理工具體系。WeCube就是將該套方法論和最佳實(shí)踐，從微眾內(nèi)部眾多IT管理工具體系中提煉出來(lái)，整合成一套開(kāi)箱即用的IT管理解決方案。

設(shè)計(jì)理念

WeCube的設(shè)計(jì)理念與IT系統(tǒng)生命周期管理基本一致。可以通過(guò)“六個(gè)維度和一個(gè)核心”來(lái)闡述。

一個(gè)核心：通過(guò)注冊(cè)新插件持續(xù)擴(kuò)展WeCube的功能，通過(guò)如下5個(gè)能力實(shí)現(xiàn)插件注冊(cè)及協(xié)作。插件注冊(cè)詳見(jiàn)“插件注冊(cè)”。

• 菜單布局：WeCube提供前端UI基座和前端開(kāi)發(fā)規(guī)范，使各個(gè)插件的前端交互能夠無(wú)縫集成到WeCube，進(jìn)而形成一個(gè)統(tǒng)一平臺(tái)。
• 權(quán)限模型：WeCube的權(quán)限模型提供“用戶-角色-菜單”三級(jí)權(quán)限模型，并提供統(tǒng)一認(rèn)證方案。數(shù)據(jù)權(quán)限及API權(quán)限，由插件自身控制。
• 流程編排：WeCube內(nèi)置一套標(biāo)準(zhǔn)的BPMN流程引擎，可以通過(guò)客戶自定義編排驅(qū)動(dòng)插件協(xié)同工作，減少人工干預(yù)。編排設(shè)計(jì)詳見(jiàn)“編排設(shè)計(jì)”。
• 數(shù)據(jù)模型：插件需要將自身需要提供給其他插件使用的數(shù)據(jù)模型注冊(cè)到WeCube的統(tǒng)一數(shù)據(jù)模型，然后通過(guò)標(biāo)準(zhǔn)的CRUD接口提供數(shù)據(jù)訪問(wèn)服務(wù)。
• 系統(tǒng)參數(shù)：WeCube的全局參數(shù)、插件需要客戶修改、插件需要暴露給其他插件使用的參數(shù)，需要注冊(cè)到WeCube的系統(tǒng)參數(shù)內(nèi)。

六個(gè)維度：通過(guò)定義六個(gè)維度的菜單，并將插件功能有組織性的插入這六個(gè)維度菜單中，形成對(duì)IT系統(tǒng)全生命周期的有效管理。

• 任務(wù)：匯聚多種類型任務(wù)，形成一體化的工作平臺(tái)。工作內(nèi)容清晰可見(jiàn)，輕重緩急一目了然。
• 設(shè)計(jì)：定義模型和規(guī)范，形成標(biāo)準(zhǔn)化設(shè)計(jì)語(yǔ)言。通過(guò)規(guī)范化設(shè)計(jì)及圖形化展示，清晰、準(zhǔn)確地描繪出對(duì)分布式架構(gòu)的期望。
• 執(zhí)行：通過(guò)各類自動(dòng)化、標(biāo)準(zhǔn)化任務(wù)的執(zhí)行，將分布式架構(gòu)的期望設(shè)計(jì)變成現(xiàn)實(shí)存在，消除人員能力參差不齊導(dǎo)致的實(shí)現(xiàn)差異。
• 監(jiān)測(cè)：定義全方位的監(jiān)測(cè)項(xiàng)指標(biāo)，通過(guò)持續(xù)收集監(jiān)測(cè)數(shù)據(jù)，精確反映現(xiàn)狀，并發(fā)現(xiàn)現(xiàn)實(shí)與期望的差異項(xiàng)。
• 智慧：應(yīng)用機(jī)器學(xué)習(xí)等技術(shù)，賦予智慧能力。通過(guò)數(shù)學(xué)建模，制定應(yīng)對(duì)監(jiān)測(cè)發(fā)現(xiàn)的差異項(xiàng)的處理策略。
• 調(diào)整：通過(guò)執(zhí)行處理策略來(lái)不斷進(jìn)行動(dòng)態(tài)調(diào)整，最終保持現(xiàn)實(shí)與期望的對(duì)等，進(jìn)而使系統(tǒng)穩(wěn)定運(yùn)行。

技術(shù)實(shí)現(xiàn)

WeCube分為核心功能模塊和插件模塊。

核心功能模塊使用Java/MySQL/VUE開(kāi)發(fā)，主要負(fù)責(zé)工作流程，可視化和核心數(shù)據(jù)存儲(chǔ)。

插件模塊用于功能擴(kuò)展，分為資源管理、數(shù)據(jù)整合、功能增強(qiáng)三類插件。對(duì)于插件，WeCube定義了一套接口規(guī)范，插件開(kāi)發(fā)者可以在遵循規(guī)范的前提下，自行選擇開(kāi)發(fā)語(yǔ)言。目前已有的插件使用的開(kāi)發(fā)語(yǔ)言包括GO語(yǔ)言和Java。

系統(tǒng)架構(gòu)

WeCube 2.0版本

組件間詳細(xì)關(guān)聯(lián)圖：

1, Portal web：瀏覽器客戶，客戶與WeCube交互的入口。
2, Portal nginx：接收客戶端訪問(wèn)請(qǐng)求，如果請(qǐng)求靜態(tài)資源，返回Core或插件的靜態(tài)資源文件。如請(qǐng)求動(dòng)態(tài)服務(wù)，轉(zhuǎn)發(fā)到后端API gateway。Portal nginx建議采用負(fù)載均衡實(shí)現(xiàn)高可用，也可以使用keepalived做主從高可用。
3, API gateway：負(fù)責(zé)Portal nginx或其他外部系統(tǒng)的動(dòng)態(tài)服務(wù)請(qǐng)求的路由分發(fā)。

• A） 登錄認(rèn)證請(qǐng)求，轉(zhuǎn)發(fā)到Auth server，使用用戶名密碼換取Token。Token采用非對(duì)稱加密，包含用戶名、角色、菜單權(quán)限信息。
• B） Core服務(wù)請(qǐng)求，轉(zhuǎn)發(fā)到Core。比如角色添加、插件注冊(cè)、編排設(shè)計(jì)等等。
• C） Plugin服務(wù)請(qǐng)求，轉(zhuǎn)發(fā)到對(duì)于的Plugin。比如CMDB配置管理、監(jiān)控?cái)?shù)據(jù)查詢、任務(wù)管理等。

建議負(fù)載均衡實(shí)現(xiàn)高可用，也可以使用keepalived做主從高可用。
APIGateway啟動(dòng)時(shí)通過(guò)Core獲取插件實(shí)例列表，并建立路由規(guī)則。
同時(shí)APIGateway會(huì)監(jiān)測(cè)Core、Auth Server、Plugins的狀態(tài)，實(shí)現(xiàn)Core、Auth server、Plugins實(shí)例的主從類型的高可用。

4, Auth server：主要負(fù)責(zé)用戶認(rèn)證服務(wù)，并返回含用
由API gateway實(shí)現(xiàn)主從類型的高可用。 5, Core：WeCube的核心模塊。提供插件注冊(cè)、編排設(shè)計(jì)、權(quán)限管理、批量任務(wù)、插件運(yùn)行資源管理、數(shù)據(jù)模型、系統(tǒng)參數(shù)等核心功能。 由API gateway實(shí)現(xiàn)主從類型的高可用。
6, MYSQL：WeCube Core和Auth server的數(shù)據(jù)庫(kù)實(shí)例。建議MYSQL主從實(shí)現(xiàn)高可用。
7, S3:插件包鏡像文件的存儲(chǔ)。插件注冊(cè)是寫(xiě)入鏡像文件，插件實(shí)例啟動(dòng)時(shí)讀取鏡像文件。
8, Plugin instance-Docker：插件運(yùn)行的容器母機(jī)，可以配置多臺(tái)母機(jī)，運(yùn)行多個(gè)插件實(shí)例，提供高可用。
9, Plugin instance-MYSQL：插件運(yùn)行所需要的數(shù)據(jù)庫(kù)實(shí)例，為每個(gè)需要數(shù)據(jù)庫(kù)的插件建立獨(dú)立數(shù)據(jù)庫(kù)。建議MYSQL主從實(shí)現(xiàn)高可用。
10, Plugin instance-S3：插件運(yùn)行所需要的對(duì)象存儲(chǔ)，為每個(gè)需要存儲(chǔ)文件的插件分配單獨(dú)的桶。
11, Plugin instance- Squid：插件訪問(wèn)外部資源的代理服務(wù)器，按域名放通白名單。在安全要求較高的時(shí)建議部署。
以上11個(gè)組件組成WeCube Platform。

主要功能簡(jiǎn)介

WeCube的功能菜單設(shè)計(jì)與設(shè)計(jì)理念保持一致。分別是任務(wù)、設(shè)計(jì)、執(zhí)行、監(jiān)測(cè)、智慧、調(diào)整、協(xié)同、系統(tǒng)。

• 系統(tǒng)

  • 系統(tǒng)參數(shù)：管理WeCube Platform運(yùn)行所需的系統(tǒng)參數(shù)。
  • 資源管理：管理WeCube提供的資源如容器母機(jī)及資源上運(yùn)行的實(shí)例。
  • 權(quán)限管理：管理WeCube Platform的用戶，角色和菜單，可以對(duì)權(quán)限進(jìn)行菜單級(jí)別的管控。

• 協(xié)同

  • 插件注冊(cè)：選擇插件包上傳，插件包需聲明本插件的依賴、所需菜單、數(shù)據(jù)模型、系統(tǒng)參數(shù)、權(quán)限設(shè)定及運(yùn)行資源，注冊(cè)后通過(guò)容器運(yùn)行，支持多實(shí)例，可以查看插件運(yùn)行的日志。選擇插件服務(wù)，通過(guò)插件運(yùn)行的參數(shù)關(guān)聯(lián)CMDB數(shù)據(jù)模型的屬性值，形成注冊(cè)。

  • 任務(wù)編排：比如設(shè)計(jì)一個(gè)VPC創(chuàng)建的編排。包括創(chuàng)建VPC、創(chuàng)建子網(wǎng)、創(chuàng)建VM。流程的每個(gè)執(zhí)行節(jié)點(diǎn)需要關(guān)聯(lián)插件。

• 設(shè)計(jì)（WeCMDB插件提供）

  • 規(guī)劃設(shè)計(jì)：用于設(shè)計(jì)機(jī)房結(jié)構(gòu)。

  • 資源規(guī)劃：用于實(shí)例化一個(gè)機(jī)房，特別是兩地三中心結(jié)構(gòu)。

  • 應(yīng)用架構(gòu)設(shè)計(jì)：用于設(shè)計(jì)一個(gè)應(yīng)用的邏輯架構(gòu)。

  • 應(yīng)用部署設(shè)計(jì)：用于實(shí)際部署一個(gè)應(yīng)用。支持灰度發(fā)布。

  • CI數(shù)據(jù)管理/查詢：通過(guò)模型圖形進(jìn)入單個(gè)數(shù)據(jù)管理以及查詢。

  • CI綜合查詢管理/數(shù)據(jù)綜合查詢：用于配制多CI屬性報(bào)表。比如一個(gè)應(yīng)用使用到了哪些主機(jī)。

  • 枚舉數(shù)據(jù)管理/查詢：通過(guò)對(duì)公共枚舉和私有枚舉進(jìn)行管理以及查詢。

• 執(zhí)行

  • 編排任務(wù)執(zhí)行：在選擇編排后可對(duì)選擇目標(biāo)對(duì)象執(zhí)行編排，支持灰度操作。比如重啟某個(gè)資源集的5臺(tái)主機(jī)。

  • 物料管理（Artifacts插件提供）：管理應(yīng)用程序的包。可以定義各種文件，可以配置環(huán)境差異導(dǎo)致的變量替換規(guī)則，不需要人工處理。

  • 批量執(zhí)行：通過(guò)配置綜合查詢并選擇目標(biāo)。在通過(guò)特定插件來(lái)執(zhí)行任務(wù)。比如某個(gè)應(yīng)用的所有主機(jī)，執(zhí)行一個(gè)用戶權(quán)限變更。

• 任務(wù)（Service-Management插件提供）

  • 模板管理：服務(wù)目錄管理， 服務(wù)請(qǐng)求模板管理；

  • 服務(wù)管理：服務(wù)請(qǐng)求管理，任務(wù)管理；

• 監(jiān)測(cè)（Open-Monitor插件提供）

  • Agent管理: 注冊(cè)、啟動(dòng)、停止；

  • 數(shù)據(jù)管理: 提供數(shù)據(jù)采集配置， 數(shù)據(jù)查詢等功能；

  • 告警管理: 提供閾值配置、日志監(jiān)控、告警觸發(fā)等功能；

  • 視圖管理: 提供圖形配置和自定義視圖功能；

• 調(diào)整（規(guī)劃中）

• 智慧（規(guī)劃中）

核心流程時(shí)序說(shuō)明：

插件注冊(cè)時(shí)序圖:

編排任務(wù)執(zhí)行:

快速入門

WeCube采用容器化部署。

如何編譯WeCube，請(qǐng)查看以下文檔?WeCube編譯文檔

如何安裝WeCube， 請(qǐng)查看以下文檔?WeCube部署文檔

用戶手冊(cè)

更多關(guān)于WeCube的使用和操作說(shuō)明， 請(qǐng)查看以下文檔?WeCube用戶手冊(cè)

開(kāi)發(fā)者文檔

WeCube使用Java和VUE進(jìn)行開(kāi)發(fā)，數(shù)據(jù)存儲(chǔ)于MySQL，并依賴Tomcat Web容器運(yùn)行。

請(qǐng)參考以下文檔進(jìn)行開(kāi)發(fā)環(huán)境配置WeCube開(kāi)發(fā)環(huán)境配置

License

WeCube是基于 Apache License 2.0 協(xié)議， 詳情請(qǐng)參考?LICENSE