try to sync documentation with the reality

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

View File

@ -42,25 +42,20 @@ invoking application and Configuration
====================================== ======================================
It can be configured by passing configuration file like:: 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.) (And more to come as Ryu evolves.)
* ryu.app.simple_isolation.SimpleIsolation * ryu.app.simple_isolation.SimpleIsolation
* ryu.app.rest.restapi * ryu.app.rest.RestAPI
* ryu.app.simple_bridge.SimpleSwitch * ryu.app.simple_bridge.SimpleSwitch
* ryu.app.event_dumper.EventDumper
The generic available is as follows:: The generic available is as follows::
--app-lists: application module name to run; --app-lists: application module name to run;
repeat this option to specify a list of values repeat this option to specify a list of values
(default: "['ryu.app.simple_isolation.SimpleIsolation', --help: show help
'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
The options for REST server:: The options for REST server::
@ -93,7 +88,7 @@ The options for log::
--[no]verbose: show debug output --[no]verbose: show debug output
(default: 'false') (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 --config-file: Path to a config file to use. Multiple config files
can be specified, with values in later files taking precedence. 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 if any, specified via --config-file, hence over-ridden options in the
directory take precedence. 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 Invoking Example
================ ================
The exmaple is as follows:: 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 % PYTHONPATH=. ./bin/ryu-manager --wsapi-port 8081 --verbose --app-lists ryu.app.simple_isolation,ryu.app.rest
unhandled event <ryu.controller.dispatcher.EventQueueCreate object at 0x22ec690> loading app ryu.app.simple_isolation
loading app ryu.app.simple_isolation.SimpleIsolation loading app ryu.app.rest
loading app ryu.app.rest.restapi loading app ryu.controller.ofp_handler
ryu.app.event_dumper: registering q datapath dispatcher dpset creating context dpset
loading app ryu.app.event_dumper.EventDumper creating context wsgi
connected socket:<socket fileno=8 sock=172.16.3.33:6633 peer=172.17.107.1:41888> address:('172.17.107.1', 41888) creating context network
ryu.app.event_dumper: queue created ofp_msg instantiating app ryu.app.simple_isolation
ryu.app.event_dumper: event <ryu.controller.dispatcher.EventQueueCreate object at 0x23bf3d0> instantiating app ryu.app.rest
ryu.app.event_dumper: event <ryu.controller.ofp_event.EventOFPHello object at 0x23bf4d0> instantiating app ryu.controller.ofp_handler
hello ev <ryu.controller.ofp_event.EventOFPHello object at 0x23bf4d0> BRICK dpset
move onto config mode CONSUMES EventOFPStateChange
dispatcher change q ofp_msg dispatcher ofp_config CONSUMES EventOFPPortStatus
ryu.app.event_dumper: dispatcher change q ofp_msg dispatcher ofp_handshake -> ofp_config CONSUMES EventOFPSwitchFeatures
ryu.app.event_dumper: event <ryu.controller.dispatcher.EventDispatcherChange object at 0x23bf950> BRICK ofp_event
ryu.app.event_dumper: event <ryu.controller.ofp_event.EventOFPSwitchFeatures object at 0x23bf450> PROVIDES EventOFPStateChange TO ['dpset']
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) PROVIDES EventOFPPortStatus TO ['dpset', 'SimpleIsolation']
dpid_add: 0x00000002b313ead6 PROVIDES EventOFPPacketIn TO ['SimpleIsolation']
ryu.app.event_dumper: event <ryu.controller.ofp_event.EventOFPBarrierReply object at 0x23bf4d0> PROVIDES EventOFPSwitchFeatures TO ['dpset', 'SimpleIsolation']
barrier reply ev <ryu.controller.ofp_event.EventOFPBarrierReply object at 0x23bf4d0> msg version: 0x1 msg_type 0x13 xid 0xd1bf86d5 CONSUMES EventOFPEchoRequest
move onto main mode CONSUMES EventOFPErrorMsg
dispatcher change q ofp_msg dispatcher ofp_main CONSUMES EventOFPSwitchFeatures
DPSET: register datapath <ryu.controller.controller.Datapath object at 0x23def10> CONSUMES EventOFPHello
ryu.app.event_dumper: event <ryu.controller.dpset.EventDP object at 0x23bf990> BRICK network
unhandled event <ryu.controller.dpset.EventDP object at 0x23bf990> BRICK RestAPI
ryu.app.event_dumper: dispatcher change q ofp_msg dispatcher ofp_config -> ofp_main BRICK SimpleIsolation
ryu.app.event_dumper: event <ryu.controller.dispatcher.EventDispatcherChange object at 0x23bf590> CONSUMES EventOFPPacketIn
CONSUMES EventOFPPortStatus
CONSUMES EventOFPSwitchFeatures