深入探秘Neutron API

一、Neutron API概述

Neutron项目作为一个虚拟网络资源池,提供了如下三种使用方式:

  • 通过Web界面,也就是通过Dashboard来使用网络上的功能。
  •  通过命令行,也就是通过neutron等命令,或者通过最新的openstack命令(社区目前的发展目标是使用一个单一的openstack命令替代过去的每个项目一个命令的方式,以后会只存在一个openstack命令)去使用。
  •  通过API,也就是通过Neutron项目提供的API来使用其服务的功能。上面提到的三种方式中,通过API这种方式是使用其他两种方式的基础。

这里,我们将重点阐述Neutron API服务。值得注意的是,Neutron中并没有像其他项目一样单独提供一个api服务,二是将api做成了Core API和Exten API等资源方式进行提供。即被封装进了neutron-server,并未被分离。

Neutron API,主要用于提供RestAPI访问,实现的核心是WSGI。Neutron将基于各种虚拟网络资源得到的API资源分为核心资源(Core API)和扩展资源(Exten API)两种。Core API只对应于ML2层的network/subnet/port三种抽象。其余的各层抽象都属于Extension API的范围,通过进行扩展,提供更多的网络服务。目前已有的扩展有L3( router)、L4(tcp/udp firewall)及L7(load balancer)。随着neutron项目的不断成熟,扩展API会演化为标准API。

在Neutron中, neutron-server(相当于REST API Server)负责将收到的REST API请求交由Plugin来进行相关处理。可以看出,这其实就是一个web服务器要完成的事情,将http请求转化为对资源的操作(通过plugin的方法调用),并返回响应。

二、如何探秘Neutron API

Neutron API实现的主要代码位于/neutron/api目录下:

这里,以neutron.api.v2包为例,其中的base.py中定义了Controller类,是实现URL到plugin的api进行mapping的核心。
其主要方法包括create、 delete、 index、 show、 update。顾名思义,create用于创建资源, delete用于删除资源, show是获取资源、 update是更新资源, index是返回请求资源的列表。代码如下:

v2目录下包括了ML2层核心资源的实现代码。每个Neutron API资源都会被封装成一个WSGI Application。Neutron API服务进程neutron-server接收到用户的HTTP请求后会通过Router模块将其路由到相关资源的Controller(即wsgi app)中去执行相应的操作。
对于ML2核心资源而言,都使用了base.py文件中的类Controller去实现。只是在封装成WSGI Application的时候去调用这个文件中的createresource()函数根据不同的参数动态创建对应的Controller对象。

而对于其他的诸如L3-L7层的扩展资源,Neutron仍然使用的是传统的方式去实现。它们在neutron/extensions/目录下都分别有对应的实现文件与对应的Controller类,而位于neutron/api/目录下的extension.py文件只是一些实现基类和共用的代码。

什么是Paste Deployment

Paste Deployment用于发现和配置WSGI Application和Server,有了Paste Deployment,WSGI applications只需向其用户提供一个单独的入口loadapp函数,然后用户调用这个函数就可以使用已经开发好的WSGI application,同时,由于只提供了一个入口,WSGI的开发者也不再需要将App的具体实现暴露给用户,大大简化了整个开发过程。

这里涉及到了两个概念: server和application,server可能大家比较熟悉,即常用的apache,nignx等等,applications广义理解就是一个符合wsgi规范的一个可调用的object,规范指的是:一个接受两个参数的函数(environ,start_response)。

neutron-server作为Neutron中的唯一一个服务进程,承担着接受用户REST API请求并分发处理的任务。

根据neutron/setup.cfg中的显示,neutron-server的入口位于neutron.cmd.eventlet.server:mainwsgieventlet,Paste Deploy会在这个WSGI Server创建时参与进来,基于Paste配置文件/etc/neutron/api-paste.ini文件去加载WSGI Application。

Neutron的paste deployment配置文件分析

定义了WSGI应用和路由信息。利用Paste来实例化Neutron的APIRouter类,将资源(端口、网络、子网)映射到URL上,以及各个资源的控制器。在neutron-server启动的时候,一般会指定参数--config-file neutron.conf --config-file xxx.ini。

Neutron的paste deployment配置文件为api-paste.ini。前面提到,paste deployment就是完成从配置文件中加载WSGI App的功能,以Neutron-server(api)为例,分析下都定义了哪些WSGI App以及每个App的含义。

#api服务的实现是service.NeutronApiService,这是一个符合WSGI规范的app
#通过paste进行配置,paste文件位置可以在配置文件中指定,默认是/etc/neutron/api-paste.ini,在代码中是etc/api-paste.ini。
#可以知道api-paste.ini的v2版api的实现是在neutron.api.v2.router:APIRouter类中。
#Neutron-Server就已经基本上启动了,无外乎就是加载配置,router各种resource,然后就等待请求了。
#其中router哪些resource完全是由配置文件来决定的。
#由于,在启动的过程中会初始化db,这也就是为何在安装neutron的时候无需像nova、glance等要执行db sync的原因了。

neutron.api.v2.router模块中的APIRouter类会完成所有Core API和Extension API的加载与路由规则的创建。从收到用户的HTTP请求到Controller中的操作具体执行时,会根据请求的资源和Action,拼接出应该调用的接口交由Plugin处理,比如所请求操作的资源是network,Action是“Create”,则应该调用的Plugin接口是“createnetwork”。代码如下所示:

三.如何给Neutron API增加资源

相信,大家看了上面的长篇叙述之后,多半已经不厌其烦。好了,这里,我们将Demo一个列子,即如何为Neutron API增加WSGI APP资源。
我的环境:由DevStack在CentOS上安装的OpenStack

1)在Neutron API的Paste deploy配置文件中,增加所需的资源配置。编辑api-paste.ini文件。

# vim /etc/neutron/api-paste.ini
在[composite:neutron]部分,增加如下一行:
/pastetest: pastetest

再在该文件最后,增加如下两行:

2)切换到Python的源码包目录下。

再新建一个test.py文件,并输入如下内容:
# cattest.py

这里的内容主要是,无论是什么REST API请求,始终将“Hello Neutron API!”这段内容作为回复。

3)最后,我们需要重启Neutron服务

4)验证。使用我们刚才添加的WSGI APP资源

输出如下所示:

当然,为了直观,我们干脆直接在浏览器中查看吧。如下图所示。

小结

通过此篇介绍,相信,能够为我们了解、学习Neutron API的运行机制以及如何为Neutron API增加WSGI APP资源提供思路和方法。

当然,限于多方面原因,这里并未讲解WSGI、webob、router等知识,大家可以参阅其他资料学习。如何扩展Neutron ML2资源,期待我们能在下一篇见面。


  • 本站原创文章仅代表作者观点,不代表SDNLAB立场。所有原创内容版权均属SDNLAB,欢迎大家转发分享。但未经授权,严禁任何媒体(平面媒体、网络媒体、自媒体等)以及微信公众号复制、转载、摘编或以其他方式进行使用,转载须注明来自 SDNLAB并附上本文链接。 本站中所有编译类文章仅用于学习和交流目的,编译工作遵照 CC 协议,如果有侵犯到您权益的地方,请及时联系我们。
  • 本文链接https://www.sdnlab.com/15223.html
分享到:
相关文章
条评论

登录后才可以评论

SDNLAB君 发表于15-12-08
2