OpenDayLight(硼Boron版本)实战开发入门

最新推荐文章于 2024-09-30 13:12:53 发布
最新推荐文章于 2024-09-30 13:12:53 发布
阅读量1.3w 收藏 11
点赞数
分类专栏： IT技术 网络技术 开源技术 文章标签： opendaylight sdn openflow RPC Blueprint


 

OpenDayLight(硼Boron版本)实战开发入门


说明： 本文原发布于SDNlab： http://www.sdnlab.com/17863.html。 下面的内容经过了部分修改。

 

OpenDayLight[1]（简写为ODL）的硼Boron(0.5.0)版本于2016-09-16这几天刚刚发布。作为一款开源SDN网络控制器，依托于强大的社区支持以及丰富的功能特性，ODL成为了目前主流的SDN网络控制器开发平台。不仅为开发者提供了大量的网络管理功能，而且藉由AD-SAL(API驱动的服务层)和MD-SAL(模型驱动的服务层),给独立的网络应用提供了完善的二次开发接口。由于OpenDaylight架构的复杂性和多样性，以及ODL上官方wiki文档更新的比较缓慢，往往给开发者带来很多的困难。

下面我们以最新的版本硼Boron为例，讲解ODL的入门应用开发技术。

 

1. 介绍

1.1 应用开发

ODL做为网络控制器,将网络设备和应用程序连接起来。通过南向接口(例如OpenFlow协议等)管理和控制实际的网络物理设备,通过北向接口(例如RESTConf形式的接口)向外部应用程序提供信息获取和操作下发的功能。如下图所示:


图1-1ODL和APP

对于南向接口,设备厂商会比较关注;应用开发主要集中于北向接口。本文我们只关注于北向接口的APP的开发。

开发ODL的应用有两种模式：如下图所示

  • 模式一 外部应用，应用通过ODL提供的RESTful接口使用ODL提供的全部功能

  • 模式二 内部应用, 应用内嵌于ODL中,同时向外部暴露RESTful接口以供外部程序调用

图1-2应用开发模式

采用RESTful接口的应用开发和传统的开发模式类似，不再详细说明。完全使用RESTful的方式，当业务逻辑复杂时，可能会导致调用RESTful接口过多影响性能而且开发复杂。另一方面, ODL提供的RESTful接口不一定能满足业务逻辑要求,此时，就需要模式二的ODL内部应用开发,然后通过自定义的RESTful接口向外暴露功能。

1.2 OSGi简介

OSGi[2]是采用Java语言的一种面向服务的组件模型,它提供了模块化为基础开发应用的基本架构。模块可以动态加载/卸载，向外暴露功能和隐藏内部实现细节等,模块在称为容器的环境中运行。OSGi的实现有Apache Felix,Equinox ,Spring DM 等.

OpenDaylight基于OSGi的实现Apache Karaf（Apache Felix的一个子项目）来构造系统。 模块也称为bundle, ODL的内部应用就是一个个的bundle,它们放置在ODL目录的system子目录下,以maven的存储库形式组织。借助于OSGi的架构, ODL中的内部应用可以动态加载和卸载,系统具有很好的灵活性和可扩展性,这对于大型系统而言是非常重要的。

模块不仅向外提供接口,而且需要使用其它模块提供的功能,也即模块之间具有依赖性。因此ODL内部应用的开发除了专注于功能,而且对不同的ODL生产版本，需要配置不同的依赖。

 

2. ODL之硼Boron版本应用开发


此部分内容主要来自于ODL的DOC。

示例代码在此:https://github.com/siwind/hello-odl-boron

2.1 开发环境搭建

开发环境配置如下:

1) 64位Linux系统，4G以上内存, 16G以上硬盘剩余空间(如果编译ODL发行版的话)

2) JDK8, maven-3.3.x

3)环境变量设置(设置JAVA_HOME, M2_HOME, PATH变量设置, MAVEN_OPTS选项设置等,略)

export JAVA_HOME=…

export MAVEN_OPTS="-Xmx1024m"

2.2 开发示例项目

0)获取ODL的maven配置文件(用于maven编译时下载ODL的相应jar文件)

 # cp ~/.m2/settings.xml ~/.m2/settings.xml.old

 # wget -q -O  -  https://raw.githubusercontent.com/opendaylight/odlparent/stable/boron/settings.xml  >   ~/.m2/settings.xml

