Commit Graph

89 Commits

Author SHA1 Message Date
Yoshihiro Kaneko
03731ad04c package: add python-ryu-doc
This patch adds python-ryu-doc package which contains the HTML
documentation generated from doc/.
Also updates the man pages in doc/source/man/.

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-19 08:41:51 +09:00
YAMAMOTO Takashi
a2fc54bd79 document ryu.app.ofctl
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-18 12:13:14 +09:00
FUJITA Tomonori
5474bf214c bgp: add bgpspaker module for non Ryu application usage
This enables you to use Ryu BGP feature as 'bgp speaker' python
library, that is, without ryu-manager, RPC API, REST API, or other Ryu
stuff, you can use Ryu BGP feature in your python application (just
import bgpspeaker.py). The sample code and the API reference docs are
included too.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Reviewed-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
2014-06-13 08:05:25 +09:00
takahashi.minoru
cfdce1f340 packet lib: add Connectivity Fault Management Protocol(CFM, IEEE 802.1ag)
Signed-off-by: TAKAHASHI Minoru <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-10 21:11:52 +09:00
Yoshihiro Kaneko
482bbc97b9 doc: add test-of-config-with-linc page
port from wiki page.

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-03 22:51:56 +09:00
Yoshihiro Kaneko
6eb3417388 doc: add test-vrrp page
port from wiki page.

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-03 22:51:54 +09:00
Yoshihiro Kaneko
2eb59a09ff doc: add components page
port from wiki.

dummy quantumclient is necessary to import ryu.app.quantum_adapter by
sphinx.ext.autodoc.

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
2014-05-27 20:24:50 +09:00
Yoshihiro Kaneko
ee5bf73b73 add openflow api reference for of1.4
Update OpenFlow API document.
- add OpenFlow 1.4 API Reference
- update OpenFlow API Reference index for OF1.4

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-05-15 08:00:35 +09:00
FUJITA Tomonori
128fd85c13 remove obsolete man pages (rpc_cli and neutron_ofagent_agent)
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-04-21 19:07:22 +09:00
FUJITA Tomonori
28f6f6020a delete bin/neutron-ofagent-agent
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Reviewed-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
2014-04-21 19:06:25 +09:00
FUJITA Tomonori
95fa2d63d4 delete bin/rpc-cli
This command is available via ryu command.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-04-21 19:05:46 +09:00
YAMAMOTO Takashi
86da3d9939 document ryu command
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
2014-04-20 21:00:57 +09:00
YAMAMOTO Takashi
07c3aa1bf8 doc: remove a stale reference
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-03-25 23:05:38 +09:00
YAMAMOTO Takashi
eb07d4bf81 library_packet.rst: fix an example code
Reported by Sebastian Gebhard on ryu-devel@.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-03-16 20:37:46 +09:00
YAMAMOTO Takashi
2743eb4da5 rename neutron agent from "ofswitch" to "ofagent"
suggested by some openstack folks.
see https://review.openstack.org/#/c/71791

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-02-17 22:40:36 +09:00
YAMAMOTO Takashi
188d68fcf8 neutron-ofswitch-agent man page
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-02-07 19:53:55 +09:00
YAMAMOTO Takashi
d5c2c1f2e3 doc: improve RyuApp documentation
This includes a small code change; the default value of OFP_VERIONS
was changed to None from the lack of the attribute.  No functional
changes are intended by this.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-01-27 22:22:10 +09:00
YAMAMOTO Takashi
bd235f1847 doc: update after the sync request change
update documentation after commit c9325a22.
("fix bidirectional event confusion")

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-01-27 22:22:09 +09:00
Satoshi Kobayashi
c9325a22c0 fix bidirectional event confusion
EventRequestBase has EventReplyBase

