docs/getting-started-guide/project-release-notes/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/features-lispflowmapping/src/main/features/features.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-carbon/
  17
  18 odl-lispflowmapping-neutron
  19 ---------------------------
  20
  21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/features-lispflowmapping/src/main/features/features.xml
  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/features-lispflowmapping/src/main/features/features.xml
  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/overview?id=31299>`_ (68%)
  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 * List of bugs fixed since the previous release:
  92
  93 * `6536 <https://bugs.opendaylight.org/show_bug.cgi?id=8679>`_ MappingSystem#getWidestNegativePrefix(Eid) returns incorrect results
  94 * `6754 <https://bugs.opendaylight.org/show_bug.cgi?id=9023>`_ Merging of negative prefixes is incorrect
  95 * `6759 <https://bugs.opendaylight.org/show_bug.cgi?id=7947>`_ Subscribers from both Northbound and Southbound origin are stored in SimpleMapCache
  96 * `6634 <https://bugs.opendaylight.org/show_bug.cgi?id=8469>`_ SMR scheduler task tracking unreliable
  97 * `6782 <https://bugs.opendaylight.org/show_bug.cgi?id=8506>`_ RNegative mapping subscriptions on SB take into account NB mappings too
  98 * `6925 <https://bugs.opendaylight.org/show_bug.cgi?id=8764>`_ Newly added mapping is removed when it has the same EID prefix as the old one
  99 * `7018 <https://bugs.opendaylight.org/show_bug.cgi?id=9037>`_ Negative mapping in SB masking overlapping more specific positive added later to NB
 100 * `7035 <https://bugs.opendaylight.org/show_bug.cgi?id=6537>`_ Expired mapping removed from map-cache, not removed from MD-SAL
 101 * `6361 <https://bugs.opendaylight.org/show_bug.cgi?id=8503>`_ DAO: Empty sub-tables are not removed
 102 * `7293 <https://bugs.opendaylight.org/show_bug.cgi?id=8112>`_ Integration tests: multi-site doesn't send SMR-invoked Map-Request on SMR
 103 * `7586 <https://bugs.opendaylight.org/show_bug.cgi?id=8591>`_ Authentication cannot be properly disabled
 104 * `7789 <https://bugs.opendaylight.org/show_bug.cgi?id=8775>`_ Upon negative mapping removal, subscribers should be notified to delete the negative
 105
 106
 107 Known Issues
 108 ------------
 109
 110 * Clustering is still an experimental feature and may have some issues particularly related to operational datastore consistency.
 111
 112 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78877&order=Importance&product=lispflowmapping&query_format=specific>`_
 113
 114 End-of-life
 115 ===========
 116
 117 * None
 118
 119 Standards
 120 =========
 121
 122 * 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:
 123
 124   - 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.
 125   - 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-04>`_.
 126   - No standards exist for the LISP Mapping System northbound API as of this date.
 127
 128 Release Mechanics
 129 =================
 130
 131 * `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Nitrogen_Release_Plan>`_
 132
 133   * No major shifts from the release plan.