1)用maven生成项目框架(设项目为hello)

# mvn archetype:generate  -DarchetypeGroupId=org.opendaylight.controller \

-DarchetypeArtifactId=opendaylight-startup-archetype\

-DarchetypeRepository=https://nexus.opendaylight.org/content/repositories/public/\

-DarchetypeCatalog=https://nexus.opendaylight.org/content/repositories/public/archetype-catalog.xml

(输入如下内容)

Define value for property 'groupId':: org.bupt.siwind.hello

Define value for property'artifactId': : hello

Define value for property'package': org.bupt.siwind.hello: :

Define value for property'classPrefix': Hello: :

Define value for property 'copyright':: BNRC, Inc.

 

或者输入如下:

(指定版本为:1.2.0-Boron.版本类型可见:https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/controller/opendaylight-startup-archetype/)

mvn archetype:generate  -DarchetypeGroupId=org.opendaylight.controller \

-DarchetypeArtifactId=opendaylight-startup-archetype\

-DarchetypeVersion=1.2.0-Boron \

-DarchetypeRepository=https://nexus.opendaylight.org/content/repositories/public/\

-DarchetypeCatalog=https://nexus.opendaylight.org/content/repositories/public/archetype-catalog.xml

 

上述步骤完成后,在当前目录下面会生成hello目录,即为我们的APP目录.

2)修改依赖项(针对硼Boron版本)

# cd hello (进入hello项目目录)

#依次打开文件:pom.xml, api/pom.xml, artifacts/pom.xml, features/pom.xml, impl/pom.xml,it/pom.xml, karaf/pom.xml,修改内容(其中features/pom.xml修改多处)

按照下面列出的各自修改对应的依赖的版本号:

odlparent(odlparent-lite): 1.7.0-Boron

 binding-parent: 0.9.0-Boron

 mdsal.model: 0.9.0-Boron

 mdsal:1.4.0-Boron

 restconf: 1.4.0-Boron

 yangtools: 1.0.0-Boron

 dlux:0.4.0-Boron

 config-parent: 0.5.0-Boron

 mdsal-it-parent: 1.4.0-Boron

 karaf-parent: 1.7.0-Boron

例如文件features/pom.xml,修改后如下(蓝色部分):

<parent>

   <groupId>org.opendaylight.odlparent</groupId>

   <artifactId>features-parent</artifactId>

   <version>1.7.0-Boron</version>

   <relativePath/>

 </parent>

……

<properties>

   <mdsal.model.version>0.9.0-Boron</mdsal.model.version>

   <mdsal.version>1.4.0-Boron</mdsal.version>

   <restconf.version>1.4.0-Boron</restconf.version>

   <yangtools.version>1.0.0-Boron</yangtools.version>

   <dlux.version>0.4.0-Boron</dlux.version>

   <configfile.directory>etc/opendaylight/karaf</configfile.directory>

 </properties>

3)编译和运行

#mvn clean install

#./karaf/target/assembly/bin/karaf

进入ODL控制台,输入如下命令可以看到结果:

opendaylight-user@root>feature:list-i | grep hello

opendaylight-user@root>log:display| grep Hello

4)添加基于yang模型的RPC接口,并编译运行

添加接口并编译的内容看ODL的文档,略.

访问URL:http://<ip>:8181/apidoc/explorer/index.html ,用户名密码admin/admin.

可以看到hello-world RPC接口,输入{"input": {"name":"Good day"}} ,可以看到结果。

图 2‑1 hello RPC example

 

Curl访问RPC验证:

#curl --user"admin":"admin" \

-H "Accept:application/json" \

-H "Content-type:application/json" \

-X POST --data "{'hello:input':{ 'name':'Good day ODL'}}" \

 http://localhost:8181/restconf/operations/hello:hello-world

2.3 安装到ODL生产版本

有三种方法:方法一为将当前生成hello项目的bundle拷贝到已经正常部署运行的ODL的硼版本上;方法二为重新编译一个包含hello项目的ODL发行版。

方法三(推荐)为拷贝项目的maven结构到生产环境ODL的system目录下，然后在生产环境ODL的features-integration-index处添加自己项目的repository仓库即可进行feature的安装。



1)方法一:手动拷贝bundle

