dragonflow/doc/source
pangliye 32d7cf1572 fix misspelling of 'neutron'
Change-Id: Icfdd3ea2790969d49d780211351a65fdd7982d90
2018-02-22 11:27:51 +08:00
..
devrefs Fixing typo in documentation 2017-07-25 22:12:26 +03:00
multi-node-conf Merge "Make remote_db_port and remote_db_ip deprecated" 2018-01-23 10:49:51 +00:00
sfc-example Add example SFC Heat template to docs 2017-08-15 16:35:50 +03:00
single-node-conf Disable Active Port Detection when using ZMQ 2018-01-17 16:49:17 +02:00
specs fix misspelling of 'neutron' 2018-02-22 11:27:51 +08:00
conf.py Switch from oslosphinx to openstackdocstheme 2017-07-27 16:44:11 +05:30
configuration.rst Implements oslo conf generator 2016-09-29 16:42:03 +08:00
containers.rst Fix the spec format for dragonflow 2017-02-12 20:20:25 +08:00
contributing.rst Initial Cookiecutter Commit. 2015-01-29 16:46:27 +02:00
distributed_dhcp.rst fix some spelling error 2017-02-11 23:18:36 +08:00
distributed_dragonflow.rst Update and optimize documentation links 2017-07-19 10:58:45 +00:00
features.rst Merge "Fix the spec format for dragonflow" 2017-02-13 11:32:16 +00:00
gmr.rst Implement Guru meditation reports 2016-06-08 15:59:44 +08:00
index.rst Remove release notes from docs 2017-12-06 15:41:01 +02:00
installation.rst Add all-in-one vagrant config 2018-01-14 15:21:54 +02:00
manual_deployment.rst Make remote_db_port and remote_db_ip deprecated 2018-01-22 16:28:00 +02:00
osprofiler.rst Add support for osprofiler in dragonflow 2018-01-14 13:27:55 +00:00
pipeline.rst Additional fixes 2016-11-10 14:47:00 +01:00
pluggable_db.rst Fix typos in dragonflow 2018-02-14 08:36:08 +00:00
pluggable_pubsub.rst Update common_params.py path and link 2018-01-25 05:34:38 +00:00
readme.rst Fix readme.rst markdown format for wiki. 2017-09-29 01:00:17 +08:00
releasenotes_create.rst Add documentation: Creating release notes with reno 2017-11-20 07:58:00 +02:00
reviewers_guide.rst Fix typo 2018-01-18 19:56:20 +08:00
testing_and_debugging.rst Added a script to create add_table_names script 2018-01-03 11:16:39 +02:00
usage.rst Fix the spec format for dragonflow 2017-02-12 20:20:25 +08:00

Installation guide for Dragonflow, Keep in mind that Dragonflow is still in beta.

Prerequisites

Require Open vSwitch 2.5.0

Quick Installation

  1. Clone Devstack

    git clone https://git.openstack.org/openstack-dev/devstack

  2. Copy one of the following as your local.conf to your devstack folder

DevStack Single Node Configuration

DevStack Multi Node Configuration

  1. Edit local.conf according to your configuration, See Detailed Installation for more details, or the Devstack configuration manual

Devstack

DHCP configuration (IPv4 Only Environment)

no configuration needed

DHCP configuration (mixed IPv4/IPv6 or pure IPv6)

enable_service q-dhcp

If the q-dhcp is installed on a different Node from the q-svc

Please add the following flag to the neutron.conf on the q-svc node

use_centralized_ipv6_DHCP=True

Meta data and cloud init

In order to enable the VMs to get configuration like public keys, hostnames, etc.. you need to enable meta service. You can do it by adding the following lines to local.conf file (before running 'stack.sh' command):

enable_service q-meta enable_service q-dhcp

For the meta service to work correctly, another "hidden" service must be started. It is called meta-service-proxy and it is used to forward meta data client requests to real meta service. By default, it is started by regular q-dhcp service for each tenant. As a result 'q-meta' and 'q-dhcp' services must be enabled.

Database configuration

Choose one of the following Database drivers in your local.conf

Etcd Database:

enable_service df-etcd

Ram Cloud Database:

enable_service df-ramcloud

enable_service df-rccoordinator

enable_service df-rcmaster

Zookeeper Database:

enable_service df-zookeeper

enable_service df-zookeeper-server

Redis Database:

enable_service df-redis

enable_service df-redis-server

Detailed Installation

Important parameters that needs to be set in local.conf :

HOST_IP <- The management IP address of the current node
FIXED_RANGE <- The overlay network address and mask
FIXED_NETWORK_SIZE <- Size of the overlay network
NETWORK_GATEWAY <- Default gateway for the overlay network
FLOATING_RANGE <- Network address and range for Floating IP addresses (in the public network)
Q_FLOATING_ALLOCATION_POOL <- range to allow allocation of floating IP from (within FLOATING_RANGE)
PUBLIC_NETWORK_GATEWAY <- Default gateway for the public network
SERVICE_HOST <- Management IP address of the controller node
MYSQL_HOST <- Management IP address of the controller node
RABBIT_HOST <- Management IP address of the controller node
GLANCE_HOSTPORT <- Management IP address of the controller node (Leave the port as-is)

You can find example configuration files in the multi-node-conf or the single-node-conf directories.

Automated setup using Vagrant + Virtualbox

Vagrant Installation Guide

Troubleshooting

You can check northbound database by using db-df utility, see details in Testing and Debugging.