docs/release-notes/projects/lispflowmapping.rst

   1 =================
   2 LISP Flow Mapping
   3 =================
   4
   5 Major Features
   6 ==============
   7
   8 odl-lispflowmapping-msmr
   9 ------------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/odl-lispflowmapping-msmr/pom.xml
  12 * **Feature Description:**  This is the core feature that provides the Mapping Services and includes the LISP southbound plugin feature as well.
  13 * **Top Level:** Yes
  14 * **User Facing:** Yes
  15 * **Experimental:** No
  16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/lispflowmapping/job/lispflowmapping-csit-1node-msmr-all-oxygen/
  17
  18 odl-lispflowmapping-neutron
  19 ---------------------------
  20
  21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/odl-lispflowmapping-neutron/pom.xml;hb=stable/oxygen
  22 * **Feature Description:**  This feature provides Neutron integration.
  23 * **Top Level:** Yes
  24 * **User Facing:** Yes
  25 * **Experimental:** Yes
  26
  27 odl-lispflowmapping-ui
  28 ----------------------
  29
  30 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/odl-lispflowmapping-ui/pom.xml;hb=stable/oxygen
  31 * **Feature Description:** This feature provides a GUI to access the Mapping Service data.
  32 * **Top Level:** Yes
  33 * **User Facing:** Yes
  34 * **Experimental:** Yes
  35
  36 Documentation
  37 =============
  38
  39 * **User Guide(s):**
  40     :ref:`lispflowmapping-user-guide`
  41
  42 Security Considerations
  43 =======================
  44
  45 * Do you have any external interfaces other than RESTCONF?
  46 * Yes, the southbound plugin
  47
  48   * If so, how are they secure?
  49     * LISP southbound plugin follows LISP `RFC6833 <https://tools.ietf.org/html/rfc6833>`_ security guidelines.
  50
  51   * What port numbers do they use?
  52     * Port used: 4342
  53
  54 * Other security issues?
  55   * None
  56
  57 Quality Assurance
  58 =================
  59
  60 * `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.lispflowmapping%3Alispflowmapping-all>`_ (59.5%)
  61 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/lispflowmapping/>`_
  62 * All modules have been unit tested. Integration tests have been performed for all major features. System tests have been performed on most major features.
  63 * Registering and retrieval of basic mappings have been tested more thoroughly. More complicated mapping policies have gone through less testing.
  64
  65
  66 Migration
  67 ---------
  68
  69 * Is it possible to migrate from the previous release? If so, how?
  70
  71   * LISP Flow Mapping service will auto-populate the datastructures from existing MD-SAL data upon service start if the data has already been migrated separately. No automated way for transfering the data is provided in this release.
  72
  73 Compatibility
  74 -------------
  75
  76 * Is this release compatible with the previous release?
  77
  78   * Yes
  79
  80 * Any API changes?
  81
  82   * No
  83
  84 * Any configuration changes?
  85
  86   * No
  87
  88 Bugs Fixed
  89 ----------
  90
  91 * `LISPMAP-151 <https://jira.opendaylight.org/browse/LISPMAP-151>`_ Subscribers from both Northbound and Southbound origin are stored in SimpleMapCache
  92 * `LISPMAP-152 <https://jira.opendaylight.org/browse/LISPMAP-152>`_ Integration tests: multi-site doesn't send SMR-invoked Map-Request on SMR
  93 * `LISPMAP-155 <https://jira.opendaylight.org/browse/LISPMAP-155>`_ SMR scheduler task tracking unreliable
  94 * `LISPMAP-163 <https://jira.opendaylight.org/browse/LISPMAP-163>`_ Merging of negative prefixes is incorrect
  95 * `LISPMAP-164 <https://jira.opendaylight.org/browse/LISPMAP-164>`_ Negative mapping in SB masking overlapping more specific positive added later to NB
  96 * `LISPMAP-165 <https://jira.opendaylight.org/browse/LISPMAP-165>`_ Adding a less specific NB mapping when an included more specific SB exists leads to SB taking preference
  97 * `LISPMAP-166 <https://jira.opendaylight.org/browse/LISPMAP-166>`_ Integration tests receiveMap(Request|Notify) don't check for packet type before deserializing
  98 * `LISPMAP-168 <https://jira.opendaylight.org/browse/LISPMAP-168>`_ When lazy removing expired mappings, the mapping system doesn't check for less specifics
  99 * `LISPMAP-169 <https://jira.opendaylight.org/browse/LISPMAP-169>`_ MapServer should not send SMR for when source EID was AFI=0 (No Address)
 100 * `LISPMAP-171 <https://jira.opendaylight.org/browse/LISPMAP-171>`_ Karaf CLI commands should trigger expired mapping removal
 101 * `LISPMAP-173 <https://jira.opendaylight.org/browse/LISPMAP-173>`_ NPE in MappingSystem#removeMapping()
 102
 103
 104 Known Issues
 105 ------------
 106
 107 * Clustering is still an experimental feature and may have some issues particularly related to operational datastore consistency.
 108
 109 * `Link to Open Bugs <https://jira.opendaylight.org/projects/LISPMAP/issues/>`_
 110
 111 End-of-life
 112 ===========
 113
 114 * None
 115
 116 Standards
 117 =========
 118
 119 * The LISP implementation module and southbound plugin conforms to the IETF `RFC6830 <https://tools.ietf.org/html/rfc6830>`_ and `RFC6833 <https://tools.ietf.org/html/rfc6833>`_ , with the following exceptions:
 120
 121   - In Map-Request message, M bit(Map-Reply Record exist in the MapRequest) is processed but any mapping data at the bottom of a Map-Request are discarded.
 122   - LISP LCAFs are limited to only up to one level of recursion, as described in the IETF `LISP YANG draft <https://tools.ietf.org/html/draft-ietf-lisp-yang-07>`_.
 123   - No standards exist for the LISP Mapping System northbound API as of this date.
 124
 125 Release Mechanics
 126 =================
 127
 128 * `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Oxygen_Release_Plan>`_
 129
 130   * No major shifts from the release plan.