Signed-off-by: Satoshi Kobayashi <satoshi-k@stratosphere.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-01-23 15:42:51 +09:00
YAMAMOTO Takashi
eb94fa67f7 A happy new year 2014
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-01-09 21:21:39 +09:00
Yuichi Ito
a41275373c packet lib: igmp: support IGMP v3
Signed-off-by: Yuichi Ito <ito.yuichi0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-12-29 15:09:03 +09:00
YAMAMOTO Takashi
60d8f416a7 rpc-cli man page
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-11-29 09:23:41 +09:00
FUJITA Tomonori
e39fec0238 Revert "doc: update tls example"
This reverts commit 01dcd0c9bc.
2013-11-25 17:48:24 +09:00
YAMAMOTO Takashi
01dcd0c9bc doc: update tls example
after commit 73ae9dd1 ("solve application dependency via @set_ev_cls"),
ryu-manager without explicit apps merely exits.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-11-19 07:58:59 -08:00
YAMAMOTO Takashi
f14b3f2c15 doc: hook up dpset
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-11-15 09:11:50 +09:00
Yuichi Ito
3ba951f403 packet lib: support Provider Backbone Bridges (PBB, IEEE 802.1ah)
Signed-off-by: Yuichi Ito <ito.yuichi0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-10-29 21:30:45 +09:00
Yuichi Ito
45c1df5f5c doc: hook up lib.packet.sctp
Signed-off-by: Yuichi Ito <ito.yuichi0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-10-21 22:55:33 +09:00
YAMAMOTO Takashi
dfe8bbb259 doc: hook up streaming parser docs
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-26 04:11:16 +09:00
YAMAMOTO Takashi
45633e83b3 doc: hook up lib.packet.bgp
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-26 04:11:05 +09:00
YAMAMOTO Takashi
1afea080d6 doc: ryu app api overview
mostly taken from ryu.wiki/API.md and conveted by hand.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-20 09:42:03 +09:00
YAMAMOTO Takashi
bdbcfda297 document OFPTableFeaturesStatsRequest/OFPTableFeaturesStatsReply
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-20 09:40:54 +09:00
YAMAMOTO Takashi
7d37903c31 doc: sprinkle of13 json examples
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-20 09:40:53 +09:00
YAMAMOTO Takashi
672db3d81a doc: sprinkle of12 json examples
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-20 09:40:53 +09:00
YAMAMOTO Takashi
32977c125e document MsgBase
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-20 09:40:53 +09:00
Yoshihiro Kaneko
62170fba87 doc: update format of pages for ofproto
- add explicit classified layout to ofproto_v1_[23]_ref
- put contents of ofproto_ref back to toctree.

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-03 13:59:13 +09:00
FUJITA Tomonori
eacabd75c5 doc: fix warnings
ryu/lib/packet/icmpv6.py:docstring of ryu.lib.packet.icmpv6.nd_option_pi:23: WARNING: Inline emphasis start-string without end-string.
ryu/doc/source/ofproto_v1_2_ref.rst:: WARNING: document isn't included in any toctree
ryu/doc/source/ofproto_v1_3_ref.rst:: WARNING: document isn't included in any toctree

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-02 20:12:51 +09:00
Yoshihiro Kaneko
673c811f85 doc: update reference page for ofproto.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-02 19:43:50 +09:00
FUJITA Tomonori
45a34eb9df fix the commit 833328a mess-up
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-24 08:05:06 +09:00
Yoshihiro Kaneko
f8da5a9c79 doc: fix overflow from the page in latex/pdf.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-23 20:20:08 +09:00
Yoshihiro Kaneko
833328a54e of1.2, of1.3: update document for OFPMatch
ofproto_v1_3_parser.OFPMatch:
  add a list of available fields.
ofproto_v1_2_parser.OFPMatch:
  add docstrings same as of1.3.
doc:
  add reference page for of1.2

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-23 20:16:58 +09:00
Yoshihiro Kaneko
d0b4e50d29 doc: add reference for ofproto api document
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 20:26:01 +09:00
YAMAMOTO Takashi
0a8e581628 doc: fix some sphinx warnings and errors
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:54 +09:00
YAMAMOTO Takashi
beb9867d7a doc: fix a typo
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:51 +09:00
Yuichi Ito
d84d9a7c93 lib/packet: add Internet Group Management Protocol
Signed-off-by: Yuichi Ito <ito.yuichi0@gmal.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-12 09:37:56 +09:00
YAMAMOTO Takashi
37a11525df note about network address representation
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01 14:26:00 +09:00
YAMAMOTO Takashi
d29b3b3d7a packet lib api: update documentation
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01 14:25:51 +09:00
FUJITA Tomonori
a1f5d458df add 2013 to copyright for documentations
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-01 08:12:00 +09:00
watanabe.fumitaka
ad3b896d58 update library_packet_ref.rst
Signed-off-by: WATANABE Fumitaka <watanabe.fumitaka@nttcom.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-31 19:43:30 +09:00
Yuichi Ito
a1b6d39f9d lib/packet: add Link Aggregation Control Protocol
Signed-off-by: Yuichi Ito <ito.yuichi0@gmal.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-24 02:58:36 +09:00
Isaku Yamahata
9dcdf938b4 man: remove man page of ryu client
ryu-client isn't installed any more as it has been moved to ryu/tests.

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-07-09 12:12:30 +09:00