Commit Graph

192 Commits

Author SHA1 Message Date
Takashi Kajinami 15d41af6d7 Fix python shebang
The current shebang requires /usr/bin/python which is not available in
Ubuntu Jammy by default.

Change-Id: I3765d2b73843db0137fe79065ab4051e1e52eab3
2023-10-17 16:03:54 +00:00
niuke 6a7cb9c994 remove unicode prefix from code
Change-Id: I5fe3d44c24cf32a70bf398b6e2cd4ac15076fae4
2022-08-11 19:42:20 +08:00
Slawek Kaplonski cd4926b235 Remove os_ken/app and os_ken/services/protocols/bgp/api/jsonrpc modules
The os_ken/services/protocols/bgp/api/jsonrpc.py module was using
os_ken/app and os_ken app is the only one which was using tinyrpc lib.
Modules under os_ken/app except os_ken/app/ofctl are not used in neutron
and neutron-dynamic-routing so lets drop them from the code.

With that we can also drop tinyrpc from the requirements file at all.

Task: #41912
Story: #2008648
Change-Id: Ic35d1f7ee4112bc5cf16fee3d828534ded26ce7f
2021-03-02 08:29:32 +09:00
Andreas Jaeger dd379ae2f6 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I2e87016e0dbabf0e5c2b6f05b8b3a2e0d026e20c
2020-05-23 18:09:47 +02:00
Rodolfo Alonso Hernandez 1f751b2d7d Replace deprecated brctl with ip commands
The bridge-utils package has been deprecated for some time now [1] and
'brctl' does not exist on some more recent distros like Fedora 28.
Replace references to brctl with the proper ip commands.

Calls to "brctl show" are not being replaced with calls to "bridge link"
because the output format is very different and in testing some bridges
were not listed.  So the simpler method of consulting /sys/class/net is
used.

[1] https://lwn.net/Articles/703776/ for example

Change-Id: I8a4891bb7ed44dc25ba3f79d2ace6927313c17b3
Related-Bug: #1801919
2020-01-21 13:36:03 +00:00
Akihiro Motoki d74ca437b4 doc: Improve the document structure
This commit updates the document structure to fix
both HTML and PDF versions.
Some minor fixes are also included.

* doc/source/conf.py: Specify openany and oneside
  as extra class options for LaTeX.
* doc/source/conf.py: Specify the depth of TOC for PDF.
* Create a separate top page for "Archived Contents"
* Adjust the content of doc/source/contributor/index.rst
  to avoid unnecessary subsection.
* Drop strings from the top page as they leads to
  separate pages in the PDF file.
* Add "T.B.D." comments to placeholder documents.
* CONTRIBUTING.rst: Remove unnecessary markups for quoting texts.
* doc/source/parameters.rst: Update the mailing list link.

Story: 2006099
Task: 35137
Change-Id: I5fc03cd8ba53df58ee75e1c1bac4e906f840ec4e
2019-10-01 17:18:14 +09:00
Akihiro Motoki 0d2059f933 PDF documentation build
It turns out that blank lines are not allowed in tables in
the latex builder. Otherwise, LaTeX complication fails.
A blank line in the docstring of 'bfd' class in os_ken/lib/packet/bfd.py
was dropped to pass LaTeX build.

Note that the structure of the generated PDF is not good (bad enough?).
This will be updated later.

Change-Id: Iec62042d4642d50d411478fadfa09e6a6bbf0a42
Story: 2006099
Task: 35137
2019-09-05 23:13:31 +09:00
Slawek Kaplonski a74bac9100 Add CLI scripts from osken to be installed via setup.cfg
Instead of keeping hardcoded files in bin/ directory it is
more flexible to install such files using setup.cfg file.
It will for example install files with correct shebang for
python2 and python3.

This patch also removes tools/osken-manager.spec file
as it was used by PyInstaller in Ryu and it isn't used
in os-ken.

Change-Id: Ie85c64d81c86f0059528ad4d8e238a4124d4e5b4
2018-12-12 15:04:37 +01:00
Hongbin Lu eb94ee01bc Rename "ryu" to "os_ken" everywhere
Change-Id: Id227a6672fb89cd512b17cddfb1fce7bb22fb0c8
2018-11-27 20:48:02 +00:00
Hongbin Lu 52a227c309 Fixup the docs building
This commit enable users to run `tox -e docs` to build docs for os-ken.
It fixes several issues to ensure the build will succeed.
In addition, the docs from upstream Ryu library is grouped into
archived content. The future work is merging those docs into
the os-ken contents.

