Update to follow style guide
[docs.git] / docs / opendaylight-with-openstack / index.rst
1 #################################
2 OpenDaylight with Openstack Guide
3 #################################
4
5 ********
6 Overview
7 ********
8
9 OpenStack_ is a popular open source Infrastructure
10 as a service project, covering compute, storage and network management.
11 OpenStack can use OpenDaylight as its network management provider through the
12 Modular Layer 2 (ML2) north-bound plug-in. OpenDaylight manages the network
13 flows for the OpenStack compute nodes via the OVSDB south-bound plug-in. This
14 page describes how to set that up, and how to tell when everything is working.
15
16 ********************
17 Installing OpenStack
18 ********************
19
20 Installing OpenStack is out of scope for this document, but to get started, it
21 is useful to have a minimal multi-node OpenStack deployment.
22
23 The reference deployment we will use for this document is a 3 node cluster:
24
25 * One control node containing all of the management services for OpenStack_
26   (Nova, Neutron, Glance, Swift, Cinder, Keystone)
27 * Two compute nodes running nova-compute
28 * Neutron using the OVS back-end and vxlan for tunnels
29
30 Once you have installed OpenStack_, verify that it is working by connecting
31 to Horizon and performing a few operations. To check the Neutron
32 configuration, create two instances on a private subnet bridging to your
33 public network, and verify that you can connect to them, and that they can
34 see each other.
35
36 ***********************
37 Installing OpenDaylight
38 ***********************
39
40 .. toctree::
41    :maxdepth: 1
42
43    openstack-with-ovsdb
44    openstack-with-gbp
45    openstack-with-vtn
46
47 .. _OpenStack: https://www.openstack.org/