由于ODL以OSGi的方式组织,因此项目hello也是一个OSGi的bundle.在ODL中,bundle位于ODL发行版的目录的system/子目录下, 并且各个bundle以maven的包形式组织。我们hello项目正常编译运行后, hello的bundle存在于当前hello目录下面的karaf/target/assembly/system下面(其它很多bundle不要拷贝),我们从此目录拷贝hello自己的bundle到ODL的发行版即可。


i)拷贝:假设当前正常部署运行的ODL发行版位于: /home/guest/distribution-karaf-0.5.0-Boron

当前的hello项目位于/home/guest/bin/hello

那么拷贝命令如下:

#cp -R   /home/guest/bin/hello/karaf/target/assembly/system/org/bupt     /home/guest/distribution-karaf-0.5.0-Boron/system/org

ii)查看hello的maven路径:

#cd hello (进入hello项目目录)

#cat  ./karaf/target/assembly/etc/org.apache.karaf.features.cfg

查看这一行:featuresRepositories

在最后有hello的mvn路径: "mvn:org.bupt.siwind.odl/hello-features/1.0.0-SNAPSHOT/xml/features"

iii)运行ODL并添加和安装hello的bundle:

#cd   /home/guest/distribution-karaf-0.5.0-Boron

#./bin/karaf (启动ODL运行,或者以干净模式启动: ./bin/karafclean)

#opendaylight@root>feature:repo-add   mvn:org.bupt.siwind.odl/hello-features/1.0.0-SNAPSHOT/xml/features

# opendaylight@root>feature:install odl-hello-ui

# opendaylight@root> feature:list| grep hello

# opendaylight@root> log:display| grep Hello

可以看到运行结果正常。

(移除bundle)

#opendaylight@root>feature:repo-remove     mvn:org.bupt.siwind.odl/hello-features/1.0.0-SNAPSHOT/xml/features

 

2)方法二:编译hello项目到ODL发行版中

i)编译ODL发行版:

#git clone  https://git.opendaylight.org/gerrit/integration/distribution.git

#git tag

#git checkout  release/boron (切换需要的版本)

#mvn mvn clean install

编译成功后在当前目录下的distribution-karaf\target下面有压缩包形式的发行版:

distribution-karaf-0.5.0-Boron.tar.gz,distribution-karaf-0.5.0-Boron.zip

当前目录下的distribution-karaf\target\assembly为解压缩后的karaf执行版本

ii)记录hello项目的信息

# cat <hello项目的目录>/features/pom.xml

 (记录hello-feature的版本等信息)

# cat   <hello项目的目录>/karaf/target/assembly/etc/org.apache.karaf.features.cfg

 (记录hello的mvn路径: "mvn:org.bupt.siwind.odl/hello-features/1.0.0-SNAPSHOT/xml/features")

iii)添加hello的bundle信息

此步骤之前，确保hello编译运行和测试例运行通过,并且用mvn clean install安装其bundle到了.m2/repository下面。

在当前的distribution目录下面,修改如下两个pom.xml文件

# vim features-index/pom.xml ,添加如下内容:

         <dependency>

         <groupId>org.bupt.siwind.odl</groupId>

         <artifactId>hello-features</artifactId>

         <version>1.0.0-SNAPSHOT</version>

         <classifier>features</classifier>

         <type>xml</type>

       </dependency>

# vim features-index/src/main/resources/features.xml,添加如下内容:

<repository>mvn:org.bupt.siwind.odl/hello-features/1.0.0-SNAPSHOT/xml/features</repository>

iv)重新编译发行版

#mvn clean install

 

3) 方法三(推荐)，结合前述两种方法，操作如下：

i) 拷贝： 在当前项目编译运行成功后，项目的目录”karaf/target/assembly/system/”下面是maven格式的仓库，拷贝我们项目的maven仓库内容到生产环境ODL的system目录下。

例如：

#cp –R  /home/guest/bin/hello/karaf/target/assembly/system/org/bupt   /home/guest/distribution-karaf-0.5.0-Boron/system/org

 

ii) 添加我们项目仓库信息到ODL生产环境的” features-integration-index”xml文件下面。此文件路径为：

“<ODL目录>\system\org\opendaylight\integration\features-integration-index\<ODL版本>\features-integration-index-<ODL版本>-features.xml”

例如： Boron-SR1的路径为：

