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

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