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/BIER-TE topo-mamagement and BIER/BIER-TE
  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-bierman**
  35
  36    -  This feature generates BIER's topology from network topology, and configuration
  37       of BIER, BIER-TE, etc.
  38
  39 -  **odl-bier-channel**
  40
  41    -  This feature provides function about multicast flow information configuration
  42       and deployment in BIER domain.
  43
  44 -  **odl-bier-service**
  45
  46    -  This feature provides function which processing the result of BIER bierman and BIER
  47       channel, and invoking south-bound-interface for driver.
  48
  49 -  **odl-bier-adapter**
  50
  51    -  This feature provides adapter for different BIER south-bound NETCONF
  52       interfaces, so all BFRs in BIER domain with different NETCONF
  53       configuration interfaces and they can operate normally together.
  54
  55 -  **odl-bier-driver**
  56
  57    -  This feature is south-bound NETCONF interface for BIER, it has implemented standard interface
  58       (ietf-bier). If your BFR's NETCONF interface is Non-standard, you should add your own
  59       interface for driver.
  60
  61 -  **odl-te-pce**
  62
  63    - This feature provides path computation function for BIER-TE.
  64
  65 -  **odl-bier-app**
  66
  67    -  This feature provides the interface of BIER management, which contain BIER/BIER-TE manager,
  68       channel manager, topology manager.
  69
  70
  71 How To Start
  72 -------------
  73
  74 Preparing for Installation
  75 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  76
  77 1. Forwarding devices must support the BGP-LS protocol, and already be
  78    configured so that OpenDaylight can discover those devices.
  79
  80 2. Forwarding devices must support BIER configuration via NETCONF, which has a
  81    standard IETF YANG model.
  82
  83 3. The feature *odl-bier-app* or third-party App provides the northbound interface
  84    of BIER management for BIER controller.
  85
  86
  87 Installation Feature
  88 ~~~~~~~~~~~~~~~~~~~~
  89
  90 Run OpenDaylight and install BIER Service *odl-bier-all* as below::
  91
  92    feature:install odl-bier-all
  93
  94 For a more detailed overview of the BIER, see the :ref:`bier-dev-guide`.