“system\org\opendaylight\integration\features-integration-index\0.5.1-Boron-SR1\features-integration-index-0.5.1-Boron-SR1-features.xml”

打开此文件，在末尾的标签</features>之前添加一行内容：

        <repository>mvn:org.bupt.siwind.odl/hello-features/1.0.0-SNAPSHOT/xml/features</repository>

 </features>


iii) 启动生产环境ODL，安装feature即可。

# <ODL目录>/bin/karaf

# opendaylight@root> feature:install  xxxx


图2-2运行结果

 

3. 结论

本文介绍了目前2016最新的ODL硼Boron版本的应用开发基础步骤,其也适用于其它版本的开发， 以及介绍了一些OSGi相关的背景技术;增加了将应用集成到发行版ODL的方法，和简单的RPC接口示例。

本文示例代码在这里：https://github.com/siwind/hello-odl-boron

采用Blueprint配置的版本在这里:https://github.com/siwind/hello-boron

 

4. FAQ

1)不能在ODL发行版中正常加载hello项目

A:查看是否hello的各个pom.xml中定义的依赖版本符合当前运行的ODL发行版

2)编译ODL的integration/distribution发行版时,某些依赖的bundle不能下载

A:查看报错的是哪个bundle,这里是ODL的仓储,用git自行下载此bundle源码,编译到本机的.m2/repository中.

例如：

# git clone  https://git.opendaylight.org/gerrit/${PROJECT}.git

# cd {PROJECT}

# git checkout release/boron (切换指定版本)

# mvn clean install

References

[1]ODL：开源 SDN平台[EB/OL].https://www.opendaylight.org/.

[2] OSGi: TheDynamic Module System for Java[EB/OL]. https://www.osgi.org/.

 


