docs/getting-started-guide/project-release-notes/topology-processing-framework.rst

   1 =============================
   2 Topology Processing Framework
   3 =============================
   4
   5 Major Features
   6 ==============
   7
   8 odl-topoprocessing-framework
   9 ----------------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/odl-topoprocessing-framework/pom.xml;h=c1c7b89ddb42af81efbeb5ae444e3179b0a14533;hb=refs/heads/stable/nitrogen
  12 * **Feature Description:**  Topology processing core
  13 * **Top Level:** No
  14 * **User Facing:** No
  15 * **Experimental:** Yes
  16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/
  17
  18 odl-topoprocessing-mlmt
  19 -----------------------
  20
  21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/odl-topoprocessing-mlmt/pom.xml;h=9fe3d505825f0f06dfcb166708b629d06855ec72;hb=refs/heads/stable/nitrogen
  22 * **Feature Description:**  Multi-Layer and Multi-Technology (MLMT) module
  23 * **Top Level:** Yes
  24 * **User Facing:** No
  25 * **Experimental:** Yes
  26 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/
  27
  28 odl-topoprocessing-network-topology
  29 -----------------------------------
  30
  31 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/odl-topoprocessing-network-topology/pom.xml;h=0de34de8dd99de3ac4b0c0bc5908a1de24a8f7ea;hb=refs/heads/stable/nitrogen
  32 * **Feature Description:**  Support for network-topology model
  33 * **Top Level:** Yes
  34 * **User Facing:** No
  35 * **Experimental:** Yes
  36 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/
  37
  38 odl-topoprocessing-inventory
  39 ----------------------------
  40
  41 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/odl-topoprocessing-inventory/pom.xml;h=ef8b9c3b1cffc72bf871fd7168799ab797e05e5d;hb=refs/heads/stable/nitrogen
  42 * **Feature Description:**  Support for inventory model
  43 * **Top Level:** Yes
  44 * **User Facing:** No
  45 * **Experimental:** Yes
  46 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/
  47
  48 odl-topoprocessing-I2rs
  49 -----------------------
  50
  51 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/odl-topoprocessing-i2rs/pom.xml;h=f6b747cadfebc92d6df58e84ed894ffd390d6768;hb=refs/heads/stable/nitrogen
  52 * **Feature Description:**  Support for i2rs model
  53 * **Top Level:** Yes
  54 * **User Facing:** No
  55 * **Experimental:** Yes
  56 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/
  57
  58 odl-topoprocessing-inventory-rendering
  59 --------------------------------------
  60
  61 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/odl-topoprocessing-inventory-rendering/pom.xml;h=cf278e2429f7ae048eac134a7c7b7f7095d4ba24;hb=refs/heads/stable/nitrogen
  62 * **Feature Description:**  Rendering demo
  63 * **Top Level:** Yes
  64 * **User Facing:** No
  65 * **Experimental:** Yes
  66 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/
  67
  68 Documentation
  69 =============
  70
  71 * **Developer Guide(s):**
  72
  73   * :ref:`topoprocessing-dev-guide`
  74   * `Wiki <https://wiki.opendaylight.org/view/Topology_Processing_Framework:Developer_Guide>`_
  75
  76 Security Considerations
  77 =======================
  78
  79 * No external interfaces other then restconf
  80 * No known security issues
  81
  82 Quality Assurance
  83 =================
  84
  85 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.topoprocessing%3Atopoprocessing-aggregator>`_ (80%)
  86 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-nitrogen/>`_
  87
  88 Migration
  89 ---------
  90
  91 * Not supported
  92
  93 Compatibility
  94 -------------
  95
  96 * Compatible
  97
  98 Bugs Fixed
  99 ----------
 100
 101 * `Link to fixed bugs <https://bugs.opendaylight.org/buglist.cgi?chfield=bug_status&chfieldto=Now&component=General&f1=bug_status&f2=bug_status&o1=changedafter&o2=changedbefore&product=topoprocessing&query_format=advanced&resolution=FIXED&v1=2017-4-24&v2=2017-9-11>`_
 102
 103 Known Issues
 104 ------------
 105
 106 * Leafs which are children (direct or indirect) of list can't be used as target fields
 107 * Aggregation of termination points in case of more mappings works only if all underlay topologies are from the same model and only if that model is Network Topology or I2RS
 108 * Aggregation of termination points in combination with aggregation of nodes doesn't work with inventory model
 109 * Aggregation of termination points in combination with aggregation of nodes in case of more mappings works only if aggregation of termination points is specified on each underlay topology and only if model of all underlay topologies is the same
 110 * Filtration of termination points in case of more filters works only if all underlay topologies are from the same model
 111 * Maximum of one correlation per correlation item (aggregation may not work correctly in case of more correlation with the same correlation item)
 112 * Link aggregation works only if user specify also link computation
 113
 114
 115 **MLMT limitations**
 116
 117 * The mlmt module provides YANG models as based on:
 118   * network-topology YANG model version 2013-10-21
 119   * TED YANG model version 2013-10-21
 120 * The mlmt module works with underlay topologies based on:
 121   * network-topology YANG model version 2013-10-21
 122   * isis-topology YANG model version 2013-10-21
 123 * The mlmt module does not support underlay topologies based on ospf-topology YANG model 2013-10-21.
 124
 125
 126 End-of-life
 127 ===========
 128
 129 * Network Topology model is not supported for overlay topologies
 130
 131 Release Mechanics
 132 =================
 133
 134 * `Link to release plan <https://wiki.opendaylight.org/view/Topology_Processing_Framework:NITROGEN_Release_Plan>`_