Change-Id: I5ee1998e0d2835495650cda530eb0b73c49b091a
2018-10-17 18:51:14 +00:00
Hongbin Lu af2e4fcee4 Apply OpenStack Cookiecutter template
Change-Id: I7172220a2b40cb856080e958bd4a340975449181
2018-09-04 17:00:24 +00:00
IWASE Yusuke a0f90115cc nicira_ext: Support DEC_NSH_TTL action
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-03-20 22:32:51 +09:00
IWASE Yusuke 09d2811569 doc: Document for ryu.lib.ovs
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-02-10 18:45:58 +09:00
IWASE Yusuke c3b484c787 doc: Usage for ryu/services/protocols/bgp/application.py
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-01-17 08:46:13 +09:00
Charlie Lewis ed2c6eca22 doc: fix typo 2017-11-18 12:26:49 +09:00
IWASE Yusuke eda4940eb8 library_ovsdb_manager: Descriptions for OVS configs
To connect OVSDB Manager library to OVS, some additional configurations
on OVS is required, but currently no description about these
configurations.

This patch adds descriptions for OVS configurations and includes some
improvements of sample application.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-11-02 09:20:55 +09:00
IWASE Yusuke cb40f779d1 doc: Deprecated option html_use_smartypants
"html_use_smartypants" in conf.py is deprecated in Sphinx 1.6.
This patch fixes to use "smart_quotes" in docutils.conf instead.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-07-30 22:07:06 +09:00
Travis Gockel 5e176f9e7c doc: Minor grammar changes in ryu_app_api 2017-07-21 21:47:47 +09:00
FUJITA Tomonori a991fed7e4 Revert "tests: Separate test files from Ryu module"
This reverts commit a67ed28584.

The commit breaks OpenStack neutron dynamic routing.
2017-06-30 14:23:03 +09:00
IWASE Yusuke a67ed28584 tests: Separate test files from Ryu module
To prevent redundant files (e.g., pcap files, json files for tests,
packet data generator) to be installed, this patch separates test
directory from Ryu module.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-06-26 15:17:44 +09:00
Satoshi Fujimoto ea23ebdadf doc/ovsdb_manager: Update Sample Code
Signed-off-by: Satoshi Fujimoto <satoshi.fujimoto7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-06-23 12:08:18 +09:00
胡鼎原 8fa14c87ec doc: fix error in ovsdb_manager.rst code
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-05-30 22:11:02 +09:00
Shinpei Muraoka 077eef801e library_packet_ref: Separate ref into each protocol
To keep readablity if include all class into library reference, this
patch separates library_packet_ref.rst into each protocol.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-05-09 10:20:16 +09:00
Satoshi Fujimoto 6dfda4a227 ofctl_rest: Add get role API
Signed-off-by: Satoshi Fujimoto <satoshi.fujimoto7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-03-28 11:00:43 +09:00
Shinpei Muraoka 06a61123be library_packet_ref: Add description of action for Flow Specification
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-03-28 10:00:28 +09:00
Shinpei Muraoka 16c3640673 library_packet_ref:Add bgp reference for Flow Specification
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-03-28 09:55:42 +09:00
IWASE Yusuke 17e2e51924 library_packet_ref: Add doc for Zebra packet library
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-01-23 22:23:24 +09:00
Olivier DESNOE 6d4b094dc3 packet lib: adding DHCPv6 support
Signed-off-by: Olivier DESNOE <olivier.desnoe@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-01-14 22:48:23 +09:00
Shinpei Muraoka 2197fd55d1 doc: library_packet_ref: Add reference of openflow
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-01-14 22:11:10 +09:00
Shinpei Muraoka 25a15406f6 library_packet_ref: Update dhcp reference method
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-01-06 05:27:09 +09:00
Shinpei Muraoka 95702135d4 library_bgp_speaker_ref: Fix unexpected unindent
This patch fixes unexpected unindent that occur when building.
Also, add ESI type to be specified for argument
esi of evpn_prefix_add and evpn_prefix_del.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-12-29 22:06:52 +09:00
IWASE Yusuke cf1a2f37c8 doc: Deprecate OpenStack plugin ref
Because the Ryu plugin for OpenStack was deprecated and the description
in "using_with_openstack.rst" is obsoleted, this patch removes the link
to this page from the index and adds the cautions for it.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-12-29 22:05:27 +09:00
Shinpei Muraoka b6c1189cc9 packet lib: Add packet library of Geneve
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-12-29 22:04:20 +09:00
Shinpei Muraoka d1c275ed6f doc: library_packet_ref: Update references
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-12-29 22:03:38 +09:00
IWASE Yusuke f8fa7b68db doc: Add MRT file library reference
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-12-10 22:00:49 +09:00
IWASE Yusuke e0c446a6b4 lib/ofctl_v_*: Enable to filter flow stats by priority
OpenFlow Spec does not allow to filter flow entries by priority,
but when with a large amount of flow entries, filtering by priority
is convenient to get statistics efficiently.

