openstack/os-ken
Code Issues Proposed changes

try to sync documentation with the reality

Browse Source 
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
YAMAMOTO Takashi 2013-02-25 16:14:30 +09:00 committed by FUJITA Tomonori
parent 0a6d7c5619
commit e1c7f737f5
1 changed files with 34 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
doc/source/parameters.rst
View File

@ -42,25 +42,20 @@ invoking application and Configuration
======================================
It can be configured by passing configuration file like::
ryu-manager [--flagfile <path to configuration file>] [generic/application specific options...]
ryu-manager [generic/application specific options...]
At the moment the following applications are available
At the moment applications including the following ones are available
(And more to come as Ryu evolves.)
* ryu.app.simple_isolation.SimpleIsolation
* ryu.app.rest.restapi
* ryu.app.rest.RestAPI
* ryu.app.simple_bridge.SimpleSwitch
* ryu.app.event_dumper.EventDumper
The generic available is as follows::
--app-lists: application module name to run;
repeat this option to specify a list of values
(default: "['ryu.app.simple_isolation.SimpleIsolation',
'ryu.app.rest.restapi']")
-?,--[no]help: show this help
--[no]helpshort: show usage only for this module
--[no]helpxml: like --help, but generates XML output
--help: show help
The options for REST server::
@ -93,7 +88,7 @@ The options for log::
--[no]verbose: show debug output
(default: 'false')
The option for openstack.common.cfg::
The option for oslo.config.cfg::
--config-file: Path to a config file to use. Multiple config files
can be specified, with values in later files taking precedence.
@ -104,42 +99,37 @@ The option for openstack.common.cfg::
if any, specified via --config-file, hence over-ridden options in the
directory take precedence.
The options for event dumper::
--dump-queue: list of dispatcher name to dump event: default any
(default: [])
--dump-dispatcher: list of dispatcher name to dump event: default any
(default: [])
Invoking Example
================
The exmaple is as follows::
$ ./bin/ryu-manager --wsapi-port 8081 --verbose --app-lists ryu.app.simple_isolation.SimpleIsolation,ryu.app.rest.restapi,ryu.app.event_dumper.EventDumper
unhandled event <ryu.controller.dispatcher.EventQueueCreate object at 0x22ec690>
loading app ryu.app.simple_isolation.SimpleIsolation
loading app ryu.app.rest.restapi
ryu.app.event_dumper: registering q datapath dispatcher dpset
loading app ryu.app.event_dumper.EventDumper
connected socket:<socket fileno=8 sock=172.16.3.33:6633 peer=172.17.107.1:41888> address:('172.17.107.1', 41888)
ryu.app.event_dumper: queue created ofp_msg
ryu.app.event_dumper: event <ryu.controller.dispatcher.EventQueueCreate object at 0x23bf3d0>
ryu.app.event_dumper: event <ryu.controller.ofp_event.EventOFPHello object at 0x23bf4d0>
hello ev <ryu.controller.ofp_event.EventOFPHello object at 0x23bf4d0>
move onto config mode
dispatcher change q ofp_msg dispatcher ofp_config
ryu.app.event_dumper: dispatcher change q ofp_msg dispatcher ofp_handshake -> ofp_config
ryu.app.event_dumper: event <ryu.controller.dispatcher.EventDispatcherChange object at 0x23bf950>
ryu.app.event_dumper: event <ryu.controller.ofp_event.EventOFPSwitchFeatures object at 0x23bf450>
switch features ev version: 0x1 msg_type 0x6 xid 0xd1bf86d2 port OFPPhyPort(port_no=8, hw_addr='b\x9d\xf4\x03\xab\xaf', name='tap5d7657d4-cb\x00\x00', config=0, state=1, curr=130, advertised=0, supported=0, peer=0) OFPPhyPort(port_no=1, hw_addr='\x00\x02\xb3\x13\xea\xd6', name='eth0\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00', config=0, state=0, curr=520, advertised=1679, supported=655, peer=0) OFPPhyPort(port_no=18, hw_addr='\xce\x12\xa2\x8a\xe5\x1c', name='tapa37f47e1-25\x00\x00', config=0, state=1, curr=130, advertised=0, supported=0, peer=0) OFPPhyPort(port_no=19, hw_addr='\x12\xba1\x7f\xe4\xde', name='tap927b77c7-8f\x00\x00', config=0, state=1, curr=130, advertised=0, supported=0, peer=0) OFPPhyPort(port_no=65534, hw_addr='\x00\x02\xb3\x13\xea\xd6', name='br-int\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00', config=1, state=1, curr=0, advertised=0, supported=0, peer=0)
dpid_add: 0x00000002b313ead6
ryu.app.event_dumper: event <ryu.controller.ofp_event.EventOFPBarrierReply object at 0x23bf4d0>
barrier reply ev <ryu.controller.ofp_event.EventOFPBarrierReply object at 0x23bf4d0> msg version: 0x1 msg_type 0x13 xid 0xd1bf86d5
move onto main mode
dispatcher change q ofp_msg dispatcher ofp_main
DPSET: register datapath <ryu.controller.controller.Datapath object at 0x23def10>
ryu.app.event_dumper: event <ryu.controller.dpset.EventDP object at 0x23bf990>
unhandled event <ryu.controller.dpset.EventDP object at 0x23bf990>
ryu.app.event_dumper: dispatcher change q ofp_msg dispatcher ofp_config -> ofp_main
ryu.app.event_dumper: event <ryu.controller.dispatcher.EventDispatcherChange object at 0x23bf590>
% PYTHONPATH=. ./bin/ryu-manager --wsapi-port 8081 --verbose --app-lists ryu.app.simple_isolation,ryu.app.rest
loading app ryu.app.simple_isolation
loading app ryu.app.rest
loading app ryu.controller.ofp_handler
creating context dpset
creating context wsgi
creating context network
instantiating app ryu.app.simple_isolation
instantiating app ryu.app.rest
instantiating app ryu.controller.ofp_handler
BRICK dpset
CONSUMES EventOFPStateChange
CONSUMES EventOFPPortStatus
CONSUMES EventOFPSwitchFeatures
BRICK ofp_event
PROVIDES EventOFPStateChange TO ['dpset']
PROVIDES EventOFPPortStatus TO ['dpset', 'SimpleIsolation']
PROVIDES EventOFPPacketIn TO ['SimpleIsolation']
PROVIDES EventOFPSwitchFeatures TO ['dpset', 'SimpleIsolation']
CONSUMES EventOFPEchoRequest
CONSUMES EventOFPErrorMsg
CONSUMES EventOFPSwitchFeatures
CONSUMES EventOFPHello
BRICK network
BRICK RestAPI
BRICK SimpleIsolation
CONSUMES EventOFPPacketIn
CONSUMES EventOFPPortStatus
CONSUMES EventOFPSwitchFeatures