openstack-horizon

一、 Django

1.1 Django介绍

Django是一个基于Python的高效的Web开发框架,它提供了通用的Web开发模式的高度抽象;目的是为了可以简便的、快速的开发数据库驱动的网站,强调代码的复用,多个组件可以很方便的以“插件”的形式存在于整个框架中。

1.2 组成部分 
1. 对象关系映射:以python类的形式定义数据模型,将模型和关系数据库连接起来,将得到一个易使用的数据库API; 
2. URL分派:使用正则式匹配URL,可以任意设计URL; 
3. 模版系统:使用django强大的可扩展的模版语言,可以设计分隔设计内容和Python代码,应具有可继承性; 
4.表单处理:可以方便的生成表单类型,实现表单的饿有效性检验; 
5. Cachece系统:可以挂在内存缓存或其他的框架实现超级缓冲 
6. 会话:用户登录与权限检查 
7. 国际化:开发多种语言的网站; 
8.自动的管理界面:自带ADMIN site; 
1.3 文件组成 
Django是基于MVC设计实现的,主要包含四类文件: 
1. Models:主要用Python类;来描述数据表。可以使用简单的Python代码来创建、检索、更新、删除数据库中的记录; 
2. Views:包含页面的业务逻辑; 
3. Urls:指出了什么样的URL调用什么样的视图; 
4. Templates:HTML模板,描述了这个页面是怎么样设计的,在模板里面可以使用带基本逻辑声明的模板语言,如{%for user in user list%};

一、 Horizon

2..1 horizon简述 
Horizon是openstack整个应用的一个入口,提供一个web UI 的方式来访问、控制他们的计算、存储、和网络资源:如创建和启动实例、分配IP地址等。 
Horizon为两种用户提供了两种不同的功能界面: 
1. 云管理员:提供了一个整体的视图可以总览整个云的资源大小及运行状况,可以创建终端用户和项目,向终端用户分配项目并进行项目的资源配额管理; 
2. 终端用户:提供了一个自主服务的门户,可以在管理员分配的项目中,在不超过额定配额的限制内,自由操作、使用和 存储网络资源;

Demo用户的界面 
这里写图片描述

Admin用户的界面 
这里写图片描述 
2.2 架构 
Horizon主要由三个dashboard组成:用户dashboard、系统dashboard和设置dashboard。

用户dashboard界面 
这里写图片描述 
系统dashboard 
这里写图片描述

设置dashboard 
这里写图片描述


Horizon Is Easy, Horizon Is Complex

如果要用一句话来概括Openstack Dashboard项目Horizon:它是一个基于django webframework开发的标准的python wsgi程序。如果要再加一句废话,它一般会运行在webserver(apache/nginx)上。

Why Is It Easy?

说Horizon简单,是指它的部署架构简单,就是个单纯的基于django的网站,后台甚至没有使用数据库。不像Swift,Nova这些项目,有非常多的组件(xxx-server,xxx-api…),理清楚各个组件之间的关系,数据流的走向都要费一番功夫。Horizon用到的技术也比较传统,没有异步非阻塞,消息队列,websocket这些比较时髦的东西(目前没有),前端也只是bootstrap+jquery+less,没有什么很前卫的东西。

用户从登陆到看到虚拟机列表的这个过程的数据流走向:

Why Is It Complex? 
Horizon的复杂性分成两方面看:

Horizon需要和几乎所有的OpenStack service api打交道, 而且各个服务可能就还有多个api版本,api多版本的兼容不是都能在client里完成的(比如Keystone),Horizon还需要针对各个api的多版本做兼容。 
Horizon代码本身很复杂,抽象,利用了django相当多的高级特性,可以说把oop的概念运用到了极致,但这也为过度自定制Horizon带来了麻烦。

Design Philosophy 
Horizon是基于django开发的,要说Horizon的设计,不得不说django,

Django focuses on automating as much as possible and adheres to the DRY(Don’t Repat Yourself) principle. 
django的设计专注于代码的高度可重用,信奉DRY原则,一切面向对象,而Horizon可以说高度match了django的设计风格,good or bad就见仁见智了。

先说一点web开发的常识,网站程序基本有三部分组成,业务逻辑代码(Python),静态文件(js/css),模板(Python中的jinja,mako,nodejs中有jade), 用户向webserver发起请求之后,server程序找到当前url对应的模板,填充模板变量(输出成字符串形式的html源码),返回给浏览器,浏览器渲染页面。

如果是简单的程序,一个页面就对应一个模板,非常简单。一般一个网站有自己的统一风格,所有页面都会有一些相同的元素,每个页面单独写一遍很累赘,也不好维护,所以一般模板语言都有继承(extend),插入(include)等特性,来提高页面的复用率。