当年老王
关注
专栏目录
OpenDaylight-Boron学习笔记: 2 DLUX模块
帆星的天空
05-12 1652
环境及软件版本说明===SN-Controller：CPU: 2 CoresRAM: 4GBDisk: 32GBOperating System: CentOS7 x86_64 1611(Linux 3.10.0-514) Infrastructure ServerIP1: 10.0.3.100/24 (Public Network)IP2: 172.16.3.100/24 (SDN Network
OpenDaylight-Boron学习笔记: 3 L2Switch模块
帆星的天空
05-12 5054
环境及软件版本说明===SN-Controller：CPU: 2 CoresRAM: 4GBDisk: 32GBOperating System: CentOS7 x86_64 1611(Linux 3.10.0-514) Infrastructure ServerIP1: 10.0.3.100/24 (Public Network)IP2: 172.16.3.100/24 (SDN Network
OpenDaylight实战手记(一)工欲善其事，必先利其器：OpenDaylight相关技术
CSDN：ICTCamera，新浪微博：ITCamera。
12-27 4714
工欲善其事，必先利其器：OpenDaylight涉及的相关技术 注：下面的实战都在windows环境下完成，下面两部分的内容需要仔细阅读，动手实践。 1、 JDK1.7和Eclipse安装与配置（网上很容易搜到） JDK1.7：jdk-7u45-windows-i586.exe(配置环境变量JAVA_HOME、PATH等等) Eclipse：eclipse-jee-kepler-SR1-
OpenDaylight Carbon版本源码分析与学习
最新发布
weixin_28771751的博客
09-30 952
本文还有配套的精品资源，点击获取 简介：OpenDaylight是一个开源的网络操作系统，提供了灵活、可扩展的平台来管理和控制网络设备。Carbon是早期的版本之一，包含MD-SAL、YANG数据模型、南向插件、流处理引擎等关键组件。通过研究Carbon版本源码，开发者可以深入理解SDN的工作原理，学习网络编程和协议。 1. OpenDaylight 网络操作系统...
opendaylight入门
下一站十字路口
03-15 4914
mininet学习后就要继续开始接触opendaylight 由于opendaylight这个工程比较复杂，这里看到前人整理的比较好，特转载来学习： http://www.muzixing.com/pages/2014/08/02/opendaylightru-men-jiao-cheng.html 关于OpenDaylight OpenDaylight is
从零开始学OpenDayLight（碳版本）之一：基础环境搭建
weixin_34217711的博客
07-26 371
Just do it ! Code is King! 一、基础环境 0. VMware-workstation +Ubuntu-16.04; 1.JDK配置： 下载链接：http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html 参考...
OpenDayLight氟版本0.9.2
02-18
OpenDayLight distribution-karaf-0.9.2-Fluorine.tar.gz 下载到链接及密码后通过百度网盘下载
OpenStack_with_OpenDaylight：此仓库包含将OpenStack Newton与OpenDaylight Boron集成的所有脚本
02-05
OpenStack_with_OpenDaylight项目是将OpenStack Newton版本与OpenDaylight Boron版本进行集成的实践，旨在构建一个先进的软件定义网络（SDN）环境。这个仓库提供的脚本集可以帮助用户顺利地完成这两个强大平台的整合...
Opendaylight MD-SAL simple Archetype
05-18
通过以上介绍，我们可以看到Opendaylight MD-SAL simple Archetype在开发基于Opendaylight的SDN应用时起到了关键作用，极大地简化了开发流程，并且使得开发者能够专注于业务逻辑，而非基础架构的搭建。这个archetype...
OpenDaylight-SR3.docx
11-20
在**安装部署OpenDaylight SR3（Boron版本）**时，需注意以下步骤： 1. **环境准备**：确保使用CentOS 7操作系统，并安装Java 1.8及Maven 3.5。 2. **预编译版本下载**：从官方网站下载ODL的Boron SR3版本并解压缩...
OpenDayLight氧版本0.8.0
02-18
OpenDayLight distribution-karaf-0.8.0-Oxygen.tar.gz 下载到链接及密码后通过百度网盘下载
Opendaylight学习及开发初级教程
05-09
SDN中的Opendaylight入门教程，含原理与实验
Opendaylight(Oxygen版本)子项目构建
八月对半
02-17 1661
Opendaylight子项目构建 1 前置安装 1.1 git 工具 sudo apt-get install git 1.2 JDK 1.8 安装配置 (1)官网下载jdk-8u162-linux-x64.tar.gz并拖入虚拟机桌面 (2)创建安装目录，并解压 cd /usr/local sudo mkdir java cd java sudo mkdir jvm sudo tar ...
OpenDaylight Silicon（硅版本）安装介绍
George_Clancy的博客
11-10 2586
目录 0简介 1 安装环境 2 安装步骤 2.1 Java JDK 11 安装 2.2 Apache Maven 安装 2.3 OpenDaylightSilicon 安装 0简介 OpenDaylight (ODL) 是一个模块化开放平台，用于定制和自动化任何规模和规模的网络。版本排序方法是元素周期表，目前已经出到鳞（Phosphorus）版本，官方认定的稳定版本是14.0硅版本。下面来介绍如何安装硅版本。 1 安装环境 本文操作系统为Ubuntu...
SDN-OpenDaylight（Solium版本）应用开发入门Toster_opendaylight开发一个应用
2401_84170414的博客
07-22 770
在features中添加三个目录，odl-mytoaster,odl-mytoster-provider,features-mytoaster。添加前添加后之后，在三个目录下分别添加pom.xml文件，内容如下odl-mytoaster下的pom.xml文件内容odl-mytoaster下的pom.xml内容features-mytoaster的内容。
硼版本opendaylight简易安装
TANDADIVVVVVVVVVVV的博客
03-20 3993
Opendaylight 安装指南 1.    opendaylight官网：http://www.opendaylight.org/software/downloads/helium最新版本的opendaylight，我用的版本是distribution-karaf-0.5.2-Boron-SR2。最新的硼版本的。 2.    在安装之前安装JDK: sudo apt-get install
有了这个网络安全面试题，面试就像开了挂！（附PDF）
lvaolan的博客
02-26 1130
还有兄弟不知道网络安全面试可以提前刷题吗？费时一周整理的160+网络安全面试题，金九银十，做网络安全面试里的显眼包！王岚嵚工程师面试题（附答案），只能帮兄弟们到这儿了！如果你能答对70%，找一个安全工作，问题不大。对于有1-3年工作经验，想要跳槽的朋友来说，也是很好的温习资料！【完整版领取方式在文末！！​​​​内容实在太多，不一一截图了。
OpenDaylight SR3：SDN控制器的开源之旅与Linux环境部署详解
1. 访问官方下载地址：<https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/integration/distribution-karaf/0.5.3-Boron-SR3/> 2. 下载预编译的karaf版本（distribution-karaf-0.5.3-...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值