summaryrefslogtreecommitdiffhomepage
path: root/doc/source/components.rst
blob: d7e53ecf3155fedcd1843111a77bcb9e18f1a094 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
*****************
Components of Ryu
*****************

Executables
===========

bin/ryu-manager
---------------

The main executable.


Base components
===============

ryu.base.app_manager
--------------------
.. automodule:: ryu.base.app_manager


OpenFlow controller
===================

ryu.controller.controller
-------------------------
.. automodule:: ryu.controller.controller

ryu.controller.dpset
--------------------
.. automodule:: ryu.controller.dpset

ryu.controller.ofp_event
------------------------
.. automodule:: ryu.controller.ofp_event

ryu.controller.ofp_handler
--------------------------
.. automodule:: ryu.controller.ofp_handler


OpenFlow wire protocol encoder and decoder
==========================================

ryu.ofproto.ofproto_v1_0
------------------------
.. automodule:: ryu.ofproto.ofproto_v1_0

ryu.ofproto.ofproto_v1_0_parser
-------------------------------
.. automodule:: ryu.ofproto.ofproto_v1_0_parser

ryu.ofproto.ofproto_v1_2
------------------------
.. automodule:: ryu.ofproto.ofproto_v1_2

ryu.ofproto.ofproto_v1_2_parser
-------------------------------
.. automodule:: ryu.ofproto.ofproto_v1_2_parser

ryu.ofproto.ofproto_v1_3
------------------------
.. automodule:: ryu.ofproto.ofproto_v1_3

ryu.ofproto.ofproto_v1_3_parser
-------------------------------
.. automodule:: ryu.ofproto.ofproto_v1_3_parser

ryu.ofproto.ofproto_v1_4
------------------------
.. automodule:: ryu.ofproto.ofproto_v1_4

ryu.ofproto.ofproto_v1_4_parser
-------------------------------
.. automodule:: ryu.ofproto.ofproto_v1_4_parser


Ryu applications
================

ryu.app.cbench
--------------
.. automodule:: ryu.app.cbench

ryu.app.simple_switch
---------------------
.. automodule:: ryu.app.simple_switch

ryu.app.simple_isolation
------------------------
.. automodule:: ryu.app.simple_isolation

ryu.app.simple_vlan
-------------------
.. automodule:: ryu.app.simple_vlan

ryu.app.gre_tunnel
------------------
.. automodule:: ryu.app.gre_tunnel

ryu.app.tunnel_port_updater
---------------------------
.. automodule:: ryu.app.tunnel_port_updater

ryu.app.quantum_adapter
-----------------------
.. automodule:: ryu.app.quantum_adapter

ryu.app.rest
------------
.. automodule:: ryu.app.rest

ryu.app.rest_conf_switch
------------------------
.. automodule:: ryu.app.rest_conf_switch

ryu.app.rest_quantum
--------------------
.. automodule:: ryu.app.rest_quantum

ryu.app.rest_tunnel
-------------------
.. automodule:: ryu.app.rest_tunnel

ryu.topology
------------
.. automodule:: ryu.topology


Libraries
=========

ryu.lib.packet
--------------
.. automodule:: ryu.lib.packet

ryu.lib.ovs
-----------
.. automodule:: ryu.lib.ovs

ryu.lib.of_config
-----------------
.. automodule:: ryu.lib.of_config

ryu.lib.netconf
---------------
.. automodule:: ryu.lib.netconf

ryu.lib.xflow
-------------
.. automodule:: ryu.lib.xflow


Third party libraries
=====================

ryu.contrib.ovs
---------------

Open vSwitch python binding. Used by ryu.lib.ovs.

ryu.contrib.oslo.config
-----------------------

Oslo configuration library. Used for ryu-manager's command-line options
and configuration files.

ryu.contrib.ncclient
--------------------

Python library for NETCONF client. Used by ryu.lib.of_config.