OpenStack Dashboard二次開發--簡明教程

問題導讀
1、如何理解Horizon的重要性?
2、對Dashboard進行二次開發,需要什麼?
3、爲什麼需要在IndexView裏定義好table_class和template_name的屬性值和get_data()方法?





Horizon簡介
Horizon是OpenStack的一個子項目,用於提供一個Web前端控制檯(稱爲Dashboard),以此來展示OpenStack的功 能。通常情況下,我們都是從Horizon、Dashboard開始來了解OpenStack的。實際上,Horizon並不會爲OpenStack添加 任何一個新的功能,它只是使用了OpenStack部分API功能,因此,我們可以擴展Horizon的功能,擴展Dashboard。

擴展Dashboard
Dashboard概覽
 

圖2-1-1 Dashboard界面

一個Dashboard(在django裏稱爲app)通常情況下由四個組件組成,分別爲panel、tab(可選)、table和view,如圖 2-1-1所示。其中,panel、tab和table用於導航的,真正展示數據的在view裏面。它們之間的關係是panel包含tab,tab包含 table,view包含table或者tab。

通過查看Horizon的源碼,可從其目錄結構看出它們之間的關係,如圖2-1-2所示。
 

圖2-1-2 Horizon源碼目錄結構

下面,我會以在admin這個Dashboard裏擴展添加一個monitoring的panel爲例,介紹擴展OpenStack Dashboard的流程。

定義panel
首先介紹Dashboard.py這個文件,它位於每個Dashboard的根目錄,其作用是註冊Dashboard(django裏稱爲app)以及設置Dashboard的屬性,比如Dashboard裏有哪些panel。

打開admin目錄下的Dashboard.py文件,設置SystemPanels有monitoring的panel:
 

我們可以在Dashboard.py文件裏隨意的添加、刪除panel屬性,這對於調試程序的時候很方便。

然後在amdin目錄下創建一個monitoring的文件夾,並在monitoring文件夾裏創建panel.py文件,定義panel:

 

這是最簡單的panel,只定義了其名字。注意:slug屬性的值要與monitoring文件夾名字一樣。當定義完成後,要記得將其註冊到Dashboard裏。

定義url
Horizon是基於Django框架,程序是通過url來找到panel的,因此,需要在monitoring目錄下建立urls.py文件,定義url:
 


定義table
table用於展示數據,Horizon提供了DataTable基類,我們可以通過繼承DataTable來實現自定義的table:
 

在MonitoringTable裏定義了兩列resources和percent。

定義view
view是用來集成table或者tab的,Horizon提供了多種vie類,下面使用DataTableView來自定義我們自己的IndexView:

 

在IndexView裏定義好table_class和template_name的屬性值,同時需要定義好get_data()方法,此方法用於獲取數據展示在table裏。

至此,擴展Dashboard已完成,需要重啓apache才能看到效果:sudo service apache2 restart。效果如下: