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

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