怎样写 OpenStack Neutron 的 Plugin （一）

鉴于不知道Neutron的人也不会看这篇文章，而知道的人也不用我再啰嗦Neutron是什么东西，我决定跳过Neutron简介，直接爆料。

首先要介绍一下我的开发环境。我没有使用DevStack，而是直接在电脑上安装了三个Virtual Box，然后根据OpenStack的Ubuntu 安装指南部署了一个环境：一个控制节点，一个网络节点和一个计算节点。接下来我会直接在控制节点上修改 <your path>/neutron/ 下面的文件，然后通过重启neutron 的各个service来更新我的修改。如果使用DevStack的话估计和我的情况也差不太多。

那我的neutron在安装完之后的完整路径是 /usr/lib/python2.7/dist-packages/neutron。neutron下的文件结构如下：

- neutron/
　　- agent/
　　- api/
　　- cmd/
　　- common/
　　- db/
　　- debug/
　　- extensions/
　　- locale/
　　- notifiers/
　　- openstack/
　　- plugins/
　　- scheduler/
　　- server/
　　- services/
　　- manager.py
　　- neutron_plugin_base_v2.py
　　- service.py
　　- wsgi.py
　　- ...

其中，自己写的plugin就会放在plugins/ 下面，而neutron_plugin_base_v2.py中定义了一个plugin应该实现的最小的API集合。其他还有一些在extensions/ 和db/ 下面的文件也比较重要，会在接下来的一些文章中提到。最后省略了一些目前我没有特别用到的文件。

如果有人对Neutron如何加载plugin感兴趣，可以再manager.py中加一些断点用pdb进行debug。它里面有一个class叫NeutronManager， 在初始化过程中有一个语句加载了plugin：plugin_provider = cfg.CONF.core_plugin。具体debug方法可以参考Yong Sheng Gong的一个ppt，链接在这里：http://www.slideshare.net/gongys2004/inside-neutron-2

好，现在我们就要开始实现自己的plugin了。

第一步就是在plugins下面创建自己的文件夹和一些文件：

- neutron
　　- plugins
　　　　- myplugin
　　　　　　- __init__.py
　　　　　　- plugin.py

上述两个文件是最基本的，当然plugin.py也可以用不同的名字。但是__init__.py的名字是不能改的，这个用来告诉Python myplugin可以看做是一个module。plugin.py里面可以先定义一个基本空的class 叫做MyPlugin，虽然现在这个plugin什么用都没有。

from neutron.db import db_base_plugin_v2
from neutron.openstack.common import log

LOG = log.getLogger(__name__)

class MyPlugin(db_base_plugin_v2.NeutronDbPluginV2):

    def __init__(self):
        LOG.info("MyPlugin is started.")

代码中出现的 neutron.db 和 neutron.openstack.common 我会在之后的章节中提到。现在暂时不用去管它们。 

第二步，搞定plugin.py之后就要想办法在Neutron里注册一下这个plugin，这样Neutron启动的时候就会认识这个plugin并且知道怎么加载它。这时候需要找到一个entry_points.txt文件。它不在之前我们提到的那个neutron大文件夹下面，而是在与之平行的一个neutron egg info 文件夹下。具体在我的环境中：

- neutron
- neutron-2014.1.egg-info
　　- entry_points.txt

在这个文件中，有一个选项是[neutron.core_plugins]，所有的注册的core_plugins都在里面。在它下面我们可以自己加一行：

　　myplugin = neutron.plugins.myplugin.plugin:MyPlugin

然后在 /etc/neutron/neturon.conf 中有一个选项是[DEFAULT]，在它下面有一行用来设置core plugin:

　　core_plugin = myplugin

如果没有找到entry_points.txt这个文件的话，据说另外一个办法就是直接在 neutron.conf 中指明这个plugin：

　　core_plugin = neutron.plugins.myplugin.plugin.MyPlugin

不过这个方法我没有尝试过。

做完这两步之后再重启一下neutron就搞定收工了。看一下/var/log/neutron/server.log，如果出现了我们那行log信息的话就说明Neutron已经加载了我们的什么都干不了的plugin了。

 

那么plugin具体是怎么实现的呢？请看下回分解。