RYU 源码剖析1- setup.py

RYU简介

Ryu是一个基于组件的软件定义网络框架。Ryu为软件组件提供定义良好的API,使开发人员可以轻松创建新的网络管理和控制应用程序。Ryu支持各种用于管理网络设备的协议,例如OpenFlow,Netconf,OF-config等。关于OpenFlow,Ryu支持完全支持1.0,1.2,1.3,1.4,1.5和Nicira Extensions。 所有代码都可以在Apache 2.0许可下免费获得。

使用Ryu非常简便,可以通过pip 直接安装

pip install ryu

同时,也可以通过源码进行安装

git clone git://github.com/osrg/ryu.git
cd ryu; pip install .

Ryu 的项目文档完善,重要的是其官方提供台湾地区繁体版文档。虽然技术术语略有不同,但对于英文不好的同学,帮助还是很大的。

繁体版Ryubook:https://osrg.github.io/ryu-book/zh_tw/Ryubook.pdf
繁体版官方文档:https://ryu-zhdoc.readthedocs.io/

文件结构

使用git clone git://github.com/osrg/ryu.git下载源码后,查看目录结构如下

$ tree -L 1

.
├── bin  可执行程序
├── CONTRIBUTING.rst
├── debian
├── doc 文档
├── etc 配置文件
├── LICENSE
├── MANIFEST.in
├── README.rst
├── run_tests.sh
├── ryu 程序
├── setup.cfg
├── setup.py
├── tools 安装虚拟环境工具
└── tox.ini

相比openstack而言,Ryu的代码量并不多,目录结构也比较简单。与大多数项目一样,bin/目录放置执行文件,其中仅含有ryu、ryu-manager两个文件。我们看下ryu-manager文件

#!/usr/bin/env python
from ryu.cmd.manager import main
main()

#!/usr/bin/env python 的含义是在#!/usr/bin/env中找到python的安装路径,然后去执行它。含有这段话,就可以使用./ryu-manager语句执行,而不必使用python ryu-manager。主程序即执行ryu.cmd.manager中的main函数。可以看出ryu.cmd.manager即为ryu程序的入口点。

setup.py

Ryu使用setup.py 进行打包分发,即使用setup.py就可以进行pip install 等pip 操作。常见的setup操作有:

  • 以源文件创建一个项目包
python setup.py sdist
  • 将代码打包为tar.gz格式文件,方便管理
python setup.py install
  • 生成egg包
python setup.py bdist_egg
  • 进行安装
easy_install

通过setup.py文件可以总览整个项目,可视为整个项目的“源码地图”。

ryu.hooks.save_orig()
setuptools.setup(name='ryu',
                 setup_requires=['pbr'],
                 pbr=True)

ryu.hooks.save_orig() 保存现有环境变量,暂不做具体分析。setuptools指定引用pbr作为其解析工具,pbr是openstack推出的解析工具,其官方文档位置为:https://docs.openstack.org/pbr/latest/user/features.html
pbr 提供以下功能

  • 版本:根据git revisions及tag管理版本号
  • 作者:从git log生成AUTHORS文件
  • ChangeLog:从git log生成ChangeLog
  • 清单:从git文件和一些标准文件生成合理的清单
  • 发行说明:使用reno生成发行说明文件
  • Requirements:文件中存储依赖
  • long_description:将您的README文件用作long_description
  • Smart find_packages:在root包下智能查找包
  • Sphinx Autodoc:为整个模块生成autodoc存根文件
    注意,其不支持setuptools的easy_install功能:虽然其依赖setup_requires,但对于任何install_requires,我们建议在运行setup.py install之前安装它们 - 手动或使用安装工具(如pip)。

pbr 所解析的文件为setup.cfg,其内容如下

[metadata]
name = ryu
summary = Component-based Software-defined Networking Framework
license = Apache License 2.0
author = Ryu project team
author-email = ryu-devel@lists.sourceforge.net
home-page = http://osrg.github.io/ryu/
description-file = README.rst
platform = any
classifier =
    Development Status :: 5 - Production/Stable
    License :: OSI Approved :: Apache Software License
    Topic :: System :: Networking
    Natural Language :: English
    Programming Language :: Python
    Programming Language :: Python :: 2.7
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.4
    Programming Language :: Python :: 3.5
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Operating System :: Unix
keywords =
    openflow
    openvswitch
    openstack

[files]
packages =
    ryu
data_files =
    etc/ryu =
        etc/ryu/ryu.conf

[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source

[bdist_rpm]
Release = 1
Group = Applications/Accessories
Requires = python-eventlet, python-routes, python-webob, python-paramiko, python-netaddr, python-lxml, python-oslo-config, python-msgpack
doc_files = LICENSE
            MANIFEST.in
            README.rst
            CONTRIBUTING.rst
            doc/

[global]
setup-hooks =
    ryu.hooks.setup_hook

[entry_points]
console_scripts =
    ryu-manager = ryu.cmd.manager:main
    ryu = ryu.cmd.ryu_base:main

其中[entry_points]项,指定其程序入口,安装后可使用ryu-manager命令,即执行ryu.cmd.manager中的main函数。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容