一、文章目标

1.1目标

随着SDN技术的逐步成熟,大量的传统数通厂家和新型的IT厂家,都投入了一定的人员进行相关的产品技术预研。而ODL作为SDN控制器的主要开源项目,自然也成了多数人学习和搭建模拟环境试验的首选。但是,从本人切入了解、学习以及在此上面,完成产品预研的经历看,由于文档缺失、网上各种文章质量不等,从搭建环境、理解框架工作机制到完成模块扩展定制,花了大量的时间,因此特整理此文,希望从代码组织、工作原理及扩展实践几个维度,系统的说明相关步骤,以方便后续人员了解、少走弯路、节省时间!


另外,开源系统自带的DLUX相关组件,由于界面比较简约,个人认为主要价值是示例性质、各团队若在ODL基础上,进一步研发自己的产品,势必会进行组件扩展,因此也希望本扩展用例能再这方面也产生一定的推进作用。


1.2文章环境及版本


DLUX组件扩展下篇-实践_java

1.3 所需背景知识

参考:DLUX组件扩展上篇-原理

需要了解: DLUX 组件注册的view的动态添加、UI-Route状态设置、nav菜单添加、Sec-logo设置、编译工程依赖等信息。


二、扩展新组件

本节以增加新feature组件dlux-apps-cowin为例,逐步详细介绍各个步骤:


2.1新Feature添加

./karaf(ODL的服务器端运行命令),系统默认加载的feature信息配置文件为当前目录的../etc/org.apache.karaf.features.cfg文件中:


DLUX组件扩展下篇-实践_java_02


其中,红色标记为加载的opendaylight的集成feature信息,上述文件对应:

/home/sdn/opendaylight/distribution-karaf-0.6.4-Carbon/system/org/opendaylight/integration/features-integration-index/0.6.4-Carbon/ eatures-integration-index-0.6.4-Carbon-features.xml文件。



在Features.xml (dluxapps\features\features-dluxapps\src\main\features) 中,修改两处:



确保在./karaf的控制台下,使用

Feature:list | grep dlux 可以发现odl-dluxapps-cowin组件。

在当前目录下,增加Odl-dluxapps-cowin目录,如下,并参考topology目录下pom.xml配置工程文件:



Pom.xml文件如下:


DLUX组件扩展下篇-实践_java_03

DLUX组件扩展下篇-实践_java_04


2.2 新模块的注册

如图,在dluxapps/Applications目录下,创建对应Cowin的目录:

DLUX组件扩展下篇-实践_java_05

参考topology目录,确定相关文件:


2.2.1 Blueprint.xml(在cowin-bundle目录下):


DLUX组件扩展下篇-实践_java_06


2.2.2 Cowin.tpl.html文件(cowin-module目录下):


DLUX组件扩展下篇-实践_java_07


2.2.3 Cowin.module.js文件:


DLUX组件扩展下篇-实践_java_08

DLUX组件扩展下篇-实践_java_09


2.2.4 Cowin.controller.js


DLUX组件扩展下篇-实践_java_10


2.2.5 Cowin.less


DLUX组件扩展下篇-实践_java_11


设置背景为淡蓝色。


2.3 新模块需要的资源的放置

在src\asserts\images下,放置:logo_cowin.gif文件

修改gulp.js的build.config.js文件,确保工程构建时,拷贝到对应的asserts目录下。


2.4 根据运行web服务目录构建本地调试环境

见2.2 web服务目录结构,拷贝ODL工程目录下对应的jar包并解压到相应目录:

如:

默认build 并install的工程目录为Linux下当前用户根目录.m2下:

~/.m2/repository/org/opendaylight/dlux/dlux.loader.resources/0.5.4-Carbon/

dlux.loader.resources-0.5.4-Carbon.jar,使用tar解压到本地,文件内容包括:

DLUX组件扩展下篇-实践_java_12

其它的modules组件在对应的dluxapps目录下,类似方式解压到对应目录即可。

构建目录架构,如图所示:


DLUX组件扩展下篇-实践_java_13


其中:

①、②就是dlux-Modules-loader-resources下文件

③是assets下image文件,需要将logo 文件放置在该目录

④将dluxapps的新建的module cowin相关文件拷贝放置该目录


2.5 编译完成,并在karaf中install

2.5.1 编译


编译,在dluxapps目录下,运行:


DLUX组件扩展下篇-实践_java_14


确认编译成功即可。


2.5.2 安装

A:su运行./karaf

B:在控制台,查看dlux相关的feature

命令: feature:list | grep dlux

如下所示:


DLUX组件扩展下篇-实践_java_15


C:安装

命令: feature:install odl-dluxapps-cowin

如下所示:


DLUX组件扩展下篇-实践_java_16


2.6 web打开

输入:http://20.0.0.22:8181/index.html,其中20.0.0.22为ODL运行服务器IP。


DLUX组件扩展下篇-实践_java_17


至此,一个全新的dlux module Cowin完全安装成功!


三、其它说明

介于篇幅所限,文章只把关键的步骤和过程中,自己碰到的坑,都详细记录。但是还有比较多的如工程pom.xml文件配置等,未涉及,只要参考类似模块,应该可以顺利完成。

文中涉及的扩展工程,方便大家参考,尽力使用了完整文档,且可以直接拷贝使用。为了节省时间,需要工程代码的同学,可以加微信直接提供参考代码,进行学习交流。