This patch enables lib/ofctl_v_* modules to filter flow stats by
priority.

This patch is suggested by China Shenzhen TICOMM Information
Technology Co. Ltd.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-12-10 15:29:37 +09:00
IWASE Yusuke a443be9433 doc: Add API reference for REST EVPN switch
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-10-01 21:28:52 +09:00
Monthadar Al-Jaberi cc24a85aad doc: specify OFP v1.0 for sample application
This is a minimal change to keep the supplied sample code
working with latest software. The sample code is not compatible
with OFP v1.3+, and if there is no requirement on supported version
Ryu will probably accept latest supported OF switch.

Signed-off-by: Monthadar Al Jaberi <monthadar.al-jaberi@infinera.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-09-07 09:51:31 +09:00
tungyueh 1970e70a0d add modify role API in ofctl_rest
add description about role API

Signed-off-by: tungyueh <tylin.cs03g@nctu.edu.tw>
Reviewed-by: Iwase Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-09-07 09:37:46 +09:00
IWASE Yusuke 985e2557b2 BGPSpeaker: Support Ethernet VPN update messages
This patch enables BGPSpeaker to advertise BGP EVPN routes and
store the advertised BGP EVPN routes from the neighbors.

TODO:
 - To support the VRF table for BGP EVPN routes.
   This patch supports the global table only.
 - To implement Multihoming Functions.
   Currently, ONLY Single-Homing is supported.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-08-25 13:33:10 +09:00
Shinpei Muraoka d0992e24ae packet lib: Add packet library of GRE
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-07-29 05:55:32 +09:00
Shinpei Muraoka 64ba9f1cdc ofproto/nx_actions: Revert API of NXAction
This patch will revert the API of NXAction for the following report.
https://bugs.launchpad.net/dragonflow/+bug/1599367
revert commit id: 3c3896fd77

This patch reverts recently introduced start and end arguments.
Add the utility method for ofs_nbits.
NXActionRegLoad now takes ofs_nbits argument instead of ofs
and nbits even with this revert.

Additionally, update test cases and documents.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-07-27 19:46:03 +09:00
Shinpei Muraoka 0288ae2cfa ofproto/nx_actions: Support some NXAction
Actions to be added are as following.
 - NXActionSample2
 - NXActionOutputTrunc

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-07-12 13:21:41 +09:00
Shinpei Muraoka eed14371b8 ofproto/nx_actions: Add comment for Ryu documents
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-07-12 13:21:36 +09:00
Shinpei Muraoka 7ca8690557 ofproto/nicira_ext: Move the variable and method for Nicira Extension
Move variable and method that exist in the ofproto_v1_0.py to the nicira_ext.py.
Move the oxm_types that exists in the nx_match.py to the nicira_ext.py.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-06-09 13:07:47 +09:00
IWASE Yusuke f3e931b03f doc: Add PCAP file library reference
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-06-01 20:40:04 +09:00
IWASE Yusuke 13ae023f2d doc: Remove warnings when building doc pages
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-05-18 16:00:51 +09:00
IWASE Yusuke 9d9f28519f doc: Move Ryu App API doc into each source code
To improve maintainability, this patch moves the descriptions of
"Ryu application API" into each source code.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-05-18 16:00:34 +09:00
IWASE Yusuke 3cccf23238 doc: Add description for EventOFPPortStateChange
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-05-18 15:59:22 +09:00
Shinpei Muraoka af2ae13ae3 doc/app/ofctl_rest: Remove unused match field
This patch removed unused match field in Openflow1.2 or later.
The following is removed match filed.
 - dl_dst
 - dl_src
 - dl_type
 - dl_vlan
 - nw_src
 - nw_dst
 - nw_proto
 - tp_src
 - tp_dst

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-05-16 15:02:40 +09:00