doc: sample configuration files

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

1 files changed, 147 insertions, 0 deletions

diff --git a/doc/source/step_by_step.rst b/doc/source/step_by_step.rst
index ab506019..9e85fb3d 100644
--- a/doc/source/step_by_step.rst
+++ b/doc/source/step_by_step.rst
@@ -195,3 +195,150 @@ Db can result in broken state easily. If you hit it, the easiest way is
 
 Although you can fix it by issuing SQL manually, you have to know what you're
 doing with db tables.
+
+Appendix
+========
+configuration file examples
+---------------------------
+This section includes sample configuration files I use for convenience.
+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
+	# For debugging
+
+    --logdir=/var/log/nova
+    --state_path=/var/lib/nova
+    --lock_path=/var/lock/nova
+	# I set those three above for my preference.
+	# You don't have to set them if the default works for you
+
+    --use_deprecated-auth=true
+	# This depends on which authentication method you use.
+
+    --sql_connection=mysql://nova:nova@localhost/nova
+	# Change this depending on how MySQL(or other db?) is setup
+
+    --dhcpbridge_flagfile=/etc/nova/nova.conf
+    --dhcpbridge=/usr/local/bin/nova-dhcpbridge
+	# This path depends on where you install nova.
+
+    --fixed_range=172.17.220.0/16
+	# You have to change this parameter depending on which IPs you uses
+
+    --network_size=128
+	# This depends on which IPs you uses for one tenant
+
+    --network_manager=nova.network.quantum.manager.QuantumManager
+    --quantum_connection_host=127.0.0.1 # <IP on which quantume server runs>
+	# Change this according to your set up
+
+    --connection_type=libvirt
+    --libvirt_type=kvm
+    --firewall_driver=quantum.plugins.ryu.nova.firewall.NopFirewallDriver
+    --libvirt_ovs_integration_bridge=br-int
+    --libvirt_vif_type=ethernet
+    --libvirt_vif_driver=quantum.plugins.ryu.nova.vif.LibvirtOpenVswitchOFPRyuDriver
+    --libvirt_ovs_ryu_api_host=<ip address on which ryu is running>:<port>
+	# default 172.0.0.1:8080
+
+    --linuxnet_interface_driver=quantum.plugins.ryu.nova.linux_net.LinuxOVSRyuInterfaceDriver
+    --linuxnet_ovs_ryu_api_host=<ip address on which ryu is running>:<port>
+	# default 172.0.0.1:8080
+	# usually same to libvirt_ovs_ryu_api_host
+
+    --quantum_use_dhcp
+
+
+* /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.::
+
+    --verbose
+
+    --logdir=/var/log/nova
+    --state_path=/var/lib/nova
+    --lock_path=/var/lock/nova
+
+    --use_deprecated_auth
+
+    --sql_connection=mysql://nova:nova@<IP address>/nova
+
+    --dhcpbridge_flagfile=/etc/nova/nova.conf
+    --dhcpbridge=/usr/bin/nova-dhcpbridge
+
+    --fixed_range=172.17.220.0/16
+    --network_size=128
+
+    --network_manager=nova.network.quantum.manager.QuantumManager
+    --quantum_connection_host=<IP address on which quantum server is runniung>
+    --connection_type=libvirt
+    --libvirt_type=kvm
+    --libvirt_ovs_integration_bridge=br-int
+    --libvirt_vif_type=ethernet
+    --libvirt_vif_driver=quantum.plugins.ryu.nova.vif.LibvirtOpenVswitchOFPRyuDriver
+    --libvirt_ovs_ryu_api_host=<ip address on which ryu is running>:<port>
+    --linuxnet_interface_driver=quantum.plugins.ryu.nova.linux_net.LinuxOVSRyuInterfaceDriver
+    --linuxnet_ovs_ryu_api_host=<ip address on which ryu is running>:<port>
+    --firewall_driver=quantum.plugins.ryu.nova.firewall.NopFirewallDriver
+    --quantum_use_dhcp
+
+    --rabbit_host=<IP address on which rabbit mq is running>
+    --glance_api_servers=<IP address on which glance api server is running>:<port>
+    --ec2_host=<IP address on which ec2 api server is running>
+    --osapi_host=<IP address on which OpenStack api server is running>
+    --s3_host=<IP address on which S3 host is running>
+    --metadata_host=<IP address on which ec2 meta data sever is running>
+
+
+* /etc/quantum/plugins.ini
+This file needs to be installed on which quantum-server is running.
+This file defines which quantum plugin is used::
+
+  [PLUGIN]
+  # Quantum plugin provider module
+  provider = quantum.plugins.ryu.ryu_quantum_plugin.RyuQuantumPlugin
+
+
+* /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::
+
+  [DATABASE]
+  # This line MUST be changed to actually run the plugin.
+  # Example: sql_connection = mysql://root:nova@127.0.0.1:3306/ovs_quantum
+  #sql_connection = mysql://<user>:<pass>@<IP>:<port>/<dbname>
+  sql_connection = mysql://quantum:quantum@172.0.0.1:3306/ovs_quantum
+
+  [OVS]
+  integration-bridge = br-int
+
+  # openflow-controller = <host IP address of ofp controller>:<port: 6633>
+  # openflow-rest-api = <host IP address of ofp rest api service>:<port: 8080>
+  openflow-controller = <IP address on which ryu-manager is running>:<port>
+	# default 127.0.0.1:6633
+	# This corresponds to <ofp_listen_host>:<ofp_listen_port> in ryu.conf
+
+  openflow-rest-api = <IP address on which ryu-manager is running>:<port>
+	# default 127.0.0.1:8080
+	# 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::
+
+    # Sample configuration file
+    #--wsapi_host=<hostip>
+    #--wsapi_port=<port:8080>
+    #--ofp_listen_host=<hostip>
+    #--ofp_listen_port=<port:6633>