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.
  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=6536>`_ Clustering: operational data is not showing up in the in-memory map-cache on the replicas 2016-09-08
  94 * `6754 <https://bugs.opendaylight.org/show_bug.cgi?id=6754>`_ No serializer defined for IPv6 prefix SimpleAddress 2016-09-20
  95 * `6759 <https://bugs.opendaylight.org/show_bug.cgi?id=6759>`_ Expired mappings are not returned from SimpleMapCache before deletion.  2016-09-21
  96 * `6634 <https://bugs.opendaylight.org/show_bug.cgi?id=6634>`_ LispNeutronService give exception: java.lang.NullPointerException 2016-10-13
  97 * `6782 <https://bugs.opendaylight.org/show_bug.cgi?id=6782>`_ RadixTrie parent insertion not done correctly for non-empty children  2016-10-13
  98 * `6925 <https://bugs.opendaylight.org/show_bug.cgi?id=6925>`_ Error during Map-Register performance test  2016-10-13
  99 * `7018 <https://bugs.opendaylight.org/show_bug.cgi?id=7018>`_ Null pointer exception when SMR map request is received 2016-10-25
 100 * `7035 <https://bugs.opendaylight.org/show_bug.cgi?id=7035>`_ Boron autorelease failing on lispflowmapping tests  2016-11-01
 101 * `6361 <https://bugs.opendaylight.org/show_bug.cgi?id=6361>`_ LispSouthboundHandler is marked @ChannelHandler.Sharable but is not stateless 2016-11-23
 102 * `7293 <https://bugs.opendaylight.org/show_bug.cgi?id=7293>`_ Radix trie node removals that update the root don't work  2016-12-05
 103 * `7586 <https://bugs.opendaylight.org/show_bug.cgi?id=7586>`_ Fix broken lispflowmapping features failing the new extended SingleFeatureTest incl. TestBundleDiag 2017-01-23
 104 * `7789 <https://bugs.opendaylight.org/show_bug.cgi?id=7789>`_ Odl-lispflowmapping-ui breaks DLUX  2017-02-15
 105 * `7628 <https://bugs.opendaylight.org/show_bug.cgi?id=7628>`_ Karaf 4 migration: provide Karaf 4 lispflowmapping features 2017-03-24
 106 * `7818 <https://bugs.opendaylight.org/show_bug.cgi?id=7818>`_ Map-Register fast path not working correctly  2017-03-27
 107 * `6071 <https://bugs.opendaylight.org/show_bug.cgi?id=6071>`_ Map Notify Authentication Data is not computed correctly  2017-03-27
 108 * `6381 <https://bugs.opendaylight.org/show_bug.cgi?id=6381>`_ Expired xTR-ID mappings are not removed 2017-03-27
 109 * `8248 <https://bugs.opendaylight.org/show_bug.cgi?id=8248>`_ Intermittent SingleFeatureTest failures in autorelease  2017-04-26
 110 * `8429 <https://bugs.opendaylight.org/show_bug.cgi?id=8429>`_ Integration tests fail intermittently with unexpected SMR (a.k.a. the Heisenbug)  04:21:56
 111 * `7272 <https://bugs.opendaylight.org/show_bug.cgi?id=7272>`_ Map-resolver replies with wrong mapping record and TTL  05:04:17
 112
 113
 114 Known Issues
 115 ------------
 116
 117 * Clustering is still an experimental feature and may have some issues particularly related to operational datastore consistency.
 118
 119 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78877&order=Importance&product=lispflowmapping&query_format=specific>`_
 120
 121 End-of-life
 122 ===========
 123
 124 * None
 125
 126 Standards
 127 =========
 128
 129 * 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:
 130
 131   - 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.
 132   - 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>`_.
 133   - No standards exist for the LISP Mapping System northbound API as of this date.
 134
 135 Release Mechanics
 136 =================
 137
 138 * `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Carbon_Release_Plan>`_
 139
 140   * No major shifts from the release plan.