docs/user-guide/neutron-service-user-guide.rst

   1 Neutron Service User Guide
   2 ==========================
   3
   4 Overview
   5 --------
   6
   7 This Karaf feature (``odl-neutron-service``) provides integration
   8 support for OpenStack Neutron via the OpenDaylight ML2 mechanism driver.
   9 The Neutron Service is only one of the components necessary for
  10 OpenStack integration. For those related components please refer to
  11 documentations of each component:
  12
  13 -  https://wiki.openstack.org/wiki/Neutron
  14
  15 -  https://launchpad.net/networking-odl
  16
  17 -  http://git.openstack.org/cgit/openstack/networking-odl/
  18
  19 -  https://wiki.opendaylight.org/view/NeutronNorthbound:Main
  20
  21 Use cases and who will use the feature
  22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23
  24 If you want OpenStack integration with OpenDaylight, you will need this
  25 feature with an OpenDaylight provider feature like ovsdb/netvirt, group
  26 based policy, VTN, and lisp mapper. For provider configuration, please
  27 refer to each individual provider’s documentation. Since the Neutron
  28 service only provides the northbound API for the OpenStack Neutron ML2
  29 mechanism driver. Without those provider features, the Neutron service
  30 itself isn’t useful.
  31
  32 Neutron Service feature Architecture
  33 ------------------------------------
  34
  35 The Neutron service provides northbound API for OpenStack Neutron via
  36 RESTCONF and also its dedicated REST API. It communicates through its
  37 YANG model with providers.
  38
  39 .. figure:: ./images/neutron/odl-neutron-service-architecture.png
  40    :alt: Neutron Service Architecture
  41
  42    Neutron Service Architecture
  43
  44 Configuring Neutron Service feature
  45 -----------------------------------
  46
  47 As the Karaf feature includes everything necessary for communicating
  48 northbound, no special configuration is needed. Usually this feature is
  49 used with an OpenDaylight southbound plugin that implements actual
  50 network virtualization functionality and OpenStack Neutron. The user
  51 wants to setup those configurations. Refer to each related
  52 documentations for each configurations.
  53
  54 Administering or Managing ``odl-neutron-service``
  55 -------------------------------------------------
  56
  57 There is no specific configuration regarding to Neutron service itself.
  58 For related configuration, please refer to OpenStack Neutron
  59 configuration and OpenDaylight related services which are providers for
  60 OpenStack.
  61
  62 installing ``odl-neutron-service`` while the controller running
  63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  64
  65 1. While OpenDaylight is running, in Karaf prompt, type:
  66    ``feature:install odl-neutron-service``.
  67
  68 2. Wait a while until the initialization is done and the controller
  69    stabilizes.
  70
  71 ``odl-neutron-service`` provides only a unified interface for OpenStack
  72 Neutron. It doesn’t provide actual functionality for network
  73 virtualization. Refer to each OpenDaylight project documentation for
  74 actual configuration with OpenStack Neutron.
  75
  76 Neutron Logger
  77 --------------
  78
  79 Another service, the Neutron Logger, is provided for debugging/logging
  80 purposes. It logs changes on Neutron YANG models.
  81
  82 ::
  83
  84     feature:install odl-neutron-logger
  85