docs/user-guide/bier-user-guide.rst

   1 .. _bier-user-guide:
   2
   3 BIER User Guide
   4 ===============
   5
   6 Overview
   7 --------
   8
   9 The technology of Bit Index Explicit Replication (BIER) specifies a new
  10 architecture for the forwarding of multicast data packets. It provides
  11 optimal forwarding of multicast data packets through a "multicast domain".
  12 However, it does not require the use of a protocol for explicitly building
  13 multicast distribution trees, and it does not require intermediate nodes
  14 to maintain any per-flow state. See specific in `draft-ietf-bier-architecture-05
  15 <https://datatracker.ietf.org/doc/draft-ietf-bier-architecture/>`_
  16 and related documents.
  17
  18 The BIER project provides functionality about BIER topo-mamagement and BIER
  19 channel-mamagement, and invoking south-bound-interface for device driver.
  20
  21
  22 BIER User-Facing Features
  23 -------------------------
  24 -  **odl-bier-all**
  25
  26    -  This feature contains all other features/bundles of BIER project. If you
  27       install it, it provides all functions that the BIER project can support.
  28
  29 -  **odl-bier-models**
  30
  31    -  This feature contains all models of BIER project, such as ietf-bier,
  32       ietf-multicast-information and so on.
  33
  34 -  **odl-bier-topomanager-ui**
  35
  36    -  This feature can display bier-topo-manager's APIs on UIs
  37       (odl-mdsal-apidocs and odl-dlux-yangui).
  38
  39 -  **odl-bier-channel-ui**
  40
  41    -  This feature can display bier-channel's APIs on UIs (odl-mdsal-apidocs
  42       and odl-dlux-yangui).
  43
  44 -  **odl-bier-service**
  45
  46    -  This feature provides function which processing the result of BIER
  47       topo-mamager and BIER channel-manager, and invoking south-bound-interface
  48       for driver.
  49
  50 -  **odl-bier-adapter**
  51
  52    -  This feature provides adapter for different BIER south-bound NETCONF
  53       interface, so all BFRs in BIER domain with different NETCONF
  54       configuration interface, they can operate normally together.
  55
  56 -  **odl-bier-driver**
  57
  58    -  This feature is south-bound NETCONF interface for BIER, it has
  59       implemented standard interface (ietf-bier). If your BFR's NETCONF
  60       interface is Non-standard, you should add your own interface for driver.
  61
  62
  63 How To Start
  64 -------------
  65
  66 Preparing for Installation
  67 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  68
  69 1. Forwarding devices must support the OpenFlow protocol, and already be
  70    configured so that OpenDaylight can discover those devices via the :ref:`OpenFlow
  71    Plugin <ofp-user-guide>`.
  72
  73 2. Forwarding devices must support BIER configuration via NETCONF, which has a
  74    standard IETF YANG model.
  75
  76
  77 Installation Feature
  78 ~~~~~~~~~~~~~~~~~~~~
  79
  80 Run OpenDaylight and install BIER Service *odl-bier-all* as below::
  81
  82    feature:install odl-bier-all
  83
  84 For a more detailed overview of the BIER, see the :ref:`bier-dev-guide`.