docs/getting-started-guide/project-release-notes/opflex.rst

   1 ======
   2 OpFlex
   3 ======
   4
   5 Major Features
   6 ==============
   7
   8 OpFlex Agent
   9 ------------
  10
  11 OpFlex Agent provides support for local enforcement of group-based
  12 policy model synced using the OpFlex protocol using an Open
  13 vSwitch-based bridge.  Supported renderer currently works with Cisco
  14 ACI.
  15
  16 libopflex
  17 ---------
  18
  19 libopflex provides an implementation of the OpFlex protocol along with
  20 an in-memory managed object database for managing OpFlex data.
  21
  22 genie
  23 -----
  24
  25 Genie provides a modeling language and code generator for producing
  26 data models that work with libopflex.  Genie also contains the
  27 group-based policy model that is used by the OpFlex Agent.
  28
  29
  30 Documentation
  31 =============
  32
  33 Please provide the URL to each document at docs.opendaylight.org. If the
  34 document is under review, provide a link to the change in Gerrit.
  35
  36 * **Installation Guide(s):**
  37
  38   * :ref:`opflex-agent-ovs-install-guide`
  39
  40 * **User Guide(s):**
  41
  42   * :ref:`opflex-agent-ovs-user-guide`
  43
  44 * **Developer Guide(s):**
  45
  46   * :ref:`opflex-libopflex-dev-guide`
  47   * :ref:`opflex-genie-dev-guide`
  48   * :ref:`opflex-agent-ovs-dev-guide`
  49
  50 Security Considerations
  51 =======================
  52
  53 * Do you have any external interfaces other than RESTCONF?
  54
  55   * No.
  56
  57 * Other security issues?
  58
  59   * None.
  60
  61 Quality Assurance
  62 =================
  63
  64 * OpFlex projects are tested with extensive unit testing as well as
  65   Cisco-internal automated testing with ACI.
  66 * Unit tests run as part of `regular build <https://jenkins.opendaylight.org/releng/view/opflex/job/opflex-merge-carbon/34/>`_
  67
  68 Migration
  69 ---------
  70
  71 * Simply install and restart daemons.
  72
  73 Compatiblity
  74 ------------
  75
  76 OpFlex GBP model and configuration files remain backward compatible.
  77
  78 Bugs Fixed
  79 ----------
  80
  81 * Flows that are routed are allowed to hairpin out the same interface
  82 * Allow working with newer compilers and development environments
  83
  84   * Newest versions of boost remove support for comments in JSON; we
  85     work around this by stripping comments before doing JSON parsing
  86     for configuration files
  87   * Various changes and improvements to enable working with musl and
  88     alpine linux
  89
  90 Known Issues
  91 ------------
  92
  93 * None
  94
  95 End-of-life
  96 ===========
  97
  98 * None
  99
 100 Standards
 101 =========
 102
 103 * `OpFlex protocol <https://tools.ietf.org/html/draft-smith-opflex-03>`_ (reference implementation)