diff options
author | Isaku Yamahata <yamahata@valinux.co.jp> | 2013-02-12 17:10:40 +0900 |
---|---|---|
committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2013-02-12 20:21:26 +0900 |
commit | 48bd30f8f17c13f362fdb599c1b9c7647ca58048 (patch) | |
tree | 3aea5299d3cfc997643b2c67f8ae2eab9bd98229 /doc | |
parent | 7edc2ab3f6273c69e513172dbedaac6cbe2fd5ca (diff) |
doc: eliminate sphinx warnings
This patch eliminates the following sphinx warnings.
> ryu/doc/source/parameters.rst:47: ERROR: Unexpected indentation.
> ryu/doc/source/step_by_step.rst:1: WARNING: malformed hyperlink target.
> ryu/doc/source/step_by_step.rst:164: ERROR: Inconsistent literal block quoting.
> ryu/doc/source/step_by_step.rst:229: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:278: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:320: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:329: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:333: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:357: WARNING: Bullet list ends without a blank line; unexpected unindent.
> checking consistency... ryudoc/source/parameters.rst:: WARNING: document isn't included in any toctree
Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/parameters.rst | 3 | ||||
-rw-r--r-- | doc/source/step_by_step.rst | 12 |
2 files changed, 13 insertions, 2 deletions
diff --git a/doc/source/parameters.rst b/doc/source/parameters.rst index de7c0df4..2fb27a7d 100644 --- a/doc/source/parameters.rst +++ b/doc/source/parameters.rst @@ -1,3 +1,5 @@ +:orphan: + .. _getting_started: *************** @@ -44,6 +46,7 @@ It can be configured by passing configuration file like:: At the moment the following applications are available (And more to come as Ryu evolves.) + * ryu.app.simple_isolation.SimpleIsolation * ryu.app.rest.restapi * ryu.app.simple_bridge.SimpleSwitch diff --git a/doc/source/step_by_step.rst b/doc/source/step_by_step.rst index 3305cc9a..ab93b869 100644 --- a/doc/source/step_by_step.rst +++ b/doc/source/step_by_step.rst @@ -1,4 +1,4 @@ -.. _step_by_step_example +.. step_by_step_example *************************************************** Step-by-step example for testing ryu with OpenStack @@ -157,7 +157,9 @@ The more openstack way is possible, though. boot instances for each projects. In order to test network segregation, 2 or more VM instances need to - be created:: + be created: + +:: $ source ./$tenant0/novarc $ euca-run-instances ami-<id which you get above> -k mykey-$tenant0 -t m1.tiny @@ -226,6 +228,7 @@ Some values need to be changed depending on your setup. For example IP addresses/port numbers. * /etc/nova/nova.conf for api, compute, network, volume, object-store and scheduler node + Here is the nova.conf on which all nova servers are running:: --verbose @@ -275,6 +278,7 @@ Here is the nova.conf on which all nova servers are running:: * /etc/nova/nova.conf on compute nodes + I copied the above to compute node and modified it. So it includes unnecessary values for network node. Since they don't harm, I didn't scrub them.:: @@ -317,6 +321,7 @@ I didn't scrub them.:: * /etc/quantum/plugins.ini + This file needs to be installed on which quantum-server is running. This file defines which quantum plugin is used:: @@ -326,10 +331,12 @@ This file defines which quantum plugin is used:: * /etc/quantum/quantum.conf + This file needs to be installed on which quantum-server is running. A configuration file for quantum server. I use this file as is. * /etc/quantum/plugins/ryu/ryu.ini + This files needs to be installed on nova-compute node, nova-network node and quantum-server node. This file defines several setting ryu quantum plugin/agent uses:: @@ -354,6 +361,7 @@ This file defines several setting ryu quantum plugin/agent uses:: # This corresponds to <wsapi_host>:<wsapi_port> in ryu.conf * /etc/ryu/ryu.conf + This file needs to be installed on which ryu-manager is running. If you use default configurations, you don't have to modify it. Just leave it blank:: |