Horizon做得就更彻底一些,它将页面上所有元素模块化,网页中一些常见元素,表单,表格,标签页,全部封装成Python类,每个组件有自己对应的一小块html模板.当渲染整个页面的时候,Horizon先找到当前页面有多少组件,将各个组件分别进行渲染变成一段html片段,最后拼装成一个完整的html页面,返回浏览器。

简单总结Horizon的特点:

页面元素模块化 
子面板可插拔 
All in One(从部署上来说,Horizon只有它自己这一个组件)

Dive into Horizon

Some Concepts

Horizon这套面板的设计分成三层:Dashboard → PanelGroup → Panel

Horizon中现有的dashboard有4个:

project 普通用户登陆后看到的项目面板 
admin 管理登陆后可见,左侧的管理员面板 
settings 右上角的设置面板,里面可设置语言,时区,更改密码 
router(配置文件中将profile_support打开可见),ciso nexus 1000v的管理面板 
每一个dashboard都是django中的一个app,django中的app可以理解成对业务逻辑模块化的一种手段,里面可以包含自己独有的url设定,模板,和业务逻辑代码.

每个dashboard下定义了一系列的PanelGroup,虚拟机管理对应到界面上就是一个PanelGroup(Manage Compute), 里面有一系列的子panel(Overview, Instances, Volumes…)。Swift,heat,neutron的管理面板各自都是一个PanelGroup,底下有各自的子panel.

Some Code 
Horizon的源码中,包含两个代码文件夹

horizon 
openstack_dashboard 
Horizon这个包是一些在django基础上写的通用组件,表格(table),标签页(tab),表单(form),面包屑导航(browser),工作流(workflow),这些代码和openstack的具体业务逻辑没有什么关系,如果做一个新的django项目,理论上可以复用Horizon这个包中的代码。horizon/base.py中还实现了一套dashboard/panel机制,使得Horizon面板上所有的dashboard都是”可插拔”的,所有的panel都是”动态加载”的。

openstack_dashboard/dashboards/中是各个面板的具体实现代码,其中包括各个面板的模板文件, 和后端service交互的业务逻辑代码等。

FAQ

Horizon怎么实现dashboard的可插拔?

之前说过,Horizon中的dashboard就是django的app,在openstack_dashboard/settings.py中的INSTALLED_APP变量定义了目前已有的四个dashboard:

openstack_dashboard.dashboards.project 
openstack_dashboard.dashboards.admin 
openstack_dashboard.dashboards.settings 
openstack_dashboard.dashboards.router 
如果自己按照Horizon自定制dashboard的流程写了新的dashboard也需要加到这个配置文件中,新面板就能正常显示。

每个dasboard是怎么找到自己拥有的panel的?

每个dashboard模块下都有一个dasbboard.py文件里面定义了属于当前dashboard的PanelGroup,和各个PanelGroup下的Panel,在Horizon模块被导入的时候会去依次遍历Dasboard→PanelGroup→Panel,所有的dashboard注册到Horizon命名空间下,各个panel注册到自己的dashboard命名空间下。

每个panel是怎么找到自己的模板的?

这需要理解django中的template loader概念,简单的说,template loader就是一个处理request的视图寻找自己的模板文件路径的方法,django自带了好几种template加载机制,Horizon用到了filesystem,app_directories这两种,另外自己自定义了一种(horizon.loaders.TemplateLoader),loader的定义在openstack_dashboard.settings中的TEMPLATED_LOADERS变量。

