chengebj5238 Spelling mistakes
Change-Id: I035f375f21e42bb36ba0625dc76582f92c67e253
Latest commit 3574f6f Sep 7, 2018
Permalink
..
Failed to load latest commit information.
devrefs Re-add D001 test and fix all documents accordingly Jul 15, 2018
multi-node-conf Merge "Make remote_db_port and remote_db_ip deprecated" Jan 23, 2018
sfc-example Add example SFC Heat template to docs Aug 15, 2017
single-node-conf Add df_skydive_service to dragonflow Apr 11, 2018
specs Spelling mistakes Sep 7, 2018
conf.py Switch from oslosphinx to openstackdocstheme Jul 27, 2017
configuration.rst Implements oslo conf generator Sep 29, 2016
containers.rst Fix the spec format for dragonflow Feb 12, 2017
contributing.rst Initial Cookiecutter Commit. Jan 29, 2015
distributed_dhcp.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
distributed_dragonflow.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
docker_install.rst Merge "Fix run_dragonflow mgmt_address parameter" Sep 3, 2018
features.rst Merge "Fix the spec format for dragonflow" Feb 13, 2017
gmr.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
index.rst Follow the new PTI for document build Jul 9, 2018
installation.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
manual_deployment.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
osprofiler.rst Add support for osprofiler in dragonflow Jan 14, 2018
pipeline.rst Additional fixes Nov 10, 2016
pluggable_db.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
pluggable_pubsub.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
readme.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
releasenotes_create.rst Add documentation: Creating release notes with reno Nov 20, 2017
reviewers_guide.rst Re-add D001 test and fix all documents accordingly Jul 15, 2018
testing_and_debugging.rst Added a script to create add_table_names script Jan 3, 2018
usage.rst Fix the spec format for dragonflow Feb 12, 2017

readme.rst

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.