TEMPLATED_LOADERS = ( 
‘django.template.loaders.filesystem.Loader’, 
‘django.template.loaders.app_directories.Loader’, 
‘horizon.loaders.TemplateLoader’, 

举例:

当点击左侧project(这是个dashboard)下的instance(这是个panel)标签时,页面会跳转到http://localhost/project/instances这个url,panel在的视图类中写了template_name=“project/instances/index.html”,查找这个文件的顺序是:

先找openstack_dashboard/templates 
没找到再找openstack_dashboard/dashboards/project/templates/,这个目录不存在,还是没找到。 
最后找openstack_dashboard/dashboards/project/instances/templates, 找了index.html这个文件。

怎么显示swift的面板?怎么显示heat的面板?

这里很好的体现了Horizon的动态特性,显不显示某panel,实际上并不由Horizon控制,而是由Keystone控制。一个后端的webservice需要集成进openstack的话,第一步是在Keyston处登记,在Keyston的service,endpoint这两张表内写入该service的的一些元数据信息(包括url地址)。

Horizon控制面板是否显示用了一套叫permission的机制,比如Container(swift的panel)要显示的条件是”openstack.services.object-store”。用户的登陆后的token中又service catalog信息,catalog中必须包含object-store这个service,满足,container这个panel就会注册到project这个dashboard之下,页面上就能显示,如果Keyston中没有swift的catalog信息,Horizon就不会注册container这个panel,swift的面板就不会显示。heat同理。

要了解permission的具体实现请看openstack_auth/backend.py 模块

普通用户看不到admin面板,这个是怎么实现的?

还是用到了上个问题提到的permission,Admin dashboard这个类中写的permission是”openstack.roles.admin”,则admin这个面板显示的条件是当前登录的用户有admin这个role,满足的用户就能看到admin dashbaord.

Horizon处理登录部分的代码在哪?

参看openstack_auth部分

Customize Horizon

自定义css 
要对Horizon的css样式做自定制,可以修改openstack_dashboard/static/less 目录下的less文件。

自定义js 
要对Horizon中js的行为做定制,可以修改horizon/static/horizon/js/ 目录下的文件,Horizon的js文件都是针对具体某个页面组件做的行为定制,比如form提交时的行为,tab切换的行为,所以都放在Horizon目录下而不在openstack_dashboard目录下。

添加新的dashboard和panel 
Horizon自带了两条命令,方便快速得生成基础代码:

python manage.py startdash test_dash 自动生成一个叫test_dash的dashboard,之后将test_dash写入settings中的INSTALLED_APP中,Horizon就能加载此新面板 
python manage.py startpanel test_panel -d openstack_dashboard.dashboards.admin –target auto 会在Horizon的admin dashboard下生成一个叫test_panel的子面板

Event Driven Horizon

Horizon目前的实现是比较传统的全刷新网站,openstack中有不少操作是异步的api,比如创建虚拟机,snapshot,volume等等。这些api被调用后资源会进入一个状态迁移的过程,Horizon在前端页面上实现状态的实时刷新,用的是ajax轮训的方式,这种方式效率比较低,也有延迟,目前也有bp要为Horizon引进real time的特性,相关bp:

support for realtime communicationi 
Spec for “push”-based realtime communication 
Use common RPC listener to consume messages 
有一个实现草案:https://review.openstack.org/#/c/40198/1

原理是通过sock.io(python版基于tornado的ioloop实现)再写一个websocket的server.同时Horizon后台添加消息队列支持,监听openstack集群中的消息,监听到了自己需要的消息之后,通知websocket server,server再通知浏览器中的js.

不过这样做有一些问题,server上需要躲开一个端口专门处理websocket请求,还需要一个daemon监听消息队列的消息,这会增加Horizon的部署复杂度。社区决定将real time的实现放到I版做,这个实现草案中将整个Horizon本身也跑在了tornado server上,这里的性能问题有待商榷(主要是对eventlet的monkey_patch的原理有疑惑)。

参见:http://www.cnblogs.com/yuxc/p/3419102.html 
转载以便学习



Horizon是OpenStack的一个子项目,用于提供一个Web前端控制台(称为Dashboard),以此来展示OpenStack的功能。通常情况下,我们都是从Horizon、Dashboard开始来了解OpenStack的。实际上,Horizon并不会为OpenStack添加任何一个新的功能,它只是使用了OpenStack部分API功能,因此,我们可以扩展Horizon的功能,扩展Dashboard。

关于dashboard的界面,自己搭起环境后可以有一个直观的感受。

Horizon源码目录结构

这里写图片描述

以在admin这个Dashboard里扩展添加一个monitoring的panel为例,介绍扩展OpenStack Dashboard的流程。

1.定义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里。

2.定义URL

Horizon是基于Django框架,程序是通过url来找到panel的,因此,需要在monitoring目录下建立urls.py文件,定义url: 
这里写图片描述

3.定义Table

table用于展示数据,Horizon提供了DataTable基类,我们可以通过继承DataTable来实现自定义的table: 
这里写图片描述 
在MonitoringTable里定义了两列resources和percent。

4.定义View

view是用来集成table或者tab的,Horizon提供了多种vie类,下面使用DataTableView来自定义我们自己的IndexView:在IndexView里定义好table_class和template_name的属性值,同时需要定义好get_data()方法,此方法用于获取数据展示在table里。 
这里写图片描述 
至此,扩展Dashboard已完成,需要重启apache才能看到效果:sudo service apache2 restart。效果如下: 
这里写图片描述 
这篇文章网上很多,将其转过来方便学习。


horizon的源代码框架

1.整体目录 
这里写图片描述 
2.horizon目录 
这里写图片描述 
3.openstack-dashboard目录 
这里写图片描述

在了解了horizon代码的结构后对于整体学习代码的实现有很大帮助, 
接下来要对具体的代码有个具体的认知。

未完…….


出处:https://blog.csdn.net/forlogen/article/details/51206713

阅读更多
个人分类: openstack 云架构
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭
关闭